In order to retrieve a bill details, you must call the web service function getInvoiceDetails.
|
Parameter |
Description |
|---|---|
|
ucode |
Unique bill number |
|
sign |
Security sign |
If merchant use the default security option with MD5, it's necessary to add a parameter named sign (request sign). The value of the parameter is MD5 hash from the string collected from the parameter values along with API security key.
When receiving a request from the store, the «Invoicebox» system will check the security parameter sign. If the value of sign parameter does not match the calculation result of the MD5 hash function from the passed parameters, the request processing will be denied.
MD5-hashing is applied to text, which is formed as a sequence of values of query parameters without delimiters. The result of hashing is reduced to the lower case.
|
Parameter |
Description |
|---|---|
|
resultCode |
Result code |
|
resultMessage |
Result code description |
|
ucode |
Unique bill number |
|
participantOrderId |
Order ID |
|
description |
Order description |
|
amount |
Order total amount |
|
personName |
Customer's full name |
|
personPhone |
Customer's mobile phone number. |
|
personEmail |
Customer's email address |
|
agentPayment |
Payment status, 1 – payment completed, 0 – payment not received |
|
agentPaymentTime |
Payment time in ATOM format |
|
agentPaymentName |
Payment instrument |
|
timecreate |
Time of bill creating in ATOM format |
|
timelimit |
Bill payment time limit in ATOM format |
|
enabled |
Bill status, 1 – bill is active, 0 – bill cancelled. Please note that funds of cancelled bills are not sent to merchant. At the same time, the bill can be paid, but cancelled. In this case, the decision on the need to transfer funds to the merchant is accepted by the support service. In the event that the order on the side of the merchant cannot be restored, the funds are returned to the customer. |
In a case of successfully bill creating the web service will return the value resultCode=0. In case of an error, the web service will return a detailed description of such an error in the resultMessage parameter and resultCode value will be non-zero.
Read next: Bill cancellation and refund →
