Skip to main content
GET
Fetch Payout Beneficiaries

Overview

The Fetch Payout Beneficiaries endpoint retrieves a deduplicated list of all unique beneficiaries that have received payouts from your account. This is useful for displaying a list of frequent recipients when creating new payouts.

Usage Examples

Basic Usage

Fetch the first page of beneficiaries with default limit:

Pagination

Fetch a specific page with custom limit:
Search for beneficiaries by account name or number:

Combined Parameters

Use multiple parameters together:

Error Handling

Notes

  • The endpoint returns deduplicated beneficiaries based on unique combinations of bank_code and account_number
  • Search functionality is case-insensitive and matches partial strings in both account_number and account_name fields
  • If no beneficiaries are found, an empty array will be returned in the data field
  • The pagination object always reflects the current state, even when no results are found

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: x >= 1

Response

OK

The response is of type object.