Balances

Get a company's balance

get/balance

Request

Base URL
https://api.conekta.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/conekta/apis/conekta-api/docs/balance/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Response

successful

target_collateral_amountobject

The balance's target collateral amount

Example response

{
  "available": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "cashout_retention_amount": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "conekta_retention": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "gateway": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "pending": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "retained": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "retention_amount": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "target_retention_amount": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ],
  "temporarily_retained": [
    {
      "amount": 100,
      "currency": "MXN"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.