International scheduled payments

Version 3.1.2 (Current Version)

What this API does

These APIs currently supports SWIFT and SEPA Payments.

These APIs currently supports Indicative rate type.

This API lets you initiate a single scheduled international 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 international scheduled payment consent resource:

  • The POST action tells Virgin Money that a international scheduled 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 international scheduled 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.

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.

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 and Risk sections 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.

If rate type is’ Indicative’, on date of scheduled payment, user need to login to bank website to accept the exchange rate before the payment can be executed.

Check the status of the 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