MOmollie
Delayed Routing API

Create a delayed route

Create a route for a specific payment. The routed amount is credited to the account of your customer.

🔑 Access with

API key

Advanced access token with payments.write

OAuth access with payments.write

post/payments/{paymentId}/routes

Request

  • Base URL
    https://api.mollie.com/v2
  • URL
    https://api.mollie.com/v2/payments/{paymentId}/routes
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: payments.write

Request body

descriptionstring

Description shown in reports.

Example request

{
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "destination": {
    "type": "organization",
    "organizationId": "org_1234567"
  },
  "description": "Payment for Order #12345"
}

Response

The route object.

resourcestring required

Indicates the response contains a route object. Will always contain the string route for this endpoint.

idstring required

The identifier uniquely referring to this route. Mollie assigns this identifier at route creation time. Mollie will always refer to the route by this ID. Example: crt_dyARQ3JzCgtPDhU2Pbq3J.

paymentIdstring required

The unique identifier of the payment. For example: tr_5B8cwPMGnU6qLbRvo7qEZo. The full payment object can be retrieved via the payment URL in the _links object.

descriptionstring

The description of the route. This description is shown in the reports.

testmodeboolean nullable

Whether to create the entity in test mode or live mode.

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

createdAtstring required

The entity's date and time of creation, in ISO 8601 format.

Example response

{
  "id": "crt_dyARQ3JzCgtPDhU2Pbq3J",
  "paymentId": "tr_5B8cwPMGnU",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "Payment for Order #12345",
  "destination": {
    "type": "organization",
    "organizationId": "org_1234567"
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "payment": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.