Domestic Scheduled Payment

Version 3.1.2 (Current Version)

What this API does

These APIs currently supports Bacs, Balance Transfers, CHAPS and Faster Payments.

This API lets you initiate a single future dated domestic payment and submit payment requests. It also let's you check the payment status.

POST

/domestic-scheduled-payment-consents

The API endpoint lets you ask Virgin Money to create a new domestic-scheduled-payment-consents resource:

The POST action tells Virgin Money that a domestic schedule 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.

Virgin Money will create a domestic-scheduled-payment-consents resource and provide a unique ConsentId.

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

GET

/domestic-scheduled-payment-consents/{ConsentId}

Check the status of the domestic-scheduled-payment-consent

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

POST

/domestic-scheduled-payments

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

This request instructs Virgin Money to begin the payment journey.
The Initiation and Risk sections of the payment must match the corresponding sections of the payment consent resource. Any discrepancy will generate an error response and request will not be processed.

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

GET

/domestic-scheduled-payments/{DomesticScheduledPaymentID}

Check the status of the domestic scheduled payment.

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

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

OpenBankingResponse@cybg.com