v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Payments API

Get payment

Retrieve a single payment object by its payment ID.

🔑 Access with

API key

Advanced access token with payments.read

OAuth access with payments.read

get/payments/{paymentId}

Query parameters

include'details.qrCode' | 'details.remainderDetails' nullable

Example:details.qrCode

This endpoint allows you to include additional information via the include query string parameter.

embed'captures' | 'refunds' | 'chargebacks' nullable

Example:captures

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.