Request a withdrawal

Request a Pix withdrawal to the company key registered in the Dashboard.

POSThttps://api.raims.com/v1/withdrawals

Request a Pix withdrawal by providing the amount you want to withdraw. The destination is the company Pix key registered in the Dashboard. The fee is deducted from the requested amount.

Keep the returned identifier and track the same withdrawal while it is pending or processing. Acceptance does not confirm that the money reached the destination account.

See Withdrawals for the conditions of use and how to track the result.

Body Params

amount_centsintegerrequired

Total amount to withdraw, in Brazilian real cents, including the fee. Check the withdrawal conditions for the balance, fee, and limits before submitting a request.

From 200 to 1000000000000

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request POST \
  --url https://api.raims.com/v1/withdrawals \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Request a withdrawal

Body Params

Responses

200OK

202Accepted

400Bad Request

403Forbidden

409Conflict