API Reference

Get beneficiaries

get
https://example.com/v1/pay/beneficiaries/all

Retrieve all beneficiaries for the organization with pagination and filtering

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

Page number for pagination

string

Number of items per page

string

Start date for filtering (ISO 8601 format)

string

End date for filtering (ISO 8601 format)

string

Filter by account number

string

Filter by bank code

string

Filter by currency code

string

Filter by country code

string
enum

Filter by payment channel

Allowed:
string

Search across account number, bank code, currency code, country code, and account name

Headers
string
required
length ≥ 1

Starks API Key for authentication

Responses

Updated 9 months ago

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

Updated 9 months ago

Did this page help you?