Refund of a previously successful Sale Transaction *
Release Notes *
**
Release Notes for every iVeri product.
Authorisation Header *** When interfacing with the Gateway endpoints, merchants can include the AuthenticationKey and AuthenticationToken in the headers for both transaction status queries and transaction submissions.
AuthenticationKey*
The key consists of the username. The key and username must be in lowercase
The Username must be encoded to base64 i.e bWVyY2hhbnRwcm9maWxlPTYxNjk1NA
AuthenticationToken*
The token consists of:
AuthenticationSecret *
This is the secret key generated by the merchant within Backoffice, which the merchant has to store on the merchant’s system.Once the secret is generated, it remains readable in plain text for a couple of minutes, after which it is hashed. Merchant must copy the secret immediately after the secret is generated.
If the merchant loses their secr
Endpoint Overview *
**
EndPoint
Purpose
Usage
/api/transactions
HTTP Method: * POST
Submit transactions to iVeri
Gateway endpoint
card processing of
transactions to the Gateway
/api/merchant/authenticate *
HTTP Method: GET
*
Returns the server UTC datetime
formatted as “yyyyMMddHHmmssfff ' *
/api/merchant/configuration?mode=live|test *
HTTP Method: GET *
Returns the user parameters configured in the BackOffice
website.
Mode is optional. When not specified “live” configuration will
be returned?
*
Usage * : Optional, and only
applicable to mPress Card Present transactions
/api/merchant/bins *
HTTP Method: GET *
Returns the current
bin list used by the gateway in determining whether to prompt for PIN entry
on POS devices when the card service code incorrectly identifies this
requiremen
* REST Endpoints *
**
On all endpoints the following applies:
Method: Only GET, POST methods are supported Format: JSON
Submission of transactions to the correct Gateway endpoint relates to the acquiring bank that holds the merchant agreement. To submit transactions to the iVeri Gateway, merchants can connect to following end points.
*Nedbank Merchants:* None [1] https://portal.nedsecure.co.za/ *CSC acquiring bank merchants* None [2] https://portal.cscacquiring.com/ *CBZ Bank merchants:* https:// None [3] portal.host.iveri.com/ *I&M Bank merchants:* https:// None [4] portal.host.iveri.com/ *CIM Merchants* None [5] https://portal.merchant.cim.mu
[1] https://portal.nedsecure.co.za/
[2] https://portal.cscacquiring.com/
[3] https://portal.host.iveri.com/
[4] https://portal.host.iveri.com/
Getting Started *
With the REST API, merchants can enable card acceptance from a card not present or card present environment, where payments can include the use of tokenised cards and 3D secure [1] authenticated data elements.
To begin processing transactions to the iVeri Gateway, the following has to be in place:
Merchant Profile Generate Certificate in Backoffice [2] Only the certificate ID is required on transaction request to the iVeri Gateway Before use, the certificate ID has to be linked to the merchants application on the Gateway, reach out to iVeri support on assist@iveri.com [3] to action
To get a view of the applicable parameters per payment instruction, the following sections can be referenced
Commands and Action
Payment Flow
Parameter Description
Parameter Per Action
REST Endpoints *
**
• Only one REST endpoint exists on the Indigo server and it will be at http://ipaddress/rest/transaction/transact or https://ipaddress/rest/transaction/transact where ipaddress is the local or external ip address or dns of the Indigo server as appropriate. Note that only TLS1.2 or above should be used.
• Only POST method is supported, and the data submitted must be in JSON format.
• The response from the Indigo server will also be in JSON format
• In the request header set request.Accept = "application/json";
• in the request header set request.ContentType = "application/json";
The design of this interface is to use synchronous REST calls to perform either an “Authorisation”, “Debit” or “Credit” which leads to a potential problem in the event that a card is not presente
Result Parameters *
*
Parameter
Node Type
Data Type
Min Length
Max Length
Description
Code
Attribute
N
3
The numeric Result Code of the completed execution. See section 10.1
Description
Attribute
String
1024
A description of the results of the completed execution. Only relevant where ResultStatus is 'Unsuccessful' [-1] or 'Successful with warning' [1]
Source
Attribute
String
138
The source of the result
Previous
Attribute
Boolean
In most cases returns false, indicating that the other result values refer to the immediately completed execution. For advanced usage within a Reprint, to indicate whether the result returned refers to the current execution, or a previous execution.
Status
Attribute
Z
2
The status of the completed execution
-1
Unsuccessful
0
Successful
1
Successful, with warning