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 "merchantAuthentication": {
6 "merchantId": "139322815010",
7 "transactionReferenceId": "TXNId00111223334571666"
8 },
9 "transactionRequest": {
10 "transactionType": 1,
11 "amount": "1500",
12 "calculateFee": false,
13 "tipsInputPrompt": false,
14 "calculateTax": false,
15 "expiry": 1,
16 "tipAmount": "",
17 "feeAmount": "",
18 "feeLabel": "",
19 "lTaxAmount": "",
20 "lTaxLabel": "",
21 "gTaxAmount": "",
22 "gTaxLabel": ""
23 },
24 "notificationOption": {
25 "notifyByPOST": true,
26 "postAPI": "",
27 "authHeader": ""
28 },
29 "preferences": {
30 "integrationType": 1,
31 "avsVerification": false,
32 "eReceipt": false,
33 "eReceiptInputPrompt": false,
34 "customerName": "",
35 "customerEmail": "",
36 "customerMobile": "",
37 "requestCardToken": false,
38 "shortenURL": "",
39 "sendPaymentLink": false,
40 "integrationVersion": "",
41 "level3CEDP": ""
42 },
43 "personalization": {}
44}'
Response

// Awaiting response…

Sample response
{
  "message": "Url generated Successful",
  "information": "https://payment.ipospays.tech/api/v1/externalPay?t=< token-value >"
}