Skip to main content
POST
Submit Settlement to Custody

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Body

application/json
taxReferenceID
string<uuid>
required
Example:

"ff0e8400-e29b-41d4-a716-446655440011"

providerName
enum<string>
required
Available options:
FIREBLOCKS,
ANCHORAGE
Example:

"FIREBLOCKS"

custodyWalletID
string

Specific custody wallet to use

unitsOverride
string

Override settlement units

Response

Settlement submitted

success
boolean
Example:

true

transactionID
string<uuid>
providerName
string
Example:

"FIREBLOCKS"