File payments

Version 3.1.2 (Current Version)

What this API does

These APIs currently supports FPS, Balance Transfers, CHAPS, and BACS Payments.

This API lets you initiate up to 150 domestic payment and submit payment requests. It also lets you check the payment status and confirm funds.

The API endpoint lets you ask Virgin Money to create a new file payment consent resource:

  • The POST action tells Virgin Money that a file payment consent has been staged. At this point, it does not identify the customer to Virgin Money; the request payload may not contain information about the account to be debited
  • The endpoint lets you send a copy of the consent between the customer and you to Virgin Money for the customer to authorise (after the file is uploaded)

Virgin Money will create a file payment consent resource and provide a unique ConsentId for the resource.

Before calling the API, you must have an access token issued by Virgin Money using a 'Client Credentials' grant.

The API endpoint lets you upload up to 150 file payment requests to Virgin:

  • Support only JSON format for file upload
  • All the payments in the file should be of one payment type i.e. FPS, CHAPS or BACS.
  • Virgin Money will upload the file payment consent resource for the given unique.

Before calling the API, you must have an access token issued by Virgin Money using a 'Client Credentials' grant.

Check the status of the payment consent. 

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

Check the status of individual payment requests in the file the payment consent. 

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

Once the customer has authorized the international scheduled-payment consent, you can submit the payment for processing:

  • This request instructs Virgin Money to begin the payment journey. Virgin Money will normally schedule the payment request immediately, but this may not always be possible, for example, during busy periods or if additional approvals are required.
  • You must ensure the Initiation section of the payment match the corresponding sections of the payment consent resource. Any discrepancy will generate an error response and we will not process the request

Before calling the API, you must have an access token issued by Virgin Money using 'Authorization Code' grant.

Check the status of overall file payment.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

Having trouble?

Contact our dedicated team members via our ticketing system or via our support mailbox

Opens in a new window Contact