Payment Consent API for UK

Consent Management APIs provide the capability to manage consents in a web application, on behalf of an end-user. A banking service consumer/ Account Servicing Payment Service Provider (ASPSP) may need to develop their own web application or use their own mechanism to deploy the consent management capabilities. At this point, a service provider needs a way to directly present consent resources to the end-user. In order to cater to this requirement, those consent capabilities (for example, consent creation/consent deletion) are presented as API resources in the Consent Management APIs.

The Payment Consent API provides payment consent capabilities as API resources. This API is secured with basic authentication. For more information, see configuring basic authentication for Consent Management APIs.

You can find the REST API documentation for Payments Information Sharing Consent Management APIs below:

Create payment consent

Creates a payment initiation resource addressable under ConsentId with all data relevant for the corresponding payment product. This is the first step in the API to initiate the related payment.

POST /payments/{PaymentType}

Retrieve payment consent

This API resource retrieves information corresponding to the given ConsentId based on the type of the payment.

GET /payments/{PaymentType}/{ConsentId}

Retrieve payment consent link

This API resource provides the payment consent link.

GET /payments/{ConsentId}/link

Update payment consent

This API resource updates a given payment consent.

PUT /payments/{PaymentType}/{ConsentId}/Consumption

Update payment consent status

This API resource updates the status of a given payment consent.

PUT /payments/{PaymentType}/{ConsentId}/status/{Status}

Persist payment consent

This resource is to update a payment consent resource and bind it with a PSU.

POST /payment-consents

Retrieve payment consent

This API resource is to retrieve a payment consent using the given ConsentId.

GET /payment-consents/{ConsentId}

Upload file for the File Payment consent

This resource allows uploading a file to an ASPSP, against a file-payment-consent resource.

POST /payments/{PaymentType}/{ConsentId}/file

Click here to see a sample request and response

Retrieve file from the File Payment consent

The API endpoint allows downloading a file that had been uploaded against a file-payment-consent resource. HTTP headers are used to describe the file.

GET /payments/{PaymentType}/{ConsentId}/file

Click here to see a sample request and response