Sale-PaymentToken

API Explorer
loading...
POST
/sale-paymenttoken

Submits a payment transaction request using a payment token ID and address verification (AVS) details.

Header Parameters

token*string

Authentication token generated using the API Key and Secret Key. Required for all API requests.

Request Body

application/json

Response Body

application/json

application/json

curl -X POST "https://example.com" \  -H "token: your-access-token-here" \  -H "Content-Type: application/json" \  -d '{    "merchantAuthentication": {      "merchantId": "567025324141",      "transactionReferenceId": "TXN1718000000123"    },    "preferences": {      "eReceipt": true,      "customerName": "John Doe",      "customerEmail": "test@example.com",      "customerMobile": "+14242424243",      "requestCardToken": true    },    "transactionRequest": {      "amount": "1250",      "transactionType": 1,      "paymentTokenId": "pay_tok_v3_998877",      "applySteamSettingTipFeeTax": false    },    "avs": {      "StreetNo": "123 Main St",      "Zip": "90210"    }  }'
{
  "iposhpresponse": {
    "responseCode": "200",
    "responseMessage": "success",
    "errResponseCode": "",
    "errResponseMessage": "",
    "transactionReferenceId": "TXN1718000000123",
    "transactionType": "1",
    "transactionId": "TXID-11223344",
    "amount": "1250",
    "responseApprovalCode": "APP98765",
    "rrn": "219313501821",
    "transactionNumber": "4321",
    "batchNumber": "123",
    "customFee": "0",
    "totalAmount": "1250"
  }
}
{
  "errors": [
    {
      "field": "cardNumber",
      "message": "Invalid card number format."
    }
  ]
}