List recipients
Recipients
List recipients
List saved recipients with optional filters
GET
List recipients
Overview
Retrieve a paginated list of saved recipients belonging to the authenticated merchant. Supports filtering by type, customer, and search term.Authentication
Your merchant API key
Query Parameters
Filter by recipient type.Allowed values:
BANK_ACCOUNT | CRYPTO_ADDRESSFilter by associated customer ID (UUID)Example:
650e8400-e29b-41d4-a716-446655440000Search by account name, account number, or wallet addressExample:
JohnResults per pageDefault:
20 | Max: 100Page number to retrieveDefault:
1Request Example
Response
Array of recipient objects
Current page number
Results per page
Total number of recipients matching the query
Total number of pages available
Success Response
Error Responses
Pagination
This endpoint uses page-based pagination.- Make your initial request (optionally with
limitandpage) - Check
total_pagesto determine how many pages are available - Increment
pageto fetch subsequent pages until you reachtotal_pages
Next Steps
Create recipient
Create a new recipient
Get recipient
Retrieve a single recipient by ID