Checking the status of an issued invoice
Endpoint: /api/einvoice/status
The request can be made either using the tracking number in the client's accounting system or using the tracking number provided by the gateway. It is mandatory to provide at least one parameter.
Parameters to be passed:
| Field | Discription |
|---|---|
| payment_id | Tracking number of the payment order in the client's accounting system |
| tracking | Tracking number of the order in the gateway's accounting system |
Example: { "payment_id": 6, "tracking": "6EEB-220B-FB62-3405-0C57-65FA-0C4C-F6D4" }
Example of a successful response: { "tracking": "0527-7AB2-D140-5DA6-5D78-27AA-96AC-118F", "payment_id": "6623237", "currency": "visamaster.uah", "created": "2017-03-14 20:36:09", "processed": "2017-03-14 21:14:05", "status": "PAYED", "amount": 5000.00, "fee": 100.00, "accrual_amount": 4900.00, "accrual_currency": "UAH", "is_recalc": false }
Returned parameters
| Field | Discription |
|---|---|
| error | Error description |
| tracking | Tracking number in the gateway's accounting system |
| payment | Tracking number in the client's accounting system |
| status | Payment status. Possible values: CREATED - order created, PAYIN - payment in progress, FAILED - payment failed (final status). The description itself is in the error block CANCELED - payment no longer expected (final status), PAYED_RECALC - invoice paid, but the refund amount has been recalculated (final status), FINISHED - funds debited (final status), PAYIN_ERROR - failed to debit funds. ONLY APPLIES TO INVOICES CREATED IN TEST MODE. |
| currency | Currency in which the debit was made |
| amount | Amount of the issued invoice |
| fee | Commission withheld from the merchant |
| accrual_amount | Amount credited to the merchant's account |
| is_recalc | If true, it means that the actual payment amount differs from the amount declared by the merchant, and the refund amount to the merchant has been recalculated based on the actual payment. |
| created | Date and time of invoice creation in the format Y-m-d H:i:s |
| processed | Date of processing (debiting funds from the client) of the invoice in the format Y-m-d H:i:s |
| accrual_currency | Currency credited to the merchant's account |
If cryptocurrency payment is accepted, the response will include a crypto object.
Example of the crypto object: { "crypto": { "address": "3HaazHQCuLfpRxPSF123ALiisMSqGYjYcSd", "current_confirmations": "1", "success_confirmations": 4 } }
| Field | Discription |
|---|---|
| address | Address to which the user should transfer the funds |
| current_confirmations | Current number of confirmations by the network for the transfer |
| success_confirmations | Number of confirmations at which the funds will be credited to the cash register balance |