View withdrawals in progress
View the count and total amount of withdrawals awaiting completion.
View the count and total amount of company withdrawals that are pending or processing. The response requires authorized Production access and does not confirm receipt in the destination account.
See Withdrawals in progress to interpret the amounts.
Responses
Response Body
Count and total amount of pending or processing withdrawals. The amount includes the fee and does not represent confirmed credit at the destination. Both fields return zero when there are no withdrawals in these statuses.
Current summary of the company's pending or processing withdrawals.
Number of withdrawals with PENDING or PROCESSING status.
Total amount requested in these withdrawals, including the fee, in Brazilian real cents. Do not add this amount to the available balance.
Response Body
This query does not accept a body or query parameters. Remove the data indicated in the error details.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
Response Body
The query requires authorized access in Production. The Sandbox does not offer this withdrawal summary.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
For common errors, see HTTP response codes.