v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Make a payment with token

Make a payment with the one-time-use token

post/v3/payment?token=

Query parameters

tokenstring required

Limited-use token

echoboolean

Return result

Request body

merchantIdinteger required

Merchant id

tenderTypestring required

Tender type. Values: Card, Cash, Check, ACH (if enabled)

amountnumber float required

Amount

Response

200

createdstring

paymentTokenstring

idinteger

creatorNamestring

merchantIdinteger

batchstring

batchIdinteger

tenderTypestring

currencystring

amountstring

authOnlyboolean

authCodestring

statusstring

riskobject

requireSignatureboolean

settledAmountstring

settledCurrencystring

settledDatestring

cardPresentboolean

authMessagestring

availableAuthAmountstring

referencestring

taxstring

invoicestring

customerCodestring

customerNamestring

clientReferencestring

typestring

taxExemptboolean

reviewIndicatorinteger

sourcestring

Example response

{
  "created": "2018-01-25T21:34:15.24Z",
  "paymentToken": "Pfcyy68HAtwxb0hM2mpYHLEzc5nSESc3",
  "id": 22028828,
  "creatorName": "John Doe",
  "merchantId": 418324776,
  "batch": "Z08X0",
  "batchId": 2092732,
  "tenderType": "Card",
  "currency": "USD",
  "amount": "0.01",
  "cardAccount": {
    "cardType": "Visa",
    "entryMode": "Keyed",
    "last4": "1111",
    "cardId": "y15QvOteHZGBm7LH3GNIlTWbA1If",
    "token": "Pfcyy68HAtwxb0hM2mpYHLEzc5nSESc3",
    "expiryMonth": "01",
    "expiryYear": "19",
    "cardPresent": true
  },
  "authCode": "PPSVI7",
  "status": "Settled",
  "customer": {
    "id": 10696183,
    "created": "2017-09-25T15:18:08.89Z",
    "name": "Jane Doe",
    "firstName": "Jane",
    "lastName": "Doe",
    "sales": "0",
    "loyaltyStatus": "Enrolled",
    "loyaltyEnrolled": "2017-09-25T15:18:08.89Z",
    "displayColor": "A1BC3A"
  },
  "settledAmount": "0",
  "settledCurrency": "USD",
  "settledDate": "2018-01-26T15:16:49.763",
  "cardPresent": true,
  "authMessage": "AUTH/TKT PPSVI7",
  "availableAuthAmount": "0",
  "reference": "053DO00MMCL7",
  "tax": "0",
  "invoice": "O00MMCL7",
  "customerCode": "053DO00MMCL7",
  "customerName": "Jane Doe",
  "clientReference": "053DO00MMCL7",
  "type": "Sale",
  "source": "QuickPay"
}