curl --request POST \
  --url https://api.panoflow.io/v1/collections/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Same-day delivery, Abuja",
  "amount_type": "fixed",
  "amount": {
    "amount": 2500000,
    "currency": "NGN"
  },
  "description": "One parcel, delivered the same day within Abuja",
  "collect_phone": true
}
'

{
  "id": "lnk_01JBGJ09TQM83XSSSS6YS3C4DW",
  "object": "payment_link",
  "created_at": "2026-10-28T09:12:00Z",
  "updated_at": "2026-10-28T09:12:00Z",
  "name": "Same-day delivery, Abuja",
  "description": "One parcel, delivered the same day within Abuja",
  "slug": "sameday-delivery-abuja",
  "url": "https://pay.panoflow.io/sameday-delivery-abuja",
  "amount_type": "fixed",
  "amount": {
    "amount": 2500000,
    "currency": "NGN"
  },
  "currency": "NGN",
  "collect_phone": true,
  "status": "active",
  "payment_count": 0,
  "amount_collected": {
    "amount": 0,
    "currency": "NGN"
  },
  "settlement_account": {
    "id": "acc_01J26W14WMCHWYFGCW8T7SWM4F",
    "name": "Naira · Main",
    "account_number": "8012457739"
  },
  "created_by": {
    "type": "user",
    "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
    "name": "Adaeze Okafor"
  }
}

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

Payment links

Create a payment link

The slug is derived from the name (lowercase, hyphenated, at most 28 characters) and is unique across pay.panoflow.io; when it is taken, a short suffix is added. The link is active straight away.

Payments settle into settlement_account_id (default Naira · Main). Each checkout on the pay page gets a one-time number tied to that account, so money is credited to it as it arrives.

Error codes: invalid_api_key, parameter_invalid, parameter_missing, resource_not_found, scope_missing, csrf_token_invalid, idempotency_key_reused, account_closed, currency_mismatch, rate_limited.

POST

collections

payment-links

curl --request POST \
  --url https://api.panoflow.io/v1/collections/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Same-day delivery, Abuja",
  "amount_type": "fixed",
  "amount": {
    "amount": 2500000,
    "currency": "NGN"
  },
  "description": "One parcel, delivered the same day within Abuja",
  "collect_phone": true
}
'

{
  "id": "lnk_01JBGJ09TQM83XSSSS6YS3C4DW",
  "object": "payment_link",
  "created_at": "2026-10-28T09:12:00Z",
  "updated_at": "2026-10-28T09:12:00Z",
  "name": "Same-day delivery, Abuja",
  "description": "One parcel, delivered the same day within Abuja",
  "slug": "sameday-delivery-abuja",
  "url": "https://pay.panoflow.io/sameday-delivery-abuja",
  "amount_type": "fixed",
  "amount": {
    "amount": 2500000,
    "currency": "NGN"
  },
  "currency": "NGN",
  "collect_phone": true,
  "status": "active",
  "payment_count": 0,
  "amount_collected": {
    "amount": 0,
    "currency": "NGN"
  },
  "settlement_account": {
    "id": "acc_01J26W14WMCHWYFGCW8T7SWM4F",
    "name": "Naira · Main",
    "account_number": "8012457739"
  },
  "created_by": {
    "type": "user",
    "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
    "name": "Adaeze Okafor"
  }
}

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

name

string

required

Shown to customers on the payment page. Also the source of the slug.

Required string length: 1 - 80

amount_type

enum<string>

required

fixed: everyone pays amount. customer_entered: the payer types the amount (deposits, tips).

Available options:

fixed,

customer_entered

description

string

What the customer is paying for.

Maximum string length: 300

amount

object

Required when amount_type is fixed; must be omitted otherwise.

Show child attributes

currency

enum<string>

For customer_entered links. Defaults to NGN.

Available options:

NGN,

USD,

GBP,

EUR,

GHS,

KES

collect_phone

boolean

default:true

Ask the payer for their phone number.

settlement_account_id

string

Account the money lands in (acc_…). Defaults to the business's Naira · Main account. Any of the business's active accounts in the same currency: Main, Payroll or a sub-account. Agent accounts are not allowed (an agent's money comes only from top-ups the team makes, within its limits). Payments are credited to this account directly.

404 resource_not_found if it isn't one of the business's accounts; 403 account_closed if it is closed; 422 currency_mismatch if it is in another currency; 400 parameter_invalid with param: settlement_account_id for an agent account, or one still opening.

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

The new link.

A reusable pay page (lnk_…, an alias view of the shared col_ collection table).

string

required

lnk_…

object

string

required

Always payment_link.

Allowed value: "payment_link"

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"

name

string

required

Shown on the pay page.

slug

string

required

Globally unique slug.

url

string<uri>

required

Full pay page URL.

amount_type

enum<string>

required

Fixed amount or customer enters it.

Available options:

fixed,

customer_entered

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

collect_phone

boolean

required

Payer is asked for a phone number.

status

enum<string>

required

active takes payments; paused does not ("Paused" in the app).

Available options:

active,

paused

payment_count

integer

required

Matched payments received through this link.

amount_collected

object

required

Total of those payments.

Show child attributes

settlement_account

object

required

One of the business's own PanoFlow accounts (owned by the Accounts service).

Show child attributes

description

string

What the customer is paying for.

amount

object

Present for fixed links.

Show child attributes

last_payment_at

string<date-time>

RFC 3339, UTC.

Example:

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

paused_at

string<date-time>

RFC 3339, UTC.

Example:

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

created_by

object

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

Show child attributes

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

Create a payment link

Authorizations

Headers

Body

Response