Payment Service Providers (PSPs)

Welcome to the Sentinal® Integration Documentation. This guide is specifically tailored for Payment Service Providers (PSPs) aiming to integrate seamlessly with the Sentinal® system. The Sentinal® API, designed around REST principles, ensures a predictable and standardized integration experience. This page will provide an overview of what PSPs are, what they need to do, and the specific API endpoints they must integrate with.

What are Payment Service Providers (PSPs)?

Payment Service Providers (PSPs) are third-party companies that provide businesses with the ability to accept various payment methods, including credit cards, bank transfers, and other payment methods. PSPs streamline the payment process by managing transactions and ensuring they are processed securely and efficiently.

Responsibilities of PSPs Integrating with Sentinal®

As a PSP integrating with the Sentinal® system, you have a few key responsibilities:

  1. Client Onboarding: You need to onboard new clients to the Sentinal® system. This involves registering the client and providing them with their unique API key for subsequent interactions.

  2. Transaction Verification: You are responsible for verifying transactions before they are processed. This ensures that the transaction details are correct, and the transaction is approved or declined based on the client's standing.

Key API Endpoints for PSP Integration

To fulfill your responsibilities as a PSP, you need to 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.

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.

3. Record Crypto Deposit

  • Endpoint: /cryptoDeposit

  • Method: POST

  • Description: Verify a crypto deposit transaction before processing. The system responds with the breakdown of VAT, processing fees, and the net amount that can be settled to the client. Based on the client's standing, the transaction will either be approved or declined.

4. Record Crypto Withdrawal

  • Endpoint: /cryptoWithdrawal

  • Method: POST

  • Description: Verify a crypto withdrawal transaction before processing. The system responds with the breakdown of VAT, processing fees, and the net amount that can be settled to the client. Based on the client's standing, the transaction will either be approved or declined.

  • Integration Details: Record Crypto Withdrawal Integration Details

By integrating with these endpoints, you will ensure that your clients can effectively use the Sentinal® system to manage their transactions securely and efficiently. If you have any questions or encounter any issues, please contact our support team at [email protected].

Last updated