Update automatic withdrawals

Enable, disable or adjust the minimum amount and time of the daily withdrawal attempt.

PATCHhttps://api.raims.com/v1/withdrawals/automatic_settings

Configure the daily withdrawal attempt for the company destination selected in the Dashboard. Send only the fields you want to change. The request requires a Production API key and does not ask for a confirmation code (OTP).

Saving the settings does not request an immediate withdrawal. See Automatic withdrawals for amount, time and tracking rules.

Body Params

enabledbooleanoptional

Enables or disables new withdrawal attempts. Disabling does not cancel withdrawals already requested.

true

minimum_amount_centsintegeroptional

Minimum balance for attempting a withdrawal, in Brazilian real cents. The withdrawn amount depends on the available balance and remaining Pix limit.

From 200 to 100000000

timestringoptional

Daily time in HH:mm format, in the São Paulo time zone.

5 to 5 characters

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

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

Response

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

application/json

Update automatic withdrawals

Body Params

Responses

200OK

400Bad Request

403Forbidden

404Not Found

409Conflict