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.

Initiate a customer deposit via a supported payin gateway. Optionally pass a quote_id from POST /exchange-rate to lock the rate and amount before redirecting the customer. 
POST https://api.yativo.com/api/v1/wallet/deposits/new
Requires Idempotency-Key header. Retrieve available gateways and their IDs with GET /payment-methods/payin?country={iso2}.

​
Request body

​
gateway
integer
required
The payin gateway ID. Get valid IDs from GET /payment-methods/payin?country={iso2}.
​
currency
string
required
The wallet currency to credit (e.g. "USD", "BRL"). Must match one of the gateway’s supported base currencies.
​
amount
number
Amount to deposit in the local (payin) currency. Required if quote_id is not provided. If quote_id is present, the amount is taken from the quote.
​
quote_id
string
A quote ID from POST /exchange-rate (created with method_type: "payin"). When supplied, the locked amount and rate from the quote are used — amount is ignored.
​
redirect_url
string
URL to redirect the customer to after completing the payment on the gateway’s hosted page.
curl -X POST 'https://api.yativo.com/api/v1/wallet/deposits/new' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: deposit-001' \
  -d '{
    "gateway": 20,
    "quote_id": "4a72ecf8-6c8a-4e38-9971-8aabe9f785ed",
    "currency": "USD",
    "redirect_url": "https://your-app.com/deposit/complete"
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "id": "dep-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "gateway": "monnet",
    "deposit_currency": "BRL",
    "deposit_amount": "1000.00",
    "receive_amount": "9.36",
    "receive_currency": "USD",
    "status": "pending",
    "checkout_url": "https://checkout.gateway.com/pay/abc123",
    "reference": "REF-2026060101",
    "created_at": "2026-06-01T10:00:00.000000Z"
  }
}
After a successful response, redirect the customer to checkout_url to complete payment on the gateway’s hosted page. Once completed, the customer is returned to your redirect_url and a deposit.completed webhook fires.