Skip to main content

Request Fields

The following request fields may be sent to provide more information on the breakdown of the purchase amount:

Field NameMandatory?Description
grossAmountNoTotal gross amount of sale.
netAmountNoTotal net amount of sale.
taxRateNoTotal tax rate (percentage).
taxAmountNo[1]Total tax amount of sale.
taxReasonNo[1]Reason for above tax (eg VAT).
discountAmountNo[1]Total discount amount of sale.
discountReasonNo[1]Reason for above discount.
handlingAmountNoHandling costs.
insuranceAmountNoInsurance costs.

The following request fields may be sent to provide more information on the purchased items:

Field NameMandatory?Description
itemXXAmount[2]NoAmount for XXth item purchased.
itemXXDescription[2]NoDescription of XXth item purchased.
itemXXQuantity[2]NoQuantity of XXth item purchased.
itemXXGrossAmount[2]NoGross amount for XXth item purchased.
itemXXNetAmount[2]NoNet amount for XXth item purchased.
itemXXTaxAmount[2]NoTax amount for XXth item purchased.
itemXXTaxRate[2]NoTotal tax rate for XXth item purchased.
itemXXTaxReason[2]NoTax reason for XXth item purchased.
itemXXDiscountAmount[2]NoTotal discount for XXth item purchased.
itemXXDiscountReason[2]NoDiscount reason for XXth item purchased.
itemXXProductCode[2]NoProduct code for XXth item purchased.
itemXXProductURL[2]NoShopping cart URL for XXth item purchased.
itemXXCommodityCode[2]NoCommodity code for XXth item purchased.
itemXXUnitOfMeasure[2]NoUnit of measure for XXth item purchased.
itemXXUnitAmount[2]NoUnit amount for XXth item purchased.
itemXXImageUrl[2]NoImage of XXth item purchased.
itemXXSize[2]NoSize of XXth item purchased in the format ‘LengthxWidthxHeight Unit’.
itemXXWeight[2]NoWeight of XXth item purchased in the format ‘Weight Unit’.
itemsNoNested 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.

info

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.

Footnotes

  1. Amex/Diners require either tax or discount, not both.
  2. XX is a number between 0 and 999