Payment Method Level Model

Level 2 or Level 3 interface for payment methods

This model represents common validation parameters that will be sent to the processor for Level 2 or 3 validation once enabled in the Partner's site or sent in the transaction's creation process.

Examples

Level 2 example object sent in the Transactions/Init request body

{
  //...
  "level": {
    "value": 2,
    "transactionId": "10",
    "tax": {
      "amount": "0.01"
    }
  }
}

Level 3 example object sent in the Transactions/Init request body

{
  //...
  "level": {
    "value": 3,
    "transactionId": "10",
    "invoiceCode": "INV001",
    "productsCode": "1010",
    "shipping": {
      "zipCode": "90000",
      "amount": "1.02",
      "dutyAmount": "0.01"
    },
    "tax": {
      "amount": "0.01",
      "details": [
        {
          "type": "test",
          "amount": "0.01",
          "rate": "1.00",
          "category": "VAT"
        }
      ]
    },
    "discount": {
      "amount": "0.01"
    },
    "customer": {
      "govtVatId": "Customer VAT"
    }
  }
}

Field	Type	Level	Constraint
value	enum	2 | 3	value 2 or 3
transactionId	string	2 | 3
invoiceCode	string	3
productsCode	string	3
shipping	object	3
shipping.zipCode	string	3	valid zip/postal code
shipping.amount	string	3	decimal, e.g. "1.02"
shipping.dutyAmount	string	3	decimal, e.g. "1.02"
tax	object	2 | 3
tax.amount	string	2 | 3	decimal, e.g. "1.02"
tax.details	array	3
tax.details[n]	object	3
tax.details[n].type	string	3
tax.details[n].amount	string	3	decimal, e.g. "1.02"
tax.details[n].rate	string	3	decimal, e.g. "1.02"
tax.details[n].category	string	3
discount	object	3
discount.amount	string	3	decimal, e.g. "1.02"
customer	object	3
customer.govtVatId	string	3

---

Payment method constraints

Coastal Pay

Field	Type	Level	Constraint
tax.details[n].category	enum	3	values: [ "SERVICE", "DUTY", "VAT", "ALTERNATE", "NATIONAL TAXEXEMPT" ]
tax.details[n].rate	range	3	min: "0", max: "100"

Required Product Model with the (minimum) following keys for Level 3: "posIdentifier", "name", "measurementUnit", "quantity", "amount", "itemNumber".