Domestic Immediate Payment

Version 3.1.2 (Current Version)

What this API does

When using our Sandbox, we have a predefined, pre-authorised set of consents to be used within the environment. The predefined authorisation code is provided in the test data

These APIs currently supports FPS, Balance Transfers types. Support for BACS, CHAPS payments are coming soon.

This API lets you initiate a single immediate domestic payment and submit payment requests. It also lets you check the payment status and confirm funds.

The API endpoint lets you ask CYBG to create a new domestic payment consent resource:

  • The POST action tells CYBG that a domestic payment consent has been staged. At this point, it does not identify the customer to CYBG; 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 CYBG for the customer to authorise

CYBG will create a domestic payment consent resource and provide a unique ConsentId for the resource.

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

Check the status of the payment consent. 

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

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

  • This request instructs CYBG to begin the payment journey. CYBG will normally execute the payment request immediately but this may not always be possible, for example, during busy periods
  • 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 CYBG using 'Authorization Code' grant.

Check the status of the payment.

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

GET

/domestic-payment-consents/{ConsentId}/funds-confirmation

Check if sufficient funds are available to make the payment. 

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

Having trouble?

Contact our dedicated team members via our ticketing system or via our support mailbox, OpenBankingResponse@cybg.com

Opens in a new window Contact