Get a batch's receipt

curl --request GET \
  --url https://api.panoflow.io/v1/batches/{batch_id}/receipt \
  --header 'Authorization: Bearer <token>'

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

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

{
  "object": "receipt",
  "batch_id": "bat_01JCYFGCW8T7SWM4FV4DK79Q9G",
  "amount": {
    "amount": 648000000,
    "currency": "NGN"
  },
  "fee": {
    "amount": 193500,
    "currency": "NGN"
  },
  "status": "processing",
  "status_label": "Processing",
  "date": "2026-10-28T08:30:00Z",
  "narration": "october-suppliers.csv",
  "sent_by": "Adaeze Okafor",
  "paid_by": {
    "name": "Adaeze Logistics Ltd",
    "detail": "Naira · Main · ••••6789"
  },
  "paid_to": {
    "name": "36 recipients",
    "detail": "october-suppliers.csv"
  },
  "verification_url": "https://panoflow.io/verify?ref=bat_01JCYFGCW8T7SWM4FV4DK79Q9G",
  "pdf_url": "https://files.panoflow.io/receipts/bat_01JCYFGCW8T7SWM4FV4DK79Q9G.pdf?sig=a71d02",
  "pdf_expires_at": "2026-10-28T08:36:00Z"
}

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

GET

batches

{batch_id}

receipt

Get a batch's receipt

curl --request GET \
  --url https://api.panoflow.io/v1/batches/{batch_id}/receipt \
  --header 'Authorization: Bearer <token>'

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

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

{
  "object": "receipt",
  "batch_id": "bat_01JCYFGCW8T7SWM4FV4DK79Q9G",
  "amount": {
    "amount": 648000000,
    "currency": "NGN"
  },
  "fee": {
    "amount": 193500,
    "currency": "NGN"
  },
  "status": "processing",
  "status_label": "Processing",
  "date": "2026-10-28T08:30:00Z",
  "narration": "october-suppliers.csv",
  "sent_by": "Adaeze Okafor",
  "paid_by": {
    "name": "Adaeze Logistics Ltd",
    "detail": "Naira · Main · ••••6789"
  },
  "paid_to": {
    "name": "36 recipients",
    "detail": "october-suppliers.csv"
  },
  "verification_url": "https://panoflow.io/verify?ref=bat_01JCYFGCW8T7SWM4FV4DK79Q9G",
  "pdf_url": "https://files.panoflow.io/receipts/bat_01JCYFGCW8T7SWM4FV4DK79Q9G.pdf?sig=a71d02",
  "pdf_expires_at": "2026-10-28T08:36:00Z"
}

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

batch_id

string

required

bat_…

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

Response

The receipt.

Data for the PayReceipt screen, for a transfer or a batch.

object

string

required

Always receipt.

Allowed value: "receipt"

amount

object

required

An amount in minor units (kobo, cents) with its currency. Never a decimal.

Show child attributes

status

enum<string>

required

Lifecycle shared by every money-moving resource (CONVENTIONS §8). UI labels: completed → "Settled", pending_approval → "Pending approval".

Available options:

draft,

pending_approval,

scheduled,

processing,

completed,

failed,

rejected,

canceled,

reversed

status_label

enum<string>

required

The pill text for status.

Available options:

Settled,

Processing,

Failed,

Scheduled,

Pending approval,

Rejected,

Canceled,

Reversed

date

string<date-time>

required

Completion time, or creation time if not completed.

Example:

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

sent_by

string

required

Name of the person or agent who created it.

paid_by

object

required

Show child attributes

paid_to

object

required

Show child attributes

verification_url

string<uri>

required

Where anyone can check the receipt with its transaction id.

pdf_url

string<uri>

required

Signed link to the PDF, valid 5 minutes.

pdf_expires_at

string<date-time>

required

RFC 3339, UTC.

Example:

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

transfer_id

string

trf_… for a transfer receipt.

batch_id

string

bat_… for a batch receipt.

transaction_id

string

txn_… shown as "Transaction ID" and used to check the receipt.

fee

object

An amount in minor units (kobo, cents) with its currency. Never a decimal.

Show child attributes

narration

string

Narration, or the file name for a batch.

nip_session_id

string

NIP session id, for payouts that were sent.

Pattern: ^\d{30}$

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Get a batch's receipt

Authorizations

Headers

Path Parameters

Response