Sign in

v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Terminal Transaction - Create

post/transaction/merchantid/{merchantId}/terminalid/{terminalId}

Path parameters

merchantIdstring required

The merchant ID.

terminalIdstring required

The MX Merchant terminal ID.

Request body

amountnumber float required
typestring required

'Sale', 'Refund', 'Authorization', 'SaleCompletion' or 'Void'.

vaultCardboolean
replayIdstring required

Unique 15 digit string only.

Response

200

OR

Example response

{
  "message": "A transaction was sent to the terminal.",
  "prioritypaymentsystems": {
    "mxmerchant": {
      "merchant": {
        "devicePaymentAuditId": "492F5E7B-9A2C-41CF-BCC5-BBEB1C1BD676"
      }
    }
  },
  "provider": {
    "key": "anywherecommerce",
    "name": "AnywhereCommerce",
    "transaction": {
      "terminalID": "11197235",
      "status": "QUEUED",
      "transactionType": "SALE",
      "totalAmount": "10",
      "callbackUrl": "https://sandbox-api2.mxmerchant.com/terminal/v1/transaction/callback/merchantid/516158974/reference/903833494836/terminalid/11197235/transactionid/492F5E7B-9A2C-41CF-BCC5-BBEB1C1BD676",
      "uuid": "fda3c84d-4c36-43ad-8fc9-b93047c81df4",
      "id": "492F5E7B-9A2C-41CF-BCC5-BBEB1C1BD676",
      "portfolio": "pps",
      "dateCreated": "2021-03-31T08:22:45.0181919-05:00",
      "clientReference": "903833494836",
      "currency": "USD",
      "merchantId": "516158974",
      "source": "Terminal",
      "replayId": "000000000000011"
    }
  },
  "status": "SENTTOTERMINAL"
}