Skip to main content
Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account and retrieve existing bank deposit activity.

Endpoints

EndpointRequest
Retrieve DepositsGET /deposits
Create DepositPOST /deposits

Attributes

account_id
string
required
Account ID that owns these deposit transactions.
bank
object[]
required
Bank deposit transactions for this account.

Properties

created_at
string
required
When the bank deposit transaction was created.
destination_amount
string | null
required
Amount credited to the account balance.
destination_currency
string | null
required
Currency credited to the account balance.
id
string
required
Bank deposit transaction ID.
source_amount
string
required
Amount sent by the depositor.
source_currency
string
required
Currency sent by the depositor.
status
string
required
Current bank deposit status.
object
string
required
Deposit
{
	"account_id": "biz_xxxxxxxxxxxxxx",
	"bank": [
		{
			"created_at": "2026-06-01T12:00:00Z",
			"destination_amount": "250.00",
			"destination_currency": "usd",
			"id": "dep_xxxxxxxxxxxxx",
			"source_amount": "250.00",
			"source_currency": "usd",
			"status": "completed"
		}
	],
	"object": "deposits"
}