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 "merchantAuthentication": {
6 "merchantId": "",
7 "transactionReferenceId": ""
8 },
9 "transactionRequest": {
10 "transactionType": 1,
11 "amount": "",
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 "notifyByRedirect": true,
26 "returnUrl": "",
27 "failureUrl": "",
28 "cancelUrl": ""
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": false,
40 "sendPaymentLink": false,
41 "integrationVersion": "",
42 "level3CEDP": ""
43 },
44 "personalization": {}
45}'
Response

// Awaiting response…

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