Skip to content

Get an auto-buy deposit reference​

GET
/v1/wallet/fiat/{currency}/deposit/reference/{buyCurrencySymbol}

Requires DEPOSITS_READ, granted by TREASURY_READ or TREASURY_WRITE (bundles)

Returns an auto-buy reference: a deposit in currency that quotes it is credited to the account (the primary, or the sub-account selected with X-VALR-SUB-ACCOUNT-ID) and used to buy buyCurrencySymbol. List the currencies you can buy with List auto-buy currencies.

Parameters​

Path Parameters

currency*

Fiat currency you'll deposit, e.g. ZAR.

Type
string
Required
Example"ZAR"
buyCurrencySymbol*

Currency to buy with the deposit, e.g. BTC.

Type
string
Required
Example"BTC"

Responses​

OK

application/json
JSON
{
"reference": "BTC4NQ8ZKW"
}

Samples​

Errors

HTTPErrorWhen
400-11INVALID_REQUESTcurrency or buyCurrencySymbol isn't a recognised currency.
400-21INVALID_CURRENCY_PAIRThere's no market for buying buyCurrencySymbol with currency.
400-32CURRENCY_PAIR_NOT_ACTIVEThe market for buying buyCurrencySymbol with currency isn't active.
400-15132CURRENCY_NOT_ENABLED_FOR_FIAT_DEPOSIT_AUTO_BUYbuyCurrencySymbol can't be auto-bought with currency; list the currencies that can with List auto-buy currencies.
451-15134CURRENCY_NOT_ALLOWED_FOR_FIAT_DEPOSIT_AUTO_BUYAuto-buy into buyCurrencySymbol with currency isn't available for your business.
451-15111FIAT_DEPOSITS_NOT_ALLOWED_FOR_CURRENCYYour business's region doesn't allow deposits in currency.

Plus the errors common to all signed endpoints.