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 thorugh a single API integration. 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.

Diagram:

Initiate In-Payment

STEP 1 Request:

Example will be provided soon

Example will be provided soon

# With shell, use below curl example
curl -i -X GET 'https://stg-ob.globalcharge.com/bi/ext/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://stg-ob.globalcharge.com/bi/ext/initiate'

Example will be provided soon

Be sure to replace all the dummy values.

API PATH: /bi/ext/initiate

METHOD: GET POST

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 from a browser on this API all the redirections will happen automatically.

Request Parameter:

GET Response:

POST Response:

STEP 1 Response(POST):

{
  "accepted": true,
  "message": "One-time redirect url generated",
  "redirectPath": "https://stg-ob.globalcharge.com/bi/ext/redirect_to_***/eyJhbGciOiJIUzI1NiJ**y*****Im8Wy",
  "data": null
}

UI control back

STEP 2 Return UI Control:

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

When the user's bank page journey is completed, GC will use the 'uicReturn/uicCancel' to hand UI control back to you. Please note the 'uicReturn/uicCancel' parameter value will overwrite the static configured URL in the account configuration. We will append some transaction references to help you identify this control call back on your side - see table below. Notice the example URL pattern contained in sample section on the right.

Request Parameter

Notifications

STEP 3 FSN Pattern: ruby 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

STEP 3 PSN Pattern: ruby 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

We will generate 2 types of notifications

1. Progress update status notification (PSN) - In Payments Only
2. Final status notification (FSN)

The PSN informs you of the real-time status of the transaction. The PSN can be used for analysis purposes to track a user's journey. The FSN is the final and last transaction status update. Your content delivery decision should be based on the status of the FSN. These notifications will be server to server, sent to your end point (configured during set up) using an HTTP POST call. We expect a '200' HTTP response code receipt confirmation, if this is not received we will resend the notification according to our retry policy.

Parameters

Initiate Out-Payment

STEP 1 Request:

Example will be provided soon

Example will be provided soon

# With shell, use below curl example

curl --location 'https://ob.globalcharge.com/ext/payout' \ --header 'Content-Type: application/json' \ --header 'Authorization: ••••••' \ --data '{ "merchantId": 12345, "countryCode": "DE", "merchantTransactionReference": "TXN123456789", "pricePoint": 300, "executionType": "PAYOUT", "executionDate": "2025-02-10", "hash": "1d787700f6701edd56d3d1c3f1d35698fbed0fa725f657a0f1b077a1e5c0c5db8fa71e6068fbd2f60134b176fb268579bfe48556114a32d70fbd6820e18f96db", "uicNotification": "notification.com", "accountId":"I12345", "merchantUserId": "user_001", "creditor": { "name": "John Doe", "addressLines": "Adress", "accountNumber": "12345678", "city": "Berlin", "postCode": "10001", "bankClearingSystemId": "KK00000", "bankName": "Bank" } }'

Be sure to replace all the dummy values.

API PATH: /ext/payout

METHOD: POST

Connect to our Open Banking payout system through a single API endpoint, allowing you to send funds directly to end users. You can initiate a payout transaction by calling our endpoint using either a POST method. When using a POST call, you will receive an HTTP 200 response followed by a notification if request was accepted.

Authentication

All requests must include Basic Authentication header: Authorization: Basic base64(username:password)

Request Parameter:

Creditor Object:

POST Response:

STEP 1 Response:

{
  "accepted": true
}

Notifications

FSN Pattern: ruby 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

The FSN is the confirmation of the payout completition. The notification will be server to server, sent to your end point (configured during set up/sent in request) using an HTTP POST call. We expect a '200' HTTP response code receipt confirmation, if this is not received we will resend the notification according to our retry policy.

Parameters

APPENDIX

FSN STATUS

PSN STATUS

Execution Type