TRtrytoku
Payout Request Ingestion

Ingestar Account Payables

Changed on

Crea un Payout Request a partir de las Account Payables enviadas y registra las filas resultantes.

Se usa para cargar cuentas por pagar desde la integración de la organización sin depender del envío de archivos por SFTP. Cada objeto de accounts_payable se valida por separado: los objetos vacíos {} se omiten y no se registran, los que fallan la validación quedan registrados para auditoría, y los válidos quedan listos para procesarse. Por eso una respuesta exitosa puede incluir filas fallidas en ingestion.failed_rows; conviene revisar siempre los conteos de ingestion.results.

El procesamiento posterior es asíncrono: la ingesta responde apenas quedan registradas las filas y el avance de cada una continúa en segundo plano. Si accounts_payable viene vacío no se crea ningún Payout Request y el campo ingestion llega en null.

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

post/payouts-data-ingestion/ingest-payouts-request/on-demand

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payouts-data-ingestion/ingest-payouts-request/on-demand
  • Auth
    API key in header x-api-key

Request body

accounts_payableobject[] required

Filas de Account Payable sin procesar; cada objeto se valida por fila al registrarse (un objeto vacío {} se omite).

agreement_codestring nullable

Convenio con el que se procesa todo el lote; se registra en el Payout Request y lo valida el servicio de payouts.

disbursement_type'IMMEDIATE_TRANSFER' | 'BATCH_FILE' | 'CASHOUT'

Forma en que se desembolsa un lote de payouts. El valor aplica a toda la solicitud de ingesta.

reference_idstring required

Identificador externo de la solicitud de ingesta

Example request

{
  "accounts_payable": [
    {
      "account_number": "987654321",
      "amount": 100,
      "beneficiary_external_id": "benef-ext-001",
      "external_id": "ext-001",
      "id_funding_account": "fund_acc_1",
      "type": "VENDOR_PAYMENT"
    }
  ],
  "agreement_code": "CONV-001",
  "reference_id": "ref-2026-08-01"
}

Response

Resultado de la ingesta del Payout Request

messagestring required

Resumen legible del resultado

Example response

{
  "ingestion": {
    "batch_row_count": 2,
    "failed_rows": [
      {
        "external_id": "ext-002",
        "index": 1,
        "message": "amount: Input should be greater than 0"
      }
    ],
    "id_payout_request": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "results": {
      "valid_count": 2
    }
  },
  "message": "Payout request ingestion initiated successfully."
}

Changes