-
Introduction
-
Commands & Actions
-
Transaction Sequence
-
MasterPass
-
Visa Checkout
-
Foreign Exchange
-
Parameter Description & Action
-
Gateway Domain Knowledge
-
Transaction Result Codes
-
Out Of Band
-
Payment Facilitator
-
Tokenization
-
SOAP API
-
Pos Device Intergration
-
Acquire Contact Information
-
3D Secure
-
Enterprise API Samples
-
Card on File
-
Additional Data Transactions
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 authenticated data elements.
To begin processing transactions to the iVeri Gateway, the following has to be in place:
- Merchant Profile
- Generate Certificate in Backoffice
- 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 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
On all REST endpoints the following applies:
- Content Type: application/JSON
- Only GET & POST methods are supported
Gateway endpoints for submitting transactions by acquiring bank:
Nedbank Merchants: https://portal.nedsecure.co.za/
iVeri PSP Merchants: https://portal.iveri.co.za/
CSC acquiring bank merchants: https://portal.cscacquiring.com/
CBZ Bank merchants: https://portal.host.iveri.com/
I&M Bank merchants: https://portal.host.iveri.com/
CIM Merchants: https://portal.merchant.cim.mu/
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 |
Authentication returns the server UTC datetime formatted as “yyyyMMddHHmmssfff' |
|
|
/api/merchant/configuration?mode=live|test HTTP Method: GET |
Returns the user parameter configuration in Backoffice. 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 requirement. |
Usage: card present scenarios |
|
/api/transactions?applicationid={applicationid} HTTP Method: GET |
Returns the application transaction history for the last 7 days |
Optional, but can be used to fetch any transactions processed by the Gateway |
|
/api/transactions/{requestid} HTTP Method: GET |
Returns transaction details for a particular transaction identified by the requestid |
|
|
/api/transactions/{requestid}/receipt HTTP Method: POST |
Upload cardholder digital signature to the iVeri Gateway |
Only applicable in the mPress, mPos Card Present solution |
|
|
|
|