Archive a recipient

curl --request POST \
  --url https://api.panoflow.io/v1/recipients/{recipient_id}/archive \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/recipients/{recipient_id}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/recipients/{recipient_id}/archive"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "id": "rcp_01JCQY77ZXYYK596NGYA1DQ91K",
  "object": "recipient",
  "name": "Chidi Eze",
  "nickname": "Lagos dispatch",
  "currency": "NGN",
  "status": "archived",
  "archived_at": "2026-10-28T08:35:00Z",
  "bank_account": {
    "account_number": "3089912245",
    "bank_code": "011",
    "bank_name": "First Bank",
    "account_name": "EZE CHIDI JOHN"
  },
  "verified_at": "2026-08-14T13:40:00Z",
  "created_by": {
    "type": "user",
    "id": "usr_01JCG0X454YG4GFDEXZR4YJ2C4",
    "name": "Ngozi Uche"
  },
  "created_at": "2026-08-14T13:40:00Z",
  "updated_at": "2026-10-28T08:35:00Z"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Recipients

Archive a recipient

The “Delete” action in the Recipients table. The recipient stops appearing in lists and pickers but stays on every past transfer. 409 invalid_state when an active or paused scheduled payment still pays this recipient (details.scheduled_payment_ids); cancel those first. Archiving an archived recipient returns it unchanged.

Error codes: invalid_api_key, parameter_invalid, resource_not_found, scope_missing, csrf_token_invalid, idempotency_key_reused, invalid_state, rate_limited.

POST

recipients

{recipient_id}

archive

Archive a recipient

curl --request POST \
  --url https://api.panoflow.io/v1/recipients/{recipient_id}/archive \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/recipients/{recipient_id}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/recipients/{recipient_id}/archive"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "id": "rcp_01JCQY77ZXYYK596NGYA1DQ91K",
  "object": "recipient",
  "name": "Chidi Eze",
  "nickname": "Lagos dispatch",
  "currency": "NGN",
  "status": "archived",
  "archived_at": "2026-10-28T08:35:00Z",
  "bank_account": {
    "account_number": "3089912245",
    "bank_code": "011",
    "bank_name": "First Bank",
    "account_name": "EZE CHIDI JOHN"
  },
  "verified_at": "2026-08-14T13:40:00Z",
  "created_by": {
    "type": "user",
    "id": "usr_01JCG0X454YG4GFDEXZR4YJ2C4",
    "name": "Ngozi Uche"
  },
  "created_at": "2026-08-14T13:40:00Z",
  "updated_at": "2026-10-28T08:35:00Z"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

Idempotency-Key

string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

recipient_id

string

required

rcp_…

Pattern: ^rcp_[0-9A-HJKMNP-TV-Z]{26}$

Response

Archived.

A saved, name-enquiry-verified bank account the business pays.

string

required

rcp_…

object

string

required

Always recipient.

Allowed value: "recipient"

name

string

required

Display name, e.g. "Zaria Haulage Co". The verified bank name is bank_account.account_name.

Maximum string length: 140

currency

enum<string>

required

ISO 4217. Only NGN is live at launch; others return 422 currency_not_enabled.

Available options:

NGN,

USD,

GBP,

EUR,

GHS,

KES

status

enum<string>

required

archived recipients are hidden from lists and pickers but stay on past transfers.

Available options:

active,

archived

bank_account

object

required

The verified account. account_name is the name the bank returned. Fixed once saved.

Show child attributes

verified_at

string<date-time>

required

When the name enquiry that verified this recipient ran.

Example:

"2026-10-27T08:41:00Z"

created_by

object

required

Who did something. Shown in activity, approvals and the audit log.

Show child attributes

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

updated_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

nickname

string

Optional label shown under the name, e.g. "Kano route haulage".

Maximum string length: 60

string<email>

Where payment receipts are emailed each time they are paid.

Maximum string length: 254

last_payment

object

The most recent payout to this recipient, for "Last paid" ("26 Oct", "Failed 25 Oct").

Show child attributes

agent_id

string

agt_… when an agent saved this recipient.

archived_at

string<date-time>

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

metadata

object

Up to 20 string keys (≤ 40 chars) with string values (≤ 500 chars). Returned on the resource and its events.

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Archive a recipient

Authorizations

Headers

Path Parameters

Response