Get payment

get

https://api.mollie.com/v2/payments/{paymentId}

Retrieve a single payment object by its payment ID.

🔑
Access with
API key Advanced access token with payments.readOAuth access with payments.read

Path Params

paymentId

string

required

Provide the ID of the related payment.

Query Params

include

string | null

enum

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

Show Details

details.qrCode	Include a QR code object. Only available for iDEAL, Bancontact and bank transfer payments.
details.remainderDetails	For payments where gift cards or vouchers were applied and the remaining amount was paid with another payment method, this include will add another `details` object specifically for the remainder payment.

Allowed:

embed

string | null

enum

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

Show Details

captures	Embed all captures created for this payment.
refunds	Embed all refunds created for this payment.
chargebacks	Embed all chargebacks created for this payment.

Allowed:

testmode

boolean

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.

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/hal+json

200The payment object.

404No entity with this ID exists.

429Rate Limit has been reached.