Simulate boleto clearing

Mark a boleto as cleared before its amount is credited to the balance.

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

Simulates the clearing of an issued boleto to test the wait for settlement. This step does not credit the balance or confirm an incoming payment in the statement.

Sandbox only

Use a key with the sk_test_ prefix. Clearing is simulated and does not move real money.

See how to complete the payment in Boleto clearing and settlement.

Path Params

idstringrequired

Public identifier of the charge created in your company Sandbox.

Up to 100 characters

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request POST \
  --url https://api.raims.com/v1/simulations/charges/%7Bid%7D/compensate_boleto \
  --header 'accept: application/json'

Response

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

application/json

Simulate boleto clearing

Path Params

Responses

200OK

400Bad Request

403Forbidden

404Not Found

409Conflict