Payment with cheque

The cheque in the order

The cheque is passed within the authorization request. An additional parameter ChequeItems must be passed in the request. The ChequeItems parameter should contain a structure in JSON-format looking like a following example.

An example of a cheque structure in the ChequeItems parameter:

{"items":[
{ "id": 1,
    "product": "123460176",
    "name": "First item",
    "price": 201.45,
    "quantity": 42.345,
    "amount": 8530.40,
    "tax": "vat10"},
    "hscode": "8528722001",
    "fpmode": 1},
{ "id": 2,
    "product": "123460189",
    "name": "Second item",
    "price": 15301.01,
    "quantity": 0.128,
    "amount": 1958.53,
    "tax": "vat20"},
    "fpmode": 1}
]}

The following cheque item parameters are transfered in the structure:

*One of the parameters must be defined – product’s code or product’s name, or both parameters must be transferred (by building a fiscal check they are combined into one string).

**The parameters tax end fpmode are not passed in the cancel or refund request.

Values of the parameters price and amount for all the cheque items should be in the same currency and (OrderCurrency parameter of the authorization request).

The total amount of the cheque items (by amount parameter) must be equal the order amount (OrderAmount parameter of the authorization request).

If the conditions above are not met then cheque is recognized as wrong-formed and the authorization request error appear.

The cheque within the charge

Internet-shop can issue a financial confirmation within 4 days in Personal account, or using Web service.

To confirm the payment, send a request to IPS Assist server via HTTP POST or SOAP method (in UTF-8 coding).

The request URL for the financial confirmation transmission and list of payment confirmation parameters are the same as the values specified here. To send a confirmation cheque via HTTP POST method, only an additional parameter ChequeItems is added, which contains a structure in JSON-format looking like a following example.

An example of a cheque structure in the ChequeItems parameter:

{"items":[
{ "id": 1,
    "product": "123460176",
    "name": "First item",
    "price": 201.45,
    "quantity": 21.12,
    "amount": 8530.40,
    "tax": "vat10"},
    "fpmode": 1}
{ "id": 2,
    "product": "123460189",
    "name": "Second item",
    "price": 15301.01,
    "quantity": 0.064,
    "amount": 979.26,
    "tax": "vat20"},
    "fpmode": 1}
]}

To send a confirmation cheque via SOAP method, only an additional repeating structure ChequeItem is added, in which the cheque items are transferred, as in following example.

Example of cheque item structures ChequeItem:

<chequeitem>
<id>1</id>
<product>123460176</product>
<name>First item</name>
<price>201.45</price>
<quantity>21.12</quantity>
<amount>8530.40</amount>
<tax> vat10</tax>
<fpmode>1</fpmode>
</chequeitem>
<chequeitem>
<id>2</id>
<product>123460176</product>
<name>Second item</name>
<price>15301.01</price>
<quantity>0.064</quantity>
<amount>979.26</amount>
<tax> vat20</tax>
<fpmode>1</fpmode>
</chequeitem>

The confirmation can be performed to both the complete amount and a part of the amount. It is allowed to issue a partial confirmation of amount not exceeding the amount of payment, if the payment operation by credit card was completed through processing with correspondent settings.

A confirmation cheque may contain all or part of the items that were present in the payment cheque.

The parameters product, name, price for each confirmation cheque item must be surely equivalent to these parameters of the corresponding item of the payment cheque.

The amount of the parameters amount of all the items in the confirmation cheque must be equal to the Amount field of the confirmation request.

In the case of the full amount confirmation it is not necessary to transfer a set of ChequeItem structures corresponding to the total cheque sent in the order. The cheque is not required for the confirmation of the full amount.

The cheque within the cancel

The cancellation of selected cheque items can be performed manually in the IPS Assist personal account or by request via the WEB-service cancel (POST format) or wscancel (SOAP format).

In order to cancel the selected cheque items the request (in UTF-8 encoding) should be sent to IPS Assist server.

The request URL for the cancel or refund and list of payment cancel parameters are the same as the values specified here. To send a cancelation cheque only an additional parameter ChequeItems is added, which contains a structure in JSON-format looking like a following example.

Example of cheque item structures ChequeItem:

<chequeitem>
<id>1</id>
<product>123460176</product>
<name>First item</name>
<price>201.45</price>
<quantity>21.12</quantity>
<amount>8530.40</amount>
<tax> vat10</tax>
</chequeitem>

In the case of the full amount cancelation it is not necessary to transfer a set of ChequeItem structures corresponding to the total cheque sent in the order. The cheque is not required for the cancelation of the full amount.

A cancelation cheque may contain all or part of the items that were present in the payment cheque or in the confirmation cheque by the two-stage operation mechanism.

The parameters product, name, price for each cancelation cheque item must be surely equivalent to these parameters of the corresponding item of the payment cheque or in the confirmation cheque by the two-stage operation mechanism.

The amount of the parameters amount of all the items in the cancelation cheque must be equal to the Amount field of the cancel request.

The parameters quantity and amount for each cancelation cheque item must not be greater, than the values of the corresponding parameters quantity and amount of the payment cheque or the confirmation cheque by the two-stage operation mechanism taking into account the values quantity and amount parameters for this item from previously performed cancelations.

Values of the parameters price and amount for all the cheque items should be in the same currency and (OrderCurrency parameter of the authorization request).

If the conditions above are not met then check is recognized as wrong-formed and the request error appear.

The cheque within the recurring payment

The parameter RecurringIndicator = 1 should be set in initial authorization request (see paragraph 2.1) in order to initiate the recurrent payment. Also the parameters of the range of amounts in subsequent recurring payments, payment frequency (in days) and the end date of subscription should be provided.

Then periodically the company will initiate the payment, setting the payment amount only and the rest required payment information (credit card data) is taken from the original payment.

The request URL for the recurring payment and list of request parameters are the same as the values specified here. To send a recurring payment cheque via HTTP POST method, only an additional parameter ChequeItems is added, which contains a structure in JSON-format looking like a following example.

An example of a cheque structure in the ChequeItems parameter:

{"items":[
{ "id": 1,
    "product": "123460176",
    "name": "First item",
    "price": 201.45,
    "quantity": 21.12,
    "amount": 8530.40,
    "tax": "vat10"},
    "fpmode": 1}
{ "id": 2,
    "product": "123460189",
    "name": "Second item",
    "price": 15301.01,
    "quantity": 0.064,
    "amount": 979.26,
    "tax": "vat20"},
    "fpmode": 1}
]}

To send a recurring payment cheque via SOAP method, only an additional repeating structure ChequeItem is added, in which the cheque items are transferred, as in following example.

Example of cheque item structures ChequeItem:

<chequeitem>
<id>1</id>
<product>123460176</product>
<name>First item</name>
<price>201.45</price>
<quantity>21.12</quantity>
<amount>8530.40</amount>
<tax> vat10</tax>
<fpmode>1</fpmode>
</chequeitem>
<chequeitem>
<id>2</id>
<product>123460176</product>
<name>Second item</name>
<price>15301.01</price>
<quantity>0.064</quantity>
<amount>979.26</amount>
<tax> vat20</tax>
<fpmode>1</fpmode>
</chequeitem>

Back on top