TRtrytoku
Payout Request Items

Listar Payout Request Items

Changed on

Devuelve los conteos por estado y el detalle fila a fila de un Payout Request ingestado.

Se usa para hacer seguimiento de una carga: summary entrega cuántos items quedaron en SUCCESS, FAILED y PREPARING, e items entrega una entrada por fila con su external_id, su estado y, cuando falló, el motivo en failure_reason.

Cada entrada incluye además el detalle del payout que se guardó cuando el lote terminó de ejecutarse: id_payout, amount, description, due_date, expire_at, voucher_url, is_fraud, source_reference, beneficiary y beneficiary_account. Esos campos llegan en null mientras el lote no termina y en las filas que nunca llegaron a generar un payout.

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

get/payouts-data-ingestion/payout-request-items/{id_payout_request}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payouts-data-ingestion/payout-request-items/{id_payout_request}
  • Auth
    API key in header x-api-key

Path parameters

id_payout_requeststring uuid required

Identificador del Payout Request cuyas filas ingestadas se quieren consultar

Example:6f1d0f5e-6b1a-4f2e-9a0c-2f3b4c5d6e7f

Response

Conteos y detalle por fila del Payout Request

id_payout_requeststring required

Payout Request consultado.

Example response

{
  "id_payout_request": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "amount": 99.5,
      "beneficiary": {
        "email": "jane@acme.com",
        "external_id": "benef-ext-001",
        "name": "Jane Doe",
        "phone": "+525512345678"
      },
      "beneficiary_account": {
        "account_number": "****1223",
        "external_id": "ben-acct-ext-001"
      },
      "description": "Comisiones",
      "due_date": "2026-06-11T00:00:00Z",
      "expire_at": "2026-12-31T23:59:59+00:00",
      "external_id": "ext-001",
      "failure_reason": "Payout ended with status REJECTED",
      "id_payout": "payout-1",
      "source_reference": "ref-1",
      "status": "SUCCESS",
      "voucher_url": "CEP-REF-1"
    }
  ],
  "summary": {
    "failed_count": 1,
    "success_count": 2
  }
}

Changes