Skip to main content
GET
/
v1
/
ramp
/
recipients
/
{id}
Get Recipient
curl --request GET \
  --url https://api.example.com/v1/ramp/recipients/{id}
Endpoint: GET https://api.rebelfi.io/v1/ramp/recipients/{id}
Retrieve full details for a specific recipient, including their address, bank accounts, and volume summaries.

Path Parameters

FieldTypeRequiredDescription
idintegerYesRecipient identifier

Example Request

curl -X GET "https://api.rebelfi.io/v1/ramp/recipients/1" \
  -H "x-api-key: your_api_key"

Example Response

{
  "id": 1,
  "name": "OnEdge",
  "type": "business",
  "external_id": "ref-123",
  "kyb_status": "approved",
  "address": {
    "street1": "123 Main St",
    "street2": null,
    "city": "New York",
    "region": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "bank_accounts": [
    {
      "id": 10,
      "account_number": "****1234",
      "routing_number": "021000021",
      "bank_name": "Chase",
      "capabilities": ["onramp", "offramp"],
      "status": "active",
      "destination_asset": "USDC",
      "network_id": "base"
    }
  ],
  "onramp_account_count": 1,
  "offramp_account_count": 2,
  "total_volume_usd": "150000.00",
  "transaction_count": 45,
  "created_at": "2025-06-01T12:00:00.000Z"
}

Response Fields

FieldTypeDescription
idnumberRecipient identifier
namestringRecipient name
typestringRecipient type
external_idstring?Your external reference ID
kyb_statusstringKYB verification status
addressobject?Recipient address
address.street1stringStreet address line 1
address.street2string?Street address line 2
address.citystringCity
address.regionstring?State or region
address.postal_codestring?Postal code
address.countrystringCountry code
bank_accountsarrayList of linked bank accounts
bank_accounts[].idnumberBank account identifier
bank_accounts[].account_numberstringMasked account number
bank_accounts[].routing_numberstringBank routing number
bank_accounts[].bank_namestringBank name
bank_accounts[].capabilitiesstring[]Account capabilities (onramp, offramp)
bank_accounts[].statusstringAccount status
bank_accounts[].destination_assetstringDestination asset (e.g., USDC)
bank_accounts[].network_idstringBlockchain network identifier
onramp_account_countnumberNumber of on-ramp accounts
offramp_account_countnumberNumber of off-ramp accounts
total_volume_usdstringTotal volume in USD
transaction_countnumberTotal number of transactions
created_atstringCreation timestamp (ISO 8601)
Bank account numbers are masked in the response for security. Only the last 4 digits are visible.