Skip to main content
GET
/
v1
/
recipients
Get all recipients
curl --request GET \
  --url https://api.railsfromthecrypt.com/v1/recipients \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "message": "Recipients retrieved successfully",
  "data": [
    {
      "id": "rec_01J8V9ZP3A7",
      "type": "crypto",
      "name": "My USDT Wallet",
      "active": true,
      "details": {
        "network": "Polygon",
        "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
        "symbol": "USDT"
      },
      "created_at": "2025-10-10T09:15:21Z"
    },
    {
      "id": "rec_02K9W0AQ4B8",
      "type": "fiat",
      "name": "Acme Ltd",
      "active": true,
      "details": {
        "bank_name": "Wema Bank",
        "account_number": "0123456789",
        "account_name": "ACME LTD",
        "currency": "NGN"
      },
      "created_at": "2025-10-12T14:30:00Z"
    }
  ],
  "meta": {
    "count": 25,
    "next": 2,
    "prev": null
  }
}
Retrieve all recipients for your account. You can filter by recipient type (crypto or fiat) using the type query parameter.

Headers

​
x-api-key
string
required

API key for authentication

Query Parameters

​
type
enum<string>

Filter by recipient type.

Available options:
crypto,
fiat
​
currency
string

Filter by currency (e.g. NGN, USDC).

​
limit
integer

Number of items per page.

Example:

10

​
page
integer

Page number.

Example:

1

Response

200 - application/json

Recipients retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Recipients retrieved successfully"

​
data
object[]
​
meta
object