Type Definitions
Type Definitions
Step 1: Get Supported Payout Countries
Retrieve the full list of countries where Yativo supports outbound payments:Step 2: Get Payout Methods for Destination
Retrieve available payment rails for the destination country. Use the ISO 3166-1 alpha-3 country code:string
required
Destination country ISO 3166-1 alpha-3 code (e.g.
CHL, MEX, BRA).id — this is your payment_method_id for subsequent steps.
Step 3: Get Required Form Fields
Each payment method requires different recipient details (CLABE, account number, routing number, etc.). Retrieve the exact fields needed:number
required
The payment method ID from Step 2.
Step 4: Create a Beneficiary
Create a beneficiary record for the recipient. Thebeneficiary_id returned here is used to attach bank details in Step 5.
string
required
Recipient’s full name (individual) or legal business name.
string
required
Recipient’s email address.
string
required
ISO 3166-1 alpha-3 country code (e.g.
CHL, MEX, BRA).string
required
"individual" or "business".Step 5: Save Recipient Bank Details
Submit the recipient’s bank account details using the fields returned in Step 3:string
required
The beneficiary ID from Step 4.
number
required
Payment method ID from Step 2.
object
required
Key-value pairs of the required fields (e.g.
account_number, bank_code, clabe, pix_key).id for use in Step 7.
Step 6: Get an Exchange Rate Quote (Recommended)
Lock in a rate before executing the payment. Quotes are valid for 5 minutes:string
required
Source currency code (e.g.
USD, EUR).string
required
Destination currency code (e.g.
CLP, MXN, BRL).number
required
Amount in the source currency.
string
required
The payment method ID saved in Step 5. This links the quote to the destination account so that executing
POST /sendmoney knows where to deliver funds.Step 7: Send Money
Execute the payment using the quote ID:string
required
The quote ID from Step 6. Guarantees the locked rate.
cURL (wallet payout)
Step 8: Track the Payment
Monitor the payment status in real-time:Manage Saved Payment Methods
List All Saved Methods
Update a Saved Method
Delete a Saved Method
Transaction Purpose
For compliance, submit the purpose of a transaction after initiating it:string
required
The transaction ID returned from
POST /sendmoney.string
required
A short description of the payment purpose, e.g.
"family_support", "business_payment", "invoice".Yativo supports payouts to LATAM (CHL, MEX, BRA, PER, COL, ARG), USA, and Europe. Contact your integration team for additional corridors.

