Hosted Payment
notifybypost
POST/notifybypost

Create external transaction notifying via server-to-server POST notification.

Header Parameters

token*
string

Body Parameters

merchantAuthentication

merchantId*
string
transactionReferenceId*
string

transactionRequest

transactionType*
number
amount*
string
calculateFee
boolean
tipsInputPrompt
boolean
calculateTax
boolean
expiry
number
tipAmount
string
feeAmountC
string
feeLabelC
string
lTaxAmountC
string
lTaxLabelC
string
gTaxAmountC
string
gTaxLabelC
string

notificationOption

notifyByPOST*
boolean
postAPI
string
authHeader
string

preferences

integrationType*
number
avsVerification
boolean
eReceipt
boolean
eReceiptInputPrompt
boolean
customerName
string
customerEmail
string
customerMobile
string
requestCardToken
boolean
shortenURL
boolean
sendPaymentLink
boolean
integrationVersion
string
level3CEDP
boolean
POST/notifybypost
1curl --location 'https://payment.ipospays.tech/api/v3/external-payment-transaction' \
2--header 'token: ' \
3--header 'Content-Type: application/json' \
4--data '{
5 "personalization": {},
6 "merchantAuthentication": {
7 "merchantId": "139322815010",
8 "transactionReferenceId": "TXNId00111223334571666"
9 },
10 "transactionRequest": {
11 "transactionType": 1,
12 "amount": "1500",
13 "calculateFee": false,
14 "tipsInputPrompt": false,
15 "calculateTax": false,
16 "expiry": 1,
17 "tipAmount": "",
18 "feeAmount": "",
19 "feeLabel": "",
20 "lTaxAmount": "",
21 "lTaxLabel": "",
22 "gTaxAmount": "",
23 "gTaxLabel": ""
24 },
25 "notificationOption": {
26 "notifyByPOST": true,
27 "postAPI": "",
28 "authHeader": ""
29 },
30 "preferences": {
31 "integrationType": 1,
32 "avsVerification": false,
33 "eReceipt": false,
34 "eReceiptInputPrompt": false,
35 "customerName": "",
36 "customerEmail": "",
37 "customerMobile": "",
38 "requestCardToken": false,
39 "shortenURL": "",
40 "sendPaymentLink": false,
41 "integrationVersion": "",
42 "level3CEDP": ""
43 }
44}'
Response

// Awaiting response…

Sample response
{
  "message": "URL generated successfully",
  "information": "",
  "iposHPResponse": {
    "responseCode": "200",
    "responseMessage": "Successful",
    "transactionType": "1",
    "cardType": "VISA",
    "cardLast4Digit": "1111",
    "responseApprovalCode": "TAS164",
    "avsRespMeg": "ADDRESS MATCH"
  },
  "responseCode": 0,
  "responseMessage": "Success",
  "transactionType": 10,
  "cardType": "CHECK",
  "isAlter": "true",
  "achData": {
    "accountNumber": "************6843",
    "providerName": "PAYA ACH"
  }
}