Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yativo.com/llms.txt

Use this file to discover all available pages before exploring further.

Yativo provides two payout paths depending on your use case:
PathBest for
POST /payout/simpleA single payment to one beneficiary
POST /payout/batchMultiple payments to different beneficiaries in one request
Both require a saved beneficiary with an attached payment method. See Send Money for setting up beneficiaries.
All payout requests require an Idempotency-Key header and the chargeWallet middleware — meaning your wallet balance is charged at submission time.

​
Single Payout

Send one payment to a saved beneficiary payment method. 
POST https://api.yativo.com/api/v1/payout/simple
​
amount
number
required
Amount to send in the debit wallet currency.
​
beneficiary_details_id
number
required
The ID of the saved beneficiary payment method (from POST /beneficiaries/payment-methods).
​
beneficiary_id
string
Optional beneficiary UUID. Useful for tracking but not required if beneficiary_details_id is provided.
curl -X POST 'https://api.yativo.com/api/v1/payout/simple' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: payout-simple-001' \
  -d '{
    "amount": 250,
    "beneficiary_details_id": 42
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "transaction_id": "txn-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "processing",
    "amount": "250.00",
    "currency": "CLP",
    "beneficiary_id": 42,
    "created_at": "2026-06-01T10:00:00.000000Z"
  }
}

​
Batch Payout

Send multiple payments in a single request. Each item in the payouts array is processed independently — partial failures are returned in an errors array rather than rolling back the entire batch. 
POST https://api.yativo.com/api/v1/payout/batch
​
payouts
array
required
Array of payout objects to process.
Batch payouts are processed within a database transaction — if your wallet has insufficient balance for the total amount, the entire batch is rejected before processing begins. Individual line-item errors (e.g. invalid beneficiary) are returned in the errors object and do not affect other items.
curl -X POST 'https://api.yativo.com/api/v1/payout/batch' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: batch-payout-june-payroll-001' \
  -d '{
    "payouts": [
      { "amount": 500, "beneficiary_details_id": 41 },
      { "amount": 750, "beneficiary_details_id": 42 },
      { "amount": 300, "beneficiary_details_id": 43 }
    ]
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "0": { "transaction_id": "txn-aaa", "status": "processing", "amount": "500.00" },
    "1": { "transaction_id": "txn-bbb", "status": "processing", "amount": "750.00" },
    "2": { "transaction_id": "txn-ccc", "status": "processing", "amount": "300.00" }
  }
}

​
List Payouts

Retrieve a paginated list of all your payouts. 
GET https://api.yativo.com/api/v1/payout/get

curl -X GET 'https://api.yativo.com/api/v1/payout/get' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

​
Get Single Payout

GET https://api.yativo.com/api/v1/payout/fetch/{payout_id}
​
payout_id
string
required
The UUID of the payout to retrieve.
curl -X GET 'https://api.yativo.com/api/v1/payout/fetch/txn-a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

​
Payout vs. Wallet Payout

POST /payout/simple or /batchPOST /wallet/payout
Beneficiary requiredYes — beneficiary_details_idYes — beneficiary_id
Quote supportNoYes — pass quote_id for locked rate
Bulk supportYes (/batch)No
Use caseDisbursements, payrollSingle cross-currency payments with rate lock
For a single payment where you want to lock a rate first, use POST /sendmoney/quote → POST /wallet/payout. For payroll-style bulk disbursements without rate locking, use POST /payout/batch.