raims simulations

Simulate boleto clearing.

POST /v1/simulations/charges/{id}/compensate_boleto

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Configure the result of the next simulated operation.

POST /v1/simulations/charges/{id}/scenario

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  action   string  required; allowed: "pix_issuance", "boleto_issuance", "cancellation"
  outcome  string  required; allowed: "pending", "failed"
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "action": "boleto_issuance",
  "outcome": "failed"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Confirm a simulated payment.

POST /v1/simulations/charges/{id}/confirm_payment

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Simulate a failed payment.

POST /v1/simulations/charges/{id}/fail_payment

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Issue a simulated payment for a charge.

POST /v1/simulations/charges/{id}/issue_payment

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  payment_method  integer  required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "payment_method": 2
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.

Create a pending simulated refund.

POST /v1/simulations/charges/{id}/refunds

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  amount_cents  integer  required
  description   string   optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "amount_cents": 2500,
  "description": "Devolução parcial do serviço"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.

Resolve a pending simulated operation.

POST /v1/simulations/charges/{id}/resolve

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  action   string  required; allowed: "pix_issuance", "boleto_issuance", "cancellation"
  outcome  string  required; allowed: "completed", "failed"
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "action": "boleto_issuance",
  "outcome": "failed"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Complete a simulated refund.

POST /v1/simulations/refunds/{id}/complete

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.

Simulate a failed refund.

POST /v1/simulations/refunds/{id}/fail

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox.

Simulations require Sandbox credentials and resources. OAuth requests must select Sandbox. Production data cannot be simulated.