Cancel a Payout

Cancel a payout that has not yet been submitted to a rail. Cancellation is only possible from created, pending_screening, pending_approval, pending_engine_review, or manual_review. Once a payout reaches processing or beyond, it cannot be cancelled via the API — contact support if you need to halt a payout in flight.

Any debited source funds (source amount, fee, and cross-currency buffer) are released back to the merchant balance on successful cancellation.

Requires an Idempotency-Key header.

POST

payouts

{id}

cancel

Cancel a payout

curl --request POST \
  --url https://api.antonpayments.com/v1/payouts/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "reason": "<string>",
  "end_user_ip": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: '<string>', end_user_ip: '<string>'})
};

fetch('https://api.antonpayments.com/v1/payouts/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.antonpayments.com/v1/payouts/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'end_user_ip' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "DPoP: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/payouts/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"end_user_ip\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "pay_01HX8Z9K0M2N3P4Q5R6S7T8UAB",
    "merchant_id": "mer_01HX8Z9K0M2N3P4Q5R6S7T8UZZ",
    "beneficiary_id": "ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1",
    "instrument_id": "ins_01HX8Z9K0M2N3P4Q5R6S7T8UA2",
    "status": "processing",
    "method": "sepa",
    "source_amount": "550.00",
    "source_currency": "USD",
    "dest_amount": "500.00",
    "dest_currency": "EUR",
    "exchange_rate": "0.9091",
    "fee": "5.00",
    "fee_currency": "USD",
    "fee_bearer": "merchant",
    "fixed_side": "fixed_dest",
    "total_debited": "557.50",
    "total_debited_currency": "USD",
    "fee_finalized": false,
    "buffer_amount": "2.50",
    "buffer_currency": "USD",
    "rail_type": "fiat",
    "rail_provider": "openpayd",
    "rail_reference": "OP-2026-04-15-778812",
    "network": "sepa",
    "purpose": "supplier_payment",
    "reference": "PO-8821",
    "created_at": "2026-04-15T14:30:00Z",
    "updated_at": "2026-04-15T14:30:05Z",
    "screened_at": "2026-04-15T14:30:02Z",
    "approved_at": "2026-04-15T14:30:04Z",
    "processed_at": "2026-04-15T14:30:05Z"
  }
}

Authorizations

DPoP

string

header

required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Headers

Idempotency-Key

string

required

Unique key identifying this operation. Sending the same key twice returns the original response instead of creating a duplicate. Keys are retained for 24 hours.

Maximum string length: 255

Path Parameters

string

required

Pattern: ^pay_[a-zA-Z0-9]+$

Body

application/json

reason

string

Free-form reason for cancellation. Recorded in the audit log.

Maximum string length: 255

end_user_ip

string

Response

Payout cancelled.

data

object

required

A single payment from your merchant balance to a beneficiary's instrument. Moves through a 13-state machine — see the How Anton Evaluates Payouts guide.

Rail-specific fields (rail_provider, rail_reference, network, wallet_address, tx_hash, etc.) populate as the payout moves through approved -> processing -> sent -> completed.

Show child attributes

Example:

{
  "id": "pay_01HX8Z9K0M2N3P4Q5R6S7T8UAB",
  "merchant_id": "mer_01HX8Z9K0M2N3P4Q5R6S7T8UZZ",
  "beneficiary_id": "ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1",
  "instrument_id": "ins_01HX8Z9K0M2N3P4Q5R6S7T8UA2",
  "status": "processing",
  "method": "sepa",
  "source_amount": "550.00",
  "source_currency": "USD",
  "dest_amount": "500.00",
  "dest_currency": "EUR",
  "exchange_rate": "0.9091",
  "fee": "5.00",
  "fee_currency": "USD",
  "fee_bearer": "merchant",
  "fixed_side": "fixed_dest",
  "total_debited": "557.50",
  "total_debited_currency": "USD",
  "fee_finalized": false,
  "buffer_amount": "2.50",
  "buffer_currency": "USD",
  "rail_type": "fiat",
  "rail_provider": "openpayd",
  "rail_reference": "OP-2026-04-15-778812",
  "network": "sepa",
  "purpose": "supplier_payment",
  "reference": "PO-8821",
  "created_at": "2026-04-15T14:30:00Z",
  "updated_at": "2026-04-15T14:30:05Z",
  "screened_at": "2026-04-15T14:30:02Z",
  "approved_at": "2026-04-15T14:30:04Z",
  "processed_at": "2026-04-15T14:30:05Z"
}

⌘I

Cancel a payout

curl --request POST \
  --url https://api.antonpayments.com/v1/payouts/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "reason": "<string>",
  "end_user_ip": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: '<string>', end_user_ip: '<string>'})
};

fetch('https://api.antonpayments.com/v1/payouts/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.antonpayments.com/v1/payouts/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'end_user_ip' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "DPoP: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/payouts/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"end_user_ip\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "pay_01HX8Z9K0M2N3P4Q5R6S7T8UAB",
    "merchant_id": "mer_01HX8Z9K0M2N3P4Q5R6S7T8UZZ",
    "beneficiary_id": "ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1",
    "instrument_id": "ins_01HX8Z9K0M2N3P4Q5R6S7T8UA2",
    "status": "processing",
    "method": "sepa",
    "source_amount": "550.00",
    "source_currency": "USD",
    "dest_amount": "500.00",
    "dest_currency": "EUR",
    "exchange_rate": "0.9091",
    "fee": "5.00",
    "fee_currency": "USD",
    "fee_bearer": "merchant",
    "fixed_side": "fixed_dest",
    "total_debited": "557.50",
    "total_debited_currency": "USD",
    "fee_finalized": false,
    "buffer_amount": "2.50",
    "buffer_currency": "USD",
    "rail_type": "fiat",
    "rail_provider": "openpayd",
    "rail_reference": "OP-2026-04-15-778812",
    "network": "sepa",
    "purpose": "supplier_payment",
    "reference": "PO-8821",
    "created_at": "2026-04-15T14:30:00Z",
    "updated_at": "2026-04-15T14:30:05Z",
    "screened_at": "2026-04-15T14:30:02Z",
    "approved_at": "2026-04-15T14:30:04Z",
    "processed_at": "2026-04-15T14:30:05Z"
  }
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Cancel a Payout

Authorizations

Headers

Path Parameters

Body

Response