Create order payment

post deprecated

https://api.mollie.com/v2/orders/{orderId}/payments

⚠️ We no longer recommend using the Orders API. Please refer to the Payments API instead.

An order has an automatically created payment that your customer can use to pay for the order. When the payment expires you can create a new payment for the order using this endpoint. A maximum of 25 payments can be created for an order.

A new payment can only be created while the status of the order is created, and when the status of the existing payment is either expired, canceled or failed.

The endpoint accepts virtually all parameters accepted by the regular Create payment endpoint. Please refer to that endpoint for the full documentation of all parameters.

The payment inherits certain properties, such as the amount and webhookUrl, directly from the order. These cannot be changed via this endpoint.

Access with

API key

Organization access token with payments.write

OAuth access with payments.write

Path Params

orderId

string

required

Provide the ID of the related order.

Body Params

method

string | null

Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment method and your customer will skip the selection screen and is sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website.

You can also specify the methods in an array. By doing so we will still show the payment method selection screen but will only show the methods specified in the array. For example, you can use this functionality to only show payment methods from a specific country to your customer ['bancontact', 'belfius'].

Possible values: alma applepay bacs bancomatpay bancontact banktransfer belfius billie 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

customerId

string

mandateId

string

Only relevant for recurring payments and stored cards.

When creating recurring or stored cards payments, the ID of a specific mandate can be supplied to indicate which of the customer's accounts should be debited.

sequenceType

string

enum

Allowed:

webhookUrl

string | null

The webhook URL where we will send payment status updates to.

The webhookUrl is optional, but without a webhook you will miss out on important status changes to your payment.

The 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.

metadata

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.

applicationFee

object | null

With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants.

If 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.

If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the routing parameter.

Responses

201The newly created payment object.

404No entity with this ID exists.