This is a documentation for the WebCashier API, a service within the Payment Management 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 Customer Insight access points, security, methods, and parameters. As always, please contact us at devteam@tsevo.com any time if further explanation is needed.
An official SDK for the GIDX Platform API is available at GitHub.com and via NuGet (GIDX.SDK) located at the URL below. This SDK can be installed directly into your C# project using the NuGet Package Manager.
SDK LocationBelow are descriptions of the methods exposed by the GIDX Platform WebCashier Service. For details about the parameters associated with these methods please see the Class Reference section below.
The following parameters are used in every WebCashier Method Request and Responses. They are labeled within the methods below as Standardized Request Parameters and Standardized Response Parameters.
Making a Request
Each API method has a corresponding Request object used to transport the request parameters as shown below.
Using the Response
Each Response object returned from the method Request will contain properties you can use to determine the status of the methods service.
Use the IsSuccess property along with the ResponseCode and ResponseMessage values to detect if the Request completed without a problem.
4QhgWWJxRlqVctrc7SxHEQ
VpGYLoXhSS+WgU9N415IJQ
Fc+k5kRDSAOrh38e21vt0w
m+2XHlcIR0O1C+iBeNzfvA
VV4XTc3tRi6g1EYLOazn0g
xHhSS+WglqVctrc7-t7SEQrc
4QhgWWJxRlqVctrc7SxHEQ
v3.0
VpGYLoXhSS+WgU9N415IJQ
xHhSS+WglqVctrc7-t7SEQrc
0
No Errors
This method should be called to create a new Cashier Web Session within the GIDX system for payments.
ABC-123
66.249.76.138
1113201405343
1113201405343_1
Default value is PAY
True
MONTHLY
2021-09-07
CashierPaymentAmount Object
CustomerRegistration Object
["NFL-HOU", "NFL-ATL"]
https://yourserver.com/GidxCallback
NOTE For Payouts: The "CustomerAmountOverride" feature is based on the merchant’s settings and must be pre-approved in order for this portion of the service to be available. When this feature is active it will allow the customer to adjust the amount of the Payout. This Payout amount will be limited (in maximum) to the amount that is provided within the CashierPaymentAmount / PaymentAmount value. The PaymentAmountOverride must also be set to "True" for this process to be enabled.
['DFP-HR','ID-EX']
xHhSS+WglqVctrc7-t7SEQrc
See Example
5/30/2017 4:57:06
This method should be called to create a new Cashier Web Session within the GIDX system for payments.
Receiving callbacks from a GIDX Web Session service to your registered callback URL for the CreateSession Method.
Once the customer's session with the GIDX Web Registration service is complete a callback will be made to the registered callback URL for you.
The callback will consist of a HTML form post with one field named "result" which contains the JSON status of the customer's session.
An examples of the returned JSON within a Callback is on the right side of this page.
0
No Errors
xHhSS+WglqVctrc7-t7SEQrc
['DFP-HR','ID-EX']
xHhSS+WglqVctrc7-t7SEQrc
98.5
1113201405343_1
Pending
NOTE: If the customer is required to verify their identity status then a Callback for Customer Identity Verification (WebReg) will be provided as well as the WebCashier Callback.
This method may be called at any time by the merchant to retrieve the status of the Web Session process based on the merchant's unique session id provided in the CreateSession method call.
xHhSS+WglqVctrc7-t7SEQrc
[“LL-GEO-US-NV”,“ID-VERIFIED”,“ID-EX”]
Once the WebCashier has been successfully completed the merchant may call this method to retrieve the full transaction details for the payment.
1113201405343_1
1113201405343_1
Array of PaymentDetails Objects
92.3
[“LL-GEO-US-NV”,“ID-VERIFIED”,“ID-EX”]
Update the status of a payment. Currently only available to cancel recurring payments.
1113201405343_1
1113201405343_1
Array of PaymentDetails Objects
This method may be called to begin a new web cashier session to allow customers to review payment transaction receipts and manage payment options but not to create a new payment transaction.
The Web Wallet allows a registered customer to view transaction history, transaction details, a list of payment methods that are registered to their virtual wallet, and the management tools needed for their registered payment methods.
ABC-123
66.249.76.138
xHhSS+WglqVctrc7-t7SEQrc
See Example
5/30/2017 4:57:06
Other Identity & Location Methods are located in the CustomerIdentity API located at the endpoint below.
You can view the details of these additional Customer Identity related methods by clicking on the links below.
The Object documented below are returned within the Response of Method Request within the GIDX Platform WebCashier Services. When applicable an Object may be shared by among other Method Responses as indicated in the listings below.
Objects are always returned in JSON format.
This object contains the detailed data of a transaction that has taken place within the WebCashier CreateSession Request.
101.08
True
MM/DD/YYYY hh:mm:ss (UTC)
MM/DD/YYYY hh:mm:ss (UTC)
MM/DD/YYYY hh:mm:ss (UTC)
MM/DD/YYYY hh:mm:ss (UTC)
96.2
This object provides an override feature for the Cashier Amount and the Bonus information.
200.00
True
50.00
True
New Customer Bonus!
MM/DD/YYYY hh:mm:ss (UTC)
This object allows for customer identity information to be passed into the CreateSession WebCashier method for identity verification.
Note
Several of the parameters within this object are duplicate values from the parent method "CreateSession". In these instances the parameter value supplied in this CustomerRegistration object must match the parameter values of the parent method.
ABC-123
66.249.76.138
(Dr., Mr., Mrs., etc.)
John
Michael
Doe
(Sr., Jr., etc.)
Dr. John Michael Doe Jr.
04/03/1984 (In MM/DD/YYYY Format)
johndoe@msn.com
444-12-1234
(999) 834-5813
5940 Main St.
Suite A
Las Vegas
77587
This object should contain the location data derived from the Devices GPS information.
For more information on collecting this data from the Device please click here to see the table below for both iOS and Android.
| Device GPS Property | Class | Property | Declaration |
|---|---|---|---|
| Latitude & Longitude | CLLocation | coordinate | CLLocationCoordinate2D |
| latitude | CLLLocationDegrees | ||
| longitude | CLLLocationDegrees | ||
| Radius | CLLocation | horizontalAccuracy | CLLocationAccuracy |
| Altitude | CLLocation | altitude | CLLocationDistance |
| Speed | CLLocation | speed | CLLocationSpeed |
| DateTime | CLLocation | timestamp | NSDate |
| Device GPS Property | Class | Property |
|---|---|---|
| Latitude | Location | getLatitude() |
| Longitude | Location | getLongitude() |
| Radius | Location | getAccuracy() |
| Altitude | Location | getAltitude() |
| Speed | Location | getSpeed() |
| DateTime | Location | getTime() |
| The DateTime in Android is a "ticks" and needs to be converted to the dateTime format MM/DD/YYYY HH:MM:SS.000 | ||
36.169727
-115.141801
600.999
22.9871
45.999
10/01/2013 12:42:15 GMT
The information documented below provides clarification of the codes used within the GIDX Platform WebCashier Services.
The PaymentStatusCode will be provided when a GIDX service is updating you about a transaction WebCashier Callback and/or the PaymentDetails method is being called because details/status of the transaction is needed.
In most instances, the PaymentStatus of Pending, Complete, or Failed will be provided, for example...
The following PaymentStatus are less common and have specific caveats to their inclusion, for example...
The PayActionCode has the following rules for usage...
When the PayActionCode value equals "PAYOUT" the PaymentAmount value located in the CashierPaymentAmount object must be a valid Payout amount. Also, when the PayActionCode is set as PAYOUT the following variables are ignored: BonusAmount, BonusAmountOverride, BonusDetails, BonusExpirationDateTime.
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
The ISO 4217 code list is used in banking and business globally. In many countries the ISO codes for the more common currencies are so well known publicly that exchange rates published in newspapers or posted in banks use only these to delineate the different currencies, instead of translated currency names or ambiguous currency symbols.
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