MOmollie
Delayed Routing API

Create a delayed route

Changed on

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

post/v2/payments/{paymentId}/routes

Request

  • Base URL
    https://api.mollie.com
  • 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

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

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
paymentIdstring required
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

{
  "resource": "route",
  "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

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status

  • ef4b5a97b56aRevision changes
    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API