Close a sub-account

curl --request POST \
  --url https://api.panoflow.io/v1/accounts/{account_id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Step-Up-Token: <x-step-up-token>' \
  --data '
{
  "reason": "Savings moved to Naira · Main."
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Step-Up-Token': '<x-step-up-token>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: 'Savings moved to Naira · Main.'})
};

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

import requests

url = "https://api.panoflow.io/v1/accounts/{account_id}/close"

payload = { "reason": "Savings moved to Naira · Main." }
headers = {
    "X-Step-Up-Token": "<x-step-up-token>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "acc_01JCKET6CKWXV0NRDWR7S60V6T",
  "object": "account",
  "created_at": "2026-09-14T10:00:00Z",
  "updated_at": "2026-10-28T08:30:00Z",
  "name": "Savings",
  "display_name": "Naira · Savings",
  "type": "sub",
  "is_primary": false,
  "currency": "NGN",
  "status": "closed",
  "balances": {
    "available": {
      "amount": 0,
      "currency": "NGN"
    },
    "ledger": {
      "amount": 0,
      "currency": "NGN"
    },
    "in_flight": {
      "amount": 0,
      "currency": "NGN"
    },
    "as_of": "2026-10-28T08:30:00Z"
  },
  "account_name": "Adaeze Logistics Ltd",
  "account_number": "0123456791",
  "bank_name": "Providus Bank",
  "bank_code": "101",
  "routing": [],
  "agent_id": null,
  "opened_at": "2026-09-14T10:00:00Z",
  "closed_at": "2026-10-28T08:30:00Z",
  "livemode": true
}

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

Accounts

Close a sub-account

Closes a sub or payroll account. The ledger balance must be zero (move money out first) and nothing scheduled or pending from it. Primary and agent accounts can’t be closed here. History is kept; the account number stops receiving money.

Roles: owner, admin.

Step-up: requires a fresh X-Step-Up-Token (403 step_up_required otherwise).

Error codes: invalid_api_key, resource_not_found, role_not_permitted, invalid_state, account_closed, account_balance_not_zero, bank_unavailable, step_up_required, csrf_token_invalid, idempotency_key_reused, rate_limited.

POST

accounts

{account_id}

Close a sub-account

curl --request POST \
  --url https://api.panoflow.io/v1/accounts/{account_id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Step-Up-Token: <x-step-up-token>' \
  --data '
{
  "reason": "Savings moved to Naira · Main."
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Step-Up-Token': '<x-step-up-token>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: 'Savings moved to Naira · Main.'})
};

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

import requests

url = "https://api.panoflow.io/v1/accounts/{account_id}/close"

payload = { "reason": "Savings moved to Naira · Main." }
headers = {
    "X-Step-Up-Token": "<x-step-up-token>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "acc_01JCKET6CKWXV0NRDWR7S60V6T",
  "object": "account",
  "created_at": "2026-09-14T10:00:00Z",
  "updated_at": "2026-10-28T08:30:00Z",
  "name": "Savings",
  "display_name": "Naira · Savings",
  "type": "sub",
  "is_primary": false,
  "currency": "NGN",
  "status": "closed",
  "balances": {
    "available": {
      "amount": 0,
      "currency": "NGN"
    },
    "ledger": {
      "amount": 0,
      "currency": "NGN"
    },
    "in_flight": {
      "amount": 0,
      "currency": "NGN"
    },
    "as_of": "2026-10-28T08:30:00Z"
  },
  "account_name": "Adaeze Logistics Ltd",
  "account_number": "0123456791",
  "bank_name": "Providus Bank",
  "bank_code": "101",
  "routing": [],
  "agent_id": null,
  "opened_at": "2026-09-14T10:00:00Z",
  "closed_at": "2026-10-28T08:30:00Z",
  "livemode": true
}

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

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

Idempotency-Key

string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255

X-Step-Up-Token

string

required

Proof of a 2FA step-up within the last 5 minutes (POST /v1/auth/step-up).

Path Parameters

account_id

string

required

Account.

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

Body

application/json

Close a sub-account. The balance must be zero.

reason

string

Why. Audited.

Maximum string length: 500

Response

OK.

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

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.

Show child attributes

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.

Show child attributes

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.

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Close a sub-account

Authorizations

Headers

Path Parameters

Body

Response