Toku Payout API
Consulta y gestión de Payouts: listado, detalle, aprobación, rechazo, edición de monto, comprobantes, actualización de estado y etapas de creación y ejecución en lote.
Consulta y gestión de Payouts: listado, detalle, aprobación, rechazo, edición de monto, comprobantes, actualización de estado y etapas de creación y ejecución en lote.
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-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 API
version: 1.0.0
description: 'Consulta y gestión de Payouts: listado, detalle, aprobación, rechazo, edición de monto, comprobantes, actualización de estado y etapas de creación y ejecución en lote.'
servers:
- description: Production
url: https://api.trytoku.com
security:
- ApiKeyAuth: []
tags:
- description: 'Consulta y gestión de Payouts: listado, detalle, aprobación, rechazo, edición de monto, comprobantes, actualización de estado y etapas de creación y ejecución en lote.'
name: Payout
paths:
/payouts-payout/payouts:
get:
description: 'List payouts with pagination.
**Límite de tasa:** 1000 solicitudes por hora. Al superarlo, la API responde `429`. Ver Límites de tasa.'
operationId: list_payouts
parameters:
- in: query
name: page
required: false
schema:
default: 1
minimum: 1
title: Page
type: integer
- in: query
name: page_size
required: false
schema:
default: 50
maximum: 200
minimum: 1
title: Page Size
type: integer
- in: query
name: id_payout_request
required: false
schema:
anyOf:
- format: uuid
type: string
- type: 'null'
title: Id Payout Request
- in: query
name: source_reference
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Source Reference
- in: query
name: id_payout_batch
required: false
schema:
anyOf:
- format: uuid
type: string
- type: 'null'
title: Id Payout Batch
- in: query
name: assigned_to_batch
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Assigned To Batch
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPayoutsResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List Payouts
tags:
- Payout
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
PayoutResponse:
properties:
amount:
minimum: 0
title: Amount
type: number
beneficiary:
$ref: '#/components/schemas/BeneficiaryInfo'
readOnly: true
beneficiary_account:
$ref: '#/components/schemas/BeneficiaryAccountInfo'
readOnly: true
description:
anyOf:
- type: string
- type: 'null'
title: Description
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
failure_reason:
anyOf:
- type: string
- type: 'null'
title: Failure Reason
id_payout:
format: uuid
title: Id Payout
type: string
id_payout_batch:
anyOf:
- format: uuid
type: string
- type: 'null'
title: Id Payout Batch
status:
$ref: '#/components/schemas/PayoutStatus'
voucher:
anyOf:
- $ref: '#/components/schemas/Voucher'
- type: 'null'
required:
- id_payout
- amount
- status
- failure_reason
- beneficiary
- beneficiary_account
title: PayoutResponse
type: object
PayoutStatus:
enum:
- CREATED
- READY_TO_EXECUTE
- IN_PROGRESS
- SUCCESS
- FAILED
- RISK_REJECTED
- REJECTED
- EXPIRED
- NOT_COLLECTED
- CANCELLED
title: PayoutStatus
type: string
BeneficiaryInfo:
properties:
email:
anyOf:
- type: string
- type: 'null'
title: Email
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
id:
format: uuid
title: Id
type: string
name:
title: Name
type: string
required:
- id
- name
title: BeneficiaryInfo
type: object
PaginatedPayoutsResponse:
properties:
payouts:
items:
$ref: '#/components/schemas/PayoutResponse'
title: Payouts
type: array
total_count:
title: Total Count
type: integer
required:
- payouts
- total_count
title: PaginatedPayoutsResponse
type: object
BeneficiaryAccountInfo:
properties:
account_number:
anyOf:
- type: string
- type: 'null'
description: Account number of the beneficiary account. Null on a cash account, which has none.
title: Account Number
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
id:
format: uuid
title: Id
type: string
required:
- id
title: BeneficiaryAccountInfo
type: object
Voucher:
properties:
is_available:
default: false
title: Is Available
type: boolean
type:
$ref: '#/components/schemas/VoucherType'
url:
title: Url
type: string
required:
- url
- type
title: Voucher
type: object
VoucherType:
enum:
- CEP
title: VoucherType
type: string
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