Domestic Standing Orders

Version 3.1.2 (Current Version)

What this API does

This API lets you create a domestic-standing-order-consent resource and submit domestic standing order payment request. It also lets you check the domestic standing order payment status.

POST

/domestic-standing-order-consents

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

  • The POST action tells Virgin Money that a domestic standing order 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-standing-order-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-standing-order-consents/{ConsentId}

Check the status of the domestic-standing-order-consents

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

Once the customer has authorized the domestic standing order 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 a 'Authorization Code' grant.

GET

/domestic-standing-orders/{DomesticPaymentId}

Check the status of the domestic standing order payment.

Before calling the API, you must have an access token issued by Virgin Money using a '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