--- updatedAt: 2026-04-21T08:30:50.000Z agentTools: projectIndex: https://docs.mollie.com/llms.txt --- # List settlement payments Retrieve all payments included in the given settlement. The response is in the same format as the response of the [List payments endpoint](list-payments). For capture-based payment methods such as Klarna, the payments are not listed here. Refer to the [List captures endpoint](list-captures) endpoint instead. > 🔑 Access with > > [Advanced access token with **settlements.read** **payments.read**](/reference/authentication) > > [OAuth access with **settlements.read** **payments.read**](/reference/authentication) # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Business operations", "version": "1.0.0", "license": { "name": "Attribution-NonCommercial-ShareAlike 4.0 International", "identifier": "CC-BY-NC-SA-4.0" } }, "servers": [ { "url": "https://api.mollie.com/v2" } ], "security": [ { "apiKey": [] }, { "advancedAccessToken": [] }, { "oAuth": [] } ], "paths": { "/settlements/{settlementId}/payments": { "parameters": [ { "name": "settlementId", "description": "Provide the ID of the related settlement.", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^stl_.+$", "example": "stl_5B8cwPMGnU" } } ], "get": { "summary": "List settlement payments", "x-speakeasy-name-override": "list-payments", "tags": [ "Settlements API" ], "operationId": "list-settlement-payments", "security": [ { "advancedAccessToken": [ "settlements.read", "payments.read" ] }, { "oAuth": [ "settlements.read", "payments.read" ] } ], "description": "Retrieve all payments included in the given settlement.\n\nThe response is in the same format as the response of the [List payments endpoint](list-payments).\n\nFor capture-based payment methods such as Klarna, the payments are not listed here. Refer to the [List captures endpoint](list-captures) endpoint instead.\n\n> 🔑 Access with\n>\n> [Advanced access token with **settlements.read** **payments.read**](/reference/authentication)\n>\n> [OAuth access with **settlements.read** **payments.read**](/reference/authentication)", "parameters": [ { "name": "from", "in": "query", "description": "Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.", "schema": { "type": "string", "pattern": "^tr_.+$", "example": "tr_5B8cwPMGnU" } }, { "name": "limit", "description": "The maximum number of items to return. Defaults to 50 items.", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 250, "default": 50, "example": 50 } }, { "name": "sort", "description": "Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.\n\nPossible values: `asc` `desc`", "in": "query", "schema": { "type": "string", "example": "desc" } }, { "name": "profileId", "description": "The identifier referring to the [profile](get-profile) you wish to retrieve the resources for.\n\nMost API credentials are linked to a single profile. In these cases the `profileId` must not be sent. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.", "in": "query", "schema": { "type": "string", "pattern": "^pfl_.+$", "example": "pfl_5B8cwPMGnU", "description": "The identifier referring to the [profile](get-profile) this entity belongs to.\n\nMost API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required." } } ], "responses": { "200": { "description": "A list of payment objects.", "content": { "application/hal+json": { "schema": { "type": "object", "required": [ "count", "_embedded", "_links" ], "properties": { "count": { "type": "integer", "description": "The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result as well.\n\nThe maximum number of items per result set is controlled by the `limit` property provided in the request. The default limit is 50 items.", "minimum": 0, "maximum": 250, "example": 5 }, "_embedded": { "type": "object", "properties": { "payments": { "description": "An array of payment objects.", "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "resource", "id", "mode", "createdAt", "amount", "description", "status", "profileId", "sequenceType", "_links" ], "allOf": [ { "type": "object", "properties": { "resource": { "type": "string", "description": "Indicates the response contains a payment object. Will always contain the string `payment` for this endpoint.", "readOnly": true, "example": "payment" }, "id": { "allOf": [ { "type": "string", "pattern": "^tr_.+$", "example": "tr_5B8cwPMGnU" } ], "description": "The identifier uniquely referring to this payment. Mollie assigns this identifier at payment creation time. Mollie will always refer to the payment by this ID. Example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.", "readOnly": true }, "mode": { "type": "string", "description": "Whether this entity was created in live mode or in test mode.\n\nPossible values: `live` `test`", "readOnly": true, "example": "live" }, "description": { "type": "string", "description": "The description of the payment will be shown to your customer on their card or bank statement when possible. We truncate the description automatically according to the limits of the used payment method. The description is also visible in any exports you generate.\n\nWe recommend you use a unique identifier so that you can always link the payment to the order in your back office. This is particularly useful for bookkeeping.\n\nThe maximum length of the description field differs per payment method, with the absolute maximum being 255 characters. The API will not reject strings longer than the maximum length but it will truncate them to fit.", "maxLength": 255, "example": "Chess Board" }, "amount": { "description": "The amount that you want to charge, e.g. `{currency:\"EUR\", value:\"1000.00\"}` if you would want to charge €1000.00.\n\nYou can find the minimum and maximum amounts per payment method in our help center. Additionally, they can be retrieved using the Get method endpoint.\n\nIf a tip was added for a Point-of-Sale payment, the amount will be updated to reflect the initial amount plus the tip amount.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "amountRefunded": { "allOf": [ { "type": "object", "description": "In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, { "description": "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." } ], "readOnly": true }, "amountRemaining": { "allOf": [ { "type": "object", "description": "In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, { "description": "The remaining amount that can be refunded. Only available when refunds are available for this payment." } ], "readOnly": true }, "amountCaptured": { "allOf": [ { "type": "object", "description": "In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, { "description": "The total amount that is already captured for this payment. Only available when this payment supports captures." } ], "readOnly": true }, "amountChargedBack": { "allOf": [ { "type": "object", "description": "In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, { "description": "The total amount that was charged back for this payment. Only available when the total charged back amount is not zero." } ], "readOnly": true }, "settlementAmount": { "deprecated": true, "allOf": [ { "type": "object", "description": "In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, { "description": "**Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or the [List balance transactions endpoint](list-balance-transactions) for settlement data.\n\nThe amount that will be settled to your account, converted to the currency your account is settled in. Only available once the payment is finalized and the final settlement amount has been determined.\n\nAmounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by Mollie, this field is omitted from the response." } ], "readOnly": true }, "redirectUrl": { "type": [ "string", "null" ], "description": "The URL your customer will be redirected to after the payment process.\n\nIt could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the right page referencing the order when your customer returns.\n\nThe parameter is normally required, but can be omitted for recurring payments (`sequenceType: recurring`) and for Apple Pay payments with an `applePayPaymentToken`.", "example": "https://example.org/redirect" }, "cancelUrl": { "type": [ "string", "null" ], "description": "The URL your customer will be redirected to when the customer explicitly cancels the payment. If this URL is not provided, the customer will be redirected to the `redirectUrl` instead — see above.\n\nMollie will always give you status updates via webhooks, including for the canceled status. This parameter is therefore entirely optional, but can be useful when implementing a dedicated customer-facing flow to handle payment cancellations.", "example": "https://example.org/cancel" }, "webhookUrl": { "type": [ "string", "null" ], "description": "The webhook URL where we will send payment status updates to.\n\nThe webhookUrl is optional, but without a webhook you will miss out on important status changes to your payment.\n\nThe webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your local machine.", "example": "https://example.org/webhooks" }, "lines": { "type": [ "array", "null" ], "description": "Optionally provide the order lines for the payment. Each line contains details such as a description of the item ordered and its price.\n\nAll lines must have the same currency as the payment.\n\nRequired for payment methods `billie`, `billink`, `in3`, `klarna`, `riverty` and `voucher`.", "items": { "allOf": [ { "type": "object", "required": [ "description", "quantity", "unitPrice", "totalAmount" ], "properties": { "type": { "type": "string", "description": "The type of product purchased. For example, a physical or a digital product.\n\nThe `tip` payment line type is not available when creating a payment.\n\nPossible values: `physical` `digital` `shipping_fee` `discount` `store_credit` `gift_card` `surcharge` `tip` (default: `physical`)", "example": "physical" }, "description": { "type": "string", "description": "A description of the line item. For example *LEGO 4440 Forest Police Station*.", "example": "LEGO 4440 Forest Police Station" }, "quantity": { "type": "integer", "description": "The number of items.", "minimum": 1, "example": 1 }, "quantityUnit": { "type": "string", "description": "The unit for the quantity. For example *pcs*, *kg*, or *cm*.", "example": "pcs" }, "unitPrice": { "description": "The price of a single item including VAT.\n\nFor example: `{\"currency\":\"EUR\", \"value\":\"89.00\"}` if the box of LEGO costs €89.00 each.\n\nFor types `discount`, `store_credit`, and `gift_card`, the unit price must be negative.\n\nThe unit price can be zero in case of free items.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "discountAmount": { "description": "Any line-specific discounts, as a positive amount. Not relevant if the line itself is already a discount type.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "totalAmount": { "description": "The total amount of the line, including VAT and discounts.\n\nShould match the following formula: `(unitPrice × quantity) - discountAmount`.\n\nThe sum of all `totalAmount` values of all order lines should be equal to the full payment amount.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "vatRate": { "type": "string", "description": "The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and not as a float, to ensure the correct number of decimals are passed.", "example": "21.00" }, "vatAmount": { "description": "The amount of value-added tax on the line. The `totalAmount` field includes VAT, so the `vatAmount` can be calculated with the formula `totalAmount × (vatRate / (100 + vatRate))`.\n\nAny deviations from this will result in an error.\n\nFor example, for a `totalAmount` of SEK 100.00 with a 25.00% VAT rate, we expect a VAT amount of `SEK 100.00 × (25 / 125) = SEK 20.00`.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "sku": { "type": "string", "description": "The SKU, EAN, ISBN or UPC of the product sold.", "maxLength": 64, "example": "9780241661628" }, "categories": { "type": "array", "description": "An array with the voucher categories, in case of a line eligible for a voucher. See the [Integrating Vouchers](https://docs.mollie.com/docs/integrating-vouchers/) guide for more information.\n\nPossible values: `eco` `gift` `meal` `sport_culture` `additional` `consume`", "items": { "type": "string", "enum": [ "eco", "gift", "meal", "sport_culture", "additional", "consume" ], "example": "eco" }, "example": [ "meal", "eco" ] }, "imageUrl": { "type": "string", "description": "A link pointing to an image of the product sold.", "example": "https://..." }, "productUrl": { "type": "string", "description": "A link pointing to the product page in your web shop of the product sold.", "example": "https://..." } } }, { "type": "object", "properties": { "recurring": { "description": "The details of subsequent recurring billing cycles. These parameters are used in the Mollie Checkout to inform the shopper of the details for recurring products in the payments.", "type": "object", "required": [ "interval" ], "properties": { "description": { "type": "string", "description": "A description of the recurring item. If not present, the main description of the item will be used.", "example": "Gym subscription" }, "interval": { "type": "string", "description": "Cadence unit of the recurring item. For example: `12 months`, `52 weeks` or `365 days`.\n\nPossible values: `... days`, `... weeks`, `... months`.", "pattern": "^(\\d+) (days?|weeks?|months?)$", "example": "12 months" }, "amount": { "description": "Total amount and currency of the recurring item.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "times": { "type": "integer", "description": "Total number of charges for the subscription to complete. Leave empty for ongoing subscription.", "example": 1 }, "startDate": { "type": [ "string", "null" ], "description": "The start date of the subscription if it does not start right away (format `YYYY-MM-DD`)", "example": "2024-12-12" } } } } } ] } }, "billingAddress": { "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the person, for example *Mr.* or *Mrs.*.", "example": "Mr." }, "givenName": { "type": "string", "description": "The given name (first name) of the person should be at least two characters and cannot contain only numbers.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Piet" }, "familyName": { "type": "string", "description": "The given family name (surname) of the person should be at least two characters and cannot contain only numbers.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Mondriaan" }, "organizationName": { "type": "string", "description": "The name of the organization, in case the addressee is an organization.", "example": "Mollie B.V." }, "streetAndNumber": { "type": "string", "description": "A street and street number.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Keizersgracht 126" }, "streetAdditional": { "type": "string", "description": "Any additional addressing details, for example an apartment number.", "example": "Apt. 1" }, "postalCode": { "type": "string", "description": "A postal code. This field may be required if the provided country has a postal code system.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "1234AB" }, "email": { "type": "string", "description": "A valid e-mail address.\n\nIf you provide the email address for a `banktransfer` payment, we will automatically send the instructions email upon payment creation. The language of the email will follow the locale parameter of the payment.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.\n\nIf the domain contains non-ASCII characters, encode it as Punycode per [RFC 3492](https://www.rfc-editor.org/rfc/rfc3492).", "example": "piet@example.org" }, "phone": { "type": "string", "description": "If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070.", "example": 31208202070 }, "city": { "type": "string", "description": "A city name.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Amsterdam" }, "region": { "type": "string", "description": "The top-level administrative subdivision of the country. For example: Noord-Holland.", "example": "Noord-Holland" }, "country": { "type": "string", "description": "A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "NL" } } }, { "type": "object", "properties": { "organizationName": { "description": "The name of the organization, in case the addressee is an organization.\n\nRequired for payment method `billie`." } } } ], "description": "The customer's billing address details. We advise to provide these details to improve fraud protection and conversion.\n\nShould include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and `country`.\n\nRequired for payment method `alma`, `in3`, `klarna`, `billie`, `billink` and `riverty`." }, "shippingAddress": { "description": "The customer's shipping address details. We advise to provide these details to improve fraud protection and conversion.\n\nShould include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and `country`.", "type": "object", "properties": { "title": { "type": "string", "description": "The title of the person, for example *Mr.* or *Mrs.*.", "example": "Mr." }, "givenName": { "type": "string", "description": "The given name (first name) of the person should be at least two characters and cannot contain only numbers.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Piet" }, "familyName": { "type": "string", "description": "The given family name (surname) of the person should be at least two characters and cannot contain only numbers.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Mondriaan" }, "organizationName": { "type": "string", "description": "The name of the organization, in case the addressee is an organization.", "example": "Mollie B.V." }, "streetAndNumber": { "type": "string", "description": "A street and street number.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Keizersgracht 126" }, "streetAdditional": { "type": "string", "description": "Any additional addressing details, for example an apartment number.", "example": "Apt. 1" }, "postalCode": { "type": "string", "description": "A postal code. This field may be required if the provided country has a postal code system.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "1234AB" }, "email": { "type": "string", "description": "A valid e-mail address.\n\nIf you provide the email address for a `banktransfer` payment, we will automatically send the instructions email upon payment creation. The language of the email will follow the locale parameter of the payment.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.\n\nIf the domain contains non-ASCII characters, encode it as Punycode per [RFC 3492](https://www.rfc-editor.org/rfc/rfc3492).", "example": "piet@example.org" }, "phone": { "type": "string", "description": "If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070.", "example": 31208202070 }, "city": { "type": "string", "description": "A city name.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "Amsterdam" }, "region": { "type": "string", "description": "The top-level administrative subdivision of the country. For example: Noord-Holland.", "example": "Noord-Holland" }, "country": { "type": "string", "description": "A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n\nRequired for payment methods `alma`, `billie`, `in3`, `klarna` and `riverty`.", "example": "NL" } } }, "locale": { "type": [ "string", "null" ], "description": "Allows you to preset the language to be used in the hosted payment pages shown to the customer. Setting a locale is highly recommended and will greatly improve your conversion rate. When this parameter is omitted the browser language will be used instead if supported by the payment method. You can provide any `xx_XX` format ISO 15897 locale, but our hosted payment pages currently only support the specified languages.\n\nFor bank transfer payments specifically, the locale will determine the target bank account the customer has to transfer the money to. We have dedicated bank accounts for Belgium, Germany, and The Netherlands. Having the customer use a local bank account greatly increases the conversion and speed of payment.\n\nPossible values: `ca_ES` `cs_CZ` `da_DK` `de_AT` `de_CH` `de_DE` `de_LU` `el_GR` `en_BE` `en_GB` `en_NL` `en_US` `es_ES` `fi_FI` `fr_BE` `fr_FR` `fr_LU` `hu_HU` `is_IS` `it_IT` `lt_LT` `lv_LV` `nb_NO` `nl_BE` `nl_NL` `pl_PL` `pt_PT` `sk_SK` `sl_SI` `sv_SE` `tr_TR`", "example": "en_US" }, "countryCode": { "type": [ "string", "null" ], "description": "This optional field contains your customer's ISO 3166-1 alpha-2 country code, detected by us during checkout. This field is omitted if the country code was not detected.", "example": "BE", "minLength": 2, "maxLength": 2, "readOnly": true }, "method": {}, "issuer": { "type": [ "string", "null" ], "description": "**Only relevant for iDEAL, KBC/CBC, gift card, and voucher payments.**\n\n**⚠️ With the introduction of iDEAL 2 in 2025, this field will be ignored for iDEAL payments. For more information on the migration, refer to our [help center](https://help.mollie.com/hc/articles/19100313768338-iDEAL-2-0).**\n\nSome payment methods are a network of connected banks or card issuers. In these cases, after selecting the payment method, the customer may still need to select the appropriate issuer before the payment can proceed.\n\nWe provide hosted issuer selection screens, but these screens can be skipped by providing the `issuer` via the API up front.\n\nThe full list of issuers for a specific method can be retrieved via the Methods API by using the optional `issuers` include.\n\nA valid issuer for iDEAL is for example `ideal_INGBNL2A` (for ING Bank).", "example": "ideal_INGBNL2A", "writeOnly": true }, "restrictPaymentMethodsToCountry": { "type": [ "string", "null" ], "description": "For digital goods in most jurisdictions, you must apply the VAT rate from your customer's country. Choose the VAT rates you have used for the order to ensure your customer's country matches the VAT country.\n\nUse this parameter to restrict the payment methods available to your customer to those from a single country.\n\nIf available, the credit card method will still be offered, but only cards from the allowed country are accepted.\n\nThe field expects a country code in ISO 3166-1 alpha-2 format, for example `NL`.", "example": "NL" }, "metadata": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB." }, "captureMode": { "type": [ "string", "null" ], "description": "Indicate if the funds should be captured immediately or if you want to [place a hold](https://docs.mollie.com/docs/place-a-hold-for-a-payment#/) and capture at a later time.\n\nThis field needs to be set to `manual` for method `riverty`.\n\nPossible values: `automatic` `manual`", "example": "manual" }, "captureDelay": { "type": [ "string", "null" ], "description": "**Only relevant if you wish to manage authorization and capturing separately.**\n\nSome payment methods allow placing a hold on the card or bank account. This hold or 'authorization' can then at a later point either be 'captured' or canceled.\n\nBy default, we charge the customer's card or bank account immediately when they complete the payment. If you set a capture delay however, we will delay the automatic capturing of the payment for the specified amount of time. For example `8 hours` or `2 days`.\n\nTo schedule an automatic capture, the `captureMode` must be set to `automatic`.\n\nThe maximum delay is 7 days (168 hours).\n\nPossible values: `... hours` `... days`", "example": "8 hours", "pattern": "^\\d+ (hours?|days?)$" }, "captureBefore": { "type": [ "string", "null" ], "description": "Indicates the date before which the payment needs to be captured, in ISO 8601 format. From this date onwards we can no longer guarantee a successful capture. The parameter is omitted if the payment is not authorized (yet).", "readOnly": true, "example": "2024-03-20T09:28:37+00:00" }, "applicationFee": { "type": [ "object", "null" ], "description": "With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants.\n\nIf you use OAuth to create payments on a connected merchant's account, you can charge a fee using this `applicationFee` parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent to your own account balance.\n\nIf instead you want to split a payment on your own account between yourself and a connected merchant, refer to the `routing` parameter.", "required": [ "amount", "description" ], "properties": { "amount": { "description": "The fee that you wish to charge.\n\nBe careful to leave enough space for Mollie's own fees to be deducted as well. For example, you cannot charge a €0.99 fee on a €1.00 payment.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "description": { "type": "string", "description": "The description of the application fee. This will appear on settlement reports towards both you and the connected merchant.", "maxLength": 255, "example": "Platform fee" } } }, "routing": { "type": [ "array", "null" ], "description": "*This functionality is not enabled by default. Reach out to our partner management team if you wish to use it.*\n\nWith Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants.\n\nIf you create payments on your own account that you want to split between yourself and one or more connected merchants, you can use this `routing` parameter to route the payment accordingly.\n\nThe `routing` parameter should contain an array of objects, with each object describing the destination for a specific portion of the payment.\n\nIt is not necessary to indicate in the array which portion goes to yourself. After all portions of the total payment amount have been routed, the amount left will be routed to the current organization automatically.\n\nIf instead you use OAuth to create payments on a connected merchant's account, refer to the `applicationFee` parameter.", "items": { "type": "object", "required": [ "resource", "id", "mode", "createdAt", "amount", "destination", "_links" ], "properties": { "resource": { "type": "string", "description": "Indicates the response contains a route object. Will always contain the string `route` for this endpoint.", "readOnly": true, "example": "route" }, "id": { "allOf": [ { "type": "string", "pattern": "^rt_.+$", "example": "rt_5B8cwPMGnU" } ], "description": "The identifier uniquely referring to this route. Mollie will always refer to the route by this ID. Example: `rt_5B8cwPMGnU6qLbRvo7qEZo`.", "readOnly": true }, "mode": { "type": "string", "description": "Whether this entity was created in live mode or in test mode.\n\nPossible values: `live` `test`", "readOnly": true, "example": "live" }, "amount": { "description": "The portion of the total payment amount being routed. Currently only `EUR` payments can be routed.", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "destination": { "type": "object", "description": "The destination of this portion of the payment.", "required": [ "type", "organizationId" ], "properties": { "type": { "type": "string", "description": "The type of destination. Currently only the destination type `organization` is supported.\n\nPossible values: `organization`", "example": "organization" }, "organizationId": { "description": "Required for destination type `organization`. The ID of the connected organization the funds should be routed to.", "type": "string", "pattern": "^org_.+$", "example": "org_1234567" } } }, "createdAt": { "type": "string", "description": "The date and time when the route was created. The date is given in ISO 8601 format.", "readOnly": true, "example": "2024-12-12T10:00:00+00:00" }, "releaseDate": { "type": [ "string", "null" ], "description": "Optionally, schedule this portion of the payment to be transferred to its destination on a later date. The date must be given in `YYYY-MM-DD` format.\n\nIf no date is given, the funds become available to the connected merchant as soon as the payment succeeds.", "example": "2024-12-12" }, "_links": { "type": "object", "description": "An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.", "required": [ "self", "payment" ], "properties": { "self": { "type": "object", "description": "In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "payment": { "description": "The API resource URL of the [payment](get-payment) that belong to this route.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } } }, "readOnly": true } } } }, "sequenceType": { "description": "**Only relevant for recurring payments.**\n\nIndicate which part of a recurring sequence this payment is for.\n\nRecurring payments can only take place if a mandate is available. A common way to establish such a mandate is through a `first` payment. With a `first` payment, the customer agrees to automatic recurring charges taking place on their account in the future.\n\nIf set to `recurring`, the customer's card is charged automatically.\n\nDefaults to `oneoff`, which is a regular non-recurring payment.\n\nFor PayPal payments, recurring is only possible if your connected PayPal account allows it. You can call our [Methods API](list-methods) with parameter `sequenceType: first` to discover which payment methods on your account are set up correctly for recurring payments.\n\nPossible values: `oneoff` `first` `recurring`", "type": "string", "example": "oneoff" }, "subscriptionId": { "type": [ "string", "null" ], "allOf": [ { "type": "string", "pattern": "^sub_.+$", "example": "sub_5B8cwPMGnU" } ], "description": "If the payment was automatically created via a subscription, the ID of the [subscription](get-subscription) will be added to the response.", "readOnly": true }, "mandateId": { "type": [ "string", "null" ], "allOf": [ { "type": "string", "pattern": "^mdt_.+$", "example": "mdt_5B8cwPMGnU" } ], "description": "**Only relevant for recurring payments and stored cards.**\n\nWhen creating recurring or stored cards payments, the ID of a specific [mandate](get-mandate) can be supplied to indicate which of the customer's accounts should be debited." }, "customerId": { "type": [ "string", "null" ], "description": "The ID of the [customer](get-customer) the payment is being created for. This is used primarily for recurring payments, but can also be used on regular payments to enable single-click payments.\n\nIf `sequenceType` is set to `recurring`, this field is required.", "pattern": "^cst_.+$", "example": "cst_5B8cwPMGnU" }, "profileId": { "type": "string", "description": "The identifier referring to the [profile](get-profile) this entity belongs to.\n\nWhen using an API Key, the `profileId` must not be sent since it is linked to the key. However, for OAuth and Organization tokens, the `profileId` is required.\n\nFor more information, see [Authentication](authentication).", "pattern": "^pfl_.+$", "example": "pfl_5B8cwPMGnU" }, "settlementId": { "type": [ "string", "null" ], "allOf": [ { "type": "string", "pattern": "^stl_.+$", "example": "stl_5B8cwPMGnU" } ], "description": "The identifier referring to the [settlement](get-settlement) this payment was settled with.", "readOnly": true }, "orderId": { "type": [ "string", "null" ], "allOf": [ { "type": "string", "pattern": "^ord_.+$", "example": "ord_5B8cwPMGnU" } ], "description": "If the payment was created for an [order](get-order), the ID of that order will be part of the response.", "readOnly": true }, "status": { "allOf": [ { "type": "string", "description": "The payment's status. Refer to the [documentation regarding statuses](https://docs.mollie.com/docs/handling-payment-status) for more info about which statuses occur at what point.\n\nPossible values: `open` `pending` `authorized` `paid` `canceled` `expired` `failed`", "readOnly": true, "example": "open" } ], "readOnly": true }, "statusReason": { "type": [ "object", "null" ], "description": "This object offers details about the status of a payment. Currently it is only available for point-of-sale payments.\n\nYou can find more information about the possible values of this object on [this page](status-reasons).**", "readOnly": true, "required": [ "code", "message" ], "properties": { "code": { "allOf": [ { "type": "string", "description": "A machine-readable code that indicates the reason for the payment's status.", "example": "insufficient_funds" }, { "anyOf": [ { "type": "string", "enum": [ "approved_or_completed_successfully", "refer_to_card_issuer", "invalid_merchant", "capture_card", "do_not_honor", "error", "partial_approval", "invalid_transaction", "invalid_amount", "invalid_issuer", "lost_card", "stolen_card", "insufficient_funds", "expired_card", "invalid_pin", "transaction_not_permitted_to_cardholder", "transaction_not_allowed_at_terminal", "exceeds_withdrawal_amount_limit", "restricted_card", "security_violation", "exceeds_withdrawal_count_limit", "allowable_number_of_pin_tries_exceeded", "no_reason_to_decline", "cannot_verify_pin", "issuer_unavailable", "unable_to_route_transaction", "duplicate_transaction", "system_malfunction", "honor_with_id", "invalid_card_number", "format_error", "contact_card_issuer", "pin_not_changed", "invalid_nonexistent_to_account_specified", "invalid_nonexistent_from_account_specified", "invalid_nonexistent_account_specified", "lifecycle_related", "domestic_debit_transaction_not_allowed", "policy_related", "fraud_security_related", "invalid_authorization_life_cycle", "purchase_amount_only_no_cash_back_allowed", "cryptographic_failure", "unacceptable_pin", "refer_to_card_issuer_special_condition", "pick_up_card_special_condition", "vip_approval", "invalid_account_number", "re_enter_transaction", "no_action_taken", "unable_to_locate_record", "file_temporarily_unavailable", "no_credit_account", "closed_account", "no_checking_account", "no_savings_account", "suspected_fraud", "transaction_does_not_fulfill_aml_requirement", "pin_data_required", "unable_to_locate_previous_message", "previous_message_located_inconsistent_data", "blocked_first_used", "transaction_reversed", "credit_issuer_unavailable", "pin_cryptographic_error_found", "negative_online_cam_result", "violation_of_law", "force_stip", "cash_service_not_available", "cashback_request_exceeds_issuer_limit", "decline_for_cvv2_failure", "transaction_amount_exceeds_pre_authorized_amount", "invalid_biller_information", "pin_change_unblock_request_declined", "unsafe_pin", "card_authentication_failed", "stop_payment_order", "revocation_of_authorization", "revocation_of_all_authorizations", "forward_to_issuer_xa", "forward_to_issuer_xd", "unable_to_go_online", "additional_customer_authentication_required" ], "x-enumDescriptions": { "approved_or_completed_successfully": "The transaction was approved.", "refer_to_card_issuer": "The transaction was cancelled after being initially approved by the issuer. This can be due to various reasons,\nfor example, if the shopper returns goods after purchase.", "invalid_merchant": "The transaction was refused by the card issuer. The shopper should contact their bank for clarification. The\nshopper can try again after resolving the issue with their bank, or use another payment method.", "capture_card": "The card issuer requests to retain the card. This can be due to a suspected counterfeit or stolen card. This\nreason is used in an E-Commerce environment although it originates from an in-person payments environment.", "do_not_honor": "This is a generic refusal that has several possible causes. The shopper should contact their issuing bank for\nclarification.", "error": "Payment could not be authorised and resulted in an error. The shopper can try again or use another payment method.", "partial_approval": "A partial approval was made but the transaction was not finalised. The shopper should retry the transaction.", "invalid_transaction": "The transaction type is not supported by the card issuer. The shopper should contact their bank for clarification\nor try another payment method.", "invalid_amount": "The transaction amount is incorrect. The shopper should try again with the correct amount.", "invalid_issuer": "The card issuer is not valid. The shopper should try another card or payment method.", "lost_card": "The card has been reported as lost. The shopper should contact their bank for a replacement card.", "stolen_card": "The card has been reported as stolen. The shopper should contact their bank for a replacement card.", "insufficient_funds": "The account associated with the card has insufficient funds. The shopper should use another payment method or\ncontact their bank.", "expired_card": "The card has expired. The shopper should use another card or contact their bank for a replacement.", "invalid_pin": "The PIN entered is incorrect. The shopper should try again with the correct PIN.", "transaction_not_permitted_to_cardholder": "The transaction is not permitted for the cardholder. The shopper should contact their bank for more information.", "transaction_not_allowed_at_terminal": "The transaction is not permitted at the acquirer terminal. The shopper should try another payment method.", "exceeds_withdrawal_amount_limit": "The transaction exceeds the withdrawal amount limit. The shopper should try again with a lower amount or contact\ntheir bank.", "restricted_card": "The card is restricted. The shopper should contact their bank for more information.", "security_violation": "There is a security violation. The shopper should contact their bank for more information.", "exceeds_withdrawal_count_limit": "The transaction exceeds the withdrawal count limit. The shopper should try again later or contact their bank.", "allowable_number_of_pin_tries_exceeded": "The allowable number of PIN tries has been exceeded. The shopper should contact their bank.", "no_reason_to_decline": "There is no specific reason to decline the request. The shopper should contact their bank for more information.", "cannot_verify_pin": "The PIN cannot be verified. The shopper should try again with the correct PIN.", "issuer_unavailable": "The issuer is not available. The shopper should try again later.", "unable_to_route_transaction": "The transaction cannot be routed. The shopper should try another payment method.", "duplicate_transaction": "Duplicate transaction detected.", "system_malfunction": "There is a system malfunction. The shopper should try again later.", "honor_with_id": "Honor with ID.", "invalid_card_number": "The card number is incorrect. The shopper should verify and try again with the correct card number.", "format_error": "There was a format error in the transaction. The shopper should try again or contact their bank.", "contact_card_issuer": "The card issuer needs to be contacted. The shopper should contact their bank for more information.", "pin_not_changed": "PIN not changed.", "invalid_nonexistent_to_account_specified": "Invalid/nonexistent 'To Account' specified.", "invalid_nonexistent_from_account_specified": "Invalid/nonexistent 'From Account' specified.", "invalid_nonexistent_account_specified": "An invalid or nonexistent account was specified. The shopper should verify the account information and try again.", "lifecycle_related": "The transaction was declined due to life cycle issues. The shopper should contact their bank for more information.", "domestic_debit_transaction_not_allowed": "Domestic debit transaction not allowed.", "policy_related": "The transaction was declined due to policy reasons. The shopper should contact their bank for more information.", "fraud_security_related": "The transaction was declined due to fraud or security concerns. The shopper should contact their bank for more\ninformation.", "invalid_authorization_life_cycle": "Invalid authorization life cycle.", "purchase_amount_only_no_cash_back_allowed": "Purchase amount only, no cash back allowed.", "cryptographic_failure": "There is a cryptographic failure.", "unacceptable_pin": "Unacceptable PIN.", "refer_to_card_issuer_special_condition": "Refer to card issuer, special condition.", "pick_up_card_special_condition": "The card issuer requests to retain the card. This can be due to a suspected counterfeit or stolen card.", "vip_approval": "V.I.P Approval.", "invalid_account_number": "The account number is incorrect.", "re_enter_transaction": "The transaction should be re-entered. The shopper should try the transaction again.", "no_action_taken": "No action taken (unable to back out prior transaction).", "unable_to_locate_record": "Unable to locate record in file, or account number is missing from the inquiry.", "file_temporarily_unavailable": "File is temporarily unavailable.", "no_credit_account": "No credit account.", "closed_account": "The account associated with the card is closed. The shopper should contact their bank.", "no_checking_account": "No checking account.", "no_savings_account": "No savings account.", "suspected_fraud": "The transaction is suspected of fraud. The shopper should contact their bank for more information.", "transaction_does_not_fulfill_aml_requirement": "Transaction does not fulfill AML requirement.", "pin_data_required": "PIN data is required. The shopper should enter the PIN and try again.", "unable_to_locate_previous_message": "Unable to locate previous message (no match on transaction ID).", "previous_message_located_inconsistent_data": "Previous message located, but the reversal data are inconsistent with original message.", "blocked_first_used": "Transaction from new cardholder, and card not properly unblocked.", "transaction_reversed": "Transaction reversed.", "credit_issuer_unavailable": "The credit issuer is unavailable. The shopper should try again later.", "pin_cryptographic_error_found": "PIN cryptographic error found (error found by VIC security module during PIN decryption).", "negative_online_cam_result": "The transaction was declined due to negative online CAM results. The shopper should contact their bank for more\ninformation.", "violation_of_law": "The transaction cannot be completed due to a violation of law. The shopper should contact their bank for more\ninformation.", "force_stip": "Force STIP.", "cash_service_not_available": "The cash service is not available. The shopper should try again later or use another payment method.", "cashback_request_exceeds_issuer_limit": "The cashback request exceeds the issuer limit. The shopper should try again with a lower amount or contact their\nbank.", "decline_for_cvv2_failure": "The transaction was declined due to CVV2 failure. The shopper should try again with the correct CVV2.", "transaction_amount_exceeds_pre_authorized_amount": "Transaction amount exceeds pre-authorized approval amount.", "invalid_biller_information": "Invalid biller information.", "pin_change_unblock_request_declined": "PIN change/unblock request declined.", "unsafe_pin": "Unsafe PIN.", "card_authentication_failed": "Card authentication failed. Or offline PIN authentication interrupted.", "stop_payment_order": "There is a stop payment order. The shopper should contact their bank for more information.", "revocation_of_authorization": "Revocation of authorisation order.", "revocation_of_all_authorizations": "Revocation of all authorisation orders.", "forward_to_issuer_xa": "Forward to issuer.", "forward_to_issuer_xd": "Forward to issuer.", "unable_to_go_online": "The transaction was declined offline. The shopper should try again or use another payment method.", "additional_customer_authentication_required": "Additional customer authentication required." } }, { "type": "string", "enum": [ "merchant_id_not_found", "merchant_account_closed", "terminal_id_not_found", "terminal_closed", "invalid_category_code", "invalid_currency", "missing_cvv2_cvc2", "cvv2_not_allowed", "merchant_not_registered_vbv", "merchant_not_registered_for_amex", "transaction_not_permitted_at_terminal", "agreement_terminal_not_related", "invalid_processor_id", "invalid_merchant_data", "sub_merchant_account_closed" ], "x-enumDescriptions": { "merchant_id_not_found": "Merchant ID not found.", "merchant_account_closed": "Merchant account closed.", "terminal_id_not_found": "Terminal ID not found.", "terminal_closed": "Terminal closed.", "invalid_category_code": "Invalid category code.", "invalid_currency": "Invalid currency.", "missing_cvv2_cvc2": "Missing CVV2/CVC2.", "cvv2_not_allowed": "CVV2 not allowed.", "merchant_not_registered_vbv": "Merchant not registered for Verified by Visa/Secure Code.", "merchant_not_registered_for_amex": "Merchant not registered for Amex.", "transaction_not_permitted_at_terminal": "Transaction not permitted at terminal.", "agreement_terminal_not_related": "Agreement and terminal are not related.", "invalid_processor_id": "Invalid processor ID.", "invalid_merchant_data": "Invalid merchant data (Name, City or Postal Code).", "sub_merchant_account_closed": "Sub-merchant account closed." } }, { "type": "string", "enum": [ "terminal_busy", "terminal_unreachable" ], "x-enumDescriptions": { "terminal_busy": "Another transaction was already ongoing on the terminal. Therefore, it could not accept this transaction.", "terminal_unreachable": "The transaction did not reach the terminal within 30 seconds. This is generally caused by issues with, or\ninstability of the internet connection of the terminal." } }, { "type": "string", "enum": [ "service_failed", "invalid_operation", "authorization_error", "login_failed_without_reason", "invalid_retailer", "refer_to_card_issuer", "card_does_not_exist", "expired_card", "card_is_blocked", "insufficient_funds", "invalid_card_id", "card_is_transferred", "card_is_not_active", "incorrect_purchase_value", "card_not_available", "wrong_currency", "login_failed_unknown_user", "login_failed_invalid_password", "invalid_pin", "invalid_ean_code" ], "x-enumDescriptions": { "service_failed": "Service failed.", "invalid_operation": "Invalid operation.", "authorization_error": "Authorization failed, not logged in.", "login_failed_without_reason": "Login failed (Reason not specified).", "invalid_retailer": "Invalid/unknown Retailer.", "refer_to_card_issuer": "The transaction was cancelled after being initially approved by the issuer. This can be due to various reasons,\nfor example, if the shopper returns goods after purchase.", "card_does_not_exist": "Card or Customer does not exist.", "expired_card": "The card has expired. The shopper should use another card or contact their bank for a replacement.", "card_is_blocked": "Card is blocked.", "insufficient_funds": "The account associated with the card has insufficient funds. The shopper should use another payment method or\ncontact their bank.", "invalid_card_id": "Invalid CardId.", "card_is_transferred": "Card is transferred.", "card_is_not_active": "Card is not active.", "incorrect_purchase_value": "Incorrect activation or purchase value.", "card_not_available": "Card not available.", "wrong_currency": "Wrong currency.", "login_failed_unknown_user": "Login failed: Unknown user.", "login_failed_invalid_password": "Login failed: Invalid password.", "invalid_pin": "Invalid PIN.", "invalid_ean_code": "Invalid EAN code." } } ], "x-methodSpecific": true } ] }, "message": { "type": "string", "description": "A description of the status reason, localized according to the payment `locale`.", "example": "The account associated with the card has insufficient funds. The shopper should use another payment method or\ncontact their bank." } } }, "isCancelable": { "type": [ "boolean", "null" ], "description": "Whether the payment can be canceled. This parameter is omitted if the payment reaches a final state.", "readOnly": true, "example": true }, "details": { "type": [ "object", "null" ], "description": "An object containing payment details collected during the payment process. For example, details may include the customer's card or bank details and a payment reference. For the full list of details, please refer to the [method-specific parameters](extra-payment-parameters) guide.", "readOnly": true, "properties": { "consumerName": { "type": [ "string", "null" ], "description": "The customer's name, if made available by the payment method. For card payments, refer to `details.cardHolder`.", "example": "John Doe", "x-methodSpecific": true, "x-method": "customer-details" }, "consumerAccount": { "type": [ "string", "null" ], "description": "The customer's account reference.\n\nFor banking-based payment methods — such as iDEAL — this is normally either an IBAN or a domestic bank account number.\n\nFor PayPal, the account reference is an email address.\n\nFor card and Bancontact payments, refer to `details.cardNumber`.", "example": "NL91ABNA0417164300", "x-methodSpecific": true, "x-method": "customer-details" }, "consumerBic": { "type": [ "string", "null" ], "description": "The BIC of the customer's bank account, if applicable.", "example": "ABNANL2A", "x-methodSpecific": true, "x-method": "customer-details" }, "shippingAddress": { "type": [ "object", "null" ], "description": "For wallet payment methods — such as Apple Pay and PayPal — the shipping address is often already known by the wallet provider. In these cases the shipping address may be available as a payment detail.", "properties": {}, "additionalProperties": true, "x-methodSpecific": true, "x-method": "customer-details" }, "cardNumber": { "type": [ "string", "null" ], "description": "The customer's masked card number.", "example": "************1234", "x-methodSpecific": true, "x-method": [ "bancontact", "cards", "point-of-sale" ], "x-method-descriptions": { "bancontact": "The customer's masked card number.", "cards": "The last4-digit of the PAN.", "point-of-sale": "The last 4 digits of the customer's masked card number." } }, "bankName": { "type": "string", "description": "The name of the bank that the customer will need to make the bank transfer payment towards.", "example": "Mollie Bank", "x-methodSpecific": true, "x-method": "bank-transfer" }, "bankAccount": { "type": "string", "description": "The bank account number the customer will need to make the bank transfer payment towards.", "example": "NL91ABNA0417164300", "x-methodSpecific": true, "x-method": "bank-transfer" }, "bankBic": { "type": "string", "description": "The BIC of the bank the customer will need to make the bank transfer payment towards.", "example": "ABNANL2A", "x-methodSpecific": true, "x-method": "bank-transfer" }, "billingEmail": { "type": [ "string", "null" ], "deprecated": true, "description": " This field is deprecated. Use `billingAddress.email` instead. \n\nThe email address which the customer requested us to send the payment instructions to. Only available if provided via the API during payment creation, or if filled out by the customer in the hosted checkout screen.", "example": "customer@example.org", "x-methodSpecific": true, "x-method": "bank-transfer" }, "transferReference": { "type": [ "string", "null" ], "description": "The Mollie-generated reference the customer needs to use when transfering the amount. Do not apply any formatting here; show it to the customer as-is.", "example": "...", "x-methodSpecific": true, "x-method": [ "bank-transfer", "sepa-direct-debit" ], "x-method-descriptions": { "bank-transfer": "The Mollie-generated reference the customer needs to use when transfering the amount. Do not apply any\nformatting here; show it to the customer as-is.", "sepa-direct-debit": "The reference generated by Mollie to uniquely identify the payment." } }, "bizumReference": { "type": [ "string", "null" ], "description": "Bizum payment reference of the transaction.", "example": "2901tq2ure1d", "x-methodSpecific": true, "x-method": "bizum" }, "cardFingerprint": { "type": [ "string", "null" ], "description": "A unique fingerprint for this specific card. Can be used to identify returning customers.", "example": "...", "x-methodSpecific": true, "x-method": [ "cards", "point-of-sale" ], "x-method-descriptions": { "cards": "A unique fingerprint for this specific card. Can be used to identify returning customers.", "point-of-sale": "A unique identifier assigned to a cardholder's payment account, linking multiple transactions from wallets\nand physical card to a single account, also across payment methods or when the card is reissued." } }, "cardHolder": { "type": [ "string", "null" ], "description": "The customer's name as shown on their card.", "example": "John Doe", "x-methodSpecific": true, "x-method": "cards" }, "cardAudience": { "x-methodSpecific": true, "x-method": [ "cards", "point-of-sale" ], "x-method-descriptions": { "cards": "The card's target audience, if known.\n\nPossible values: `consumer` `business`", "point-of-sale": "The card's target audience, if known. Possible values: `consumer` `business`" }, "type": [ "string", "null" ], "description": "The card's target audience, if known.\n\nPossible values: `consumer` `business`", "example": "consumer" }, "cardLabel": { "x-methodSpecific": true, "x-method": [ "cards", "point-of-sale" ], "x-method-descriptions": { "cards": "The card's label, if known.\n\nPossible values: `American Express` `Carta Si` `Carte Bleue` `Cartes Bancaires` `Dankort` `Diners Club`\n`Discover` `JCB` `Laser` `Maestro` `Mastercard` `Unionpay` `Visa`", "point-of-sale": "The card's label, if known. Possible values: `Mastercard` `Visa` `Maestro` `Vpay`" }, "type": [ "string", "null" ], "description": "The card's label, if known.\n\nPossible values: `American Express` `Carta Si` `Carte Bleue` `Cartes Bancaires` `Dankort` `Diners Club` `Discover` `JCB` `Laser` `Maestro` `Mastercard` `Unionpay` `Visa` `Vpay`", "example": "Mastercard" }, "cardCountryCode": { "type": [ "string", "null" ], "description": "The ISO 3166-1 alpha-2 country code of the country the card was issued in.", "example": "NL", "x-methodSpecific": true, "x-method": [ "cards", "point-of-sale" ] }, "cardExpiryDate": { "type": [ "string", "null" ], "description": "The expiry date (`MM/YY`) of the card as displayed on the card.", "example": "12/25", "x-methodSpecific": true, "x-method": "cards" }, "cardFunding": { "x-methodSpecific": true, "x-method": [ "cards", "point-of-sale" ], "x-method-descriptions": { "cards": "The card type.\n\nPossible values: `debit`, `credit`, `prepaid`, `deferred-debit`", "point-of-sale": "The card funding type, if known. Possible values: `credit` `debit`" }, "type": [ "string", "null" ], "description": "The card type.\n\nPossible values: `debit` `credit` `prepaid` `deferred-debit`", "example": "credit" }, "cardSecurity": { "type": [ "string", "null" ], "description": "The level of security applied during card processing.\n\nPossible values: `normal` `3dsecure`", "x-methodSpecific": true, "x-method": "cards", "example": "normal" }, "feeRegion": { "x-methodSpecific": true, "x-method": [ "cards", "point-of-sale" ], "x-method-descriptions": { "cards": "The applicable card fee region.\n\nFor example, `intra-eu` applies to consumer cards from the European Economic Area (EEA).\n\nPossible values: `american-express` `amex-intra_eea` `carte-bancaire` `intra-eu` `intra-eu-corporate`\n`domestic` `maestro` `other`", "point-of-sale": "The applicable card fee region. For example, `intra_eea` applies to consumer cards from the European\nEconomic Area (EEA). Possible values: `domestic` `inter` `intra_eea`" }, "type": [ "string", "null" ], "description": "The applicable card fee region.\n\nPossible values: `american-express` `amex-intra-eea` `carte-bancaire` `cartes-bancaires-business` `cartes-bancaires-consumer` `domestic` `inter` `intra-eu` `intra-eu-corporate` `intra_eea` `maestro` `mastercard-credit-business-domestic` `mastercard-credit-consumer-domestic` `mastercard-credit-consumer-intra-eea` `mastercard-debit-business-domestic` `mastercard-debit-business-intra-eea` `mastercard-debit-consumer-domestic` `mastercard-debit-consumer-inter` `mastercard-debit-consumer-intra-eea` `other` `visa-credit-business-domestic` `visa-credit-consumer-domestic` `visa-credit-consumer-inter` `visa-credit-consumer-intra-eea` `visa-debit-business-domestic` `visa-debit-business-intra-eea` `visa-debit-consumer-domestic` `visa-debit-consumer-inter` `visa-debit-consumer-intra-eea`", "example": "maestro" }, "cardMaskedNumber": { "type": [ "string", "null" ], "description": "The first6 and last4 digits of the card number.", "example": "...", "x-methodSpecific": true, "x-method": "cards" }, "card3dsEci": { "type": [ "string", "null" ], "description": "The outcome of authentication attempted on transactions enforced by 3DS (ie valid only for `oneoff` and `first`).", "example": "...", "x-methodSpecific": true, "x-method": "cards" }, "cardBin": { "type": [ "string", "null" ], "description": "The first6 digit of the card bank identification number.", "example": "...", "x-methodSpecific": true, "x-method": "cards" }, "cardIssuer": { "type": [ "string", "null" ], "description": "The issuer of the Card.", "example": "...", "x-methodSpecific": true, "x-method": "cards" }, "failureReason": { "description": "A failure code to help understand why the payment failed.\n\nPossible 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`", "x-methodSpecific": true, "x-method": "cards", "type": [ "string", "null" ], "example": "card_declined" }, "failureMessage": { "type": [ "string", "null" ], "description": "A human-friendly failure message that can be shown to the customer. The message is translated in accordance with the payment's locale setting.", "example": "Your card was declined.", "x-methodSpecific": true, "x-method": "cards" }, "wallet": { "description": "The wallet used when creating the payment.\n\nPossible values: `applepay` `googlepay`", "x-methodSpecific": true, "x-method": "cards", "type": [ "string", "null" ], "x-enumDescriptions": { "applepay": "The payment was made using Apple Pay.", "googlepay": "The payment was made using Google Pay." }, "example": "applepay" }, "multibancoReference": { "type": [ "string", "null" ], "description": "Multibanco payment reference of the transaction.", "example": 123456789, "x-methodSpecific": true, "x-method": "multibanco" }, "multibancoEntity": { "type": [ "string", "null" ], "description": "Multibanco entity reference of the transaction.", "example": 98765, "x-methodSpecific": true, "x-method": "multibanco" }, "paypalReference": { "type": [ "string", "null" ], "description": "PayPal's reference for the payment.", "example": "...", "x-methodSpecific": true, "x-method": "paypal" }, "paypalPayerId": { "type": [ "string", "null" ], "description": "ID of the customer's PayPal account.", "example": "...", "x-methodSpecific": true, "x-method": "paypal" }, "sellerProtection": { "description": "Indicates to what extent the payment is eligible for PayPal's Seller Protection. Only available for PayPal payments, if the information is made available by PayPal.\n\nClassic values: `Eligible` `Ineligible` `Partially Eligible - INR Only` `Partially Eligible - Unauth Only` `PartiallyEligible` `None` `Active` `Fraud Control - Unauth Premium Eligible`\n\nCurrent values: `ELIGIBLE` `PARTIALLY_ELIGIBLE` `NOT_ELIGIBLE`\n\n_Note:_ Classic values are legacy and may still appear in older payments.\n\nPossible values: `ELIGIBLE` `PARTIALLY_ELIGIBLE` `NOT_ELIGIBLE`", "x-methodSpecific": true, "x-method": "paypal", "type": [ "string", "null" ], "x-deprecated-enum": [ "Eligible", "Ineligible", "Partially Eligible - INR Only", "Partially Eligible - Unauth Only", "Partially Eligible", "None", "Active", "Fraud Control - Unauth Premium Eligible" ], "x-speakeasy-enum-descriptions": { "Eligible": "Deprecated value", "Ineligible": "Deprecated value", "Partially Eligible - INR Only": "Deprecated value", "Partially Eligible - Unauth Only": "Deprecated value", "Partially Eligible": "Deprecated value", "None": "Deprecated value", "Active": "Deprecated value", "Fraud Control - Unauth Premium Eligible": "Deprecated value" }, "example": "ELIGIBLE" }, "paypalFee": { "description": "An amount object containing the fee PayPal will charge for this transaction. The field may be omitted if PayPal will not charge a fee for this transaction.", "x-methodSpecific": true, "x-method": "paypal", "type": [ "object", "null" ], "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "customerReference": { "type": "string", "description": "The paysafecard customer reference either provided via the API or otherwise auto-generated by Mollie.", "example": "...", "x-methodSpecific": true, "x-method": "paysafecard" }, "terminalId": { "type": "string", "description": "The ID of the terminal device where the payment took place on.", "example": "term_12345", "x-methodSpecific": true, "x-method": "point-of-sale" }, "maskedNumber": { "type": [ "string", "null" ], "description": "The first 6 digits & last 4 digits of the customer's masked card number.", "example": "...", "x-methodSpecific": true, "x-method": "point-of-sale" }, "creditorIdentifier": { "type": [ "string", "null" ], "description": "The creditor identifier indicates who is authorized to execute the payment. In this case, it is a reference to Mollie.", "example": "...", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "dueDate": { "type": [ "string", "null" ], "format": "date", "description": "Estimated date the payment is debited from the customer's bank account, in `YYYY-MM-DD` format.", "example": "2025-01-01", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "signatureDate": { "type": [ "string", "null" ], "format": "date", "description": "Date the payment has been signed by the customer, in `YYYY-MM-DD` format. Only available if the payment has been signed.", "example": "2024-03-20", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "bankReasonCode": { "type": [ "string", "null" ], "description": "The official reason why this payment has failed. A detailed description of each reason is available on the website of the European Payments Council.", "example": "...", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "bankReason": { "type": [ "string", "null" ], "description": "A human-friendly description of the failure reason.", "example": "...", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "endToEndIdentifier": { "type": [ "string", "null" ], "description": "The end-to-end identifier you provided in the batch file.", "example": "...", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "mandateReference": { "type": [ "string", "null" ], "description": "The mandate reference you provided in the batch file.", "example": "...", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "batchReference": { "type": [ "string", "null" ], "description": "The batch reference you provided in the batch file.", "example": "...", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "fileReference": { "type": [ "string", "null" ], "description": "The file reference you provided in the batch file.", "example": "...", "x-methodSpecific": true, "x-method": "sepa-direct-debit" }, "qrCode": { "type": "object", "description": "**Optional include.** If a QR code was requested during payment creation for a QR-compatible payment method, the QR code details will be available in this object.\n\nThe QR code can be scanned by the customer to complete the payment on their mobile device. For example, Bancontact QR payments can be completed by the customer using the Bancontact app.\n\n* `height` _integer_\n* `width` _integer_\n* `src` _string_", "properties": { "height": { "type": "integer", "description": "The height of the QR code image in pixels.", "example": 300 }, "width": { "type": "integer", "description": "The width of the QR code image in pixels.", "example": 300 }, "src": { "type": "string", "description": "The URL to the QR code image.", "example": "https://www.mollie.com/images/qr-code.png" } }, "x-methodSpecific": true, "x-method": "qr-enabled" }, "voucherNumber": { "type": "string", "description": "For payments with gift cards: the masked gift card number of the first gift card applied to the payment.", "example": "...", "x-methodSpecific": true, "x-method": "gift-cards-vouchers" }, "giftcards": { "type": "array", "description": "An array of detail objects for each gift card that was used on this payment, if any.", "items": { "type": "object", "properties": {}, "additionalProperties": true }, "x-methodSpecific": true, "x-method": "gift-cards-vouchers" }, "issuer": { "type": "string", "description": "For payments with vouchers: the brand name of the first voucher applied.", "example": "...", "x-methodSpecific": true, "x-method": "gift-cards-vouchers" }, "vouchers": { "type": "array", "description": "An array of detail objects for each voucher that was used on this payment, if any.", "items": { "type": "object", "properties": {}, "additionalProperties": true }, "x-methodSpecific": true, "x-method": "gift-cards-vouchers" }, "remainderAmount": { "description": "An amount object for the amount that remained after all gift cards or vouchers were applied.", "x-methodSpecific": true, "x-method": "gift-cards-vouchers", "type": "object", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, "remainderMethod": { "type": "string", "description": "The payment method used to pay the remainder amount, after all gift cards or vouchers were applied.", "example": "creditcard", "x-methodSpecific": true, "x-method": "gift-cards-vouchers" }, "remainderDetails": { "type": "object", "description": "**Optional include.** The full payment method details of the remainder payment.", "properties": {}, "additionalProperties": true, "x-methodSpecific": true, "x-method": "gift-cards-vouchers" } } }, "createdAt": { "type": "string", "description": "The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "readOnly": true, "example": "2024-03-20T09:13:37+00:00" }, "authorizedAt": { "type": [ "string", "null" ], "description": "The date and time the payment became authorized, in ISO 8601 format. This parameter is omitted if the payment is not authorized (yet).", "readOnly": true, "example": "2024-03-20T09:28:37+00:00" }, "paidAt": { "type": [ "string", "null" ], "description": "The date and time the payment became paid, in ISO 8601 format. This parameter is omitted if the payment is not completed (yet).", "readOnly": true, "example": "2024-03-20T09:28:37+00:00" }, "canceledAt": { "type": [ "string", "null" ], "description": "The date and time the payment was canceled, in ISO 8601 format. This parameter is omitted if the payment is not canceled (yet).", "readOnly": true, "example": "2024-03-20T09:28:37+00:00" }, "expiresAt": { "type": [ "string", "null" ], "description": "The date and time the payment will expire, in ISO 8601 format. This parameter is omitted if the payment can no longer expire.", "readOnly": true, "example": "2024-03-20T09:28:37+00:00" }, "expiredAt": { "type": [ "string", "null" ], "description": "The date and time the payment was expired, in ISO 8601 format. This parameter is omitted if the payment did not expire (yet).", "readOnly": true, "example": "2024-03-20T09:28:37+00:00" }, "failedAt": { "type": [ "string", "null" ], "description": "The date and time the payment failed, in ISO 8601 format. This parameter is omitted if the payment did not fail (yet).", "readOnly": true, "example": "2024-03-20T09:28:37+00:00" }, "dueDate": { "type": [ "string", "null" ], "description": "The date by which the payment should be completed in `YYYY-MM-DD` format. Sending `null` has the same effect as omitting the field.", "example": "2025-01-01", "writeOnly": true }, "storeCredentials": { "type": [ "boolean" ], "description": "Whether the card details should be stored for the customer after a successful payment. This will create a mandate for the customer, allowing for future customer present saved-card CIT payments. Requires customerId, cardToken, and the creditcard method to be specified. ", "writeOnly": true, "example": true }, "testmode": { "type": [ "boolean", "null" ], "description": "Whether to create the entity in test mode or live mode.\n\nMost API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.", "writeOnly": true, "example": false }, "_links": { "type": "object", "description": "An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.", "required": [ "self", "dashboard" ], "properties": { "self": { "type": "object", "description": "In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "checkout": { "description": "The URL your customer should visit to make the payment. This is where you should redirect the customer to.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "mobileAppCheckout": { "description": "The deeplink URL to the app of the payment method. Currently only available for `bancontact`.", "x-methodSpecific": true, "x-method": "bancontact", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "changePaymentState": { "description": "For test mode payments in certain scenarios, a hosted interface is available to help you test different payment states.\n\nFirstly, for recurring test mode payments. Recurring payments do not have a checkout URL, because these payments are executed without any user interaction.\n\nSecondly, for paid test mode payments. The payment state screen will then allow you to create a refund or chargeback for the test payment.", "type": [ "object", "null" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "dashboard": { "description": "Direct link to the payment in the Mollie Dashboard.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "refunds": { "description": "The API resource URL of the [refunds](list-payment-refunds) that belong to this payment.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "chargebacks": { "description": "The API resource URL of the [chargebacks](list-payment-chargebacks) that belong to this payment.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "captures": { "description": "The API resource URL of the [captures](list-payment-captures) that belong to this payment.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "settlement": { "description": "The API resource URL of the [settlement](get-settlement) this payment has been settled with. Not present if not yet settled.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "customer": { "description": "The API resource URL of the [customer](get-customer).", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "mandate": { "description": "The API resource URL of the [mandate](get-mandate).", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "subscription": { "description": "The API resource URL of the [subscription](get-subscription).", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "order": { "description": "The API resource URL of the [order](get-order) this payment was created for. Not present if not created for an order.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "terminal": { "description": "The API resource URL of the [terminal](get-terminal) this payment was created for. Only present for point-of-sale payments.", "x-methodSpecific": true, "x-method": "point-of-sale", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "status": { "description": "Link to customer-facing page showing the status of the bank transfer (to verify if the transaction was successful).", "x-methodSpecific": true, "x-method": "bank-transfer", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "payOnline": { "description": "Link to Mollie Checkout page allowing customers to select a different payment method instead of legacy bank transfer.", "x-methodSpecific": true, "x-method": "bank-transfer", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } } }, "readOnly": true } } }, { "type": "object", "properties": { "method": { "description": "The payment method used for this transaction. If a specific method was selected during payment initialization, this field reflects that choice.\n\nPossible values: `alma` `applepay` `bacs` `bancomatpay` `bancontact` `banktransfer` `belfius` `billie` `billink` `bizum` `blik` `creditcard` `directdebit` `eps` `giftcard` `ideal` `in3` `kbc` `klarna` `mbway` `mobilepay` `multibanco` `mybank` `paybybank` `paypal` `paysafecard` `pointofsale` `przelewy24` `riverty` `satispay` `swish` `trustly` `twint` `vipps` `voucher` `wero`", "type": [ "string", "null" ], "example": "ideal", "x-deprecated-enum": [ "klarnapaylater", "klarnapaynow", "klarnasliceit", "payconiq" ], "x-speakeasy-enum-descriptions": { "klarnapaylater": "Deprecated, use 'klarna' instead", "klarnapaynow": "Deprecated, use 'klarna' instead", "klarnasliceit": "Deprecated, use 'klarna' instead", "payconiq": "No longer available" } } } } ] }, { "type": "object", "properties": { "mode": { "type": "string", "description": "Whether this entity was created in live mode or in test mode. Settlements are always in live mode.\n\nPossible values: `live`", "readOnly": true, "example": "live" }, "status": { "type": "string", "description": "The payment's status. Settlement payments always have a status of `paid`.\n\nPossible values: `paid`", "readOnly": true, "example": "paid" }, "settlementAmount": { "allOf": [ { "type": "object", "description": "In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.", "required": [ "currency", "value" ], "properties": { "currency": { "type": "string", "description": "A three-character ISO 4217 currency code.", "example": "EUR" }, "value": { "type": "string", "description": "A string containing an exact monetary amount in the given currency.", "example": "10.00" } } }, { "description": "The amount settled to your account for this payment, converted to the currency your account is settled in.\n\nAmounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by Mollie, this field is omitted from the response." } ], "readOnly": true } } } ] } } } }, "_links": { "type": "object", "description": "Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.", "required": [ "self", "previous", "next", "documentation" ], "properties": { "self": { "description": "The URL to the current set of items.", "type": "object", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "previous": { "description": "The previous set of items, if available.", "type": [ "object", "null" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "next": { "description": "The next set of items, if available.", "type": [ "object", "null" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } }, "documentation": { "type": "object", "description": "In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "description": "The actual URL string.", "example": "https://..." }, "type": { "type": "string", "description": "The content type of the page or endpoint the URL points to.", "example": "application/hal+json" } } } } } } }, "examples": { "list-settlement-payments-200-1": { "summary": "A list of settlement payment objects", "value": { "count": 1, "_embedded": { "payments": [ { "resource": "payment", "id": "tr_5B8cwPMGnU6qLbRvo7qEZo", "mode": "live", "status": "paid", "sequenceType": "oneoff", "amount": { "value": "75.00", "currency": "EUR" }, "description": "Order #12345", "method": "ideal", "metadata": null, "details": null, "profileId": "pfl_QkEhN94Ba", "settlementId": "stl_jDk30akdN", "redirectUrl": "https://webshop.example.org/order/12345/", "createdAt": "2024-02-12T11:58:35+00:00", "paidAt": "2024-02-12T12:01:35+00:00", "_links": { "self": { "href": "...", "type": "application/hal+json" }, "dashboard": { "href": "https://www.mollie.com/dashboard/org_12345678/payments/tr_5B8cwPMGnU6qLbRvo7qEZo", "type": "text/html" } } } ] }, "_links": { "self": { "href": "...", "type": "application/hal+json" }, "previous": null, "next": { "href": { "value": "https://api.mollie.test/v2/settlements/stl_nml7kw/payments?from=tr_5B8cwPMGnU6qLbRvo7qEZo&limit=1" }, "type": "application/hal+json" }, "documentation": { "href": "...", "type": "text/html" } } } } } } } }, "400": { "description": "The request contains issues. For example, if the specified `from` value is not a valid ID.", "content": { "application/hal+json": { "schema": { "type": "object", "description": "An error response object.", "required": [ "status", "title", "detail", "_links" ], "properties": { "status": { "type": "integer", "description": "The status code of the error message. This is always the same code as the status code of the HTTP message itself.", "minimum": 400, "maximum": 599, "example": 404 }, "title": { "type": "string", "description": "The HTTP reason phrase of the error. For example, for a `404` error, the `title` will be `Not Found`.", "example": "Not Found" }, "detail": { "type": "string", "description": "A detailed human-readable description of the error that occurred.", "example": "The resource does not exist" }, "field": { "type": "string", "description": "If the error was caused by a value provided by you in a specific field, the `field` property will contain the name of the field that caused the issue.", "example": "description" }, "_links": { "type": "object", "required": [ "documentation" ], "properties": { "documentation": { "type": "object", "description": "The URL to the generic Mollie API error handling guide.", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "example": "https://docs.mollie.com/errors" }, "type": { "type": "string", "example": "text/html" } } } } } } }, "example": { "status": 400, "title": "Bad Request", "detail": "Invalid cursor value", "field": "from", "_links": { "documentation": { "href": "...", "type": "text/html" } } } } } }, "429": { "$ref": "#/components/responses/429-rate-limit" } }, "x-speakeasy-pagination": { "type": "url", "outputs": { "nextUrl": "$._links.next.href" } }, "x-readme": { "code-samples": [ { "language": "shell", "code": "curl -X GET https://api.mollie.com/v2/settlements/stl_jDk30akdN/payments \\\n -H \"Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ\"" }, { "language": "php", "code": "setAccessToken('access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ');\n\n$request = new GetPaginatedSettlementPaymentsRequest('stl_jDk30akdN');\n\n$payments = $mollie->send($request);", "install": "composer require mollie/mollie-api-php" }, { "language": "node", "code": "const { createMollieClient } = require('mollie-api-typescript');\nconst mollieClient = createMollieClient({ accessToken: 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ' });\n\nconst settlement = await mollieClient.settlementPayments.iterate({\n settlementId: 'stl_jDk30akdN'\n});", "install": "npm install mollie-api-typescript" }, { "language": "python", "code": "from mollie.api.client import Client\n\nmollie_client = Client()\nmollie_client.set_access_token(\"access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ\")\n\nsettlement = mollie_client.settlements.get(\"stl_jDk30akdN\")\npayments = settlement.payments.list()", "install": "pip install mollie-api-py" }, { "language": "ruby", "code": "require 'mollie-api-ruby'\n\nMollie::Client.configure do |config|\n config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ'\nend\n\npayments = Mollie::Settlement::Payment.all(settlement_id: 'stl_jDk30akdN')", "install": "gem install mollie-api-ruby" } ] } } } }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "Authenticates API requests for a single website profile. Each key targets\neither live mode (`live_...`) or test mode (`test_...`).\n\nKeys are shown only once, at creation. Store the key securely — it cannot\nbe retrieved afterwards. If lost, create a new key under Developers → API\naccess tokens in the Dashboard and revoke the old one.", "x-default": "live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" }, "advancedAccessToken": { "type": "http", "scheme": "bearer", "description": "Authenticates API requests with configurable permissions. Can access\norganization-level resources and optionally scope to a specific payment\nprofile (`access_...`). Use for advanced integrations — such as bookkeeping\nor reporting tools — that need fine-grained control over API access.\n\nTokens are shown only once, at creation. Store it securely — it cannot be\nretrieved afterwards. If lost, create a new token under Developers → API\naccess tokens in the Dashboard and revoke the old one.", "x-default": "access_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" }, "oAuth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://my.mollie.com/oauth2/authorize", "tokenUrl": "https://api.mollie.com/oauth2/tokens", "scopes": {} } } } }, "responses": { "429-rate-limit": { "description": "Rate Limit has been reached.", "content": { "application/hal+json": { "schema": { "type": "object", "description": "An error response object.", "required": [ "status", "title", "detail", "_links" ], "properties": { "status": { "type": "integer", "description": "The status code of the error message. This is always the same code as the status code of the HTTP message itself.", "minimum": 400, "maximum": 599, "example": 404 }, "title": { "type": "string", "description": "The HTTP reason phrase of the error. For example, for a `404` error, the `title` will be `Not Found`.", "example": "Not Found" }, "detail": { "type": "string", "description": "A detailed human-readable description of the error that occurred.", "example": "The resource does not exist" }, "field": { "type": "string", "description": "If the error was caused by a value provided by you in a specific field, the `field` property will contain the name of the field that caused the issue.", "example": "description" }, "_links": { "type": "object", "required": [ "documentation" ], "properties": { "documentation": { "type": "object", "description": "The URL to the generic Mollie API error handling guide.", "required": [ "href", "type" ], "properties": { "href": { "type": "string", "example": "https://docs.mollie.com/errors" }, "type": { "type": "string", "example": "text/html" } } } } } } }, "example": { "status": 429, "title": "Too Many Requests", "detail": "You have exceeded the rate limit. Please slow down your requests.", "_links": { "documentation": { "href": "https://docs.mollie.com/overview/handling-errors", "type": "text/html" } } } } } } } }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "shell", "php", "node", "python", "ruby" ] } } ```