TRtrytoku
Funding Account

Obtener saldo de Funding Account

Changed on

Devuelve el saldo disponible de una Funding Account de la organización, consultado en el gateway que la opera.

Se usa para verificar que hay fondos antes de ejecutar payouts. La cuenta se elige con id_funding_account; una organización con una sola Funding Account puede omitirlo y se consulta esa. Con más de una el parámetro es obligatorio: el saldo decide si se dispersa, así que no se elige una cuenta por posición. El saldo se lee por el primer gateway activo de la cuenta. El número de cuenta se devuelve enmascarado: solo quedan visibles sus últimos cuatro caracteres.

La organización consultada es siempre la que el gateway autentica, no una que se pueda elegir en la petición.

Responde 422 cuando la organización no tiene Funding Accounts, cuando tiene más de una y la petición no indica id_funding_account, cuando ninguno de los gateways de la cuenta está activo, o cuando el gateway consultado exige el tax_id de la organización y no está registrado.

Límite de tasa: 1000 solicitudes por hora. Al superarlo, la API responde 429. Ver Límites de tasa.

get/payouts-configuration/funding-account/balance

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payouts-configuration/funding-account/balance
  • Auth
    API key in header x-api-key

Query parameters

id_funding_accountstring uuid nullable

Funding Account cuyo saldo se consulta. Se puede omitir solo cuando la organización tiene una sola cuenta vigente

Example:39e0f293-929d-4c8a-8a7f-1c9c01078fcb

Response

Saldo de la Funding Account de la organización.

account_numberstring required

Número de cuenta enmascarado de la Funding Account con que se hizo la consulta (solo quedan visibles los últimos cuatro caracteres).

balancestring required

Saldo disponible que informa el gateway.

currency_codestring required

Código de moneda de la Funding Account con que se hizo la consulta.

gatewaystring required

Gateway con que se obtuvo el saldo (actualmente, el primer gateway habilitado de la organización).

id_funding_accountstring required

Funding Account con que se consultó el saldo (actualmente, la primera configurada en la organización).

organization_idstring required

Identificador de la organización para la que se consultó el saldo.

Example response

{
  "account_number": "*********9999",
  "balance": "98765.43",
  "currency_code": "MXN",
  "gateway": "STP",
  "id_funding_account": "39e0f293-929d-4c8a-8a7f-1c9c01078fcb",
  "organization_id": "org_pBf2NL0d0gvBM7Ei_1E3HIWnTN4W93_O"
}

Changes