TRtrytoku
Beneficiary Accounts

Listar verificaciones de Beneficiary Accounts por lote

Changed on

Lista el resultado de la verificación bancaria de todas las Beneficiary Accounts cuyo Beneficiary fue creado en un mismo lote.

El identificador de lote es el id_beneficiary_batch que devuelve la creación masiva de Beneficiaries, de modo que esta operación permite seguir el avance de una carga completa sin consultar cuenta por cuenta. Cada elemento informa el estado de la verificación y, cuando corresponde, la razón por la que quedó inválida.

La respuesta viene paginada mediante page y limit, e incluye el total de verificaciones del lote en total_count.

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

get/payouts-beneficiary/beneficiary-account/by-batch/{id_beneficiary_batch}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payouts-beneficiary/beneficiary-account/by-batch/{id_beneficiary_batch}
  • Auth
    API key in header x-api-key

Path parameters

id_beneficiary_batchstring uuid required

Identificador del lote devuelto por la creación masiva de Beneficiaries.

Query parameters

pageinteger

Número de página que se quiere obtener; la primera es la 1.

limitinteger

Cantidad máxima de elementos por página.

Response

Página de verificaciones del lote, con el total de verificaciones.

total_countinteger

Total de verificaciones del lote, no solo las de esta página.

Example response

{
  "total_count": 42,
  "verifications": [
    {
      "account_number": "002010077777777771",
      "beneficiary_account_external_id": "CTA-000123",
      "beneficiary_external_id": "PROV-000123",
      "beneficiary_name": "Comercializadora Andina",
      "id_beneficiary": "8c1d5e02-47ab-4f39-9d6c-2b0a7f4e1c83",
      "id_beneficiary_account": "3f2a1c64-9b0e-4d7a-8f21-5c6b7e8d9a01",
      "invalid_reason": "DOCUMENT_MISMATCH",
      "tokenized_account_number": "tok_5f3a90c17be24d8ab6c0e1f27d4a8395"
    }
  ]
}

Changes