Skip to main content
POST
List your beneficiaries
The fields above are what you encrypt, not what goes on the wire. The body is always { "data": "<aes-256-gcm ciphertext>" } — see Authentication.
Every field is optional. Sending {} lists all of them.

Pagination

next_cursor is null on the last page. Pass it back as cursor to fetch the next one — do not construct cursors yourself, and do not assume they stay valid indefinitely.
recipient_details is masked on every item, the same as a single read. A list is not a way to export what you stored.

Example request

The snippets assume you have already encrypted the body and signed the request — see the Quickstart for the full helper in Node and Python.
See Beneficiaries for how saving and reusing recipients fits together, and Errors for the envelope shape shared by every endpoint.

Authorizations

x-api-key
string
header
required

Identifies your account. Issued from Developer Tools in the dashboard.

Authorization
string
header
required

Short-lived token from /api/v1/user/login, bound to your account and mode. Expires in 900 seconds.

Headers

x-timestamp
integer<int64>
required

Unix epoch in seconds — not milliseconds. Must be within ±5 minutes of our clock, which is what makes a captured request unusable later. Keep your client's clock NTP-synced.

Example:

1748023400

x-signature
string
required

HMAC-SHA256 over the signing string, hex encoded. The timestamp is part of what is signed, so a replayed body cannot be re-dated. See https://docs.pontisglobe.com/authentication for how it is built.

Example:

"2f8a9b4c1d7e0a3f6b8c2d5e9f1a4b7c0d3e6f9a2b5c8d1e4f7a0b3c6d9e2f5a"

Body

application/json
country_code
string
Required string length: 2
Example:

"NG"

currency_code
string
Required string length: 2 - 8
Example:

"NGN"

cursor
string<uuid>

next_cursor from the previous page — it is the last beneficiary_id of that page. Do not construct one yourself.

limit
integer
default:20
Required range: 1 <= x <= 100
Example:

50

Response

A page of beneficiaries.

ok
enum<boolean>
Available options:
true
data
object