DiVert Functionality *
**
The Divert API has a parameter “CreateTransactionUrl” that can be set to either “True or “False”. The value set determines how the Gateway handles and processes the message request.
Scenario 1 *
If CreateTransactionUrl” is set to“True” - the Gateway generates a transaction URL and makes a callback to the merchant with the URL.
The merchant can then construct and format their own message, including the URL (returned by the Gateway) and distribute the message to their cardholder using either SMS|Email
When the cardholder receives the messages, it will have all the particulars of the merchant, the cardholder can then click on the URL, and be redirected to a payment page wherein they can make a payment to the merchant
Scenario 2*
If CreateTransactionUrl is set to “Fal
Create Code *
**
Function: Generate a transactional code that can then be paid for by a cardholder. This code can be represented as a QR code, transferred using NFC or manually entered a device. The code can also be used as part of an In-App payment.
/Create Code Parameters/*
Request
Parameter
Description
MasterPassAction
Mandatory, The action to perform.
MasterPassMerchantID
Mandatory, The merchant id as captured on MasterPass.
MasterPassShortDescription
Mandatory, This will be displayed to the consumer at the time a code
is scanned. Length is 5 to 45 characters
MasterPassCodeExpiryDate
Optional. If this is empty the code will by default expire in 30
minutes from issue. If this value is 0 the code will never expire. This time
is specified in epoch.
Amount
Mandatory, To use a variable amou
*** Requirements ***
With the API, merchants are able to generate payment requests to their clients by implementing the “DebitRequest” command and include the specific data parameters that are expected in the message request to the Gateway. The data elements required in the “DebitRequest” command are covered in the Enterprise Documentation
In order to implement the DebitRuquest method, the following should be downloaded or in place.
Reference the Divert Specification Guide Reference the using the “RequestDebit” method in the Enterprise Documentation Merchant Agreement with an acquirer with Divert as the solution which will result in a merchant profile on the Gateway
Query Code *
**
Function: Query a code that has been created.
Query Code Parameters *
Request
Parameter
Description
MasterPassAction
Mandatory, The action to perform.
MasterPassMerchantID
Mandatory, The merchant id as captured on MasterPass.
MasterPassCode
Mandatory, The result code that must be queried
Response
Parameter
Description
MasterPassAction
The action that was performed
MasterPassShortDescription
Short decription linked to the code
MasterPassCodeExpiryDate
Date until the code is valid. This is in epoch time.
MasterPassMerchantName
The name of the merchant as captured on MasterPass
Amount
Amount linked to the code.
Currency
The currency is tied to the merchant setup.
MerchantReference
Linked to the code.
Query Code – REST Sample *
Request
Response
{
"Version" : "2.0" ,
"Certifica
*** The Divert Batch Upload Data Elements ***
* The Divert Batch XML upload file uses the following logic: *
The <Divert> element can occur multiple times The <DivertItem> element can occur multiple times under a <Divert> element The Application ID used in the <DivertItem> elements should be the same through-out the <Divert> element
* Divert attributes *
Tag Name
Length
Data Type
Format
Description
Amount
<=12
Numeric
The sum of the Amount sub-element values of all the <DivertItem> sub-elements
Count
<=6
Number
The number of <DivertItem> sub-elements
*Divert sub-elements*
Tag Name
Length
Data Type
Format
Description
Date
8
Numeric
YYYYMMDD
The date when the batch was created (in which case the batch will be processed on the upload date) or a future date on which the batch should be process
*Registering as a merchant * **
Merchant account can be attained by registering with an acquiring bank, a list of which can be found on this page [1]
[1] /knowsystem/distributors-contact-information-33
DiVert API Process Flow *
**
The merchant portal Backoffice allows for the following core functions:
Management of User Creation of users Transaction Types allowed per user created Backoffice functionality views allowed Applications permitted on a user created Transaction Reports & Listing & Lookups Reconciliation Reports Blacklisting of cards Customise payment request page with Merchant’s Corporate Identity. Create Transaction Requests Process Subsequent Transactions (Refunds)
DiVert Batch Result File Data Elements *
**
The result file data elements described in this section are returned to the merchant when the <CreateTransactionURL> in the “DivertUpload” file is set to “True”. Merchants can use the returned data elements to create and format their own payment request messages and send the requests to their cardholder using their own delivery method i.e. SMS|EMAIL
The Divert Batch has the following logic:
The <Divert> element can occur multiple times The <DivertItem> element can occur multiple times under a <Divert> element
Divert Attributes *
Tag Name
Length
Data Type
Format
Description
Amount
<=12
Numeric
The sum of the Amount sub-element values of all the <DivertItem> sub-elements
Count
<=6
Number
The number of <DivertItem> sub-elements
Divert sub-elements *
DiVert Batch Upload Response Code *
**
Error Description *
Possible Reasons *
Not a valid payment request Batch file
Can occur due to the following reasons:
Incorrect File format Type VXML tags that may be opened but not closed or Vice Versa
DiVertItem element Command attribute not valid
Check the Command file
Invalid Date
Make sure date is provided and on the correct format
User, Administrator, you have already uploaded a file, Teswa.XML, with applicationId, 8c4adb24-bda4-473b-af75-e4c4cd85ee05.
File with the same name already uploaded