Initiate a pre-authorization.

This API endpoint initiates a pre-authorization command to a terminal. The final approval/decline result is delivered asynchronously to the callbackURL.

Body Params
string
required

12-digit merchant identifier (MID).

string
required

10-digit terminal serial number.

string
required
length ≤ 16

Client-generated transaction identifier used for reconciliation.

amount
object
required

Message amount providing total, subtotal, currency, tip, and tax.

integer
enum
required

Allowed values:
0 – No receipt
1 – Print merchant receipt
2 – Print customer receipt
3 – Print both merchant and customer receipts

Allowed:
string
required

HTTPS endpoint that receives the asynchronous callback payload.

metadata
object
Headers
string
required

Bearer token used to authenticate API requests.

uuid
required

Unique key used to prevent duplicate transaction commands.

Responses

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