Download a transaction receipt PDF

get

https://api.benjipays.com/v2/transactions/{transactionId}/receipt

Returns a receipt PDF for a payment transaction (data.id from POST /v2/transactions or GET /v2/transactions). Default is the customer copy. Pass ?type=merchant for the merchant copy. Same receipt formatting as the merchant app download — raw PDF bytes only, no email.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transactionId

string

required

length ≤ 50

Transaction identifier — data.id from POST /v2/transactions or a GET /v2/transactions row (24-character hex). Unknown or malformed ids return 404.

Query Params

type

string

enum

Receipt copy to download. Default customer. Use merchant for the merchant copy.

Allowed:

Headers

X-Request-ID

uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

X-Correlation-ID

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/pdf

application/problem+json

200Transaction receipt PDF. Content-Disposition is attachment; filename="Receipt-{transactionId}.pdf".

400Bad request — invalid type query value (customer or merchant only).

401Unauthorized

403Forbidden — missing required OAuth scope (organizations:transactions:read), insufficient live mapping permission on the API key owner (e.g. companyAdmin), and/or free trial ended without billing enabled. Scope, mapping, and billing state are independent gates; see response detail.

404Not found — unknown or malformed transaction id, or the transaction belongs to another organization.

429Too Many Requests