Skip to main content
GET
Get payment receipt

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Path Parameters

paymentId
string<uuid>
required

The payment ID.

Query Parameters

format
enum<string>
default:html

Output format.

Available options:
html,
text

Response

The rendered receipt. The response body is the document itself — HTML with Content-Type: text/html, or plain text with Content-Type: text/plain. It is not JSON, and it is not a PDF.

The response is of type string.