Skip to main content
POST
/
v1
/
ramp
/
recipients
/
{id}
/
archive
Archive Recipient
curl --request POST \
  --url https://api.example.com/v1/ramp/recipients/{id}/archive
Endpoint: POST https://api.rebelfi.io/v1/ramp/recipients/{id}/archive
Archive a recipient. Archived recipients can no longer be used for new ramping operations.

​
Path Parameters

FieldTypeRequiredDescription
idintegerYesRecipient identifier

​
Example Request

curl -X POST "https://api.rebelfi.io/v1/ramp/recipients/1/archive" \
  -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",
  "archived_at": "2025-07-15T09:30:00.000Z"
}

​
Response Fields

FieldTypeDescription
idnumberRecipient identifier
namestringRecipient name
typestringRecipient type
external_idstring?Your external reference ID
kyb_statusstringKYB verification status
addressobject?Recipient address
bank_accountsarrayList of linked bank accounts
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)
archived_atstringArchive timestamp (ISO 8601)
Archiving is a soft delete. The recipient and its data are preserved but the recipient cannot be used for new operations.