Sale

The Sale method creates a new authorization and a capture request by default.

It is important to note that these requests need to always include the system terminal.id for which you are making a payment.

Sale transactions are settled automatically while auth-only transactions are not included in the batch for settlement.

Keep in mind the required fields in order to initiate a sale transaction. If you want to perform level 2 or level 3 the required fields are outlined below.

Fields	Level 2	Level 3	Visa	Mastercard	AMEX (Level 2 Only)
order.id	No	Yes	Yes	Yes	No
order.date	No	Yes	Yes	No	No
order.invoice	No	Yes	Yes	No	No
order.summaryCommodityCode	No	Yes	Yes	No	No
order.description	No	No	No	No	Yes
order.supplierRefNo	No	No	No	No	Yes
order.customer.id	No	No	No	No	Yes
order.customer.vat	No	Yes	Yes	No	No
order.shipping.fromZip	No	Yes	Yes	Yes	No
order.shipping.toZip	No	Yes	Yes	Yes	Yes
order.shipping.toCountry	No	Yes	Yes	Yes	No
order.shipping.cost	No	Yes	Yes	Yes	No
order.shipping.dutyCost	No	Yes	Yes	Yes	No
order.tax.amount	Yes	Yes	Yes	Yes	Yes
order.tax.details.type	Yes	Yes	Yes	Yes	No
order.tax.details.amount	Yes	Yes	Yes	Yes	No
order.tax.details.rate	Yes	Yes	Yes	No	No
order.tax.details.category	Yes	Yes	Yes	Yes	No
order.products	No	Yes	Yes	Yes	No
order.discount.amount	No	Yes	Yes	Yes	No

Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the payment record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Payment amount	Number	No	Yes	No
source	Transaction source `Internet`, `Phone` and `Mail`	ENUM	Yes	Yes	No
origin	Origin of the transaction (i.e. Website, CRM, etc)	String	Yes	No	No
level	Desired level of the payment `1`, `2` or `3`	ENUM	Yes	Yes	No
threeds	3DS Object	Object	No	Yes	No
threeds.id	The ID that is returned from the 3DS response	Integer	No	Yes	No
card	Card details	Object	No	Yes	No
card.name	Cardholder name	String	No	Conditional	No
card.number	Card number	Integer	No	Conditional	No
card.cvv	Card security code / CVV	Integer	No	Conditional	No
card.exp	Card expiration date /Format: mm/yy	String	No	Conditional	No
card.save	Save the card details for future use `Yes` or `No`. This will return a token	ENUM	No	No	No
card.store	`Yes` or `No`. This indicates if the transaction is a Card On File (COF) or Merchant Initiated Transaction (MIT) type. For use with Visa only	ENUM	No	No	No
card.token	Card token. This is used for saved card and for future billing.	String	No	Conditional	No
card.verification	Verification object	Object	No	No	Yes
card.verification.cvv	The card security code verification response.	String	No	No	Yes
card.verification.address	The Address Verification System response.	String	No	No	Yes
card.address	Card billing address details	Object	No	No	No
card.address.country	Card billing country	String	No	No	No
card.address.state	Card billing state	String	No	No	No
card.address.city	Card billing city	String	No	No	No
card.address.street	Card billing street	String	No	No	No
card.address.zip	Card billing zip	String	No	No	No
card.networkTransactionId	This field is a unique network transaction identifier for all card types. If used in consecutive Visa/Mastercard transactions, it indicates the transaction is being processed using a card in the customer wallet.	String	No	No	Yes
contact	Contact object	Object	No	No	No
contact.name	Contact name	String	No	No	No
contact.phone	Contact phone	String	No	No	No
contact.email	Contact email	String	No	No	No
sendReceipt	Send receipt on `Sale` or `Capture` action. This parameter requires `contact.email` to be provided. `Yes` or `No`.	ENUM	No	No	No
externalId	Unique record identifiers from a system outside of Payment Gateway	String	Yes	No	No
isRecurring	Set this flag to `Yes` if the payment request comes from a recurring system	Boolean	No	No	No
split	`Yes` or `No`If this is a split Tender transaction. This will return an ID that needs to be provided in the next sequence	String	No	No	No
ip	IP Object	Object	No	No	No
ip.address	Cardholder IP address	String	Yes	No	No
ip.isp	Internet Service Provider	String	No	No	No
ip.type	The type of the IP	String	No	No	No
ip.location	IP location Object	Object	No	No	No
ip.location.city	City	String	No	No	No
ip.location.state	State	String	No	No	No
ip.location.country	Country	String	No	No	No
ip.location.zip	ZIP Code	String	No	No	No
ip.info	Info	Object	No	No	No
ip.info.isAnonymous	Anonymous Check	Boolean	No	No	No
ip.info.isAnonymousVpn	Anonymous VPN	Boolean	No	No	No
ip.info.isPublicProxy	Public Proxy	Boolean	No	No	No
ip.info.isHostingProvider	Hosting Provider IP	Boolean	No	No	No
ip.info.isTorExitNode	Tor Exit Node of the IP	Boolean	No	No	No
order	Order details	Object	No	No	No
order.id	Purchase order	String	No	No	No
order.date	Purchase order date	Date	No	No	No
order.invoice	Order invoice number	String	No	No	No
order.summaryCommodityCode	The international description code of the overall goods/services being supplied.	String	No	No	No
order.description	Also referred to as Soft Descriptor. The text on the cardholder's statement that describes the purchase. If the order.description is sent, it will be forwarded in the authorization and capture for all card types.	String	No	No	No
order.supplierRefNo	Supplier reference number	String	No	No	No
order.customer	Customer details	Object	No	No	No
order.customer.identifier	Customer reference identifier	String	No	No	No
order.customer.vat	Customer's government assigned tax identification number	String	No	No	No
order.shipping	Order shipping details	Object	No	No	No
order.shipping.fromZip	Shipping from zip code	String	No	No	No
order.shipping.toZip	Destination zip code	String	No	No	No
order.shipping.toCountry	Destination county code	String	No	No	No
order.shipping.cost	Shipping cost	Number	No	No	No
order.shipping.dutyCost	Shipping duty cost	Number	No	No	No
order.tax	Order tax details	Object	No	No	No
order.tax.amount	Sales tax	Number	No	No	No
order.tax.details	Additional sales tax information	Array	No	No	No
order.tax.details.type	The type of sales tax applied	String	No	No	No
order.tax.details.amount	The sales tax amount applied to the order	Number	No	No	No
order.tax.details.rate	Tax rate (Allowed range 0.01-100)	Number	No	No	No
order.tax.details.category	`Service`, `Duty`, `VAT`, `Alternate`, `National` `TaxExempt`	ENUM	No	No	No
order.products	Product/s details	Object	No	No	No
order.products.id	Product ID	String	No	No	No
order.products.name	Product name	String	No	No	No
order.products.price	Product price	Number	No	No	No
order.products.quantity	Product quantity	Integer	No	No	No
order.products.measurementUnit	Product measurement unit	String	No	No	No
order.products.commodityCode	Product commodity code	String	No	No	No
order.discount	Order discounts details	Object	No	No	No
order.discount.amount	Discounts amount	Number	No	No	No
order.discount.details	Discount	Object	No	No	No
order.discount.details.name	Discount name	String	No	No	No
order.discount.details.amount	Discount amount	Number	No	No	No
order.discount.details.percentage	Discount percentage	Number	No	No	No
order.discount.details.priority	Discount priority	Integer	No	No	No
feeTransaction	In cases where a fee is run as a separate transaction on another terminal	Object	No	No	Yes
feeTransaction.id	Fee Transaction ID	Integer	No	No	Yes
feeTransaction.type	The type of sales tax applied	String	No	No	Yes
feeTransaction.amount	The sales tax amount applied to the order	Number	No	No	Yes
batch	Object	Object	No	No	Yes
batch.id	Batch ID	Integer	Yes	No	Yes
batch.number	Batch Number	Integer	No	No	Yes
batch.batchedOn	Date when batch was generated	Datetime	No	No	Yes
status	Status Object	Object	No	No	Yes
status.status	Status	String	Yes	No	Yes
status.reason	Description	String	No	No	Yes

If you pass the level parameter in your request, we will validate the field requirements of the level you have requested. In the event of an incomplete validation we will return an error with the missing fields.

If a transaction has a batch information in the response, this means that this transaction has batched.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

application/json

Body

Example

{
    "id": 874,
    "amount": "2.10",
    "origin": null,
    "type": "Auth",
    "level": 1,
    "authCode": "VTLMC1",
    "parent": {
        "id": null
    },
    "terminal": {
        "id": 24
    },
    "threeds": {
        "id": null
    },
    "card": {
        "bin": 530957,
        "name": "John Wick",
        "number": 2257,
        "exp": "2030-12-31",
        "verification": {
            "cvv": "M",
            "address": "Y"
        },
        "networkTransactionId": "1212MCC111736**"
    },
    "contact": {
        "name": null,
        "phone": null,
        "email": "test@testemail.com"
    },
    "externalId": null,
    "isRecurring": "No",
    "split": null,
    "refunded": false,
    "captured": true,
    "history": [
        {
            "id": 875,
            "type": "Capture",
            "amount": "2.10",
            "createdOn": "2023-05-09 15:03:50"
        }
    ],
    "order": null,
    "feeTransaction": null,
    "batch": {
        "id": null,
        "number": null,
        "batchedOn": null
    },
    "ip": {
        "address": "173.239.211.197",
        "isp": "Ipxo Limited",
        "type": "hosting",
        "location": {
            "city": "New York",
            "state": "NY",
            "country": "US",
            "zip": "10118"
        },
        "info": {
            "isAnonymous": "Yes",
            "isAnonymousVpn": "No",
            "isPublicProxy": "No",
            "isHostingProvider": "No",
            "isTorExitNode": "No"
        }
    },
    "status": {
        "status": "Approved",
        "reason": null
    },
    "updatedOn": "2023-05-09 15:03:51",
    "createdOn": "2023-05-09 15:03:48"
}

Request

Request Code Samples

Responses