Create Pre-Auth create intent

Create a Pre-Authorisation create intent for a physical terminal to begin processing.

Securityapi_key
Request
path Parameters
mid
required
string

Merchant Identifier.

Request Body schema: application/json
subTotal
required
number

Currency is in a no-decimal format. For decimal based currencies, when converting to a decimal based format place a decimal before the last two digits.

tip
number
tax
number
merchantReference
string

A field where you can provide your own reference to send to the host

postbackUrl
string <uri>

When a terminal has finished processing a transaction it will send a callback to the url defined here.

manualCardEntry
boolean

If true, the terminal will not attempt to read a card and will instead prompt the user to enter the card details manually.

Responses
201
400

Bad payload.

401

Invalid API key/MID.

403

Forbidden from performing this action.

500
post/merchant/{mid}/intent/preauth/create
Request samples
application/json
{}
Response samples
application/json
{
  • "intentId": "uuid-uuid-uuid-uuid"
}