Skip to main content
POST
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.
Requires Idempotency-Key header. Retrieve available gateways and their IDs with GET /payment-methods/payin?country={iso2}.
After a successful response, redirect the customer to deposit_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.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Headers

Idempotency-Key
string
required

A unique string per request to ensure idempotent processing.

Body

application/json
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.

Example:

"USD"

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<uuid>

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<uri>

URL to redirect the customer to after completing the payment on the gateway's hosted page.

Response

Deposit initiated

status
string
status_code
integer
message
string
data
object