Skip to main content
POST
/
payment
/
api
/
v1
/
offramp
Initiate Offramp
curl --request POST \
  --url https://api.carbnconnect.com/payment/api/v1/offramp \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "5d1aabf5-361e-4470-8b99-51d1ce3ef338",
  "account_id": "5bc098b7-027f-48a9-9c67-c1666555f5a6"
}
'
{
  "address": "9fV7wU6bnbY1Y2Snhmmow8rtUmxhuze6FYVBjm2dRvmX",
  "crypto": "USDC",
  "chain": "solana"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
​
user_id
string<uuid>
required

The unique identifier of the user

Example:

"5d1aabf5-361e-4470-8b99-51d1ce3ef338"

​
account_id
string<uuid>
required

The unique identifier of the registered destination account

Example:

"5bc098b7-027f-48a9-9c67-c1666555f5a6"

Response

Offramp initiated successfully

​
address
string

Cryptocurrency deposit address where users should send their crypto

Example:

"9fV7wU6bnbY1Y2Snhmmow8rtUmxhuze6FYVBjm2dRvmX"

​
crypto
string

Cryptocurrency type (e.g., USDC, BTC, ETH)

Example:

"USDC"

​
chain
string

Blockchain network (e.g., solana, ethereum, polygon)

Example:

"solana"