Exchanges

Welcome to the Sentinal® Integration Documentation. This guide is specifically tailored for Exchanges 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 Exchanges are, what they need to do, and the specific API endpoints they must integrate with.

What are Exchanges?

Exchanges are platforms that facilitate the trading of assets between two parties, enabling the buying and selling of financial instruments, commodities, cryptocurrencies, and other assets. Exchanges ensure secure, efficient, and transparent transactions between traders.

Responsibilities of Exchanges Integrating with Sentinal®

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

  1. Payment Processing: You need to process payments for trades and transactions using approved Payment Providers.

  2. Trade Registration: You are responsible for registering trades between parties, capturing all necessary details including the involved customers, trade values, and associated fees.

Key API Endpoints for Exchange Integration

To fulfill your responsibilities as an Exchange, you need to integrate with the following Sentinal® API endpoints:

1. Create Payment

  • Endpoint: /createPayment

  • Method: POST

  • Description: This endpoint allows clients to submit a payment for processing to their associated processor that is approved by the Sentinal system.

  • Integration Details: Create Payment Integration Details

2. Register Trade

  • Endpoint: /registerTrade

  • Method: POST

  • Description: Record a new trade in the Sentinal® system, capturing essential details about the trade, including the gross value, fees, and the net value.

  • Integration Details: Register Trade Integration Details

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.

  • Integration Details: Record Crypto Deposit Integration Details

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 exchange platform can effectively use the Sentinal® system to manage payments and trades securely and efficiently. If you have any questions or encounter any issues, please contact our support team at [email protected].

PreviousTelecommunication OperatorsNextGaming Operators

Last updated