Create a Withdrawal

post

https://api.sqala.tech/core/v1/withdrawals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

code

string

Unique identifier for the object in your system.

amount

int32

required

Amount in cents to be transferred.

method

string

enum

required

The method of the withdrawal.

Allowed:

pixKey

string

The PIX key of the destination bank account. Required if method is PIX

pixQrCode

string

The PIX qrcode (copia e cola). Required if method is PIX_QRCODE

hash

string

Transaction identifier used for PIX_QRCODE method. use GET core/v1/dict/barcode to get the hash.

expectedHolderTaxId

string

The expected TaxId for the bank account holder. If the TaxId of a pix key is different from this field, the withdrawal status will be failed.

bankAccount

object

The destination bank account. Required if method is STANDARD.

bankAccountId

string

The ID of the destination bank account. Required if method is STANDARD.

metadata

array of objects

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

metadata

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400