Toku Payout Request Ingestion API
Ingesta de Account Payables para crear un Payout Request —enviándolas por API o depositando archivos CSV en el SFTP de la organización— y avance de las filas resultantes hacia el servicio de payouts.
Ingesta de Account Payables para crear un Payout Request —enviándolas por API o depositando archivos CSV en el SFTP de la organización— y avance de las filas resultantes hacia el servicio de payouts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/toku:toku-payout-request-ingestion-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Recursos secundarios Payout Request Ingestion API
version: 1.0.0
description: Ingesta de Account Payables para crear un Payout Request —enviándolas por API o depositando archivos CSV en el SFTP de la organización— y avance de las filas resultantes hacia el servicio de payouts.
servers:
- description: Production
url: https://api.trytoku.com
security:
- ApiKeyAuth: []
tags:
- description: Ingesta de Account Payables para crear un Payout Request —enviándolas por API o depositando archivos CSV en el SFTP de la organización— y avance de las filas resultantes hacia el servicio de payouts.
name: Payout Request Ingestion
paths:
/payouts-data-ingestion/ingest-payouts-request/on-demand:
post:
description: '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.'
operationId: ingest_payout_request_input
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAccountPayableRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OnDemandIngestionResponse'
description: Resultado de la ingesta del Payout Request
'400':
description: El servicio de configuración respondió con un error de cliente. Su código de estado se propaga sin modificarlo, por lo que cualquier código 4xx de ese servicio puede aparecer aquí.
'401':
description: Falta la API key de la organización o no es válida
'422':
description: El cuerpo de la petición no cumple el formato esperado
summary: Ingestar Account Payables
tags:
- Payout Request Ingestion
components:
schemas:
DataIngestionResponse:
description: 'Resultado de un lote de ingesta: el Payout Request creado y el desglose de sus filas.'
properties:
batch_row_count:
description: Cantidad de elementos en el arreglo accounts_payable enviado
examples:
- 2
title: Batch Row Count
type: integer
failed_rows:
description: Fallas de validación de ingesta por fila (las filas se registran igualmente cuando es posible).
items:
$ref: '#/components/schemas/IngestionFailedRow'
title: Failed Rows
type: array
id_payout_request:
description: Identificador del Payout Request creado para esta ingesta
examples:
- 3fa85f64-5717-4562-b3fc-2c963f66afa6
title: Id Payout Request
type: string
results:
allOf:
- $ref: '#/components/schemas/DataIngestionResults'
description: Conteos de resultados de inserción de este lote
required:
- id_payout_request
- batch_row_count
- results
title: DataIngestionResponse
type: object
CreateAccountPayableRequest:
description: Lote de Account Payables con el que se crea un Payout Request.
properties:
accounts_payable:
description: Filas de Account Payable sin procesar; cada objeto se valida por fila al registrarse (un objeto vacío {} se omite).
examples:
- - account_number: '987654321'
amount: 100
beneficiary_external_id: benef-ext-001
external_id: ext-001
id_funding_account: fund_acc_1
type: VENDOR_PAYMENT
items:
additionalProperties: true
type: object
title: Accounts Payable
type: array
agreement_code:
anyOf:
- minLength: 1
type: string
- type: 'null'
description: Convenio con el que se procesa todo el lote; se registra en el Payout Request y lo valida el servicio de payouts.
examples:
- CONV-001
title: Agreement Code
disbursement_type:
anyOf:
- $ref: '#/components/schemas/DisbursementType'
- type: 'null'
description: Forma de desembolso para todo el lote; se registra en el Payout Request y el servicio de payouts la infiere cuando no viene o la valida cuando sí.
examples:
- IMMEDIATE_TRANSFER
reference_id:
description: Identificador externo de la solicitud de ingesta
examples:
- ref-2026-08-01
title: Reference Id
type: string
required:
- reference_id
- accounts_payable
title: CreateAccountPayableRequest
type: object
DisbursementType:
description: Forma en que se desembolsa un lote de payouts. El valor aplica a toda la solicitud de ingesta.
enum:
- IMMEDIATE_TRANSFER
- BATCH_FILE
- CASHOUT
title: DisbursementType
type: string
IngestionFailedRow:
description: Resumen de una fila registrada con una falla de ingesta o que no pudo validarse como Account Payable completo.
properties:
external_id:
anyOf:
- type: string
- type: 'null'
description: external_id de la fila cuando viene en el payload sin procesar
examples:
- ext-002
title: External Id
index:
description: Índice base 0 en el lote accounts_payable enviado
examples:
- 1
title: Index
type: integer
message:
description: Resumen legible de la validación o de la persistencia
examples:
- 'amount: Input should be greater than 0'
title: Message
type: string
required:
- index
- message
title: IngestionFailedRow
type: object
OnDemandIngestionResponse:
description: Respuesta de la API para la ingesta on demand del Payout Request (mensaje más resumen opcional del lote).
properties:
ingestion:
anyOf:
- $ref: '#/components/schemas/DataIngestionResponse'
- type: 'null'
description: Presente cuando se creó un Payout Request y se ejecutó la ingesta del lote.
message:
description: Resumen legible del resultado
examples:
- Payout request ingestion initiated successfully.
title: Message
type: string
required:
- message
title: OnDemandIngestionResponse
type: object
DataIngestionResults:
description: Conteos agregados de un único lote de ingesta.
properties:
failed_count:
description: Filas con falla de validación que igualmente quedaron registradas para auditoría.
examples:
- 0
title: Failed Count
type: integer
skipped_count:
description: Filas que venían como objetos vacíos {} y que no se registraron.
examples:
- 0
title: Skipped Count
type: integer
valid_count:
description: Filas aceptadas que quedaron registradas para su procesamiento.
examples:
- 2
title: Valid Count
type: integer
required:
- valid_count
- failed_count
- skipped_count
title: DataIngestionResults
type: object
securitySchemes:
ApiKeyAuth:
description: Toku public API key. Send it in the x-api-key header on every request.
in: header
name: x-api-key
type: apiKey
x-toku-api-version: '2026-10-08'
x-toku-dto-versions:
DTOAccountPaymentInstrument: DTOAccountPaymentInstrumentV1
DTOAggregatedPaymentMethod: DTOAggregatedPaymentMethodV2
DTOAggregatedTransaction: DTOAggregatedTransactionV2
DTOBankAccountPaymentMethod: DTOBankAccountPaymentMethodV1
DTOBoletoPaymentInstrument: DTOBoletoPaymentInstrumentV2
DTOBrPaymentInstrument: DTOBrPaymentInstrumentV2
DTOCardPaymentInstrument: DTOCardPaymentInstrumentV1
DTOCardPaymentMethod: DTOCardPaymentMethodV1
DTOCashClPaymentInstrument: DTOCashClPaymentInstrumentV1
DTOCashMxPaymentInstrument: DTOCashMxPaymentInstrumentV1
DTOClPaymentInstrument: DTOClPaymentInstrumentV2
DTOCustomer: DTOCustomerV2
DTOInvoice: DTOInvoiceV4
DTOMxPaymentInstrument: DTOMxPaymentInstrumentV3
DTOPacManagementPaymentInstrument: DTOPacManagementPaymentInstrumentV1
DTOPatpassPaymentInstrument: DTOPatpassPaymentInstrumentV1
DTOPaymentIntent: DTOPaymentIntentV5
DTOPaymentMethod: DTOPaymentMethodV7
DTOPixPaymentInstrument: DTOPixPaymentInstrumentV1
DTOPixPaymentMethod: DTOPixPaymentMethodV1
DTOReferencedPaymentMXInstrument: DTOReferencedPaymentMXInstrumentV1
DTOTransaction: DTOTransactionV10
DTOTransferClPaymentInstrument: DTOTransferClPaymentInstrumentV2
DTOTransferMxPaymentInstrument: DTOTransferMxPaymentInstrumentV1
DTOUpdatedFields: DTOUpdatedFieldsV1
DTOWalletMovement: DTOWalletMovementV1
DTOWalletPaymentInstrument: DTOWalletPaymentInstrumentV2
x-toku-schema-names:
ApiPaymentMethod_AssociatePaymentMethodResponse: AssociatePaymentMethodResponse
ApiPaymentMethod_DTOPaymentMethodV7: PaymentMethod
ApiPaymentTransaction_DTOTransactionV10: Transaction
ApiPaymentTransaction_TransactionStatus: TransactionStatus
ApiRenditionFile_BusinessDaysBeforeFilter: BusinessDaysBeforeFilter
ApiRenditionFile_DaysBeforeFilter: DaysBeforeFilter
ApiRenditionFile_DueDatesDaysFutureFilter: DueDatesDaysFutureFilter
ApiRenditionFile_EntityRestrictions: EntityRestrictions
ApiRenditionFile_NewestNInvoicesFilter: NewestNInvoicesFilter
ApiRenditionFile_OldestNInvoicesFilter: OldestNInvoicesFilter
CheckoutApi_AccountDetailsResponse: AccountDetailsResponse
CheckoutApi_CheckoutSessionResponse: CheckoutSession
ClientPaymentPortalBackend_CheckoutSessionResponse: CheckoutSessionResponse
CollectionStrategist_InstitutionId: InstitutionId
CollectionStrategist_SubTreeConfiguration: SubTreeConfiguration
DTOAccountPaymentInstrumentV1: AccountPaymentInstrument
DTOAggregatedTransactionV2: AggregatedTransaction
DTOAppliedAdjustmentDocumentV1: AppliedAdjustmentDocument
DTOBoletoPaymentInstrumentV2: BoletoPaymentInstrument
DTOBrPaymentInstrumentV2: BrPaymentInstrument
DTOCardPaymentInstrumentV1: CardPaymentInstrument
DTOCardPaymentMethodV1: CardPaymentMethod
DTOCashClPaymentInstrumentV1: CashClPaymentInstrument
DTOCashMxPaymentInstrumentV1: CashMxPaymentInstrument
DTOClPaymentInstrumentV2: ClPaymentInstrument
DTOInvoiceV4: Invoice
DTOMxPaymentInstrumentV3: MxPaymentInstrument
DTOPacManagementPaymentInstrumentV1: PacManagementPaymentInstrument
DTOPatpassPaymentInstrumentV1: PatpassPaymentInstrument
DTOPaymentIntentV5: PaymentIntent
DTOPixPaymentInstrumentV1: PixPaymentInstrument
DTOPixPaymentMethodV1: PixPaymentMethod
DTOReferencedPaymentMXInstrumentV1: ReferencedPaymentMXInstrument
DTOTransferClPaymentInstrumentV2: TransferClPaymentInstrument
DTOTransferMxPaymentInstrumentV1: TransferMxPaymentInstrument
DTOUpdatedFieldsV1: UpdatedFields
DTOWalletMovementV1: WalletMovement
DTOWalletPaymentInstrumentV2: WalletPaymentInstrument
GetCustomerResponse: Customer
GetSubscriptionResponse: Subscription
PayoutsBeneficiaryService_ApprovalFlowsStatus: ApprovalFlowsStatus
PayoutsBeneficiaryService_Beneficiary: Beneficiary
PayoutsBeneficiaryService_BeneficiaryAccount: BeneficiaryAccount
PayoutsBeneficiaryService_BeneficiaryAccountVerification: BeneficiaryAccountVerification
PayoutsBeneficiaryService_IdentityDocument: IdentityDocument
PayoutsBeneficiaryService_VerificationStatus: VerificationStatus
PayoutsDataIngestionService_DisbursementType: DisbursementType
WebhookEndpointResponse: WebhookEndpoint
x-provenance:
method: searched
source: https://docs.trytoku.com/reference
harvested: '2026-10-29'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.trytoku.com/reference/associate_subscription.md
- https://docs.trytoku.com/reference/associate_subscription_bulk.md
- https://docs.trytoku.com/reference/bulk_inscriptions_public.md
- https://docs.trytoku.com/reference/cancel_billing_document.md
- https://docs.trytoku.com/reference/cancel_preauth_endpoint.md
- https://docs.trytoku.com/reference/capture_preauth_endpoint.md
- https://docs.trytoku.com/reference/change_subscription_status.md
- https://docs.trytoku.com/reference/create_adjustment_document.md
- https://docs.trytoku.com/reference/create_beneficiaries.md
- https://docs.trytoku.com/reference/create_bulk_automatic_debit_payment_methods.md
- https://docs.trytoku.com/reference/create_credit_note.md
- https://docs.trytoku.com/reference/create_customer.md
- https://docs.trytoku.com/reference/create_customer_billing_data.md
- https://docs.trytoku.com/reference/create_customer_billing_data_bulk.md
- https://docs.trytoku.com/reference/create_document.md
- https://docs.trytoku.com/reference/create_external_transaction.md
- https://docs.trytoku.com/reference/create_external_transactions.md
- https://docs.trytoku.com/reference/create_handler.md
- https://docs.trytoku.com/reference/create_intent.md
- https://docs.trytoku.com/reference/create_invoice_billing_data.md
- https://docs.trytoku.com/reference/create_m2m_access_token.md
- https://docs.trytoku.com/reference/create_or_update_invoice.md
- https://docs.trytoku.com/reference/create_or_update_subscription.md
- https://docs.trytoku.com/reference/create_pacs.md
- https://docs.trytoku.com/reference/create_pix_automatic_configuration.md
- https://docs.trytoku.com/reference/create_ppd_billing_document.md
- https://docs.trytoku.com/reference/create_ppd_complement_billing_document.md
- https://docs.trytoku.com/reference/create_ppd_complement_from_wallet_movement_billing_document.md
- https://docs.trytoku.com/reference/create_public_validator_execution.md
- https://docs.trytoku.com/reference/create_pue_billing_document.md
- https://docs.trytoku.com/reference/create_receipt.md
- https://docs.trytoku.com/reference/create_referenced_payment_mx_reference_endpoint.md
- https://docs.trytoku.com/reference/create_terminal.md
- https://docs.trytoku.com/reference/create_transfer_clabe_account.md
- https://docs.trytoku.com/reference/create_webhook_endpoint.md
- https://docs.trytoku.com/reference/delete_customer.md
- https://docs.trytoku.com/reference/delete_customer_collection_account_endpoint.md
- https://docs.trytoku.com/reference/delete_external_transaction.md
- https://docs.trytoku.com/reference/delete_external_transactions.md
- https://docs.trytoku.com/reference/delete_invoice.md
- https://docs.trytoku.com/reference/delete_pacs.md
- https://docs.trytoku.com/reference/delete_payment_method.md
- https://docs.trytoku.com/reference/delete_subscription.md
- https://docs.trytoku.com/reference/delete_terminal.md
- https://docs.trytoku.com/reference/download_pdf_for_transaction.md
- https://docs.trytoku.com/reference/edit_customer.md
- https://docs.trytoku.com/reference/edit_invoice.md
- https://docs.trytoku.com/reference/edit_invoice_billing_data.md
- https://docs.trytoku.com/reference/edit_subscription.md
- https://docs.trytoku.com/reference/edit_webhook_endpoint.md
- https://docs.trytoku.com/reference/enroll_carteira_boleto.md
- https://docs.trytoku.com/reference/expire_checkout_session_endpoint.md
- https://docs.trytoku.com/reference/expire_handler.md
- https://docs.trytoku.com/reference/expire_webhook_sender_organization_configuration_endpoint.md
- https://docs.trytoku.com/reference/external_boleto_initialize.md
- https://docs.trytoku.com/reference/external_onetime_initialize.md
- https://docs.trytoku.com/reference/generate_report.md
- https://docs.trytoku.com/reference/get_account_verifications_by_batch.md
- https://docs.trytoku.com/reference/get_adjustment_document.md
- https://docs.trytoku.com/reference/get_bank_account_verification_by_id.md
- https://docs.trytoku.com/reference/get_bank_account_verifications.md
- https://docs.trytoku.com/reference/get_beneficiary_accounts.md
- https://docs.trytoku.com/reference/get_billing_document.md
- https://docs.trytoku.com/reference/get_checkout_session_endpoint_v2.md
- https://docs.trytoku.com/reference/get_customer.md
- https://docs.trytoku.com/reference/get_customer_billing_data.md
- https://docs.trytoku.com/reference/get_customer_collection_account_endpoint.md
- https://docs.trytoku.com/reference/get_customers.md
- https://docs.trytoku.com/reference/get_handler.md
- https://docs.trytoku.com/reference/get_invoice.md
- https://docs.trytoku.com/reference/get_invoice_billing_data.md
- https://docs.trytoku.com/reference/get_paginated_chargeable_invoices.md
- https://docs.trytoku.com/reference/get_payment_method.md
- https://docs.trytoku.com/reference/get_payment_method_by_id.md
- https://docs.trytoku.com/reference/get_payment_methods.md
- https://docs.trytoku.com/reference/get_pix_automatic_configuration.md
- https://docs.trytoku.com/reference/get_public_transactions.md
- https://docs.trytoku.com/reference/get_receipt.md
- https://docs.trytoku.com/reference/get_report_columns.md
- https://docs.trytoku.com/reference/get_signed_document_url.md
- https://docs.trytoku.com/reference/get_subscription.md
- https://docs.trytoku.com/reference/get_subscriptions.md
- https://docs.trytoku.com/reference/get_terminal.md
- https://docs.trytoku.com/reference/get_transaction.md
- https://docs.trytoku.com/reference/get_transaction_data_for_refund.md
- https://docs.trytoku.com/reference/get_transaction_fees_public.md
- https://docs.trytoku.com/reference/get_transfer_clabe_account.md
- https://docs.trytoku.com/reference/get_webhook_endpoint.md
- https://docs.trytoku.com/reference/get_webhook_endpoints.md
- https://docs.trytoku.com/reference/get_webhook_sender_organization_configuration_endpoint.md
- https://docs.trytoku.com/reference/ingest_payout_request_input.md
- https://docs.trytoku.com/reference/initialize_enrollment_pix.md
- https://docs.trytoku.com/reference/initialize_push_notification_enrollment.md
- https://docs.trytoku.com/reference/list_adjustment_documents.md
- https://docs.trytoku.com/reference/list_customer_invoices.md
- https://docs.trytoku.com/reference/list_invoices.md
- https://docs.trytoku.com/reference/list_invoices_by_customer.md
- https://docs.trytoku.com/reference/list_payout_request_items.md
- https://docs.trytoku.com/reference/list_payouts.md
- https://docs.trytoku.com/reference/list_subject_consents.md
- https://docs.trytoku.com/reference/list_terminals.md
- https://docs.trytoku.com/reference/lookup_customer.md
- https://docs.trytoku.com/reference/lookup_invoice.md
- https://docs.trytoku.com/reference/lookup_subscription.md
- https://docs.trytoku.com/reference/open_checkout_session_endpoint.md
- https://docs.trytoku.com/reference/patch_beneficiary_account_data.md
- https://docs.trytoku.com/reference/patch_beneficiary_account_external_id.md
- https://docs.trytoku.com/reference/patch_beneficiary_metadata.md
- https://docs.trytoku.com/reference/patch_webhook_sender_organization_configuration_endpoint.md
- https://docs.trytoku.com/reference/pos_charge_endpoint.md
- https://docs.trytoku.com/reference/post_customer_collection_account_endpoint.md
- https://docs.trytoku.com/reference/post_webhook_sender_organization_configuration_endpoint.md
- https://docs.trytoku.com/reference/public_available_institutions.md
- https://docs.trytoku.com/reference/public_start_create_cash_mx_reference.md
- https://docs.trytoku.com/reference/public_update_checkout_session_endpoint.md
- https://docs.trytoku.com/reference/refund_invoice_public.md
- https://docs.trytoku.com/reference/refund_transaction_public.md
- https://docs.trytoku.com/reference/soft_delete_pix_automatic_configuration.md
- https://docs.trytoku.com/reference/subscriptions_by_customer.md
- https://docs.trytoku.com/reference/undo_debt_reconciliation_by_invoice_endpoint.md
- https://docs.trytoku.com/reference/update_adjustment_document.md
- https://docs.trytoku.com/reference/update_customer_billing_data.md
- https://docs.trytoku.com/reference/update_external_transaction.md
- https://docs.trytoku.com/reference/update_external_transactions.md
- https://docs.trytoku.com/reference/update_pix_automatic_configuration.md
- https://docs.trytoku.com/reference/update_terminal.md
- https://docs.trytoku.com/reference/upload_external_pdf.md
- https://docs.trytoku.com/reference/validate_handler.md
- https://docs.trytoku.com/reference/verify_bank_account.md
- https://docs.trytoku.com/reference/verify_public_bulk_bank_accounts.md
- https://docs.trytoku.com/reference/void_invoice.md
merge:
pages: 131
deduped: 757
conflicts_kept_first: 0