List Recipients
Recipients
List Recipients
Retrieve a paginated list of all payment recipients associated with your account.
GET
List Recipients
Retrieve a paginated list of all payment recipients associated with your account. This endpoint supports filtering by various criteria.
Overview
This endpoint returns all recipients you’ve created, with optional filtering capabilities. You can filter by account type, country, currency, account name, or account number.Query Parameters
integer
Page number for pagination (default: 1)
integer
Number of items per page (default: 10)
string
Filter by account type: “individual” or “business”
string
Filter by country name
string
Filter by currency code (e.g., “NGN”, “USD”)
string
Filter by account holder name (partial match)
string
Filter by account number
Response
object
Paginated response containing:
total_pages: Total number of pagescurrent_page: Current page numbertotal_records: Total number of recipientsnext_page: URL for next pageprevious_page: URL for previous pageitems: Array of recipient objects
object
Each recipient object includes:
id: Recipient UUIDaccount_number: Account numberaccount_name: Account holder nameaccount_type: Account typeaccount_currency: Currency codeaccount_bank_name: Bank nameaccount_bank_code: Bank codelimit: Payment limitidentification: Identification informationpayment_details: Payment detailscreated_at: Creation timestampupdated_at: Last update timestamp
Authorizations
Bearer token authentication. Include your API key in the Authorization header as: Bearer {your_api_key}
Query Parameters
Page number for pagination
Number of items per page
Filter by account type (individual | business)
Available options:
individual, business Filter by country
Filter by currency code
Filter by account name
Filter by account number