Create payment intent

Creates a payment intent. This is the first step in making a payment / purchase / sale transaction.

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

customerRef
string
Deprecated

Replaced by merchantReference. A field where you can provide your own reference to send to the host

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. Note: This is only supported on terminals that allow unlinked refunds. ie when the 'parentTransactionId' is omitted from the request body.

postbackUrl
string <uri>

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

object (IBasketItem)
Responses
201
400

Bad payload.

401

Invalid API key/MID.

403

Forbidden from performing this action.

500
post/merchant/{mid}/intent/payment
Request samples
application/json
{
  • "subTotal": 100,
  • "tip": 50,
  • "tax": 10,
  • "merchantReference": "sale-10-10-2022",
  • "customerRef": "sale-10-10-2022",
  • "manualCardEntry": false,
  • "postbackUrl": "https://<your-domain>.com/postback",
  • "items": {
    }
}
Response samples
application/json
{
  • "intentId": "uuid-uuid-uuid-uuid"
}