Integration Guide, Preparation, Workflow, and API Reference.
This is a documentation for the GIDX Platform API, a service within the GIDX Platform Solution set of the GIDX Platform.
This set of documents serves as the integration guide for implementing services of the GIDX Platform API within the operator’s environment. The following pages outline the GIDX Platform API access points, security, methods, and parameters. As always, please contact us at devteam@tsevo.com any time if further explanation is needed.
The following API Reference documents provide all of the instructions for connecting to and successfully using the GIDX Platform services.
The individual or patron who the merchant will use the GIDX platform in order manage the payment process.
MerchantA specific e-commerce site, platform, or brand with which customers are processed through the payment management services within the GIDX platform. By tracking activity at a merchant level the GIDX platform is able to dynamically adapt to the individual merchant compliance and risk environment. Each merchant will be assigned a unique id that will be provided to the operator.
OperatorThe legal entity that is the GIDX platform service agreement account holder and integration manager on behalf of one or more merchants so that the operator and merchant platforms can be configured and integrated to utilize the GIDX platform. In most cases the operator is the legal owner of the merchant or contractually manages the operations of the merchant.
SessionA session is the interactive process between the merchant and GIDX platform. The GIDX Pay Management API requires that the merchant uniquely identifies each session by supplying the GIDX service with a unique session id for each session. The GIDX service will timeout an inactive session after a set period of time, usually a few minutes. The expiration time is configurable at both an operator and merchant level.
The GIDX Platform API Services are implemented as a REST API service and is accessed via GET and POST methods using the HTTPS protocol. GET Method Request should be formated as QueryStrings and POST Method Request should be formated as JSON. All Method, Callback, and Notification Responses are returned in JSON format. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.
To make the API as explorable as possible, accounts have test mode and live mode Security Credentials keys. There is no "switch" for changing between modes, just use the appropriate Credentials to perform a live or test transaction. Requests made with test mode credentials never hit the banking networks.
Accessing the GIDX Platform APIAs part of your Merchant On-boarding process you will receive a security packet containing the end point URL, version number for your implementation, and the specific security credentials assigned to your account. The URL provided in this documentation may not be the one assigned to your account and may not result in valid connectivity.
In order to access the GIDX Platform environment you will need to obtain your security keys; you can find this set of keys within the "Integration" section of the GIDX Portal located at GIDX Environment Portal.
Access to the GIDX Platform API occurs over a secure channel (128-bit SSL encryption) and is only accessible by registered merchants. The security features of the API are as follows:
SSL Required (128-bit)The GIDX Platform API only accepts connections using 128-bit SSL encryption. Connections attempted "in the clear" or with SSL that is less than 128-bits are rejected.
IP Address Restrictions (whitelist)The GIDX Platform API only accepts connections from a registered set of IP addresses. As part of the GIDX Platform process, you will need to provide the IP addresses or address ranges you will be using both for testing and for the live environment.
Unique Merchant ID and API KeyEach Merchant Account will be assigned a unique set of IDs associated with the account and to establish integration types associated with any license or compliance requirements that the account may have. Please see sample code below and to the right of each method request for examples on how to properly use the Account API Key and Merchant Integration IDs.
ISO 3166-1 is part of the ISO 3166 standard published by the International Organization for Standardization (ISO), and defines codes for the names of countries, dependent territories, and special areas of geographical interest.
http://en.wikipedia.org/wiki/ISO_3166-1
ISO 3166-2:US is the entry for the United States in ISO 3166-2, part of the ISO 3166 standard published by the International Organization for Standardization (ISO), which defines codes for the names of the principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1.
http://en.wikipedia.org/wiki/ISO_3166-2:US
ISO 4217 is a standard first published by International Organization for Standardization in 1978, which delineates currency designators, country codes (alpha and numeric), and references to minor units.
https://en.wikipedia.org/wiki/ISO_4217
For the latest list of Reason Codes and their description please go to the following URL.
View Reason Codes