Skip to main content
POST
/
v1
/
payouts
Create a payout
curl --request POST \
  --url http://localhost:8080/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiary_id": "<string>",
  "source_amount": "<string>",
  "source_currency": "<string>",
  "dest_currency": "<string>",
  "method": "bank_transfer",
  "purpose": "<string>",
  "reference": "<string>",
  "network": "<string>",
  "wallet_address": "<string>",
  "token_contract": "<string>",
  "metadata": {}
}
'
{
  "id": "pay_cq1234567890abcdef",
  "merchant_id": "<string>",
  "beneficiary_id": "<string>",
  "batch_id": "<string>",
  "idempotency_key": "<string>",
  "status": "created",
  "method": "bank_transfer",
  "source_amount": "<string>",
  "source_currency": "<string>",
  "dest_amount": "<string>",
  "dest_currency": "<string>",
  "exchange_rate": "<string>",
  "fee": "<string>",
  "fee_currency": "<string>",
  "rail_type": "fiat",
  "rail_provider": "<string>",
  "rail_reference": "<string>",
  "network": "<string>",
  "wallet_address": "<string>",
  "token_contract": "<string>",
  "token_symbol": "<string>",
  "tx_hash": "<string>",
  "block_confirmations": 123,
  "required_confirms": 123,
  "network_fee": "<string>",
  "network_fee_currency": "<string>",
  "purpose": "<string>",
  "reference": "<string>",
  "compliance_status": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "screened_at": "2023-11-07T05:31:56Z",
  "approved_at": "2023-11-07T05:31:56Z",
  "processed_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Headers

Idempotency-Key
string<uuid>

Unique key for idempotent request deduplication

Body

application/json
beneficiary_id
string
required
source_amount
string
required
source_currency
string
required
dest_currency
string
required
method
enum<string>
required
Available options:
bank_transfer,
wire,
sepa,
swift,
ach,
faster_payment,
mobile_money,
wallet,
on_chain,
layer2,
exchange,
stablecoin
purpose
string
required
reference
string
required
network
string
wallet_address
string
token_contract
string
metadata
object

Response

Payout created

id
string
Example:

"pay_cq1234567890abcdef"

merchant_id
string
beneficiary_id
string
batch_id
string
idempotency_key
string
status
enum<string>
Available options:
created,
pending_screening,
screening_failed,
pending_approval,
approved,
processing,
sent,
completed,
failed,
returned,
cancelled,
manual_review
method
enum<string>
Available options:
bank_transfer,
wire,
sepa,
swift,
ach,
faster_payment,
mobile_money,
wallet,
on_chain,
layer2,
exchange,
stablecoin
source_amount
string

Decimal string

source_currency
string
dest_amount
string
dest_currency
string
exchange_rate
string
fee
string
fee_currency
string
rail_type
enum<string>
Available options:
fiat,
crypto,
stablecoin
rail_provider
string
rail_reference
string
network
string
wallet_address
string
token_contract
string
token_symbol
string
tx_hash
string
block_confirmations
integer
required_confirms
integer
network_fee
string
network_fee_currency
string
purpose
string
reference
string
compliance_status
string
metadata
object
created_at
string<date-time>
updated_at
string<date-time>
screened_at
string<date-time>
approved_at
string<date-time>
processed_at
string<date-time>
completed_at
string<date-time>
failed_at
string<date-time>
cancelled_at
string<date-time>