v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Payment Initiations

Get standing order initiation request details

Retrieve the details of a specific standing order initiation request.

get/standing-order-initiations/{standingOrderInitiationId}

Path parameters

standingOrderInitiationIdstring required

Standing order initiation ID

Response

Standing order initiation found

idstring

The identifier of the standing order initiation

statusstring

The status of the standing order initiation, can be one of SUBMITTED, AWAITING_CONSENT, CONSENT_REJECTED, EXECUTED, ER_EXPIRED, ER_EXTSYS, ER_GENERAL

aspspIdstring

The identifier of the ASPSP used for the standing order

standingOrderStatusstring

The status of the standing order at the ASPSP. When available, this is passed through from the ASPSP without modification.

Example response

{
  "id": "I000000001",
  "payment": {
    "destination": {
      "id": "A1100001",
      "accountNumber": "12345678",
      "sortCode": "000000",
      "name": "Test"
    },
    "reference": "Invoice ABC123"
  },
  "schedule": {
    "initialDate": "2021-03-25",
    "finalDate": "2021-03-25"
  },
  "status": "AWAITING_CONSENT",
  "aspspId": "H100000001",
  "standingOrderStatus": "InitiationCompleted"
}