List Beneficiaries - Anton Payments

GET

/

v1

/

beneficiaries

List beneficiaries

curl --request GET \
  --url https://api.antonpayments.com/v1/beneficiaries \
  --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/beneficiaries', 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/beneficiaries",
  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/beneficiaries"

	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": "ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1",
      "merchant_id": "mer_01HX8Z9K0M2N3P4Q5R6S7T8UZZ",
      "type": "individual",
      "status": "active",
      "display_name": "Jane Smith",
      "country": "GB",
      "external_ref": "contractor-1042",
      "risk_score": 120,
      "risk_tier": "LOW",
      "metadata": {
        "department": "engineering"
      },
      "created_at": "2026-04-15T14:30:00Z",
      "updated_at": "2026-04-15T14:30:00Z"
    }
  ],
  "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 beneficiary status.

Available options:

active,

archived,

blocked

type

enum<string>

Filter by beneficiary type.

Available options:

individual,

business

country

string

Filter by ISO-3166 alpha-2 country code. ISO 3166-1 alpha-2 country code.

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

Example:

"US"

search

string

Substring match on the beneficiary's display name / external reference.

created_via

enum<string>

Filter by how the beneficiary was created.

Available options:

api,

batch,

portal

source_batch_id

string

Filter to beneficiaries a specific batch created or first referenced (ANT-105 provenance). Prefixed bat_.

Response

Paginated list of beneficiaries.

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 beneficiaries

curl --request GET \
  --url https://api.antonpayments.com/v1/beneficiaries \
  --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/beneficiaries', 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/beneficiaries",
  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/beneficiaries"

	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": "ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1",
      "merchant_id": "mer_01HX8Z9K0M2N3P4Q5R6S7T8UZZ",
      "type": "individual",
      "status": "active",
      "display_name": "Jane Smith",
      "country": "GB",
      "external_ref": "contractor-1042",
      "risk_score": 120,
      "risk_tier": "LOW",
      "metadata": {
        "department": "engineering"
      },
      "created_at": "2026-04-15T14:30:00Z",
      "updated_at": "2026-04-15T14:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}