Create Payout

Create a payout to a crypto wallet address

POST /partners/accounts/{account_ref}/payout/address

Create Payout

cURL

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/payout/address \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-Nonce: <api-key>' \
  --header 'X-API-Signature: <api-key>' \
  --data '
{
  "amount": "10.5",
  "ccy": "USDC",
  "chain_id": 8453,
  "wallet_address": "<string>",
  "metadata": {},
  "reference": "<string>",
  "token_address": "<string>"
}
'

200

{
  "data": {
    "amount": "<string>",
    "created_at": "<string>",
    "currency": "<string>",
    "customer": {
      "created_at": "<string>",
      "deleted_at": "<string>",
      "email": "<string>",
      "id": "<string>",
      "metadata": [
        123
      ],
      "name": "<string>",
      "org_id": "<string>",
      "phone": "<string>",
      "properties": [
        123
      ],
      "reference": "<string>",
      "updated_at": "<string>",
      "wallet_address": "<string>"
    },
    "customer_id": "<string>",
    "id": "<string>",
    "invoice_id": "<string>",
    "next_action": "<string>",
    "org_id": "<string>",
    "parent_id": "<string>",
    "properties": {},
    "reference": "<string>",
    "scheduled_time": 123,
    "updated_at": "<string>"
  },
  "error": true,
  "message": "<string>"
}

Authorizations

X-API-KEY · string · header · required

X-API-Nonce · string · header · required

X-API-Signature · string · header · required

Path Parameters

account_ref · string · required

Merchant-defined virtual account reference

Body

application/json

body

amount · string · required

Amount to send (token units as a decimal string).

Example:

"10.5"

ccy · string · required

Token/currency symbol to send.

Example:

"USDC"

chain_id · integer · required

Destination chain ID.

Example:

8453

wallet_address · string · required

Destination wallet address.

metadata · object

Optional payout metadata returned on the payment record.

Show child attributes

reference · string

Optional client reference (max 1024 chars).

Maximum string length: 1024

token_address · string

Token contract address when not the native asset.

Response

200

application/json

OK

data · object

Response payload when the request succeeded.

Show child attributes

error · boolean

True when the request failed.

message · string

Human-readable status or error message.