TRtrytoku
Beneficiaries

Listar Beneficiary Accounts de un Beneficiary

Changed on

Lista las Beneficiary Accounts asociadas a un Beneficiary, identificado por su external_id.

Devuelve, por cada cuenta, sus datos bancarios, el estado de su verificación y el estado agregado de su flujo de aprobación. Es la vista que permite saber cuáles de las cuentas de un destinatario ya están habilitadas para recibir un pago.

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

get/payouts-beneficiary/{beneficiary_external_id}/accounts

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payouts-beneficiary/{beneficiary_external_id}/accounts
  • Auth
    API key in header x-api-key

Path parameters

beneficiary_external_idstring required

Identificador del Beneficiary en el sistema de origen (external_id).

Response

Beneficiary Accounts del Beneficiary consultado.

approval_flows_status'INITIALIZING' | 'APPROVED' | 'REJECTED' | 'PENDING' | 'SKIPPED' required

Aggregated approval status for a BeneficiaryAccount.

INITIALIZING is a transient state set at creation time. Downstream consumers must treat INITIALIZING as blocking (same gating as PENDING/REJECTED).

currency_codestring required

Moneda de la cuenta, en formato ISO.

external_idstring nullable required

Identificador de la cuenta en el sistema de origen.

gateway_referencesobject

Identificador que la cuenta ya tiene en cada pasarela de pago, con el nombre de la pasarela como clave. Una cuenta de efectivo recibe el de OXXO Pay al darse de alta, y no se le puede pagar mientras no lo tenga. Viene vacío en una cuenta bancaria.

id_beneficiary_accountstring uuid required

Identificador de la Beneficiary Account.

Example response

[
  {
    "currency_code": "MXN",
    "details": {
      "account_number": "002010077777777771",
      "bank_code": "002",
      "tokenized_account_number": "tok_5f3a90c17be24d8ab6c0e1f27d4a8395"
    },
    "external_id": "CTA-000123",
    "gateway_references": {
      "OXXO_PAY": "cus_2NYbDRXiuHGSwZtvE"
    },
    "id_beneficiary_account": "3f2a1c64-9b0e-4d7a-8f21-5c6b7e8d9a01",
    "verification": {
      "invalid_reason": "DOCUMENT_MISMATCH"
    }
  }
]

Changes