Skip to main content

PayOut API

Use this API to initiate disbursements to bank accounts and supported wallets. Supported methods by country:
  • Colombia: BANK_TRANSFER, TRANSFIYA, TUMIPAY, BREB (see Bre-B integration)
  • Peru: BANK_TRANSFER
  • Mexico: SPEI
  • Guatemala: BANK_TRANSFER
  • Honduras: BANK_TRANSFER
For country-specific details (banks, account types, document types, limits), see the Colombia, Peru, Mexico, Guatemala, and Honduras configuration pages.

Transaction Flow

The PayOut process follows a clear sequence of interactions between different participants:

Preauthorization Rules

Preauthorization, limits and validations depend on each country and method. Refer to the country pages for current values and processes.

Endpoints

POST Initiate a PayOut Transaction

/api/v1/payout

This endpoint allows you to perform dispersions using methods like TumiPay Wallet and Bank Transfer. Transactions are processed asynchronously, ensuring efficiency and reliability.

Request Headers

string
required
Secret token for authorization
string
required
Authorization key for access

Request Body

string
required
Specifies the payment method. See country-specific options:
string
required
Unique reference for the transaction
integer
required
Amount to be transferred
string
required
Currency for the transaction. Use COP for Colombia, PEN for Peru, MXN for Mexico
string
required
Two-letter country code. Possible values: “CO”, “PE”, “MX”
string
required
Webhook URL to receive transaction status updates
object
required

Response

string
required
Response code (see Error Codes)
string
required
Status of the transaction (e.g., “SUCCESS”)
string
Transaction result message
object
required

Examples for Mexico

SPEI

Disbursement via SPEI to a CLABE account. The 18-digit CLABE uniquely identifies the destination bank and account.

Error Codes

Supported Banks

For a complete list of supported banks for PayOut transactions, please refer to the country-specific documentation:

Valid Account Types

The following account types are valid for processing transactions through this API. Always use the corresponding account type in your API requests to ensure proper processing of the transaction.

Common Bank Response Messages for “REJECTED” Status

When a payout transaction is rejected, the top_response_message field in the webhook payload contains a message provided by the bank explaining the reason for the rejection. These messages should be monitored and logged to understand the reason for the rejection and take any necessary corrective actions.

Response Examples

Error Response