Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Business

Create Business Standing Order

Create a SWAP_ONLY standing order for a business account. Identical to POST /create except the owner is identified by businessId instead of userId. action must be SWAP_ONLY — SWAP_AND_WITHDRAW is not yet supported for business accounts.

post/business/create

Request body

businessIdstring uuid required

Unique ID of the business for whom a standing order is to be created

accountIdstring required

The account of the business for which deposits are to be monitored and paid out as part of this standing order

whitelistedAddressIdstring uuid

One of the business's whitelisted crypto addresses for which this standing order is to be paid out (REQUIRED if source account is a EUR account and action is SWAP_AND_WITHDRAW, unless destinationCurrency is provided instead for a SWAP_ONLY order)

whitelistedIbanIdstring uuid

ID of a whitelisted destination IBAN to which this standing order is to be paid out (REQUIRED if source account is not a EUR account and action is SWAP_AND_WITHDRAW)

action'SWAP_ONLY' | 'SWAP_AND_WITHDRAW'

Whether the standing order should perform a swap only or swap and withdraw on each execution. SWAP_AND_WITHDRAW (default) pays out to a whitelisted address/IBAN after each swap. SWAP_ONLY swaps the deposit into the destination currency in the same wallet and stops — no external payout.

destinationCurrencystring

Destination currency to swap into, honoured only for SWAP_ONLY. When the source account is EUR, selects which crypto the EUR is swapped into. When the source account is crypto, must be EUR or USDC.

fixedFeestring

The fixed fee in cents for the standing order (optional)

percentFeeBpsstring

The percentage fee in basis points for the standing order (optional)

verificationMethod'sms' | 'totp' | 'passkey'

SCA factor to issue the setup challenge against. Defaults to sms.

Response

success

challengeIdstring uuid required

Unique challenge ID to be used when confirming the standing order via OTP

dateExpiresstring date-time required

Date at which this challenge ID expires. If this expires, please create a new standing order. Standing orders are not persisted in storage unless confirmed.

verificationMethod'sms' | 'totp' | 'passkey'

SCA factor that the standing-order challenge is bound to (echoes the request, defaults to sms).

Example response

{
  "dateExpires": "2024-07-25T06:49:13.606Z"
}