Skip to main content
POST

Authorizations

x-partner-api-key
string
header
required

The client's own API key (kmi_<id>_<secret>), issued by Kamui. A missing, malformed, unknown, revoked or expired key answers 401 unauthorized.

Headers

x-request-id
string

Your id for this request: 1 to 128 letters, digits, ., _, : or -. It is echoed in the response. Any other value is replaced with a new UUID.

Pattern: ^[A-Za-z0-9._:-]{1,128}$

Body

application/json
type
string
default:DEPOSIT
required
Allowed value: "DEPOSIT"
slug
string
required

Vault slug, matched exactly: lowercase letters, digits and single hyphens (stable-vault). Case and whitespace count, so Stable-Vault and stable-vault answer 400. A legacy slug works; the response carries the canonical one.

Required string length: 1 - 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"stable-vault"

amount
string
required
Required string length: 1 - 30
Pattern: ^[1-9][0-9]{0,29}$
Example:

"1000000000"

sender
string
required

Ethereum address: 0x and 40 hex characters, in lowercase or with a valid EIP-55 checksum. Other mixed case, all-uppercase hex, a 0X prefix and the zero address answer 400.

Required string length: 42
Pattern: ^0x[0-9a-fA-F]{40}$
Example:

"0x1111111111111111111111111111111111111111"

receiver
string

Ethereum address: 0x and 40 hex characters, in lowercase or with a valid EIP-55 checksum. Other mixed case, all-uppercase hex, a 0X prefix and the zero address answer 400.

Required string length: 42
Pattern: ^0x[0-9a-fA-F]{40}$
referral
string

Ethereum address: 0x and 40 hex characters, in lowercase or with a valid EIP-55 checksum. Other mixed case, all-uppercase hex and a 0X prefix answer 400.

Required string length: 42
Pattern: ^0x[0-9a-fA-F]{40}$
chainId
number
skipSimulation
boolean

Response

Success

data
DEPOSIT · object
required
asOf
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991