Resolve a pending scenario
Complete or fail pending issuance or cancellation in the Sandbox.
Sets the result of issuance or cancellation left pending in the test scenario. The action must already have been started on the charge.
Sandbox only
Use a Sandbox key or an OAuth connection with Sandbox access. Resolution is simulated and does not move real money.
See how to prepare and start the action in Pending or failed issuance and cancellation.
Path Params
Public identifier of the charge created in your company Sandbox.
Up to 100 characters
Headers
Unique key chosen by your system to identify this request. When retrying, send the same key and parameters. Without this header, the request is processed normally. See the idempotency guide for retention and handling pending or uncertain responses.
1 to 255 characters
Body Params
Applying an example replaces the body fields.
Action to test: pix_issuance for Pix issuance, boleto_issuance for boleto issuance or cancellation for cancellation.
1 to 32 characters
Result for the pending action: completed completes the action; failed confirms failure.
1 to 16 characters
Responses
Response Body
Result of the applied pending scenario. Completed issuance makes payment details available; completed cancellation revokes the charge. The response does not confirm payment.
Result of configuring or resolving a Sandbox scenario.
Public identifier of the Sandbox charge.
Scenario action: Pix issuance, boleto issuance or cancellation.
Result selected for the action: pending, failed or completed.
Scenario progress: configured awaits the action; pending awaits resolution; failed and completed are final results.
Current charge state, according to the Charges resource codes.
Indicates that the same result was already recorded without repeating the action.
Response Body
The identifier, action, result or request is invalid. Check the fields indicated in 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 simulation accepts only Sandbox, using an API key or OAuth authorization for that environment.
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 charge was not found in the company Sandbox. IDs from another company or from Production receive the same response.
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 charge or scenario does not allow this step. Prepare the scenario before the action; resolve only a pending result already applied. Use another charge to test a different scenario.
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.