curl -X POST https://sandbox.core.linkio.world/api/payments/offramp \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: withdrawal-2001" \
-d '{
"customer_id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"quote_id": "qte_1wZ4cB6dE8fK2mQ9xLp3VnR7tY",
"payment_details": {
"type": "bank_transfer",
"currency": "NGN",
"details": { "bank_code": "058", "account_number": "0123456789", "account_name": "Ada Obi" }
},
"source_wallet": { "currency": "USDC", "address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8", "network": "base" }
}'
{
"status": "success",
"message": "Offramp payment initiated",
"payment": {
"id": "pay_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": "pending",
"state": "initiated",
"event_id": "evt_7tY1wZ4cB6dE8fK2mQ9xLp3VnR",
"deposit": {
"type": "stablecoin",
"currency": "USDC",
"details": {
"address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8",
"network": "base",
"tag": null
}
}
}
}
{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "source_wallet is required",
"request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": 422,
"errors": [
{ "field": "source_wallet", "message": "source_wallet is required" }
]
}
}
Payments
Create an offramp
Start a payment where the customer sends stablecoin and receives fiat.
POST
/
payments
/
offramp
curl -X POST https://sandbox.core.linkio.world/api/payments/offramp \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: withdrawal-2001" \
-d '{
"customer_id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"quote_id": "qte_1wZ4cB6dE8fK2mQ9xLp3VnR7tY",
"payment_details": {
"type": "bank_transfer",
"currency": "NGN",
"details": { "bank_code": "058", "account_number": "0123456789", "account_name": "Ada Obi" }
},
"source_wallet": { "currency": "USDC", "address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8", "network": "base" }
}'
{
"status": "success",
"message": "Offramp payment initiated",
"payment": {
"id": "pay_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": "pending",
"state": "initiated",
"event_id": "evt_7tY1wZ4cB6dE8fK2mQ9xLp3VnR",
"deposit": {
"type": "stablecoin",
"currency": "USDC",
"details": {
"address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8",
"network": "base",
"tag": null
}
}
}
}
{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "source_wallet is required",
"request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": 422,
"errors": [
{ "field": "source_wallet", "message": "source_wallet is required" }
]
}
}
Requires the Ramps, banks & methods scope (offramp write). See Offramp for a walkthrough.
Headers
string
default:"2026-10-29-atlas"
required
Your account’s API version.
string
Recommended. A unique value so retries don’t create a second payment.
Body
string
required
The customer. Must match the quote’s customer.
string
required
An unexpired, unused offramp quote.
string
default:"1st"
1st if the money goes to the customer, 3rd if it goes to someone else.object
required
The account that receives the fiat.
Show fields
Show fields
string
required
bank_transfer or momo. Must match the quote’s payout_method.string
required
Must match the quote’s
target_currency.string
required
Bank code, or mobile money network code.
string
required
Account number (NGN: 10 digits) or mobile money number (10 to 12 digits).
string
required
Account holder’s name, 2 to 100 characters.
object
required
Response
202 Accepted
string
successstring
Offramp payment initiatedobject
Show fields
Show fields
string
Payment ID, starting with
pay_.string
pendingstring
The current state, usually
initiated.string
The first event’s ID.
Errors
The same as Create an onramp. Offramp-specificvalidation_failed messages are listed on the Offramp page.
curl -X POST https://sandbox.core.linkio.world/api/payments/offramp \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: withdrawal-2001" \
-d '{
"customer_id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"quote_id": "qte_1wZ4cB6dE8fK2mQ9xLp3VnR7tY",
"payment_details": {
"type": "bank_transfer",
"currency": "NGN",
"details": { "bank_code": "058", "account_number": "0123456789", "account_name": "Ada Obi" }
},
"source_wallet": { "currency": "USDC", "address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8", "network": "base" }
}'
{
"status": "success",
"message": "Offramp payment initiated",
"payment": {
"id": "pay_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": "pending",
"state": "initiated",
"event_id": "evt_7tY1wZ4cB6dE8fK2mQ9xLp3VnR",
"deposit": {
"type": "stablecoin",
"currency": "USDC",
"details": {
"address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8",
"network": "base",
"tag": null
}
}
}
}
{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "source_wallet is required",
"request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": 422,
"errors": [
{ "field": "source_wallet", "message": "source_wallet is required" }
]
}
}
Last modified on October 29, 2026
Was this page helpful?