Skip to main content
POST
Create a funds withdrawal request

Authorizations

Api-Key
string
header
required

Headers

Idempotency-Key
string
required

Path Parameters

customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*
cardAccountID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*

Body

application/json

The withdrawal request

A card funds withdrawal

amount
string
required

The amount represented as a decimal string

destination
object
required
type
enum<string>

The type of the withdrawal. Defaults to top_up_balance_withdrawal.

Available options:
top_up_balance_withdrawal,
fee
client_note
string

An optional client-provided note for the withdrawal

Response

The successfully created card funds withdrawal

A card funds withdrawal

id
string
required
read-only

ID of the withdrawal

Required string length: 1 - 42
Pattern: [a-z0-9]*
card_account_id
string
required
read-only

ID of the card account associated with the withdrawal

Required string length: 1 - 42
Pattern: [a-z0-9]*
customer_id
string
required
read-only

ID of the customer who owns the card account

Required string length: 1 - 42
Pattern: [a-z0-9]*
amount
string
required

The amount represented as a decimal string

currency
enum<string>
required
read-only

The currency of the withdrawal, which is the crypto currency on the card account

Available options:
usdc
destination
object
required
created_at
string
required
read-only

Timestamp when the withdrawal was created, in ISO8601 format

updated_at
string
required
read-only

Timestamp when the withdrawal was last updated, in ISO8601 format

type
enum<string>

The type of the withdrawal. Defaults to top_up_balance_withdrawal.

Available options:
top_up_balance_withdrawal,
fee
client_note
string

An optional client-provided note for the withdrawal