Request Fields
The following request fields may be sent to provide more information on the breakdown of the purchase amount:
| Field Name | Mandatory? | Description |
|---|---|---|
| grossAmount | No | Total gross amount of sale. |
| netAmount | No | Total net amount of sale. |
| taxRate | No | Total tax rate (percentage). |
| taxAmount | No[1] | Total tax amount of sale. |
| taxReason | No[1] | Reason for above tax (eg VAT). |
| discountAmount | No[1] | Total discount amount of sale. |
| discountReason | No[1] | Reason for above discount. |
| handlingAmount | No | Handling costs. |
| insuranceAmount | No | Insurance costs. |
The following request fields may be sent to provide more information on the purchased items:
| Field Name | Mandatory? | Description |
|---|---|---|
| itemXXAmount[2] | No | Amount for XXth item purchased. |
| itemXXDescription[2] | No | Description of XXth item purchased. |
| itemXXQuantity[2] | No | Quantity of XXth item purchased. |
| itemXXGrossAmount[2] | No | Gross amount for XXth item purchased. |
| itemXXNetAmount[2] | No | Net amount for XXth item purchased. |
| itemXXTaxAmount[2] | No | Tax amount for XXth item purchased. |
| itemXXTaxRate[2] | No | Total tax rate for XXth item purchased. |
| itemXXTaxReason[2] | No | Tax reason for XXth item purchased. |
| itemXXDiscountAmount[2] | No | Total discount for XXth item purchased. |
| itemXXDiscountReason[2] | No | Discount reason for XXth item purchased. |
| itemXXProductCode[2] | No | Product code for XXth item purchased. |
| itemXXProductURL[2] | No | Shopping cart URL for XXth item purchased. |
| itemXXCommodityCode[2] | No | Commodity code for XXth item purchased. |
| itemXXUnitOfMeasure[2] | No | Unit of measure for XXth item purchased. |
| itemXXUnitAmount[2] | No | Unit amount for XXth item purchased. |
| itemXXImageUrl[2] | No | Image of XXth item purchased. |
| itemXXSize[2] | No | Size of XXth item purchased in the format ‘LengthxWidthxHeight Unit’. |
| itemXXWeight[2] | No | Weight of XXth item purchased in the format ‘Weight Unit’. |
| items | No | Nested line item records (see below). |
[2] XX is a number between 0 and 999.
The purchased items can be passed as either individual itemXXField fields; or as a single items field whose value is a sequential array of nested records.
Both formats cannot be used together. The presence of an items field will cause the Gateway to ignore any individual fields.
The Gateway does not currently support items to be formatted as a serialised array of records.
No attempt is made to check that any gross, net and tax amounts are correct with respect to each other. It is the sender’s responsibility to ensure alternative amount formats are correct.
Line item fields can either be sent ‘flat’ using field names containing the item row number as a sequential number from 1 to 1000; or be sent using nested arrays of the form items[XX][field] where XX is the row number from 0 to 999 and field is the field name from the above table without the itemXX prefix and starting with a lowercase first letter. For example, the tax rate for item 5 can be sent either as item5TaxRate; or as items[5][taxRate]. The two formats should not be mixed. If a request field of items is seen, then the ‘flat’ fields are ignored.