Skip to main content
PATCH
Rename an account

Authorizations

Authorization
string
header
required

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

Headers

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

account_id
string
required

Account.

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

Body

application/json

Rename an account.

name
string
required

New name ("Rename"). Only the team sees it.

Required string length: 1 - 40

Response

OK.

A customer account, with its own account number and balances.

id
string
required

Account id.

Pattern: ^acc_[0-9A-HJKMNP-TV-Z]{26}$
object
string
required

Always account.

Allowed value: "account"
created_at
string<date-time>
required

When it was created.

Example:

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

updated_at
string<date-time>
required

When it was created.

Example:

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

name
string
required

Name in PanoFlow ("Main", "Payroll", "Savings"). Only the team sees it.

Maximum string length: 40
display_name
string
required

Currency plus name, e.g. "Naira · Main".

type
enum<string>
required

main: the primary account per currency (Naira · Main opens on approval).

Available options:
main,
payroll,
sub,
agent
is_primary
boolean
required

True for the primary account of its currency ("Primary account" vs "Sub-account").

currency
enum<string>
required

Currency.

Available options:
NGN,
USD,
GBP,
EUR,
GHS,
KES
status
enum<string>
required

opening: the partner bank has not returned the account number yet.

Available options:
opening,
active,
closed
balances
object
required

The account's balances: available, ledger, in_flight.

account_name
string
required

Name on the bank account, as payers see it ("Adaeze Logistics Ltd").

account_number
string | null
required

10-digit NUBAN for NGN accounts. Null while opening.

bank_name
string
required

The bank that issued the account number, as shown on the account details.

bank_code
string
required

That bank's institution code.

Example:

"058"

routing
object[]
required

Extra local details for non-naira accounts. Empty for NGN.

livemode
boolean
required

False for sandbox accounts (test money).

agent_id
string | null

For agent accounts: the agent (agt_…).

Pattern: ^agt_[0-9A-HJKMNP-TV-Z]{26}$
opened_at
string<date-time> | null

"Opened 2 Jun 2026". Null while opening.

closed_at
string<date-time> | null

When closed.