In order to create a bill for a customer, you must call the web service function addInvoice.
Parameter |
Description |
---|---|
participantOrderId |
Order ID |
description |
Order description |
amount |
Order total amount |
personName |
Customer's full name |
personPhone |
Customer's mobile phone number. Phone number in E.164 format with “+” prefix |
personEmail |
Customer's email address |
timelimit |
Payment time limit. After the specified time, the unpaid bill will be cancelled. Time in ATOM format |
agentOperationIdent |
Not used |
agentOperationExtra |
Not used |
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 signparameter 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 |
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: Retrieving bill details →