Add Level3 Item

Adds a Level 3 line item to a transaction. All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Request Body

application/json

Amount?|

Amount of the transaction.

Formatdouble

Tip?|

Tip of the transaction.

Formatdouble

CashbackAmount?|

Cashback amount of the transaction.

Formatdouble

Frequency?string

Indicates the Frequency.

CustomFee?|

Custom fee of the transaction.

Formatdouble

AuthCode?string

Authorization code provided by payment processor.

TaxAmount?|

Sum of all tax amount for item level.

Formatdouble

LocalTaxFlag?string

Indicates the local tax flag.

NationalTaxAmount?|

Sum of national tax amount for item level.

Formatdouble

CustRef?string

Indicates the customer reference.

DestZipCode?string

Indicates the destination zip code.

CustomerVatReg?string

Indicates customer Vat reg.

SummaryCommodityCode?string

Indicates summary commodity code.

FreightAmount?|

Freight amount of the transaction.

Formatdouble

DutyAmount?|

Duty amount of the transaction.

Formatdouble

ShipfromZipCode?string

Indicates ship from zip code.

DestCountryCode?string

Indicates destination country code.

LineItemCount?|

Indicates line item count.

Formatint32

Level3LineItems?

Indicates level3 line items.

PaymentType*string

Indicates electronic data capture (EDC) type.

ReferenceId*string

Alphanumeric SPIn transaction identifier. Has to be unique within one batch.

Length1 <= length <= 50

PrintReceipt?string

Indicates if any of receipt copies should be printed after the transaction.

Value in"No" | "Both" | "Merchant" | "Customer"

GetReceipt?string

Indicates if any of receipt copies should be returned in response.

Value in"No" | "Both" | "Merchant" | "Customer"

MerchantNumber?|

Merchant number for multi-merchant environment. If not present in multi-merchant environment, transaction will be cancelled.

Formatint32

Range1 <= value <= 5

InvoiceNumber?string

Unique alphanumeric invoice number.

Lengthlength <= 50

CaptureSignature?boolean

Indicates whether customer signature should be captured or not in course of transaction.

GetExtendedData?boolean

Indicates whether extended transaction data should be returned or not.

IsReadyForIS?boolean

Indicates whether register is ready to receive intermediate status or not.

CallbackInfo?

Information for callback with transaction result.

ReconId?string

Used for reconciliation purposes. This field is applicable only for Fiserv North transactions and it is optional. It contains an alphanumeric reference ID that links the transaction to its corresponding settlement record in Fiserv.

Length1 <= length <= 10

IsvId?string

This is the unique identifier generated by iPOSpays for each ISV. It must be sent to associate the transaction and the merchant with the corresponding ISV.

Length1 <= length <= 16

Tpn?string

Terminal profile number. Can be used to identify the terminal in SPIn Proxy environment. Required if no RegisterId.

Length10 <= length <= 12

RegisterId?string

Terminal identifier for register. [Obsolete] Can be used to identify the terminal instead of Tpn in SPIn Proxy environment. Required if no Tpn.

Length2 <= length <= 50

Authkey?string

Merchant's authorization password. Required if no SPInToken.

Length10 <= length <= 10

SPInProxyTimeout?|

Timeout for processing transaction with SPIn proxy. If null, the default timeout will be used.

Formatint32

Range1 <= value <= 720

CustomFields?

A collection of custom fields in key-value format. Numeric fields must contain a decimal point. For example: "CustomFee": 1.0 or "CustomFee": 1.00 or "CustomFee": "1.00"

Response Body

`application/json`

curl -X POST "https://example.com/v2/L3Data/AddLevel3Item" \  -H "Content-Type: application/json" \  -d '{    "Amount": null,    "Tip": null,    "CashbackAmount": null,    "Frequency": "",    "CustomFee": null,    "AuthCode": "",    "TaxAmount": null,    "LocalTaxFlag": "",    "NationalTaxAmount": null,    "CustRef": "",    "DestZipCode": "",    "CustomerVatReg": "",    "SummaryCommodityCode": "",    "FreightAmount": null,    "DutyAmount": null,    "ShipfromZipCode": "",    "DestCountryCode": "",    "LineItemCount": null,    "Level3LineItems": {      "Group": [        {          "CommodityCode": "",          "Description": "",          "ProductCode": "",          "Quantity": null,          "UnitOfMeasure": null,          "UnitCost": null,          "VatTaxAmount": null,          "VatTaxRate": null,          "DiscountAmount": null,          "TotalAmount": null        }      ]    },    "PaymentType": "Credit",    "ReferenceId": "",    "PrintReceipt": "No",    "GetReceipt": "No",    "MerchantNumber": null,    "InvoiceNumber": "",    "CaptureSignature": false,    "GetExtendedData": false,    "IsReadyForIS": false,    "CallbackInfo": {      "Url": ""    },    "ReconId": "",    "IsvId": "",    "Tpn": "",    "RegisterId": "",    "Authkey": "",    "SPInProxyTimeout": null,    "CustomFields": {}  }'

{
  "AuthCode": "",
  "ReferenceId": "",
  "LineItemCount": null,
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

{
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

Add Level3 Item

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`