ob-p-a2a-status
Payments have different status depending on the actual state of processing:
- Open
- Authorised
- PartiallyAuthorised
- SettlementIinProcess
- SettlementCompleted
- ReceivedByCreditorBank
- ReceivedOnCreditorAccount
- Cancelled
- CancelledAtTPP
- Error
- Expired
- Pending (The Apsps put the payment in a pending state, this can happen for multiple reasons. This is not a final state, another get payments/status should be made to get an update on the status)
Not all ASPSPs are differentiating between all the status values listed above. The Status PartiallyAuthorised can be given for a payment in multi-authorizations if the first PSU has authorised and there are still authorizations of additional PSUs are outstanding. The Multi-Authorization is an extended service of Accout-to-Account payments.
For some ASPSPs the status of a payment isn’t updated furthermore when the Authorised status is achieved. For most ASPSPs the final status is SettlementCompleted. Information on the final status for payments for given ASPSPs can be retrieved form the Reach API.
Open Banking Services
In the following picture the status values are shown in a state diagram:
Bank Selection Interface
While using the Bank selection interface the following payment status flow is applicable:
GET Payment Status
These endpoints are used to retrieve the status of a payment.
Endpoint: GET /payments/{paymentId}/status
Endpoint: GET /periodic-payments/{paymentId}/status
Endpoint: GET /scheduled-payments/{paymentId}/status
Endpoint: GET /bulk-payments/{paymentId}/status
Data model
Request | Response (click to enlarge) |
![]() | ![]() |
Example
Request
Address: https://localhost:8443/xs2a/routingservice/services/ob/v3/payments/11376380/status
HttpMethod: GET
Headers: {Accept=application/json, Digest=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=,
X-Request-ID=de875f27-5eb7-2b3d-bb88-86e0fe0cdf65, Authorization=Bearer ec464ba833a955952646cbc834f4e6b, MessageCreateDateTime=2022-03-24T14:48:16.143Z}
Response
ResponseCode: 200
Headers: { X-Request-ID=283c264a-3212-4240-a039-01b229fa854f, MessageCreateDateTime=2022-03-24T14:48:16.541Z}
Payload: {"CommonPaymentData":
"PaymentStatus": "SettlementCompleted",
"PaymentId": "11376380",
"AspspPaymentId": "00015952769469210",
"AspspId": "10002"
}}