Payments API
Get payment
Changed onRetrieve a single payment object by its payment ID.
get/v2/payments/{paymentId}
Request
- Base URLhttps://api.mollie.com
- URLhttps://api.mollie.com/v2/payments/{paymentId}
- Auth
- HTTP bearer
- or HTTP bearer
- or OAuth 2Authorization code: https://my.mollie.com/oauth2/authorizeToken URL: https://api.mollie.com/oauth2/tokens scopes: payments.read
Query parameters
includestring nullable
This endpoint allows you to include additional information via the include query string parameter.
embedstring nullable
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.
Headers
idempotency-keystring
Example:123e4567-e89b-12d3-a456-426
A unique key to ensure idempotent requests. This key should be a UUID v4 string.
Response
The payment object.
Example response
{
"resource": "payment",
"id": "tr_5B8cwPMGnU",
"mode": "live",
"description": "Chess Board",
"amount": {
"currency": "EUR",
"value": "10.00"
},
"amountRefunded": {
"currency": "EUR",
"value": "10.00"
},
"amountRemaining": {
"currency": "EUR",
"value": "10.00"
},
"amountCaptured": {
"currency": "EUR",
"value": "10.00"
},
"amountChargedBack": {
"currency": "EUR",
"value": "10.00"
},
"redirectUrl": "https://example.org/redirect",
"cancelUrl": "https://example.org/cancel",
"webhookUrl": "https://example.org/webhooks",
"lines": [
{
"type": "physical",
"description": "LEGO 4440 Forest Police Station",
"quantity": 1,
"quantityUnit": "pcs",
"unitPrice": {
"currency": "EUR",
"value": "10.00"
},
"discountAmount": {
"currency": "EUR",
"value": "10.00"
},
"totalAmount": {
"currency": "EUR",
"value": "10.00"
},
"vatRate": "21.00",
"vatAmount": {
"currency": "EUR",
"value": "10.00"
},
"sku": "9780241661628",
"categories": [
"meal",
"eco"
],
"imageUrl": "https://...",
"productUrl": "https://...",
"recurring": {
"description": "Gym subscription",
"interval": "12 months",
"amount": {
"currency": "EUR",
"value": "10.00"
},
"times": 1,
"startDate": "2024-12-12"
}
}
],
"billingAddress": {
"title": "Mr.",
"givenName": "Piet",
"familyName": "Mondriaan",
"organizationName": "Mollie B.V.",
"streetAndNumber": "Keizersgracht 126",
"streetAdditional": "Apt. 1",
"postalCode": "1234AB",
"email": "piet@example.org",
"city": "Amsterdam",
"region": "Noord-Holland",
"country": "NL"
},
"shippingAddress": {
"title": "Mr.",
"givenName": "Piet",
"familyName": "Mondriaan",
"organizationName": "Mollie B.V.",
"streetAndNumber": "Keizersgracht 126",
"streetAdditional": "Apt. 1",
"postalCode": "1234AB",
"email": "piet@example.org",
"city": "Amsterdam",
"region": "Noord-Holland",
"country": "NL"
},
"locale": "en_US",
"countryCode": "BE",
"method": "ideal",
"issuer": "ideal_INGBNL2A",
"restrictPaymentMethodsToCountry": "NL",
"captureMode": "manual",
"captureDelay": "8 hours",
"captureBefore": "2024-03-20T09:28:37+00:00",
"applicationFee": {
"amount": {
"currency": "EUR",
"value": "10.00"
},
"description": "Platform fee"
},
"routing": [
{
"resource": "route",
"id": "rt_5B8cwPMGnU",
"mode": "live",
"amount": {
"currency": "EUR",
"value": "10.00"
},
"destination": {
"type": "organization",
"organizationId": "org_1234567"
},
"createdAt": "2024-12-12T10:00:00+00:00",
"releaseDate": "2024-12-12",
"_links": {
"self": {
"href": "https://...",
"type": "application/hal+json"
},
"payment": {
"href": "https://...",
"type": "application/hal+json"
}
}
}
],
"sequenceType": "oneoff",
"subscriptionId": "sub_5B8cwPMGnU",
"mandateId": "mdt_5B8cwPMGnU",
"customerId": "cst_5B8cwPMGnU",
"profileId": "pfl_5B8cwPMGnU",
"settlementId": "stl_5B8cwPMGnU",
"orderId": "ord_5B8cwPMGnU",
"status": "open",
"statusReason": {
"code": "insufficient_funds",
"message": "The account associated with the card has insufficient funds. The shopper should use another payment method or\ncontact their bank."
},
"isCancelable": true,
"details": {
"consumerName": "John Doe",
"consumerAccount": "NL91ABNA0417164300",
"consumerBic": "ABNANL2A",
"cardNumber": "************1234",
"bankName": "Mollie Bank",
"bankAccount": "NL91ABNA0417164300",
"bankBic": "ABNANL2A",
"transferReference": "...",
"bizumReference": "2901tq2ure1d",
"cardFingerprint": "...",
"cardHolder": "John Doe",
"cardAudience": "consumer",
"cardLabel": "Mastercard",
"cardCountryCode": "NL",
"cardExpiryDate": "12/25",
"cardFunding": "credit",
"cardSecurity": "normal",
"feeRegion": "maestro",
"cardMaskedNumber": "...",
"card3dsEci": "...",
"cardBin": "...",
"cardIssuer": "...",
"failureReason": "card_declined",
"failureMessage": "Your card was declined.",
"wallet": "applepay",
"paypalReference": "...",
"paypalPayerId": "...",
"sellerProtection": "ELIGIBLE",
"paypalFee": {
"currency": "EUR",
"value": "10.00"
},
"customerReference": "...",
"terminalId": "term_12345",
"maskedNumber": "...",
"creditorIdentifier": "...",
"dueDate": "2025-01-01",
"signatureDate": "2024-03-20",
"bankReasonCode": "...",
"bankReason": "...",
"endToEndIdentifier": "...",
"mandateReference": "...",
"batchReference": "...",
"fileReference": "...",
"qrCode": {
"height": 300,
"width": 300,
"src": "https://www.mollie.com/images/qr-code.png"
},
"voucherNumber": "...",
"issuer": "...",
"remainderAmount": {
"currency": "EUR",
"value": "10.00"
},
"remainderMethod": "creditcard"
},
"createdAt": "2024-03-20T09:13:37+00:00",
"authorizedAt": "2024-03-20T09:28:37+00:00",
"paidAt": "2024-03-20T09:28:37+00:00",
"canceledAt": "2024-03-20T09:28:37+00:00",
"expiresAt": "2024-03-20T09:28:37+00:00",
"expiredAt": "2024-03-20T09:28:37+00:00",
"failedAt": "2024-03-20T09:28:37+00:00",
"dueDate": "2025-01-01",
"storeCredentials": true,
"_links": {
"self": {
"href": "https://...",
"type": "application/hal+json"
},
"checkout": {
"href": "https://...",
"type": "application/hal+json"
},
"mobileAppCheckout": {
"href": "https://...",
"type": "application/hal+json"
},
"changePaymentState": {
"href": "https://...",
"type": "application/hal+json"
},
"dashboard": {
"href": "https://...",
"type": "application/hal+json"
},
"refunds": {
"href": "https://...",
"type": "application/hal+json"
},
"chargebacks": {
"href": "https://...",
"type": "application/hal+json"
},
"captures": {
"href": "https://...",
"type": "application/hal+json"
},
"settlement": {
"href": "https://...",
"type": "application/hal+json"
},
"customer": {
"href": "https://...",
"type": "application/hal+json"
},
"mandate": {
"href": "https://...",
"type": "application/hal+json"
},
"subscription": {
"href": "https://...",
"type": "application/hal+json"
},
"order": {
"href": "https://...",
"type": "application/hal+json"
},
"terminal": {
"href": "https://...",
"type": "application/hal+json"
},
"documentation": {
"href": "https://...",
"type": "application/hal+json"
},
"status": {
"href": "https://...",
"type": "application/hal+json"
},
"payOnline": {
"href": "https://...",
"type": "application/hal+json"
}
}
}Changes
- warning
removed the optional property
/////from the response with the status
- warning
- info
the response property
/////became required for the status - info
the response property
/////became required for the status
- info