Submit

Fields	Description	Type	Filterable	Required
terminalId	ID of the terminal for which you're submitting external transaction	Integer	No	Yes
transactionId	Unique ID of the transaction in the external system	Integer	String	No
amount	Total Amount of the transaction	Decimal	No	Yes
date	Date of the transaction	Datetime	No	Yes
cardBin	The first six digits of the card used in the transaction	Integer	No	Yes
cardNumber	The last four digits of the card used in the transaction	Integer	No	Yes
cardExpDate	Card Expiration Date	Date	No	Yes
authCode	Transaction Auth Code	String	No	No
arn	Transaction ARN Number	String	No	No
ip	IP Address from which the transaction was made	String	No	Yes
order	Object with order information	Object	No	Yes
order.orderNumber	Number of order. If N/A you can provide the invoice number	String	Integer	No
order.invoice	Invoice Number	String	Integer	No
order.taxAmount	Total Amount of taxes for the order	Decimal	No	No
order.products	List of purchased products	[Object]	No	Yes
order.taxses	List of taxses	[Object]	No	Yes
order.billing	Information for customer billing	[Object]	No	Yes
order.shipping	Information for order shipping	[Object]	No	Yes
cardholder	Information for the cardholder	Object	No	Yes
cardholder.name	Cardholder Name	String	No	Yes
cardholder.country	Cardholder Country	String	No	Yes
cardholder.city	Cardholder city	String	No	Yes
cardholder.state	Cardholder state	String	No	No
cardholder.street	Cardholder street	String	No	Yes
cardholder.zip	Cardholder zip	String	Number	No
contact	Cardholder Contact	Object	No	Yes
contact.name	Contact Name	String	No	Yes
contact.phone	Contact Phone	String	No	Yes
contact.email	Contact Valid Email Address	String	No	Yes

Product Object

This is the structure of each product object. When submitting the external transaction please provide a list of these objects inside order.products field.

Fields	Description	Type	Filterable	Required
name	Name of the purchased product	String	No	Yes
price	Price of а single product	Decimal	No	Yes
quantity	Quantity of purchased products	Integer	No	Yes

Example Product Object

{
    "name": "Hosting",
    "price": "24.00",
    "quantity": "1.00",
}

Tax Object

This is the structure of each tax object. When submitting the external transaction please provide a list of these objects inside order.taxses field.

Fields	Description	Type	Filterable	Required
type	Type of tax	String	No	Yes
amount	Tax amount	Decimal	No	Yes
rate	Tax rate	Integer	No	Yes
category	Tax category	String	No	Yes

Example Tax Object

{
    "type": "VAT",
    "amount": "2.40",
    "rate": "10.00",
    "category": "VAT"
}

Billing Object

This is the structure of the billing object. It provides data about the billed person. When submitting the external transaction please provide it under order.billing field.

Fields	Description	Type	Filterable	Required
name	Name of the billed person	String	No	Yes
country	Country	String	No	Yes
state	State	String	No	No
city	City	String	No	Yes
street	Street	String	No	Yes
zip	Zip	String	Number	No

Example Billing Object

{
    "name": "Craig  Dewayne",
    "country": "United States",
    "state": "Arkansas",
    "city": "Pea Ridge",
    "street": "1302 Spruce St",
    "zip": "72751"
}

Shipping Object

This is the structure of the Shipping object. It provides data about the order shipping. When submitting the external transaction please provide it under order.shipping field.

Fields	Description	Type	Filterable	Required
fromZip	Shipping from zip	String	Number	No
toAddress	Delivery address information	String	No	Yes
toCity	Delivery city information	String	No	No
toZip	Shipping to zip	String	Number	No
toCountry	Shipping Country	String	No	Yes

Example Shipping Object

{
    "toCountry": "United States",
    "toCity": "Pea Ridge",
    "toAddress": "1302 Spruce St",
    "toZip": "72751",
    "fromZip": "31151"
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************