Get a transfer's receipt
The data for the PayReceipt screen plus a signed pdf_url for “Download PDF” (valid 5 minutes; ask again
for a fresh one). Available for any status; the status pill shows where it is. Downloads are logged.
Error codes: invalid_api_key, parameter_invalid, resource_not_found, scope_missing, rate_limited.
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
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.
128Path Parameters
trf_…
^trf_[0-9A-HJKMNP-TV-Z]{26}$Response
The receipt.
Data for the PayReceipt screen, for a transfer or a batch.
Always receipt.
"receipt"An amount in minor units (kobo, cents) with its currency. Never a decimal.
Lifecycle shared by every money-moving resource (CONVENTIONS §8). UI labels: completed → "Settled", pending_approval → "Pending approval".
draft, pending_approval, scheduled, processing, completed, failed, rejected, canceled, reversed The pill text for status.
Settled, Processing, Failed, Scheduled, Pending approval, Rejected, Canceled, Reversed Completion time, or creation time if not completed.
"2026-10-27T08:41:00Z"
Name of the person or agent who created it.
Where anyone can check the receipt with its transaction id.
Signed link to the PDF, valid 5 minutes.
RFC 3339, UTC.
"2026-10-27T08:41:00Z"
trf_… for a transfer receipt.
bat_… for a batch receipt.
txn_… shown as "Transaction ID" and used to check the receipt.
An amount in minor units (kobo, cents) with its currency. Never a decimal.
Narration, or the file name for a batch.
NIP session id, for payouts that were sent.
^\d{30}$