Get payment

Payments API v1

Warning

The v1 API has been deprecated. The v1 API will be supported for the foreseeable future, at least until July 2023. However, new features will only be added to the v2 API.

The documentation for retrieving payments in the new v2 API can be found here. For more information on the v2 API, refer to our v2 migration guide.

GEThttps://api.mollie.com/v1/payments/*id*

Retrieve a single payment object by its payment token.

Note

We call your webhook when the payment status changes, so there’s no need to poll this endpoint for status changes.

Parameters

Replace id in the endpoint URL by the payment’s ID, for example tr_7UhSN1zuXS.

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the testmode query string parameter is available. You must pass this as a parameter in the query string if you want to retrieve a payment that was created in test mode.

testmodebooleanoptional

Includes

This endpoint allows you to include additional information by appending the following values via the include querystring parameter.

  • settlement Include the settlement this payment belongs to, when available.
  • details.qrCode Include a QR code object. Only available for iDEAL, Bancontact and bank transfer payments.

Response

200 application/json

resourcestring
Indicates the response contains a payment object. Will always contain payment for this endpoint.
idstring
The identifier uniquely referring to this payment. Mollie assigns this identifier at payment creation time. For example tr_7UhSN1zuXS. Its ID will always be used by Mollie to refer to a certain payment.
modestring

The mode used to create this payment. Mode determines whether a payment is real (live mode) or a test payment.

Possible values: live test

createdDatetimedatetime
The payment’s date and time of creation, in ISO 8601 format.
statusstring
The payment’s status. Please refer to the documentation regarding statuses for more info about which statuses occur at what point.
isCancelableboolean
Whether or not the payment can be canceled.
paidDatetimedatetime
The date and time the payment became paid, in ISO 8601 format. This parameter is omitted if the payment isn’t completed (yet).
cancelledDatetimedatetime
The date and time the payment was canceled, in ISO 8601 format. This parameter is omitted if the payment isn’t canceled (yet).
expiredDatetimedatetime
The date and time the payment was expired, in ISO 8601 format. This parameter is omitted if the payment did not expire (yet).
expiryPeriodduration
The time until the payment will expire in ISO 8601 duration format.
failedDatetimedatetime
The date and time the payment failed, in ISO 8601 format. This parameter is omitted if the payment did not fail (yet).
amountdecimal
The amount in EUR.
amountRefundeddecimal
The total amount that is already refunded. Only available when refunds are available for this payment. For some payment methods, this amount may be higher than the payment amount, for example to allow reimbursement of the costs for a return shipment to the customer.
amountRemainingdecimal
The remaining amount that can be refunded. Only available when refunds are available for this payment.
descriptionstring
A short description of the payment. The description is visible in the Dashboard and will be shown on the customer’s bank or card statement when possible.
methodstring

The payment method used for this payment, either forced on creation by specifying the method parameter, or chosen by the customer on our payment method selection screen.

If the payment is only partially paid with a gift card, the method remains giftcard.

Possible values: null banktransfer belfius creditcard directdebit eps, giftcard giropay ideal kbc klarnapaylater klarnapaynow klarnasliceit mistercash mybank paypal paysafecard przelewy24 sofort

metadatamixed
The optional metadata you provided upon payment creation. Metadata can for example be used to link an order to a payment.
localestring
The customer’s locale, either forced on creation by specifying the locale parameter, or detected by us during checkout. Will be a full locale, for example nl_NL.
countryCodestring
The customer’s ISO 3166-1 alpha-2 country code, detected by us during checkout. For example: BE.
profileIdstring
The identifier referring to the profile this payment was created on. For example, pfl_QkEhN94Ba.
settlementIdstring
The identifier referring to the settlement this payment was settled with. For example, stl_BkEjN2eBb.
issuerstring
Only available for payment methods that use an issuer, e.g. iDEAL, KBC/CBC payment button and gift cards. Holds the ID of the issuer that was used during the payment.
failureReasonstring

Only available for failed Bancontact and credit card payments. Contains a failure reason code.

Possible values: authentication_abandoned authentication_failed authentication_required authentication_unavailable_acs card_declined card_expired inactive_card insufficient_funds invalid_cvv invalid_card_holder_name invalid_card_number invalid_card_type possible_fraud refused_by_issuer unknown_reason

linksobject

An object with several URLs important to the payment process.

Show child parameters

paymentUrlstringoptional

The URL your customer should visit to make the payment. This is where you should redirect the consumer to.

Note

You should use HTTP GET for the redirect to the checkout URL. Using HTTP POST for redirection will cause issues with some payment methods or iDEAL issuers. Use HTTP status code 303 See Other to force an HTTP GET redirect.

Recurring payments do not have a paymentUrl.

webhookUrlstringoptional
The URL Mollie will call as soon an important status change takes place.
redirectUrlstring

The URL your customer will be redirected to after completing or canceling the payment process.

Note

The URL will be null for recurring payments.

settlementstringoptional
The API resource URL of the settlement this payment belongs to.
refundsstringoptional
The API resource URL of the refunds that belong to this payment.
chargebacksstringoptional
The API resource URL of the chargebacks that belong to this payment.

Response parameters for recurring payments

recurringTypestring
mandateIdstring
customerIdstring
subscriptionIdstring

Payment method-specific response parameters

If the payment has been created with a method, or if the customer selected a method in the payment method selection screen, a details object becomes available on the payment object. This object contains detail fields specific to the selected payment method.

Bancontact

detailsobject

An object with payment details.

Hide child parameters

cardNumberstring
Only available if the payment is completed - The last four digits of the card number.
cardFingerprintstring

Only available if the payment is completed - Unique alphanumeric representation of card, usable for identifying returning customers.

Warning

The fingerprint is now (as of November 28th, 2019) unique per transaction what makes it not useful anymore for identifying returning customers. Use the consumerAccount field instead.

qrCodeobject
Only available if requested during payment creation - The QR code that can be scanned by the mobile Bancontact application. This enables the desktop to mobile feature.
consumerNamestring
Only available if the payment is completed – The consumer’s name.
consumerAccountstring
Only available if the payment is completed – The consumer’s bank account. This may be an IBAN, or it may be a domestic account number.
consumerBicstring
Only available if the payment is completed – The consumer’s bank’s BIC / SWIFT code.

Bank transfer

detailsobject

An object with payment details.

Hide child parameters

bankNamestring
The name of the bank the consumer should wire the amount to.
bankAccountstring
The IBAN the consumer should wire the amount to.
bankBicstring
The BIC of the bank the consumer should wire the amount to.
transferReferencestring
The reference the consumer should use when wiring the amount. Note you should not apply any formatting here; show it to the consumer as-is.
consumerNamestring
Only available if the payment has been completed – The consumer’s name.
consumerAccountstring
Only available if the payment has been completed – The consumer’s bank account. This may be an IBAN, or it may be a domestic account number.
consumerBicstring
Only available if the payment has been completed – The consumer’s bank’s BIC / SWIFT code.
billingEmailstring
Only available if filled out in the API or by your customer – The email address which your customer asked the payment instructions to be sent to.

Belfius Pay Button

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
Only available one banking day after the payment has been completed – The consumer’s name.
consumerAccountstring
Only available one banking day after the payment has been completed – The consumer’s bank account’s IBAN.
consumerBicstring
Only available one banking day after the payment has been completed – GKCCBEBB.

Credit card

detailsobject

An object with payment details.

Hide child parameters

cardHolderstring
Only available if the payment has been completed - The card holder’s name.
cardNumberstring
Only available if the payment has been completed - The last four digits of the card number.
cardFingerprintstring
Only available if the payment has been completed - Unique alphanumeric representation of card, usable for identifying returning customers.
cardAudiencestring

Only available if the payment has been completed and if the data is available - The card’s target audience.

Possible values: consumer business null

cardLabelstring

Only available if the payment has been completed - The card’s label. Note that not all labels can be processed through Mollie.

Possible values: American Express Carta Si Carte Bleue Dankort Diners Club Discover JCB Laser Maestro Mastercard Unionpay Visa null

cardCountryCodestring
Only available if the payment has been completed - The ISO 3166-1 alpha-2 country code of the country the card was issued in. For example: BE.
cardSecuritystring

Only available if the payment has been completed – The type of security used during payment processing.

Possible values: normal 3dsecure

feeRegionstring

Only available if the payment has been completed: the fee region for the payment. The intra-eu value is for consumer cards from the EEA.

Possible values: american-express amex-intra-eea carte-bancaire intra-eu intra-eu-corporate domestic maestro other

EPS

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
Generally only available one banking day after the payment has been completed – The consumer’s name.
consumerAccountstring
Generally only available one banking day after the payment has been completed – The consumer’s bank account IBAN.
consumerBicstring
Generally only available one banking day after the payment has been completed. The consumer’s bank’s BIC.

Gift cards

detailsobject

An object with payment details.

Hide child parameters

voucherNumberstring
The voucher number, with the last four digits masked. When multiple gift cards are used, this is the first voucher number. Example: 606436353088147****.
giftcardsarray

A list of details of all giftcards that are used for this payment. Each object will contain the following properties.

Show child parameters

issuerstring
The ID of the gift card brand that was used during the payment.
amountdecimal
The amount in EUR that was paid with this gift card.
voucherNumberstring
The voucher number, with the last four digits masked. Example: 606436353088147****
remainderAmountdecimal
Only available if another payment method was used to pay the remainder amount – The amount in EUR that was paid with another payment method for the remainder amount.
remainderMethodstring
Only available if another payment method was used to pay the remainder amount – The payment method that was used to pay the remainder amount.

Giropay

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
Generally only available one banking day after the payment has been completed – The consumer’s name.
consumerAccountstring
Generally only available one banking day after the payment has been completed – The consumer’s bank account IBAN.
consumerBicstring
Generally only available one banking day after the payment has been completed. The consumer’s bank’s BIC.

iDEAL

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
Only available if the payment has been completed – The consumer’s name.
consumerAccountstring
Only available if the payment has been completed – The consumer’s IBAN.
consumerBicstring
Only available if the payment has been completed – The consumer’s bank’s BIC.

KBC/CBC Payment Button

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
Only available one banking day after the payment has been completed – The consumer’s name.
consumerAccountstring
Only available one banking day after the payment has been completed – The consumer’s IBAN.
consumerBicstring
Only available one banking day after the payment has been completed – The consumer’s bank’s BIC.

PayPal

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
Only available if the payment has been completed – The consumer’s first and last name.
consumerAccountstring
Only available if the payment has been completed – The consumer’s email address.
paypalReferencestring
PayPal’s reference for the transaction, for instance 9AL35361CF606152E.
paypalPayerIdstring
ID for the consumer’s PayPal account, for instance WDJJHEBZ4X2LY.
paypalFeedecimal
The amount of fee PayPal will charge for this transaction. This field is omitted if PayPal will not charge a fee for this transaction.

paysafecard

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
The consumer identification supplied when the payment was created.

SEPA Direct Debit

detailsobject

An object with payment details.

Hide child parameters

transferReferencestring
Transfer reference used by Mollie to identify this payment.
creditorIdentifierstring
The creditor identifier indicates who is authorized to execute the payment. In this case, it is a reference to Mollie.
consumerNamestring
The consumer’s name.
consumerAccountstring
The consumer’s IBAN.
consumerBicstring
The consumer’s bank’s BIC.
dueDatedate
Estimated date the payment is debited from the consumer’s bank account, in YYYY-MM-DD format.
signatureDatedate
Only available if the payment has been verified – Date the payment has been signed by the consumer, in YYYY-MM-DD format.
bankReasonCodestring
Only available if the payment has failed – The official reason why this payment has failed. A detailed description of each reason is available on the website of the European Payments Council.
bankReasonstring
Only available if the payment has failed – A textual desciption of the failure reason.
endToEndIdentifierstring
Only available for batch transactions – The original end-to-end identifier that you’ve specified in your batch.
mandateReferencestring
Only available for batch transactions – The original mandate reference that you’ve specified in your batch.
batchReferencestring
Only available for batch transactions – The original batch reference that you’ve specified in your batch.
fileReferencestring
Only available for batch transactions – The original file reference that you’ve specified in your batch.

SOFORT Banking

detailsobject

An object with payment details.

Hide child parameters

consumerNamestring
Only available if the payment has been completed – The consumer’s name.
consumerAccountstring
Only available if the payment has been completed – The consumer’s IBAN.
consumerBicstring
Only available if the payment has been completed – The consumer’s bank’s BIC.

Vouchers

detailsobject

An object with payment details.

Hide child parameters

issuerstring
The ID of the voucher brand that was used during the payment. When multiple vouchers are used, this is the issuer of the first voucher.
vouchersarray

A list of details of all vouchers that are used for this payment. Each object will contain the following properties.

Show child parameters

issuerstring
The ID of the voucher brand that was used during the payment.
issuerNamestring
The name of the voucher brand that was used during the payment.
amountdecimal
The amount in EUR that was paid with this voucher.
remainderAmountdecimal
Only available if another payment method was used to pay the remainder amount – The amount in EUR that was paid with another payment method for the remainder amount.
remainderMethodstring
Only available if another payment method was used to pay the remainder amount – The payment method that was used to pay the remainder amount.

Mollie Connect response parameters

applicationFeeobject

QR codes (optional)

A QR code object with payment method specific values is available for certain payment methods if you pass the include details.qrCode to the resource endpoint.

The qrCode key in the details object will then become available. The key will contain this object:

heightinteger
Height of the image in pixels.
widthinteger
Width of the image in pixels.
srcstring
The URI you can use to display the QR code. Note that we can send both data URIs as well as links to HTTPS images. You should support both.

For an implemention guide, see our QR codes guide.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/payments/tr_WDqYK6vllg \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
HTTP/1.1 200 OK
Content-Type: application/json

{
    "resource": "payment",
    "id": "tr_WDqYK6vllg",
    "mode": "test",
    "createdDatetime": "2018-03-16T14:30:07.0Z",
    "status": "paid",
    "paidDatetime": "2018-03-16T14:34:50.0Z",
    "amount": "35.07",
    "description": "Order 33",
    "method": "ideal",
    "metadata": {
        "order_id": "33"
    },
    "details": {
        "consumerName": "Hr E G H Kloppers en/of MW M.J. Kloppers-Veeneman",
        "consumerAccount": "NL53INGB0618365937",
        "consumerBic": "INGBNL2A"
    },
    "locale": "nl_NL",
    "profileId": "pfl_QkEhN94Ba",
    "links": {
        "webhookUrl": "https://webshop.example.org/payments/webhook",
        "redirectUrl": "https://webshop.example.org/order/33/"
    }
}