Archive Recipient
curl --request POST \
--url https://api.example.com/v1/ramp/recipients/{id}/archiveimport requests
url = "https://api.example.com/v1/ramp/recipients/{id}/archive"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/ramp/recipients/{id}/archive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/ramp/recipients/{id}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/ramp/recipients/{id}/archive"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/ramp/recipients/{id}/archive")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/ramp/recipients/{id}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyRamping — Recipients
Archive Recipient
POST /v1/ramp/recipients//archive — Archive a recipient
POST
/
v1
/
ramp
/
recipients
/
{id}
/
archive
Archive Recipient
curl --request POST \
--url https://api.example.com/v1/ramp/recipients/{id}/archiveimport requests
url = "https://api.example.com/v1/ramp/recipients/{id}/archive"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/ramp/recipients/{id}/archive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/ramp/recipients/{id}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/ramp/recipients/{id}/archive"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/ramp/recipients/{id}/archive")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/ramp/recipients/{id}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyEndpoint:
POST https://api.rebelfi.io/v1/ramp/recipients/{id}/archivePath Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Recipient identifier |
Example Request
curl -X POST "https://api.rebelfi.io/v1/ramp/recipients/1/archive" \
-H "x-api-key: your_api_key"
const recipient = await client.ramp.archiveRecipient(1);
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
| Field | Type | Description |
|---|---|---|
id | number | Recipient identifier |
name | string | Recipient name |
type | string | Recipient type |
external_id | string? | Your external reference ID |
kyb_status | string | KYB verification status |
address | object? | Recipient address |
bank_accounts | array | List of linked bank accounts |
onramp_account_count | number | Number of on-ramp accounts |
offramp_account_count | number | Number of off-ramp accounts |
total_volume_usd | string | Total volume in USD |
transaction_count | number | Total number of transactions |
created_at | string | Creation timestamp (ISO 8601) |
archived_at | string | Archive timestamp (ISO 8601) |
Archiving is a soft delete. The recipient and its data are preserved but the recipient cannot be used for new operations.