Customer Information

This API allows clients to retrieve customer information, including wallets , balance , and exchange rates

Endpoint

• URL: /customer/info

• Method: GET

Request Parameters

• No request parameters are required.

• The customer's information is retrieved based on the provided authentication token.

Success Response

• Code: 200 OK

• Content:

{
    "message": "No Message",
    "data": {
        "uid": "string",
        "name": "string",
        "wallet": {
            ["CurrencyCode"]: //example EUR {
                "balance": 0,
                "frozenBalance": 0,
                "creditBalance": 0
            }
            // Additional currencies can be listed here
        },
        "retailCurrency": "CurrencyCode", // example IRT
        "exchangeRates": [
            {
                "targetCurrency": "string",
                "rate": 0.0,
                "modifiedDate": {
                    "_seconds": 0,
                    "_nanoseconds": 0
                },
                "baseCurrency": "string"
            }
            // Additional rates can be listed here
        ]
    }
}

Fields Explanation

• message: A message related to the API response, if any.

• data: Contains the customer's detailed information.

  • uid: Unique identifier for the customer.

  • name: Name of the customer.

  • retailCurrency: The currency in which the retail invoice is generated

  • wallet: An object containing the customer's wallet information, indexed by currency code.

    • balance: Available balance.

    • frozenBalance: Balance that is frozen and not currently available for use.

    • creditBalance: Balance available as credit.

  • exchangeRates: An array of exchange rates available to the customer.

    • baseCurrency: The currency from which conversion starts.

    • targetCurrency: The currency into which conversion is done.

    • rate: The exchange rate applied to the currency conversion.

    • modifiedDate: The last modification date of the exchange deal, represented in seconds and nanoseconds.

  • Notes

    • The wallet object may contain multiple currency codes based on your existing wallet on Gifthub core, each with its own balance details.

    • The exchangeRates array may include multiple deals, each with its own base currency, target currency, and rate.