API Reference

List beneficiaries

get
https://api.checker.finance/v1/payments/beneficiaries

Return a paginated list of beneficiaries.

Filtering by customer_id returns the beneficiaries registered for
that customer, plus pooled beneficiaries (registered without a
customer) on payout routes the customer is itself onboarded to. A
well-formed ID that is not one of your customers returns an empty
list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Optional filter by customer (registered for it, or pooled on a route it is onboarded to)

string
enum

Optional filter by beneficiary status

Allowed:
integer
1 to 200
Defaults to 50

Number of items to return per page (default 50, max 200)

string

Keyset pagination cursor returned as next_cursor

Headers
string
required

Your API key

string
required

Request timestamp (ISO 8601 UTC), included in the signature payload

string
required

Unique request nonce (e.g. UUID)

string
required

HMAC-SHA256 hex digest of {METHOD}\n{path}\n{query}\n{X-Timestamp}\n{body}, signed with your API secret. Path excludes the query string; use an empty string for query/body when absent.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?