Sale (Using Token)

Sale

This API endpoint is used to process a sale transaction providing the full card information.

URL: {{base_url}}/locations/{{location_id}}/sale
Method: POST

Request Headers

Header Type Required Description
Authorization String Yes Bearer {access_token}
Content-Type String Yes application/json

Request Parameters

Field Type Required Description
user_idStringYesUser ID
currency_isoStringNoCurrency
country_isoStringNoCountry Code
phone_numberStringNoPhone Number
customer_nameStringNoCustomer name
customer_emailStringNoCustomer email
orderidStringNoOrder Id
reconciliation_idStringNoReconciliation identifier for transaction tracking
inv_numberStringNoInvoice number associated with the transaction
amountNumericNoAmount
card_dataObjectYesCard data
billing_addressObjectNoBilling Address
orderObjectNoOrder Details

Object Type Parameters

card_data

Field Type Required Description
card_typeStringWhen token is not presentVisa, Mastercard, Amex
tokenStringWhen Card Number is not presentCard Token
panStringWhen Card token is not presentCard Number
sadStringWhen Card token is not presentCVV
exp_monthStringWhen Card token is not presentCard Expiry Month
exp_yearStringWhen Card token is not presentCard Expiry Year
card_holderStringCard Holder Name

billing_address

Field Type Required Description
streetStringNoStreet
street2StringNoStreet 2
zipStringNoZipcode
stateStringNoState
cityStringNoCity
country_isoStringNoCountry

order

Field Type Required Description
itemsArrayNoOrder items
discountsArrayNoOrder Discounts

items

Field Type Required Description
idStringNoItem Id
nameStringNoItem Name
quantityNumericNoItem Quantity
priceNumericNoItem Price
taxNumericNoItem Tax
typeStringNoItem Type
sales_categoryStringNoSales Category
phone_numberStringNoPhone Number

discounts

Field Type Required Description
idStringNoDiscount Id
nameStringNoDiscount Name
valueNumericNoDiscount Value
item_idStringNoItem Id
Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!