Receiving balances accounts

Endpoint

  • URL: {{base_url}}/api/external/v1/fiat-gateway/mercuryo/get-balance

  • Method: GET

  • Authentication: Requires valid authentication or API key.

Description

This API endpoint allows you to retrieve the balance from the Mercuryo fiat gateway. It returns the available balance in your Mercuryo account.

Response

A successful response will have the following structure:

{
  "success": true,
  "status": null,
  "response": {
    "balance": "5"
  },
  "errors": null
}
  • success (boolean): Indicates whether the request was successful.

  • status (null): If applicable, a status message (null in this case).

  • response (object): Contains the retrieved balance.

    • balance (string): The available balance in your Mercuryo account.

Errors

In case of an error, the response may contain relevant error messages.

Example Usage

Request

GET {{base_url}}/api/external/v1/fiat-gateway/mercuryo/get-balance

Response

{
  "success": true,
  "status": null,
  "response": {
    "balance": "5"
  },
  "errors": null
}

Authentication

To use this endpoint, you need to include the appropriate authentication or API key as required by your integration.

Last updated