Skip to main content
POST
Create deposit

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42

Body

application/json

A deposit from a supported payment source.

method_id
string<uuid>
required

Identifier returned by deposit-method discovery for the selected account and asset. Currently supports Plaid US.

asset_symbol
string
required

Asset symbol returned by the Assets API.

Required string length: 1 - 16
amount
string
required

Amount to pull, expressed in the asset's units.

Required string length: 1 - 64
Pattern: ^[0-9]+(\.[0-9]+)?$
source
Account link · object
required

Source of funds for the deposit.

Response

Deposit initiation accepted; settlement is asynchronous.

Accepted deposit reference.

data
object
required

Result of deposit initiation.