Sale

This API endpoint enables you to charge a credit card via a terminal. When you call this endpoint, the API sends the necessary instructions to the terminal to process a credit card charge with the specified amount.

Tip Adjustment is also supported. With this additional endpoint, you can modify the tip amount on an existing transaction as needed. For more details, please visit the Tip Adjust Endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
TypeFormatAllowed Values
StringAlphaCREDIT, DEBIT
Allowed:
string
required
Defaults to SALE
TypeFormatAllowed Values
StringAlphaSALE
string
required

Unique code for this transaction provided by the user for your own records.

Type Format
StringAlphanumeric

string
required

A positive integer in cents representing how much to charge.

Format Min Length Max Length Examples
Numeric (in cents)1 digit8 digits9 would be $0.09;
99999999 would be $999,999.99

string
required

Serial number of your terminal found on the back of the device labeled "S/N:".

TypeFormat
StringAlphanumeric

string

A positive integer in cents representing how much to add as a tip on the transaction. Any tip that is added will add to the total amount charged. If Amount is set to 100 and TipAmount is set to 50 then a total of 150 would be charged.

Format Min Length Max Length Examples
Numeric (in cents)1 digit8 digits9 would be $0.09;
99999999 would be $999,999.99

integer
enum

Flag that controls receipt printing behavior during a sale.

TypeAllowed Values
Int0 – No receipt
1 – Print merchant receipt
2 – Print customer receipt
3 – Print both merchant and customer receipts

Allowed:
boolean
Defaults to false

Flag that controls tip request behavior during a sale.

TypeAllowed Values
Booleantrue - Prompt for tip
false – Do not prompt for tip

Headers
string
required
Defaults to application/json

Indicates which content types, expressed as MIME types, the client is able to understand.

string
required
Defaults to application/json

Indicates the media type of the resource sent in the HTTP message body.

Possible Values:
application/json
application/x-www-form-urlencoded

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json