Save a recipient

curl --request POST \
  --url https://api.panoflow.io/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bank_account": {
    "account_number": "0119337731",
    "bank_code": "058"
  },
  "nickname": "Abuja dispatch",
  "email": "ngozi.adeyemi@example.com"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bank_account: {account_number: '0119337731', bank_code: '058'},
    nickname: 'Abuja dispatch',
    email: 'ngozi.adeyemi@example.com'
  })
};

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

import requests

url = "https://api.panoflow.io/v1/recipients"

payload = {
    "bank_account": {
        "account_number": "0119337731",
        "bank_code": "058"
    },
    "nickname": "Abuja dispatch",
    "email": "ngozi.adeyemi@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "rcp_01JC5GQAPENECFSECZP11HYGCP",
  "object": "recipient",
  "name": "Ngozi Adeyemi",
  "nickname": "Abuja dispatch",
  "email": "ngozi.adeyemi@example.com",
  "currency": "NGN",
  "status": "active",
  "bank_account": {
    "account_number": "0119337731",
    "bank_code": "058",
    "bank_name": "GTBank",
    "account_name": "NGOZI ADEYEMI"
  },
  "verified_at": "2026-10-28T08:29:12Z",
  "created_by": {
    "type": "user",
    "id": "usr_01JCMZ9J92V81E5128Q6RW31FZ",
    "name": "Adaeze Okafor"
  },
  "created_at": "2026-10-28T08:29:40Z",
  "updated_at": "2026-10-28T08:29:40Z"
}

{
  "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": {}
  }
}

{
  "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

Save a recipient

Runs (or reuses a cached) name enquiry and saves the account with the name the bank returned (bank_account.account_name). name is the display name; when omitted it is the account name in title case.

409 duplicate_resource when an active recipient already has this bank and account number (details.recipient_id).
422 name_enquiry_failed / account_number_invalid as for name enquiry.
Agent tokens: the new recipient is checked against the agent’s allowlist rules (422 recipient_not_allowed).

Recipients can also be saved while paying, with save_recipient on POST /transfers.

Error codes: invalid_api_key, parameter_invalid, parameter_missing, scope_missing, csrf_token_invalid, idempotency_key_reused, duplicate_resource, name_enquiry_failed, account_number_invalid, recipient_not_allowed, partner_timeout, bank_unavailable, rate_limited.

POST

recipients

Save a recipient

curl --request POST \
  --url https://api.panoflow.io/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bank_account": {
    "account_number": "0119337731",
    "bank_code": "058"
  },
  "nickname": "Abuja dispatch",
  "email": "ngozi.adeyemi@example.com"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bank_account: {account_number: '0119337731', bank_code: '058'},
    nickname: 'Abuja dispatch',
    email: 'ngozi.adeyemi@example.com'
  })
};

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

import requests

url = "https://api.panoflow.io/v1/recipients"

payload = {
    "bank_account": {
        "account_number": "0119337731",
        "bank_code": "058"
    },
    "nickname": "Abuja dispatch",
    "email": "ngozi.adeyemi@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "rcp_01JC5GQAPENECFSECZP11HYGCP",
  "object": "recipient",
  "name": "Ngozi Adeyemi",
  "nickname": "Abuja dispatch",
  "email": "ngozi.adeyemi@example.com",
  "currency": "NGN",
  "status": "active",
  "bank_account": {
    "account_number": "0119337731",
    "bank_code": "058",
    "bank_name": "GTBank",
    "account_name": "NGOZI ADEYEMI"
  },
  "verified_at": "2026-10-28T08:29:12Z",
  "created_by": {
    "type": "user",
    "id": "usr_01JCMZ9J92V81E5128Q6RW31FZ",
    "name": "Adaeze Okafor"
  },
  "created_at": "2026-10-28T08:29:40Z",
  "updated_at": "2026-10-28T08:29:40Z"
}

{
  "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": {}
  }
}

{
  "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

Body

application/json

bank_account

object

required

The account to verify and save. NGN (NUBAN) only at launch.

Show child attributes

name

string

Display name. Defaults to the bank's account name in title case.

Maximum string length: 140

nickname

string

Optional label.

Maximum string length: 60

string<email>

Optional; receipts are emailed here.

Maximum string length: 254

metadata

object

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

Show child attributes

Response

Saved.

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

Save a recipient

Authorizations

Headers

Body

Response