Skip to main content
GET
/
v1
/
ramp
/
recipients
List Recipients
curl --request GET \
  --url https://api.example.com/v1/ramp/recipients
Endpoint: GET https://api.rebelfi.io/v1/ramp/recipients
List all recipients for your organization, including their KYB status, account counts, and volume summaries.

​
Query Parameters

FieldTypeRequiredDescription
pageintegerNoPage number (default: 1)
per_pageintegerNoResults per page (default: 20, max: 100)

​
Example Request

curl -X GET "https://api.rebelfi.io/v1/ramp/recipients?page=1&per_page=20" \
  -H "x-api-key: your_api_key"

​
Example Response

{
  "data": [
    {
      "id": 1,
      "name": "OnEdge",
      "type": "business",
      "external_id": "ref-123",
      "kyb_status": "approved",
      "onramp_account_count": 1,
      "offramp_account_count": 2,
      "total_volume_usd": "150000.00",
      "transaction_count": 45,
      "created_at": "2025-06-01T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}

​
Response Fields

FieldTypeDescription
dataarrayList of recipient objects
data[].idnumberRecipient identifier
data[].namestringRecipient name
data[].typestringRecipient type
data[].external_idstring?Your external reference ID
data[].kyb_statusstringKYB verification status
data[].onramp_account_countnumberNumber of on-ramp accounts
data[].offramp_account_countnumberNumber of off-ramp accounts
data[].total_volume_usdstringTotal volume in USD
data[].transaction_countnumberTotal number of transactions
data[].created_atstringCreation timestamp (ISO 8601)
pagination.pagenumberCurrent page number
pagination.per_pagenumberResults per page
pagination.totalnumberTotal number of recipients
Results are paginated. Use the page and per_page query parameters to navigate through large result sets.