MOmollie
Delayed Routing API

List payment routes

Changed on

Retrieve a list of all routes created for a specific payment.

get/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.read

Query parameters

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

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

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

Response

A list of route objects.

countinteger required

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.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "routes": [
      {
        "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"
          },
          "payment": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes