Banks
Welcome to the Sentinal® Integration Documentation for Banks. This guide is specifically tailored for Banks that are looking to integrate seamlessly with the Sentinal® system. The Sentinal® API is designed around REST principles, ensuring a predictable, secure, and standardised integration experience. This documentation outlines the responsibilities of banks when processing payments received over any rail, as well as the specific endpoints required for integration.
What are Banks in the Sentinal® Ecosystem?
Banks play a critical role in the financial ecosystem by serving as custodians of funds and processors of payments across various rails — including card networks, EFT, RTGS, and any other method from time to time. In the context of Sentinal®, banks receive payment requests and must validate, verify, and onboard clients before transactions can be processed.
Responsibilities of Banks Integrating with Sentinal®
As a bank integrating with the Sentinal® system, you are responsible for:
Client Onboarding: Before processing any transactions on behalf of a client, you must register the client in the Sentinal® system. This registration will provide them with a unique API key used for secure transaction validation and tracking.
Transaction Verification: Upon receiving a payment instruction across any rail, the transaction must be verified via Sentinal® to ensure its legitimacy and compliance. Sentinal® will return a structured response indicating whether the transaction should be approved or declined based on the client’s standing and applicable fees.
Key API Endpoints for Bank Integration
To fulfill these responsibilities, banks must integrate with the following Sentinal® API endpoints:
1. Register Client
Endpoint:
/registerClient
Method:
POST
Description: Onboard a new client to the Sentinal® system. This registration process will provide the client with their unique API key, which they will use for all subsequent interactions with the system.
Integration Details: Register Client Integration Details
2. Verify Transaction
Endpoint:
/verifyTransaction
Method:
POST
Description: Verify a transaction's details, including VAT, fees, and settlement amount. The system will approve or decline based on the client's standing.
Integration Details: Verify Transaction Integration Details
By integrating with these endpoints, banks will ensure that all incoming payments — across any rail — are processed through a secure, auditable, and policy-compliant workflow. This ensures alignment with regulatory requirements and provides clients with transparency and confidence. If you have questions, need credentials, or run into any issues, our team is here to support you at [email protected].
Last updated