Skip to main content
POST
/
api
/
v0
/
assets
/
{asset}
/
withdrawals
Create a withdrawal for asset
curl --request POST \
  --url https://api.brl.xyz/api/v0/assets/{asset}/withdrawals \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "pix",
  "amount": "100.50",
  "pix-key": "[email protected]",
  "bank-code": "001",
  "branch-number": "1234",
  "account-number": "12345678",
  "account-holder-name": "John Doe",
  "account-holder-tax-id": "12345678901"
}
'
{
  "withdrawal": {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "amount": "100.50",
    "method": "pix",
    "state": "created",
    "created-at": "2024-01-15T10:30:00Z",
    "state-updated-at": "2024-01-15T10:30:00Z"
  }
}

Path Parameters

​
asset
enum<string>
required
Available options:
usdc,
usdt,
brl,
usd

Body

application/json
​
method
enum<string>
required

Withdrawal method. Must be either 'pix' or 'ted'

Available options:
ted,
pix
Example:

"pix"

​
amount
required

Amount in BRL to withdraw

Example:

"100.50"

​
pix-key
string

PIX key (email, phone, CPF/CNPJ, or random key). Required when method is 'pix'

Example:

"[email protected]"

​
bank-code
string

3-digit Brazilian bank code. Required when method is 'ted'

Example:

"001"

​
branch-number
string

4-5 digit Brazilian branch number. Required when method is 'ted'

Example:

"1234"

​
account-number
string

Brazilian account number. Required when method is 'ted'

Example:

"12345678"

​
account-holder-name
string

Name of the account holder. Required when method is 'ted'

Example:

"John Doe"

​
account-holder-tax-id

CPF or CNPJ of the account holder. Required when method is 'ted'

Example:

"12345678901"

Response

Asset withdrawal created successfully

​
withdrawal
object
required

Details of the created withdrawal