Description and Protocol Details

Disbursement Interaction Diagram

Disbursement Interaction Diagram Description

User initiates a disbursement operation in Partner’s service using a Payment method.
Partner’s service sends a disbursement request to a specific System URL.
The System accepts the request after verifying the required request parameters and request signature validity.
The System returns a response with a message stating that the request is either correct and accepted or with an error message if the request did not meet the System requirements for processing.
The System performs further request processing and sends the data to the Payment method.
Payment method’s service performs further disbursement request processing.
Payment method informs the System about the disbursement result.
The System notifies Partner’s service about the disbursement operation result.

General Description

The protocol (API) is designed to facilitate information exchange between the Partner and the System. The API enables the Partner to perform various operations, such as mass payments to bank and mobile phone accounts, requesting and receiving information on the current state of transactions, and requesting a registry of operations.

Protocol Details

Information interaction is conducted via the HTTP protocol with SSL/TLS encryption.

Authentication and authorization are handled through the Partner's provided IP address. Each request to the System includes the external system identifier assigned to the Partner (Service_ID) and the secret key (SecretKey). Each request to and from the System is signed with a control signature using the request parameters and the secret key. The external system identifier and the secret key are generated upon request to technical support and sent to the Partner.

List of Requests

Request Direction	Request Method	Description	URL
Main Requests:
Partner –> Payout System	Payout method. Payout request, POST	Used by Partner for payout transaction initialization.	`url_system/partner/service_id/payout`
Payout System –> Partner	Payout notification (callback), POST	Used by the System to notify the Partner about the transaction and its status.	URL provided by the Partner
Additional Requests:
Partner –> Payout System	Check method. Transaction status request, POST	Used by Partner to receive payout transaction status.	`url_system/partner/service_id/check`
Partner –> Payout System	Balance method. Partner balance request, POST	Used by Partner to receive current account balance information.	`url_system/partner/service_id/balance`
Partner –> Payout System	Balance_statement method, POST	Used by Partner to receive account balance operation detail.	`url_system/partner/service_id/balance_statement`
Partner –> Payout System	Payout_reestr method. Payout transaction registry request, GET	Used by Partner to receive payout transaction registry.	`url_system/payout_reestr`
Partner –> Payout System	Notify method. Callback resend request, POST	Used by Partner to resend callback with current transaction status.	`url_system/partner/service_id/notify`

At the beginning of the engagement, the Merchant receives credentials to access the Web Portal at the following URLs:

Test environment: https://int.8b.world
Production environment: https://api.8b.world