File payment

File payments, which you can use to process all individual payments in an uploaded CSV file that you specify.

As a regulated third party provider, you can use the provided endpoints to initiate a payment in the following high-level workflow:

Create a consent.
Get the consent.
Create a payment.
Get the payment.

Before you begin, ensure that you've registered your application with the payments scope. For more information, see Tutorials: Create a file payment.

Create a file payment consent

Create a file payment consent described in the Open Banking API documentation: Account and Transaction API Specification.

Retrieve a file payment consent

Get the details of a file payment consent.

Retrieve an uploaded payment file

Get the payment file that was uploaded with the given consent.

Upload a payment file

Use this endpoint to upload a file for the given file payment consent.

Create a file payment

Create a file payment.

Retrieve a file payment

Get the state of a file payment.

Retrieve all payments of a file payment

Get the state of all individual payments for the given file payment.