Documents

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method	Path	Description
GET	/v1/payments/{id}/invoice	Invoice (PDF)
GET	/v1/payments/{id}/receipt	Payment receipt (PDF)

GET /v1/payments/{id}/invoice

Invoice (PDF)

The numbered invoice matching an operation, as a PDF.

Parameters

Name	In	Required	Description
id	path	yes	The operation: identifier, reference, or your client_ref.

Responses

• 200 — The PDF (file)
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 404 — No operation with that identifier on this account (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

GET /v1/payments/{id}/receipt

Payment receipt (PDF)

Proof of a successful payment, as a PDF. It is the same document the payer receives and the dashboard shows.

Parameters

Name	In	Required	Description
id	path	yes	The operation: identifier, reference, or your client_ref.

Responses

• 200 — The PDF (file)
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 404 — No operation with that identifier on this account (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

Schemas

The shapes the operations above return.

Error

Field	Type	Description
error	object
error.code	string
error.message	string