Developer Reference Docs

Transactions APIs allow you to perform the activities related to transactions operations.

The Transactions - Process APIs' end points and their functionalities are given below:

iCG Authentication Service

iCG APIs are secured by OAuth 2.0 ROPC grant type. The external application must obtain user authorization before it executes an endpoint call incase this API chooses to use OAuth 2.0 ROPC Grant. This authorization includes the following steps:

• You must first exchange the user's credentials for an access token.
• The access token is an object containing information for authorizing client requests and refreshing the token itself.

The end-to-end authorization request is represented in the below diagram.

sequenceDiagram
    participant Merchant
    participant ICG (token URL)
    autonumber
    Merchant ->>ICG (token URL): Client ID, username, password
    ICG (token URL)->>Merchant: id_token, access token, refresh token

The above step is to generate access token using the iCG provided Client id and with Merchant's user credentials.

Key Request Parameters

Once you receive the Client ID, and the user credentials, the next step is call the OAuth 2.0 ROPC endpoint to generate the access token.

Sample cURL Request

curl -X POST \

--url 'https://auth.icheckdev.com/Login' \

--header 'Accept: application/json' \

--data 'grant_type=password' \

--data 'username={USERNAME}' \

--data 'password={PASSWORD}' \

--data 'client_id={iCG APPLICATION AUDIENCE ID}' \

 On receiving the requests, iCG Authorization system validates all the parameters in the request and, if the request pass through the validation process, then it will generate your access token and return it in the response.

Sample Response Body

{
"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJjNjFhY2JhYy02NjA4LTQ3Y2YtYWIxOS0wZWQ2YmY3NTI5MTciLCJ1bmlxdWVfbmFtZSI6IlN1c2VlbGEiLCJlbmNyeXB0ZWRfZW1haWwiOiJGcGJnZ1RqbTNkbXl2cFlWVlVZNnJzcHBDKzcweFIwWGoyeTR1Mm8rc1ZRPSIsInR5cGUiOiIiLCJpc3MiOiJodHRwczovL2F1dGguaWNoZWNrZGV2LmNvbS8iLCJhdWQiOiJmMWZhN2ZmZi05MmU0LTQxMzMtOGQxMC0zNjg2OGM0OTg3YWQiLCJleHAiOjE3MDQ5MDY1MjAsIm5iZiI6MTcwNDgyMDEyMH0.Q03E-HrXto9CBzHcC43qn2wZG5VpUV4hzIfcCuRGWu4"
"token_type":"bearer"
"expires_in":86399
}

The response parameters and their descriptions are:

Note

The user can find the details to generate token in iCG Authorization API section.

Request Body Parameters

 Sample cURL

curl --location 'https://process.icheckdev.com/process' \
--header 'SiteId: EEJT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiNGZiMDA3NWFiZWIxNDI1YzkxMWY4MmRhYTExZGY2MzYiLCJleHAiOjE3MTE2MjM4NDMsIm5iZiI6MTcxMTUzNzQ0M30.tqN5rQgEJOw3iaukFXC65HS0j67WXd3nxBaZuYzcWm0' \
--data-raw '{
    "Amount": 1,
    "Type": "D",
    "Description": "",
    "SaveCustomer": false,
    "Customer": {
        "Number": "F74E14A35828411",
        "FirstName": "BURCU",
        "LastName": "BOLEK",
        "Company": "icg",
        "Email": "bbolek@icheckgateway.com",
        "Phone": "1231231231",
        "Addresses": [
            {
                "Type": "B",
                "Address1": "ADDRESS",
                "Address2": "",
                "City": "city",
                "State": "AZ",
                "ZipCode": "12333",
                "Country": "USA"
            }
        ]
    },
    "Method": {
        "Card": {
            "Number": "4111111111111111",
            "ExpDate": "0125",
            "CvcCode": "123",
            "PaymentType": "Credit",
            "EntryMode": "Keyed"
        }
    },
    "IMetaData": []
}'

Sample Response

{
    "transactionAmount": 1.0,
    "transactionDate": "2024-03-27T06:05:49",
    "rawRequest": null,
    "rawResponse": null,
    "status": "A",
    "statusMessage": "Approved",
    "confirmationCode": "EEJTADAE3D77030A",
    "approvalCode": "502402",
    "cvcResponse": "",
    "avsResponse": "",
    "cardDisplay": null,
    "cardType": "Visa",
    "arpc": null,
    "errorData": null,
    "issuerScript": null,
    "issuerScript2": null,
    "applicationId": null,
    "referenceNumber": "327110549",
    "extraData": null,
    "transactionId": 0
}

Process Reversal

In this endpoint request, a new instance that creates a reversal of a transaction.

Key Request Parameter