List Payouts

GET

payouts

List payouts

curl --request GET \
  --url https://api.antonpayments.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

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

fetch('https://api.antonpayments.com/v1/payouts', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/payouts"

	req, _ := http.NewRequest("GET", 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))

}

{
  "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": "partner_bank",
      "rail_reference": "RAIL-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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

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.

Query Parameters

limit

integer

default:20

Items per page. Maximum 100.

Required range: 1 <= x <= 100

cursor

string

Opaque cursor returned by a previous list response. Omit for the first page.

status

enum<string>[]

Filter by one or more statuses. Repeat the param to pass multiple values.

Payout lifecycle state. See the How Anton Evaluates Payouts guide for the full state machine and integration guidance.

On returned, the source amount is credited back to your balance in the source currency and any unused FX buffer is released; the fee is retained, because the payout was attempted. (A payout cancelled before rail submission releases the source amount, fee and buffer in full.)

Available options:

created,

pending_screening,

screening_failed,

pending_approval,

approved,

processing,

sent,

completed,

failed,

returned,

cancelled,

manual_review,

velocity_blocked,

pending_engine_review,

cannot_be_processed

beneficiary_id

string

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

instrument_id

string

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

batch_id

string

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

dest_currency

string

ISO 4217 three-letter currency code.

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

Example:

"USD"

reference

string

Exact-match filter on the merchant's reference field.

created_after

string<date-time>

RFC 3339 timestamp. Returns payouts with created_at >= this. RFC 3339 / ISO 8601 timestamp in UTC.

Example:

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

created_before

string<date-time>

RFC 3339 timestamp. Returns payouts with created_at <= this (inclusive upper bound — matches /v1/batches). RFC 3339 / ISO 8601 timestamp in UTC.

Example:

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

Response

Paginated list of payouts.

data

object[]

required

Array of results for this page. Element schema varies by endpoint.

Show child attributes

has_more

boolean

required

Whether more results exist beyond this page.

next_cursor

string

Cursor for the next page. Present only when has_more is true.

⌘I

List payouts

curl --request GET \
  --url https://api.antonpayments.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

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

fetch('https://api.antonpayments.com/v1/payouts', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/payouts"

	req, _ := http.NewRequest("GET", 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))

}

{
  "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": "partner_bank",
      "rail_reference": "RAIL-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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Reviews

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Authorizations

Query Parameters

Response