GuidesAPI ReferenceChangelog
Log In
API Reference

List Beneficiaries

get
https://api.sandbox.uqpay.tech/api/v1/beneficiaries

Get list of beneficiaries.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
≥ 1

The maximum number of items to return per page. This number can be between 10 - 100, and will default to 10

integer
required
≥ 1

The page number to retrieve the next set of items. The number has to be greater than 1, and will default to 1

string
enum

Filter on entity type of the beneficiary.One of COMPANY, INDIVIDUAL

Allowed:
string

Nickname of the beneficiary

string

Currency of the beneficiary.Three-letter ISO 4217 currency code.

string

Company of the beneficiary

Headers
string

The value set to the connected account's ID. More information at List Connected Accounts

Responses

Updated over 1 year ago

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 over 1 year ago