Upload a Batch

Upload a batch file (CSV or XLSX) containing many payout rows. The file is stored, hashed for duplicate detection, and queued for asynchronous validation. The response returns the batch in uploaded status; the status transitions to validating, then validated (or validation_failed) via webhook.

After validated, review GET /v1/batches/{id} and the summary, then call POST /v1/batches/{id}/confirm to actually create the payouts. Confirmation expires — see expires_at on the batch record.

Maximum file size: 32 MB. Maximum rows per batch: check current limits with support.

POST

batches

Upload a batch

curl --request POST \
  --url https://api.antonpayments.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --form file='@example-file'

const form = new FormData();
form.append('file', '<string>');

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

options.body = form;

fetch('https://api.antonpayments.com/v1/batches', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data",
    "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/batches"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	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>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "id": "bat_01HX8Z9K0M2N3P4Q5R6S7T8UBT",
    "merchant_id": "<string>",
    "uploaded_by": "<string>",
    "status": "uploaded",
    "file_name": "payroll_2026_04_15.csv",
    "file_format": "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

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

Body

multipart/form-data

file

required

CSV or XLSX file. Filename is preserved.

Response

Batch accepted and queued for validation.

data

object

required

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

Show child attributes

⌘I

Upload a batch

curl --request POST \
  --url https://api.antonpayments.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --form file='@example-file'

const form = new FormData();
form.append('file', '<string>');

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

options.body = form;

fetch('https://api.antonpayments.com/v1/batches', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data",
    "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/batches"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	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>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "id": "bat_01HX8Z9K0M2N3P4Q5R6S7T8UBT",
    "merchant_id": "<string>",
    "uploaded_by": "<string>",
    "status": "uploaded",
    "file_name": "payroll_2026_04_15.csv",
    "file_format": "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"
  }
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Upload a Batch

Authorizations

Headers

Body

Response