Introduction

Open Banking is an initiative regulated by the FCA and their European equivalents and designed to bring more competition and innovation to financial services. Enabled by European PSD2 regulation and driven by governments across the EU to open up the financial services sector, Open Banking creates a new, frictionless way to pay. Under the framework, UK and EU banks have created open interfaces ( APIs ) into previously locked customer accounts and payment systems.. GlobalCharge has refined and reduced the complexity of accessing the Open Banking network with 1 API. This document details the 2 simple integration steps required to integrate with our system empowering online merchants to offer Open Banking as a new payment mechanism to end users.

STEP 1 - Initiate a transaction

To initiate a transaction:

Example will be provided soon

Example will be provided soon

# With shell, use below curl example
curl -i -X GET 'https://ob.globalcharge.com/initiate?merchantId=12345&countryCode=GB&merchantTransactionReference=ABC123&pricePoint=1&executionType=IMMEDIATE&executionDate=2021-04-29&productName=ExampleProductName&hash=7GABCDEABCDEF3BABCDEF3E'

curl -i -X POST -H "Content-Type: application/json" -d '{ "merchantId":"12345", "countryCode":"GB", "merchantTransactionReference":"ABC123", "pricePoint":"1", "executionType"-:"IMMEDIATE", "executionDate":"2021-04-29", "productName":"ExampleProductName", "hash":"7GABCDEABCDEF3BABCDEF3E"}' 'https://ob.globalcharge.com/initiate'

Example will be provided soon

Make sure to replace all the dummy values.

PROTOCOL SUPPORTED: HTTPS

METHOD SUPPORTED: GET POST

DOMAIN: ob.globalcharge.com

API PATH: /initiate

Connect to our Open Banking billing system through a single API endpoint allowing end users to make payments. You can initiate a transaction by calling our endpoint using a GET or POST method. When using a POST call to this API you will receive an HTTP response code 200 with a response body containing the redirection url where the end user needs to be redirected. If you perform a GET call on this API we do all that out of the box.

Parameters

API GET Endpoint: https://ob.globalcharge.com/initiate

GET Response

API GET Endpoint: https://ob.globalcharge.com/initiate

POST Response

Sample response:

{
  "accepted": true,
  "message": "One-time redirect url generated",
  "redirectPath": "https://stg-ms.globalcharge.com/redirectToConsent/eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJXRUIyOTA5VEVTVDExODY5NjYiLCJpYXQiOjE2MjU2NjcyOTgsImV4cCI6MTYyNTY2NzcxOH0.dltDrKcv42YVNr9n4zQdB_6qsA_8VSNIm8Wy_oWwa1o",
  "data": null
}

API POST Endpoint: https://ob.globalcharge.com/initiate

STEP 2 - Receive UI control back

Sample request:

Example will be provided soon

Example will be provided soon

# With shell, use below curl example
curl -i -X GET 'https://your-site-domain.com/return_control?merchantTransactionReference=ABC123&gc_ref=WSGDF2535'

Example will be provided soon

Once we’ve received the status update of a transaction from the bank, control will return back to you on your return control URL configured at GlobalCharge during account set up. It will be an HTTP redirection (HTTP 302) from the browser

Parameters

API Endpoint: https://your-site-domain.com/return_control

STEP 3 - Receive async notification

API Endpoint: http://your-notification-end-point.com/receive_notification

Example will be provided soon

Example will be provided soon

# With shell, use below curl example
curl -i -X POST -H "Content-Type: application/json" -d '{ "status":"status", "transactionId":"WEB8433RQPCIMQLCBP", "merchantTransactionReference":"string", "countryCode":"GB", "pricePoint":1 }' 'http://your-notification-end-point.com/receive_notification'

Example will be provided soon

A server to server notification that will be sent to your notification URL configured at GlobalCharge during account set up. It will be an HTTP POST call. We expect HTTP response code 200 to be returned once the notification is handled successfully. If HTTP response code 200 is not returned we shall retry sending the notification in line with our retrial policy.

Parameters

APPENDIX

STATUS

Execution Type