Payment cancellation service

This API allows a transaction to be cancelled or deleted. Cancel or delete depends on the status of the payment.

This API will support the following payment services and products:
Payment services:

• payments
  Payment products
  • sepa-credit-transfers
  • cross-border-credit-transfers
• bulk-payments
  Payment products
  • pain.001-sepa-credit-transfers

NOTE: To use these APIs a valid TLS certificate is required. Please refer to the Getting Started page section to obtain a test certificate for use with the Sandbox environment. Also note that bulk payments for direct debits do not support cancellation.

The following methods are supported by the Sandbox environment:

• Certificate validation
• Delete/cancel
• Save / confirm cancellation
• Retrieve authorisations
• Retrieve authorisation details

Status

Whether a payment or bulk payment can be deleted or cancelled depends on its status, refer to the table below for the possibilities per status. Information about payment or bulk payment status retrieval can be found on the payment initiation documentation page.

Delete/cancel

To delete or cancel a payment initiation, the DELETE endpoint can be called with an access token and with PSU involvement (using PSU-IP-Address indicator).

Headers

Perform request

If the call was successful, a 200 or 202 status is returned. Response body is empty.

For other possible return codes, see the API DOCUMENTATION page.

go to top

Save / confirm cancellation

After a payment or bulk payments cancellation has been initiated by calling the DELETE payment initiation endpoint which resulted in a statuscode of 202, it has to be created and confirmed. To do so, the following actions have to be taken:

• Redirect to OAuth2.0 endpoint
• Review cancellation
• Save and confirm

Redirect to OAuth2.0 endpoint

To create an OAuth2.0 redirect URL, please refer to the Oauth2.0 page.

When creating an OAuth2.0 redirect for payment or bulk payment cancellation confirmation, a scope is required. This scope should look like: "PIS:[paymentinitiation-id]". Where paymentinitiation-id is the id of the payment initiation for which the DELETE payment initiation endpoint was called. For example: "PIS:dea36cf3-63fa-48b3-b203-2136f5453751".

Review cancellation

After navigating to the OAuth2.0 redirect URL. A confirmation details page will be displayed. Before details are shown, the user has to be known. To identify the user, a form will be displayed to submit the username who will be initiating the confirmation. A username can also be supplied using the username querystring parameter. If the username is valid, the payment initiation cancellation details will be displayed.

Confirm cancellation

If the user has sufficient authorisation to cancel the payment or bulk payment, the payment or bulk payment cancellation can be confirmed. Click "Confirm" to confirm the cancellationIn the Sandbox environment, enter 12345678 as the confirmation code and click "Confirm" to confirm the payment or bulk payment. . Click "Back" to return to redirect_url without confirming. No access code will be returned.

Redirect

After a cancellation has been confirmed, the user is redirected back to the redirect_uri that has been passed on the query string. This redirect_uri will contain an additional query string parameter "code". This code can be used to obtain an access token. With this access token, data regarding this payment initiation can be retrieved.

go to top

{
    "authorisationIds": [
      "19e54cc4-400e-4ba5-a9cd-0bfd39753f64"
    ]
}

go to top

{
    "scaStatus": "finalised"
}

go to top