Pause a payment link

curl --request POST \
  --url https://api.panoflow.io/v1/collections/payment-links/{payment_link_id}/pause \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.panoflow.io/v1/collections/payment-links/{payment_link_id}/pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/collections/payment-links/{payment_link_id}/pause"

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

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

print(response.text)

{
  "id": "<string>",
  "object": "payment_link",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "slug": "<string>",
  "url": "<string>",
  "amount_type": "fixed",
  "currency": "NGN",
  "collect_phone": true,
  "status": "active",
  "payment_count": 123,
  "amount_collected": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "settlement_account": {
    "id": "<string>",
    "name": "<string>",
    "account_number": "8012457739"
  },
  "description": "<string>",
  "amount": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "last_payment_at": "2026-10-27T08:41:00Z",
  "paused_at": "2026-10-27T08:41:00Z",
  "created_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "metadata": {}
}

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

POST

collections

payment-links

{payment_link_id}

pause

Pause a payment link

curl --request POST \
  --url https://api.panoflow.io/v1/collections/payment-links/{payment_link_id}/pause \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.panoflow.io/v1/collections/payment-links/{payment_link_id}/pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/collections/payment-links/{payment_link_id}/pause"

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

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

print(response.text)

{
  "id": "<string>",
  "object": "payment_link",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "slug": "<string>",
  "url": "<string>",
  "amount_type": "fixed",
  "currency": "NGN",
  "collect_phone": true,
  "status": "active",
  "payment_count": 123,
  "amount_collected": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "settlement_account": {
    "id": "<string>",
    "name": "<string>",
    "account_number": "8012457739"
  },
  "description": "<string>",
  "amount": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "last_payment_at": "2026-10-27T08:41:00Z",
  "paused_at": "2026-10-27T08:41:00Z",
  "created_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "metadata": {}
}

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

Path Parameters

payment_link_id

string

required

Payment link id (lnk_…).

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

Response

The paused 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

Pause a payment link

Authorizations

Headers

Path Parameters

Response