API
Checking Raims account

Prepare a scenario

Choose a pending or failed result for the next issuance or cancellation in the Sandbox.

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

Prepares the result of Pix or boleto issuance, or of cancellation. After this request, perform the corresponding action on the same charge.

Sandbox only

Use a key with the sk_test_ prefix. The scenario does not move real money or change Production charges.

See the sequence in Pending or failed issuance and cancellation.

Path Params

Public identifier of the charge created in your company Sandbox.

Up to 100 characters

Body Params

Action to test: pix_issuance for Pix issuance, boleto_issuance for boleto issuance or cancellation for cancellation.

1 to 32 characters

pix_issuance

Action result: pending keeps confirmation open; failed shows a failure.

1 to 16 characters

pending

Responses

For common errors, see HTTP response codes.