Skip to main content
POST
/
payment
/
api
/
v1
/
offramp
/
payout
Initiate Offramp Payout
curl --request POST \
  --url https://api.carbnconnect.com/payment/api/v1/offramp/payout \
  --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",
  "crypto_deposit_id": "0750ead5-7f17-4470-8b8f-f13429f7232e"
}
'
{
  "id": "5bb01569-77ac-437a-82ef-a8f1deca18d5",
  "status": "PAYMENT_SUBMITTED",
  "source_amount": 2,
  "destination_amount": 115.25,
  "rail_fee": 10,
  "account_details": {
    "accountId": "6704bfed-79da-4a1c-89ac-0444ccd88db8",
    "currency": "PHP",
    "userId": "b8aacdf0-876b-43c1-bbe1-2f2465bbed86",
    "bank_account": {
      "bank_name": "seabank",
      "account_holder_name": "Jhoebe Kates Albino",
      "recipient_account_number": "14313487142"
    },
    "bank_account_type": "INDIVIDUAL"
  }
}

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"

​
crypto_deposit_id
string<uuid>
required

The unique identifier of the crypto deposit transaction

Example:

"0750ead5-7f17-4470-8b8f-f13429f7232e"

Response

Payout initiated successfully

​
id
string<uuid>

Unique identifier for the payout transaction

Example:

"5bb01569-77ac-437a-82ef-a8f1deca18d5"

​
status
string

Current status of the payout transaction

Example:

"PAYMENT_SUBMITTED"

​
source_amount
number

Amount of crypto being converted (source amount)

Example:

2

​
destination_amount
number

Amount of fiat to be received (destination amount)

Example:

115.25

​
rail_fee
number

Rail fee charged for the transfer

Example:

10

​
account_details
object