Hosted Payment
notifyByReturn
POST/notifyByReturn

Create external transaction notifying via standard return redirection.

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

notifyByRedirect*
boolean
returnUrl
string
failureUrl
string
cancelUrl
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/notifyByReturn
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": "",
8 "transactionReferenceId": ""
9 },
10 "transactionRequest": {
11 "transactionType": 1,
12 "amount": "",
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 "notifyByRedirect": true,
27 "returnUrl": "",
28 "failureUrl": "",
29 "cancelUrl": ""
30 },
31 "preferences": {
32 "integrationType": 1,
33 "avsVerification": false,
34 "eReceipt": false,
35 "eReceiptInputPrompt": false,
36 "customerName": "",
37 "customerEmail": "",
38 "customerMobile": "",
39 "requestCardToken": false,
40 "shortenURL": false,
41 "sendPaymentLink": false,
42 "integrationVersion": "",
43 "level3CEDP": ""
44 }
45}'
Response

// Awaiting response…

Sample response
{
  "message": "URL generated successfully",
  "information": ""
}