The API reference is not available right now

This instance could not load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance does not document an operation under that identifier. It may have been renamed, or it may belong to a feature this installation does not have enabled.

Back to the API reference

API reference Hosted Payment Pages

Serves a QR code PNG image for the session's payment link.

GET /api/hostedpaymentpages/sessions/{sessionId}/qrcode.png deprecated

Requires: HostedPaymentPage.HppSessions, merchant scope.

This endpoint is anonymous so the hosted QR URL can be shared publicly. Returns 404 if the session is not found, or 410 (Gone) if it has expired or been consumed or revoked.

Parameters

Name In Type Description
sessionId required path string (uuid) The session ID to generate a QR code for.
suppressNulls required query boolean If true, omit properties with null values.

Request body

application/json , required

Field Type Description

This request body has no documented fields.

Responses

200 OK

Field Type Description

This response has no documented body fields.

404 Not Found

Field Type Description

This response has no documented body fields.

410 Gone

Field Type Description

This response has no documented body fields.

403 Forbidden

Field Type Description

This response has no documented body fields.

401 Unauthorized

Field Type Description

This response has no documented body fields.

400 Bad Request

Field Type Description

This response has no documented body fields.

501 Not Implemented

Field Type Description

This response has no documented body fields.

500 Internal Server Error

Field Type Description

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

Field Type Description

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication