Skip to main content
GET
/
api
/
v3
/
deposit
/
crypto-bridge
/
{kotani_reference_id}
/
refund-config
Get current refund config
curl --request GET \
  --url https://sandbox-api.kotanipay.com/api/v3/api/v3/deposit/crypto-bridge/{kotani_reference_id}/refund-config \
  --header 'Authorization: Bearer <token>'
{
  "success": false,
  "message": "Transaction not found",
  "data": {}
}
Retrieve the current refund configuration for a crypto bridge deposit. The refund config holds the bolt11 Lightning invoice (or fallback on-chain address) that the crypto provider uses to return funds to Kotani Pay if the transaction’s fiat settlement fails.

​
When to Use

Check the refund config when:
  • Displaying refund readiness to the user
  • Verifying the refund invoice is still valid (not expired)
  • Deciding whether to call Regenerate Refund Config because the current invoice has expired

​
Response Fields

FieldDescription
primary_methodCRYPTO_INVOICE (Lightning bolt11) or CRYPTO_ADDRESS (on-chain fallback)
refund_invoiceThe bolt11 invoice the provider pays if settlement fails (Lightning only)
refund_payment_hashPayment hash for the Lightning invoice — use this to track refund execution
refund_amount_msatRefund amount in millisatoshis
fallback_addressKotani on-chain address used if the invoice cannot be paid
expires_atISO 8601 timestamp when the bolt11 invoice expires
regeneration_countHow many times the invoice has been regenerated (max 3)
regenerations_remainingRegenerations still available
Note: Only Lightning (CHAIN: LIGHTNING) transactions carry a bolt11 refund invoice. On-chain crypto bridge transactions always use CRYPTO_ADDRESS as the primary refund method and the expires_at field will be absent.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
kotani_reference_id
string
required

Response

404 - application/json
​
success
boolean
Example:

false

​
message
string
Example:

"Transaction not found"

​
data
object
Example:
{}