Level 2/3 processing
Send Level 2/3 data on payins
Upgrade to the latest version
These docs are for version
2023-12-01
. We encourage you to upgrade to version2024-10-16
to access new features. Please see the changelog for more information.
Level 2 and Level 3 data is submitted with a business or commercial card to provide additional benefit to the cardholder through enhanced payment information, and benefits the merchant with lower interchange rates assessed by the card networks (Visa and Mastercard).
Where practical, it is highly recommended that Level 2 and Level 3 data be included in a payin request.
The following fields can be provided in the payin config request.
Note: Only some fields are required for Level 2 qualification.
Field Name | Description | Type | Level 2 | Level 3 |
---|---|---|---|---|
tax_amount | The sales tax included in the total payment amount associated with the item(s) being purchased, in minor units. For example, 1000 is 10.00 USD. | Integer | ✔ | ✔ |
shipping_amount | The freight or shipping amount included in the total payment amount, in minor units. For example, 1000 is 10.00 USD. | Integer | ✔ | ✔ |
order_number | The purchase order number. | String | ✔ | ✔ |
shipping_country | The 2-digit country code for the delivery address of the item(s) being purchased. Find country codes here: https://www.iso.org/obp | String | ✘ | ✔ |
shipping_postal_code | Postal code or ZIP code for the delivery address of the item(s) being purchased. This field can be identical to the shipping_from_postal_code if the customer is present and takes immediate possession of the item(s). | String | ✘ | ✔ |
shipping_from_postal_code | Postal code or ZIP code of the address the item(s) being purchased are shipped from. | String | ✘ | ✔ |
line_items (array) | The details on the item(s) being purchased. | Array | ✘ | ✔ |
Line Item Fields
Note: All fields are required for Level 3 qualification.
Field Name | Description | Type |
---|---|---|
product_code | The merchant defined product code of the item(s) being purchased. | String |
description | The description of the item(s) being purchased. | String |
unit_amount | The amount of the item(s) being purchased, in minor units. For example, 1000 is 10.00 USD. | Integer |
quantity | The quantity of the item(s). | String |
tax_amount | The sales tax on the item(s) being purchased, in minor units. For example, 1000 is 10.00 USD. | Integer |
tax_rate | The percentage representing the value-added tax applied, in per cent mille. For example, 1000 is 1%. | Integer |
See Level 2/3 API specs for additional details.
Updated about 2 months ago