Skip to main content
GET
/
v1
/
recipients
List recipients
curl --request GET \
  --url https://api.daya.co/v1/recipients \
  --header 'X-Api-Key: <x-api-key>'
{
  "data": [
    {
      "id": "750e8400-e29b-41d4-a716-446655440000",
      "type": "BANK_ACCOUNT",
      "first_name": "John",
      "last_name": "Doe",
      "bank_account": {
        "account_number": "1234567890",
        "account_name": "John Doe",
        "bank_code": "044",
        "bank_name": "Access Bank"
      },
      "crypto_address": null,
      "created_at": "2026-01-05T15:04:05Z"
    },
    {
      "id": "850e8400-e29b-41d4-a716-446655440000",
      "type": "CRYPTO_ADDRESS",
      "first_name": null,
      "last_name": null,
      "bank_account": null,
      "crypto_address": {
        "asset": "USDC",
        "chain": "BASE",
        "address": "0x1234567890abcdef1234567890abcdef12345678"
      },
      "created_at": "2026-01-05T15:04:05Z"
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 2,
  "total_pages": 1
}

​
Overview

Retrieve a paginated list of payout recipients belonging to the authenticated merchant. Supports filtering by type, customer, and search term.

​
Authentication

​
X-Api-Key
string
required
Your merchant API key

​
Query Parameters

​
type
string
Filter by recipient typeAllowed values: BANK_ACCOUNT | CRYPTO_ADDRESS
​
customer_id
string
Filter by associated customer ID (UUID)Example: 650e8400-e29b-41d4-a716-446655440000
​
search
string
Search by account name, account number, or wallet addressExample: John
​
limit
integer
Results per pageDefault: 20 | Max: 100
​
page
integer
Page number to retrieveDefault: 1

​
Request Example

curl --request GET \
  --url 'https://api.daya.co/v1/recipients?limit=20&page=1' \
  --header 'X-Api-Key: YOUR_API_KEY'

​
Response

​
data
array
required
Array of recipient objects
​
page
integer
required
Current page number
​
limit
integer
required
Results per page
​
total
integer
required
Total number of recipients matching the query
​
total_pages
integer
required
Total number of pages available

​
Success Response

{
  "data": [
    {
      "id": "750e8400-e29b-41d4-a716-446655440000",
      "type": "BANK_ACCOUNT",
      "first_name": "John",
      "last_name": "Doe",
      "bank_account": {
        "account_number": "1234567890",
        "account_name": "John Doe",
        "bank_code": "044",
        "bank_name": "Access Bank"
      },
      "crypto_address": null,
      "created_at": "2026-01-05T15:04:05Z"
    },
    {
      "id": "850e8400-e29b-41d4-a716-446655440000",
      "type": "CRYPTO_ADDRESS",
      "first_name": null,
      "last_name": null,
      "bank_account": null,
      "crypto_address": {
        "asset": "USDC",
        "chain": "BASE",
        "address": "0x1234567890abcdef1234567890abcdef12345678"
      },
      "created_at": "2026-01-05T15:04:05Z"
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 2,
  "total_pages": 1
}

​
Error Responses

{
  "error": {
    "code": "validation_failed",
    "message": "Validation failed",
    "details": "type must be one of: BANK_ACCOUNT, CRYPTO_ADDRESS"
  }
}

​
Pagination

This endpoint uses page-based pagination.
  1. Make your initial request (optionally with limit and page)
  2. Check total_pages to determine how many pages are available
  3. Increment page to fetch subsequent pages until you reach total_pages

​
Next Steps

Create recipient

Create a new payout recipient

Get recipient

Retrieve a single recipient by ID