Sale-EncryptedCard

Submits a payment transaction request using encrypted card data or alternative tokens.

Header Parameters

token*string

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

Request Body

application/json

merchantAuthentication*

Includes merchant authentication details, such as the TPN number and unique transaction reference ID.

preferences?

Specifies whether AVS (Address Verification Service) verification is needed or if an e-receipt should be sent via SMS/email to the end user.

transactionRequest*

Contains details such as transaction type, card token, amount, fee calculation, etc.

avs?

Provides AVS details, including street number and ZIP code.

Response Body

`application/json`

curl -X POST "https://example.com" \  -H "token: string" \  -H "Content-Type: application/json" \  -d '{    "merchantAuthentication": {      "merchantId": "",      "transactionReferenceId": ""    },    "preferences": {      "eReceipt": false,      "customerName": "",      "customerEmail": "",      "customerMobile": "",      "requestCardToken": true    },    "transactionRequest": {      "amount": "",      "transactionType": 1,      "encryptedCardData": "",      "applySteamSettingTipFeeTax": false    },    "avs": {      "StreetNo": "",      "Zip": ""    }  }'

{
  "iposhpresponse": {
    "responseCode": "200",
    "responseMessage": "success",
    "errResponseCode": "",
    "errResponseMessage": "",
    "transactionReferenceId": "",
    "transactionType": "1",
    "transactionId": "",
    "amount": "",
    "responseApprovalCode": "",
    "rrn": "",
    "transactionNumber": "",
    "batchNumber": "",
    "customFee": "",
    "totalAmount": ""
  }
}

{
  "errors": [
    {
      "field": "IPOS_REQ_001",
      "message": "Invalid Payload Request"
    }
  ]
}

Sale-EncryptedCard

Header Parameters

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`