Cancel a Batch - Anton Payments

POST

batches

{id}

cancel

Cancel a batch

curl --request POST \
  --url https://api.antonpayments.com/v1/batches/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>', DPoP: '<api-key>'}};

fetch('https://api.antonpayments.com/v1/batches/{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/batches/{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_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "DPoP: <api-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"
	"net/http"
	"io"
)

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "id": "bat_01HX8Z9K0M2N3P4Q5R6S7T8UBT",
  "merchant_id": "<string>",
  "uploaded_by": "<string>",
  "file_name": "payroll_2026_04_15.csv",
  "file_size": 123,
  "created_at": "2026-04-15T14:30:00Z",
  "updated_at": "2026-04-15T14:30:00Z",
  "total_rows": 123,
  "valid_rows": 123,
  "invalid_rows": 123,
  "warning_rows": 123,
  "skipped_rows": 123,
  "processed_rows": 123,
  "summary": {
    "new_beneficiaries": 123,
    "matched_beneficiaries": 123,
    "existing_beneficiaries": 123,
    "methods": {},
    "estimated_debits": [
      {
        "currency": "USD",
        "amount": "1234.56",
        "fx_rows": 123,
        "same_currency_rows": 123,
        "rate_timestamp": "2026-04-15T14:30:00Z"
      }
    ],
    "fx_markup_bps": 123,
    "balance_check": {}
  },
  "source_currency": "USD",
  "total_amount": "12345.67",
  "total_currency": "USD",
  "current_row_index": 123,
  "expires_at": "2026-04-15T14:30:00Z",
  "confirmed_at": "2026-04-15T14:30:00Z",
  "confirmed_by": "<string>",
  "cancelled_at": "2026-04-15T14:30:00Z",
  "cancelled_by": "<string>",
  "processing_started_at": "2026-04-15T14:30:00Z",
  "completed_at": "2026-04-15T14:30:00Z"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client_credentials grant (RFC 6749 §4.4) bound to a DPoP keypair (RFC 9449).

Flow (every authenticated /v1 call requires both an access token AND a fresh per-request DPoP proof):

Register a credential via the merchant portal. Anton issues a client_id (ant_oc_<env>_<32hex>) and a client_secret (ant_ocs_<env>_<48hex>, shown ONCE). The portal generates an ES256 or Ed25519 DPoP keypair in your browser; you store the private half.
Mint an access token: POST /oauth/token with Authorization: Basic <client_id:client_secret> and Content-Type: application/x-www-form-urlencoded. Body: grant_type=client_credentials. A DPoP header carrying a proof signed for the token endpoint is required (no ath claim on this proof).
Use the token: send Authorization: DPoP <access_token> plus a fresh DPoP: <proof> header on every /v1 request. The proof JWT MUST carry htm (request method), htu (request URL, no query/fragment), iat (within ±60s), jti (unique within 5 min), and ath (SHA-256 of the access token, base64url).

Tokens expire in 1 hour in production / staging and 8 hours in sandbox. There are no refresh tokens — call /oauth/token again with your secret. Anton's public signing key is published at /.well-known/jwks.json.

OpenAPI 3.0 has no native DPoP scheme; this declaration plus dpopHeader together convey both the access-token Authorization and the per-request proof header.

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.

Path Parameters

string

required

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

Response

Batch cancelled.

A batch upload. Moves through uploaded -> validating -> validated -> confirmed -> processing -> completed | partial | failed. Can be cancelled from any pre-processing state.

string

required

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

Example:

"bat_01HX8Z9K0M2N3P4Q5R6S7T8UBT"

merchant_id

string

required

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

uploaded_by

string

required

User ID of the operator who uploaded this batch.

status

enum<string>

required

Available options:

uploaded,

validating,

validated,

validation_failed,

confirmed,

processing,

completed,

partial,

failed,

cancelled

file_name

string

required

Example:

"payroll_2026_04_15.csv"

file_format

enum<string>

required

Available options:

csv,

xlsx

file_size

integer

required

Bytes.

created_at

string<date-time>

required

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

updated_at

string<date-time>

required

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

total_rows

integer

valid_rows

integer

invalid_rows

integer

warning_rows

integer

skipped_rows

integer

processed_rows

integer

summary

object

Validation summary the merchant reviews before confirming.

Show child attributes

source_currency

string

Default funding currency used for rows that don't specify their own. Set at confirmation.

Pattern: ^[A-Z]{3}$

Example:

"USD"

total_amount

string

Aggregate destination-side amount across every valid row, populated during validation when all rows share a single destination currency. Absent for mixed-currency batches and legacy batches uploaded before the aggregate was materialized — callers should fall back to the per-currency breakdown in summary.estimated_debits.

Example:

"12345.67"

total_currency

string

Currency of total_amount. Absent for mixed-currency batches.

Pattern: ^[A-Z]{3}$

Example:

"USD"

current_row_index

integer

Resumability checkpoint — highest row index successfully processed.

expires_at

string<date-time>

Deadline for confirming a validated batch.

Example:

"2026-04-15T14:30:00Z"

confirmed_at

string<date-time>

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

confirmed_by

string

cancelled_at

string<date-time>

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

cancelled_by

string

processing_started_at

string<date-time>

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

completed_at

string<date-time>

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

List Payouts Created from a BatchCursor-paginated list of payouts created by processing this batch. Row order in the original file is preserved in the response.

⌘I

Cancel a batch

curl --request POST \
  --url https://api.antonpayments.com/v1/batches/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>', DPoP: '<api-key>'}};

fetch('https://api.antonpayments.com/v1/batches/{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/batches/{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_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "DPoP: <api-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"
	"net/http"
	"io"
)

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "id": "bat_01HX8Z9K0M2N3P4Q5R6S7T8UBT",
  "merchant_id": "<string>",
  "uploaded_by": "<string>",
  "file_name": "payroll_2026_04_15.csv",
  "file_size": 123,
  "created_at": "2026-04-15T14:30:00Z",
  "updated_at": "2026-04-15T14:30:00Z",
  "total_rows": 123,
  "valid_rows": 123,
  "invalid_rows": 123,
  "warning_rows": 123,
  "skipped_rows": 123,
  "processed_rows": 123,
  "summary": {
    "new_beneficiaries": 123,
    "matched_beneficiaries": 123,
    "existing_beneficiaries": 123,
    "methods": {},
    "estimated_debits": [
      {
        "currency": "USD",
        "amount": "1234.56",
        "fx_rows": 123,
        "same_currency_rows": 123,
        "rate_timestamp": "2026-04-15T14:30:00Z"
      }
    ],
    "fx_markup_bps": 123,
    "balance_check": {}
  },
  "source_currency": "USD",
  "total_amount": "12345.67",
  "total_currency": "USD",
  "current_row_index": 123,
  "expires_at": "2026-04-15T14:30:00Z",
  "confirmed_at": "2026-04-15T14:30:00Z",
  "confirmed_by": "<string>",
  "cancelled_at": "2026-04-15T14:30:00Z",
  "cancelled_by": "<string>",
  "processing_started_at": "2026-04-15T14:30:00Z",
  "completed_at": "2026-04-15T14:30:00Z"
}