curl --request GET \
--url https://api.example.com/open-banking/v1/payments/{payment-product}/{paymentId}/status \
--header 'X-Request-ID: <x-request-id>'{
"transactionStatus": "ACCP",
"fundsAvailable": true,
"psuMessage": "Please check your bank app",
"ownerNames": [
{
"name": "Heike Mustermann",
"role": "owner"
}
],
"psuName": "Max Mustermann",
"_links": {
"scaRedirect": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"scaOAuth": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"confirmation": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisation": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithPsuIdentification": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updatePsuIdentification": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithProprietaryData": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateProprietaryData": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updatePsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateAdditionalPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateEncryptedPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateAdditionalEncryptedPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"selectAuthenticationMethod": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"creditorNameConfirmation": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"self": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"status": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"scaStatus": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"account": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"balances": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"transactions": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"cardAccount": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"cardTransactions": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"transactionDetails": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"first": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"next": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"previous": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"last": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"download": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
}
},
"tppMessages": [
{
"category": "ERROR",
"code": "SERVICE_UNAVAILABLE",
"path": "access.balances",
"text": "The ASPSP server is currently unavailable"
}
]
}Returns the transaction status of an initiated payment
curl --request GET \
--url https://api.example.com/open-banking/v1/payments/{payment-product}/{paymentId}/status \
--header 'X-Request-ID: <x-request-id>'{
"transactionStatus": "ACCP",
"fundsAvailable": true,
"psuMessage": "Please check your bank app",
"ownerNames": [
{
"name": "Heike Mustermann",
"role": "owner"
}
],
"psuName": "Max Mustermann",
"_links": {
"scaRedirect": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"scaOAuth": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"confirmation": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisation": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithPsuIdentification": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updatePsuIdentification": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithProprietaryData": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateProprietaryData": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updatePsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateAdditionalPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateEncryptedPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"updateAdditionalEncryptedPsuAuthentication": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"selectAuthenticationMethod": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"creditorNameConfirmation": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"self": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"status": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"scaStatus": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"account": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"balances": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"transactions": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"cardAccount": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"cardTransactions": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"transactionDetails": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"first": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"next": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"previous": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"last": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
},
"download": {
"href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
}
},
"tppMessages": [
{
"category": "ERROR",
"code": "SERVICE_UNAVAILABLE",
"path": "access.balances",
"text": "The ASPSP server is currently unavailable"
}
]
}ID of the request, unique to the call, as determined by the initiating party
The addressed payment product
Resource identification of the payment initiation
Payment status successfully retrieved
ISO 20022 transaction status
ACCC, ACCP, ACSC, ACSP, ACTC, ACWC, ACWP, RCVD, PDNG, RJCT, CANC, ACFC, PATC, PART, RVCM, RVNC, RCVC "ACCP"
Equals true if sufficient funds are available at the time of the request, if supported by the ASPSP
Text to be displayed to the PSU
"Please check your bank app"
List of owner names
Show child attributes
Name of the PSU
"Max Mustermann"
HATEOAS links, e.g. for re-submission of credentials
Show child attributes
Messages to the TPP on operational issues
Show child attributes