List all beneficiaries

Retrieve a paginated list of all the beneficiaries on the merchant's profile.

Bank and inter-merchant beneficiary lists are retrieved separately.

List bank transfer beneficiaries

Retrieve a paginated list of bank transfer beneficiaries.

get
Authorizations
AuthorizationstringRequired

API Key as Bearer Token

Query parameters
searchstringOptional
pageinteger · int32Optional
page_sizeinteger · int32Optional
show_shadow_deletedbooleanOptional
Responses
200

Success

application/json
get
/v1/beneficiaries/list-bank-beneficiaries
200

Success

List inter-merchant disbursement beneficiaries

List gateway beneficiaries

get
Authorizations
AuthorizationstringRequired

API Key as Bearer Token

Query parameters
searchstringOptional
pageinteger · int32Optional
page_sizeinteger · int32Optional
show_shadow_deletedbooleanOptional
Responses
200

Success

application/json
get
/v1/beneficiaries/list-gateway-beneficiaries
200

Success

Last updated