Payment Cancellation

These endpoints are used to cancel a payment on behalf of the Payment Service User. Strong Customer Authentication might be required by the ASPSP, the response will indicate which step is required to complete the payment.

DELETE Payments

Endpoint: DELETE /payments/{paymentId}

Endpoint: DELETE /periodic-payments/{paymentId}

Endpoint: DELETE /scheduled-payments/{paymentId}

Endpoint: DELETE /bulk-payments/{paymentId}

Data model

RequestResponse (click to enlarge)
Delete payments request

If the ASPSP doesn’t require an SCA for the deletion of a payment, the response will be empty with the HTTP code 204 (deleted). If SCA is required the response will be given with HTTP 200, and the following response:

Delete payments response

POST Cancellation-Identification

Endpoint: POST /payments/{paymentId}/cancellation-identification

This API is used to start an authorization process explicitly in the Decoupled Approach, where the PSU identification isn’t given in the DELETE payment already. 

Data model

RequestResponse
Post payments cancellation identification requestPost payments cancellation identification response

POST Cancellation-Authorisations

Endpoint: POST /payments/{paymentId}/cancellation-authorisations

This endpoint is used to start an authorization process explicitly which is required for some ASPSPs. As well it is used in Multi-Authorization scenarios (supported in an extended PIS service) and in Embedded Approach.

Data model

RequestResponse (click to enlarge)
Post payments cancellation authorisations requestPost payments cancellation authorisations response

PUT Cancellation-Authorisations

Endpoint: PUT /payments/{paymentId}/cancellation-authorisations/{authorisationId}

This endpoint is used in Embedded Approach to provide the required information according to the necessary steps driven by the ASPSP due to the Links section. 

Data model

RequestResponse (click to enlarge)
Put payments cancellation authorisations requestPut payments cancellation authorisations response
 
Enable "on this page" menu on doc section
On