In order to cancel a bill or make a refund, you must call the web service function disableInvoice, disableInvoiceExA or disableInvoiceExB.
- disableInvoice – unconditional cancellation of a bill. Bill will be cancelled. If the bill is paid, the funds are returned to the customer in full;
- disableInvoiceExA – сancellation function with a refund amount (partial refund). Bill will be cancelled. If the bill is paid, the funds are returned to the customer in the amount of the specified amount;
- disableInvoiceExB – сancellation function with a penalty amount (partial refund). Bill will be cancelled. In the event that the bill is paid, the funds are returned to the customer in the amount of the bill amount minus the specified amount of the penalty.
disableInvoice |
|
---|---|
Parameter |
Description |
ucode |
Unique bill number |
ident |
Unique merchant's refund ID |
sign |
Security sign |
disableInvoiceExA |
|
Parameter |
Description |
ucode |
Unique bill number |
ident |
Unique merchant's refund ID |
comment |
The reason for the partial refund, comment - why merchant not returned the full amount |
amount |
Refund amount, not more than the total amount of the bill |
sign |
Security sign |
disableInvoiceExB |
|
Parameter |
Description |
ucode |
Unique bill number |
ident |
Unique merchant's refund ID |
comment |
The reason for the partial refund, comment - why merchant not returned the full amount |
penalty |
Penalty amount, not more than the total amount of the bill |
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.
The order of the parameters:
Parameter |
Description |
---|---|
resultCode |
Result code |
resultMessage |
Result code description |
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.