Skip to main content
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 pages
  • current_page: Current page number
  • total_records: Total number of recipients
  • next_page: URL for next page
  • previous_page: URL for previous page
  • items: Array of recipient objects
object
Each recipient object includes:
  • id: Recipient UUID
  • account_number: Account number
  • account_name: Account holder name
  • account_type: Account type
  • account_currency: Currency code
  • account_bank_name: Bank name
  • account_bank_code: Bank code
  • limit: Payment limit
  • identification: Identification information
  • payment_details: Payment details
  • created_at: Creation timestamp
  • updated_at: Last update timestamp

Authorizations

Authorization
string
header
required

Bearer token authentication. Include your API key in the Authorization header as: Bearer {your_api_key}

Query Parameters

page
integer
default:1

Page number for pagination

per_page
integer
default:10

Number of items per page

account_type
enum<string>

Filter by account type (individual | business)

Available options:
individual,
business
country
string

Filter by country

currency
string

Filter by currency code

account_name
string

Filter by account name

account_number
string

Filter by account number

Response

200 - application/json

Recipients retrieved successfully

success
boolean
message
string
stan
string<uuid>
data
object