API
Checking Raims account

Resolve a pending scenario

Complete or fail pending issuance or cancellation in the Sandbox.

POSThttps://api.raims.com/v1/simulations/charges/{id}/resolve

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

pix_issuance

Result for the pending action: completed completes the action; failed confirms failure.

1 to 16 characters

completed

Responses

For common errors, see HTTP response codes.