Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Consumer

Resume/Execute Standing Order

For example, a tier 1 approved user with an active standing order deposits 50,000 EUR and the standing order runs to convert this into the chosen crypto-currency. The withdrawal will not be executed as it would exceed tier 1 limits. In this case, the user may opt to finish Tier 2 and after Tier 2 is completed, this API can be used to force run a standing order without waiting for another incoming EUR deposit to trigger it.

post/resume

Request body

userIdstring uuid required

Unique ID of the user for whom the standing order is to be run

standingOrderIdstring uuid required

Unique ID of the standing order to resume

Response

success

idstring

The unique identifier for the standing order

userIdstring

The user ID for the standing order

statusstring

The status of the standing order

currencystring

The destination currency of the standing order (what deposits are converted into)

sourceCurrencystring

The currency of the root (debit) account this standing order draws from

addressstring

The address of the standing order

proposedRatestring

The last proposed rate (if set)

parentWalletIdstring

The wallet ID to which the rootAccountId belongs

rootAccountIdstring

The root account used as the debit account for this standing order

whitelistedAddressIdstring

The whitelisted address ID of the standing order

whitelistedIbanIdstring

The whitelisted IBAN ID of the standing order

ibanstring

IBAN if applicable to which this SO is paid out

bicstring

BIC if applicable to which this SO is paid out

standingOrderDirection'CRYPTO_TO_FIAT' | 'FIAT_TO_CRYPTO'

Direction of the SO

action'SWAP_ONLY' | 'SWAP_AND_WITHDRAW'

Execution mode of the SO. SWAP_AND_WITHDRAW performs swap then external payout. SWAP_ONLY performs only the swap (internal). Older SOs without this field behave as SWAP_AND_WITHDRAW.

createdAtstring date-time

The date and time the standing order was created

lastUpdatedAtstring date-time

The date and time the standing order was last updated