API for developers
Payout status check
Check payment status
Endpoint: /api/payment/status
Transmitted parameters (mandatory to include one of the fields):
| Field | Discription |
|---|---|
| payment_id | payment account number in the agent's system (e.g., application number) |
| tracking | accounting code of the payment in the payment gateway's accounting system (optional parameter) |
Fields received in the response
| Field | Discription |
|---|---|
| status | current payment status |
| payment_id | agent's payment account number (e.g., application number) |
| tracking | payment gateway accounting code |
| created_at | payment creation date and time (in Y-m-d H:i:s format) |
| processed_at | payment processing date and time (in Y-m-d H:i:s format) |
| amount | amount credited to the recipient |
| fee | commission deducted by the gateway (commission is deducted from the account on top of the credited amount) |
| full_amount | total amount debited from the agent's account |
| recipient | recipient details (e.g., card number) |
| currency | payment currency |
Possible values for STATUS:
| Field | Discription |
|---|---|
| CREATED | Payment created and awaiting validation |
| PAYED | Payment successfully executed (final status) |
| PAYOUT | Payment being processed by the payment gateway |
| CANCELED | Payment cancelled (final status) |
| REVERSED | Payment refunded (final status) |
| BLOCKED | Payment blocked by the monitoring system and awaiting operator review |
| FAILED | Payment failed (final status) |
| IN_PROGRESS | Payment in the processing queue |
| REFILL | Technical operation of agent account replenishment (final status) |
If a cryptocurrency payout is being made, the response will include a crypto object.
Example of a crypto: { "crypto": { "transaction": "4fb2de69804a730072111a3d1506ddc16fdf2f29a35c77e11d7d5e0986bf1be1", "confirmations": "1" } }
| Field | Discription |
|---|---|
| transaction | Transaction hash |
| transaction | Number of confirmations of the transaction |