Skip to main content
POST
/
v1
/
payouts
Create a payout
curl --request POST \
  --url https://api.antonpayments.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "payee_id": "pye_abc123",
  "instrument_id": "ins_abc123",
  "source_amount": "1000.00",
  "dest_amount": "850.00",
  "dest_currency": "EUR",
  "method": "bank_transfer",
  "purpose": "<string>",
  "reference": "<string>",
  "source_currency": "USD",
  "rail_type": "fiat",
  "network": "<string>",
  "fee_bearer": "merchant",
  "fixed_side": "fixed_source",
  "metadata": {}
}
'
{
  "data": {
    "id": "pay_abc123",
    "merchant_id": "<string>",
    "payee_id": "<string>",
    "instrument_id": "<string>",
    "batch_id": "<string>",
    "status": "created",
    "method": "<string>",
    "source_amount": "<string>",
    "source_currency": "<string>",
    "dest_amount": "<string>",
    "dest_currency": "<string>",
    "exchange_rate": "<string>",
    "fee": "<string>",
    "fee_currency": "<string>",
    "fee_bearer": "merchant",
    "fixed_side": "fixed_source",
    "total_debited": "<string>",
    "total_debited_currency": "<string>",
    "rail_type": "<string>",
    "rail_provider": "<string>",
    "rail_reference": "<string>",
    "network": "<string>",
    "wallet_address": "<string>",
    "tx_hash": "<string>",
    "cancelled_reason": "<string>",
    "purpose": "<string>",
    "reference": "<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_* (production) or ak_test_* (sandbox).

Headers

Idempotency-Key
string
required

Unique key to ensure idempotent request processing.

Body

application/json
payee_id
string
required
Example:

"pye_abc123"

instrument_id
string
required
Example:

"ins_abc123"

source_amount
string
required
Example:

"1000.00"

dest_amount
string
required
Example:

"850.00"

dest_currency
string
required
Example:

"EUR"

method
string
required
Example:

"bank_transfer"

purpose
string
required
Maximum string length: 255
reference
string
required
Maximum string length: 100
source_currency
string
Example:

"USD"

rail_type
enum<string>
Available options:
fiat,
crypto,
stablecoin
network
string
fee_bearer
enum<string>
Available options:
merchant,
payee
fixed_side
enum<string>
Available options:
fixed_source,
fixed_dest
metadata
object

Response

Payout created.

data
object
required