03 - Cancel a Payment

Description

For the purpose of carrying out a payment cancellation with the XS2A APIs, it is necessary for the TPP to ask for the cancellation to the ASPSP.

Redirect OAuth2

In this approach, the PISP has to proceed with an OAuth2 authorization. The cancellation request is established and validated thanks to a redirection of the PSU towards the ASPSP Authentication platform.
See How to Perform a Strong Customer Authentication for details.

Decision matrix : on DELETE {payment-service}/{payment-product}
Request Headers Response Headers
TPP-Explicit-AuthorisationPreferred PSU-ID and PSU-ID-Type TPP-Redirect-Preferred ASPSP-SCA-Approach (Response from ASPSP) Explanation
true provided/not provided true/false/not provided not provided
false/not provided not provided true/false/not provided REDIRECT
provided true REDIRECT
false/not provided REDIRECT / DECOUPLED 1. Decoupled workflow is the default process, if PSU is eligible.
2. If PSU is not eligible for decoupled workflow, DECOUPLED will be provided.
Decision matrix : on POST authorisations
Request Headers Response Headers
PSU-ID and PSU-ID-Type TPP-Redirect-Preferred ASPSP-SCA-Approach(Response from ASPSP) Explanation
Not provided true / false / not provided REDIRECT
Provided true REDIRECT
false / not provided REDIRECT / DECOUPLED 1. DECOUPLED workflow is the default process, if PSU is eligible.
2. If PSU is not eligible for decoupled workflow, DECOUPLED will be provided.
Payment Cancellation
Initiate Payment Cancellation
DELETE /berlingroup/v1/{payment-service}/{payment-product}/{payment-id}

Asks for payment cancellation at the ASPSP for a given payment (giving id, service and product). Specificities for this API and available services and products are listed in the dedicated HowTo.

Create a cancellation authorisation resource on a payment
POST /berlingroup/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations

Creates an authorisation sub-resource of the payment resource for its cancellation and start the authorisation process.

Authorization request
GET /berlingroup/authorization/authorize/{authorisation-id}

Requests an authorisation from a PSU following the OAuth2 protocol. Details of the authentication workflow and user interfaces are described in the dedicated HowTo section.
Our specificities regarding the OAuth2 protocol are listed below.

response_type : code
code_challenge_method : S256

After successful authorisation, the user will be redirected to the redirect URI provided in the request with the following parameters :

https://your_redirect_uri?code=authorization_code&state=test
Specific BerlinGroup Implementation on Payment Initiation Service

For specific BerlinGroup Implementation on the Payment Initiation Service, please refer to specific implementation How To.