v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Payment Initiations

Get payment initiation request details

Retrieve the details of a specific payment initiation request.

get/payment-initiations/{paymentInitiationId}

Path parameters

paymentInitiationIdstring required

Payment initiation ID

Response

Payment initiation found

idstring

The identifier of the payment initiation

statusstring

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

paymentReferencestring

The payment reference

aspspIdstring

The identifier of the ASPSP used for the payment

aspspPaymentStatusstring

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

Example response

{
  "id": "I000000001",
  "status": "AWAITING_CONSENT",
  "destination": {
    "id": "A1100001",
    "accountNumber": "12345678",
    "sortCode": "000000",
    "name": "Test"
  },
  "aspspId": "H100000001",
  "aspspPaymentStatus": "AcceptedSettlementCompleted"
}