---
updatedAt: 2026-03-24T22:29:34.000Z
agentTools:
  projectIndex: https://developers.digitalfemsa.io/llms.txt
---

# Get a company's balance

Retrieves the current balance information for the authenticated company.

Monetary fields are returned as arrays of amounts grouped by currency.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "contact": {
      "email": "engineering@femsa.com",
      "name": "Engineering Femsa",
      "url": "https://github.com/digitalfemsa/openapi/issues"
    },
    "description": "Femsa sdk",
    "license": {
      "name": "MIT-LICENSE",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Femsa API",
    "version": "2.1.0"
  },
  "servers": [
    {
      "description": "Femsa main server",
      "url": "https://api.digitalfemsa.io"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/balance": {
      "get": {
        "description": "Retrieves the current balance information for the authenticated company.\n\nMonetary fields are returned as arrays of amounts grouped by currency.\n",
        "operationId": "getBalance",
        "parameters": [
          {
            "description": "Use for knowing which language to use",
            "examples": {
              "es": {
                "summary": "for spanish request/response",
                "value": "es"
              },
              "en": {
                "summary": "for english request/response",
                "value": "en"
              }
            },
            "in": "header",
            "name": "Accept-Language",
            "required": false,
            "schema": {
              "default": "es",
              "enum": [
                "es",
                "en"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/balance_response"
                }
              }
            },
            "description": "successful operation"
          },
          "401": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "Please include your access key in your request.",
                      "param": null,
                      "code": "femsa.errors.authentication.missing_key"
                    }
                  ],
                  "log_id": "507f1f77bcf86cd799439011",
                  "object": "error",
                  "type": "authentication_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "authentication error"
          },
          "402": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "The order could not be processed.",
                      "code": "femsa.errors.processing.order.used",
                      "debug_message": "The order has already been used."
                    }
                  ],
                  "log_id": "641b6d073cd9a50001515007",
                  "object": "error",
                  "type": "processing_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "payment required error"
          },
          "422": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "The name does not exist.",
                      "param": "payment_method.name",
                      "code": "femsa.errors.parameter_validation.payment_method.name.nonexistent_token",
                      "debug_message": "The name does not exist."
                    }
                  ],
                  "log_id": "641b6d813cd9a50001515017",
                  "object": "error",
                  "type": "parameter_validation_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "parameter validation error"
          },
          "500": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "debug_message": "There was a runtime error and Femsa engineers have been notified.",
                      "message": "There was a runtime error and Femsa engineers have been notified.",
                      "param": null,
                      "code": "femsa.errors.api.system.general_failure"
                    }
                  ],
                  "object": "error",
                  "type": "api_error",
                  "log_id": "641b6f2b3cd9a50001515098"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get a company's balance",
        "tags": [
          "Balances"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "error": {
        "allOf": [
          {
            "$ref": "#/components/schemas/details"
          },
          {
            "properties": {
              "log_id": {
                "description": "log id",
                "example": "507f1f77bcf86cd799439011",
                "nullable": true,
                "type": "string"
              },
              "type": {
                "example": "authentication_error",
                "type": "string"
              },
              "object": {
                "example": "error",
                "type": "string"
              }
            },
            "type": "object"
          }
        ],
        "description": "err model",
        "title": "error"
      },
      "balance_response": {
        "description": "Company balance summary.\n\nMonetary fields are returned as arrays of amounts grouped by currency (see `balance_common_field` items).\n",
        "properties": {
          "available": {
            "description": "Amounts currently available, grouped by currency.",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "cashout_retention_amount": {
            "description": "The balance's cashout retention amount",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "conekta_retention": {
            "description": "The balance's Femsa retention",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "gateway": {
            "description": "Gateway balance amounts, grouped by currency.",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "pending": {
            "description": "Amounts pending settlement, grouped by currency.",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "retained": {
            "description": "Amounts currently retained, grouped by currency.",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "retention_amount": {
            "description": "Retention amount applied, grouped by currency.",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "target_collateral_amount": {
            "description": "Target collateral amount, grouped by currency.",
            "type": "object"
          },
          "target_retention_amount": {
            "description": "Target retention amount, grouped by currency.",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          },
          "temporarily_retained": {
            "description": "Amounts temporarily retained",
            "items": {
              "$ref": "#/components/schemas/balance_common_field"
            },
            "type": "array"
          }
        },
        "title": "balance_response",
        "type": "object"
      },
      "details": {
        "properties": {
          "details": {
            "items": {
              "$ref": "#/components/schemas/details_error"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "balance_common_field": {
        "description": "balance common fields model",
        "properties": {
          "amount": {
            "description": "The balance's amount",
            "example": 100,
            "format": "int64",
            "type": "integer"
          },
          "currency": {
            "description": "The balance's currency",
            "example": "MXN",
            "type": "string"
          }
        },
        "title": "balance_common_fiels_response",
        "type": "object"
      },
      "details_error": {
        "properties": {
          "code": {
            "example": "femsa.errors.authentication.missing_key",
            "type": "string"
          },
          "param": {
            "nullable": true,
            "type": "string"
          },
          "message": {
            "example": "Acceso no autorizado.",
            "type": "string"
          },
          "debug_message": {
            "example": "Please include your access key in your request.",
            "type": "string"
          }
        },
        "title": "details_error",
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```