Skip to main content
POST
/
v1
/
payouts
/
{id}
/
cancel
Cancel a payout
curl --request POST \
  --url https://api.antonpayments.com/v1/payouts/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "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).

Path Parameters

​
id
string
required

Resource identifier.

Response

Payout cancelled.

​
data
object
required