Loading...
The OpenEdge Mobile SDK allows OpenEdge partners to develop mobile payment-processing applications, built around the OpenEdge Mobile SDK. Integrators have the freedom to design their own User Interface and transactions while using the OpenEdge Mobile SDK to handle payment authentication and processing. This solution simplifies the integration process by not requiring merchants to download, install, and run two separate applications, as has been true with previous mobile solutions.
| When Calling out to the Device | 1. Get the setupController Instance 2. Register Callback to listen to transaction events 3. Use GetAvailableDevices to obtain the device’s MAC address 4. Generate a AuthToken 5. Build a JSON request with required HTTP headers and any additional fields 6. Listen to intermediate response data that is sent 7. Parse the response to get the transaction status and build a receipt 8. Send releaseResource |
| When not Collecting Card Data | 1. Get the setupController Instance 2. Gather Alias/reference_id for the request 3. Generate a AuthToken 4. Build a JSON request with required HTTP headers and any additional fields 5. Parse the response to get the transaction status and build a receipt 6. Send releaseResource |
Every request to our gateway requires a set of headers and additional identifying information to set up and process transactions. These are detailed below.
Each request requires setting certain headers required for processing transactions. Include the following data elements in the header of your JSON request to our gateway. We use these to authenticate your request.
| Parameter | Description | Format |
|---|---|---|
| X-GP-API-Key | Partner level credential. Sent in the header of every gateway request | afmuKXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| Authorization | Partner level credential. Used when generating the AuthToken | "AuthToken x.y.z" |
| X-GP-Environment | Explicit flags to indicate which environment is being called. Acceptable values include: - “pit” -Partner Integration Test environment - “prod” -Production environment | "XXX" or "XXXX" |
| X-GP-Request-Id | Custom value generated and sent from integrating application. Value is a GUID prefixed with "MER-" | MER-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
Credentials
| Parameter | Description | Format | Max Length |
|---|---|---|---|
| account_credential | Merchant level credential. Used when generating the AuthToken | 8000000XXXXX:800XXXXX:6teY5XXXXXXXXXXXXXXXXXXXXXXXXXXXX | |
| X-GP-API-Key | Partner level credential. Sent in the header of every gateway request | afmuKXXXXXXXXXXXXXXXXXXXXXXXXXXX | |
| API Secret | Partner level credential. Used when generating the AuthToken | D91qPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
AuthToken is a secure custom JWT token used for transaction authentication by the platform. Integrating partners will also receive an API Secret associated with the API Key. This API Secret should be used to generate the AuthToken.
The authorization header in the request should be as follows:
Where ‘x.y.z’ is an AuthToken JWT. Refer to the AuthToken Documentation below for information on generating the required AuthToken.
AuthToken Documentation
