Skip to main content
GET
Get a transfer's receipt

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

transfer_id
string
required

trf_…

Pattern: ^trf_[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.

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
paid_to
object
required
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.

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}$