Skip to main content
Detailed documentation for Payments obpm connector including API references, examples, and best practices. This connector allows you to securely process credit card payments and manage customer billing information.

Get started

This guide describes the steps you need to take before you can start using your OBPM connector.

Prerequisites

Before you begin, make sure that the following requirements are met:

Configure the OBPM connector

To configure your connector, follow these steps:
  1. Set your APIM subscription key in the header as follows:
    • Key: api-key
    • Value: <your subscription key>
  2. Request the Grand Central team to set up a connection with OBPM.
  3. Configure the following details in the gc-ecos-applications-live repository in the connector’s payment-v0.values.yaml file:
flexcube.baseUrl: "<your_flexcube_base_url>" # The base URL to access the FLEXCUBE OBPM core banking system.
flexcube.source: "<your_source>" # The name of the external system or the source of the request.
flexcube.ubsComp: "<your_ubs_component>" # The name of the FLEXCUBE OBPM component of the request.
flexcube.userId: "<your_user_id>" # The user name in the FLEXCUBE OBPM core banking system for the source.
flexcube.branch: "<your_branch_code>" # The financial institution branch in which notification has been triggered.
# Add any other configuration here
Optional: To enable retry between Grand Central and OBPM, set retryFlag to true. An example of the connector’s payment-v0.values.yaml file’s location:
├── iPaaS
└── azure/runtimes
    ├── dev
    |   └── values
    |       ├── gc-flexcube
    |           └── payment-v0.values.yaml
    └── test
        └── values
            ├── gc-flexcube
                └── payment-v0.values.yaml
How to invoke api from a sample javascript below
<script>
    document.addEventListener('DOMContentLoaded', () => {
    fetch('/create-payment-session', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({ amount: 5000, currency: 'USD' })
    })
        .then(response => response.json())
        .then(data => {
            const securepay = SecurePay('YOUR_PUBLIC_KEY');
            securepay.init({
                sessionId: data.sessionId,
                containerId: 'payment-form',
                onSuccess: (response) => {
                    // Handle successful payment
                    console.log(response);
                },
                onFailure: (error) => {
                    // Handle payment failure
                    console.error(error);
                }
            });
        });
});
</script>