raims simulations | Raims Documentation

Look up syntax, arguments, and options for each command. Use raims COMMAND --help to read the help in your terminal.

`raims simulations`

Simulate operations allowed by the API for the selected credential

Shell

raims simulations [flags]

--help, -h bool default: false
- help for simulations

Subcommands: raims simulations charges, raims simulations refunds.

`raims simulations charges`

Simulate charge and payment operations

Shell

raims simulations charges [flags]

--help, -h bool default: false
- help for charges

Subcommands: raims simulations charges compensate-boleto, raims simulations charges configure-scenario, raims simulations charges confirm-payment, raims simulations charges fail-payment, raims simulations charges issue-payment, raims simulations charges refunds, raims simulations charges resolve-scenario.

`raims simulations charges compensate-boleto`

Simulate boleto clearing

Shell

raims simulations charges compensate-boleto ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for compensate-boleto
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations charges compensate-boleto ID --dry-run

`raims simulations charges configure-scenario`

Configure the result of the next simulated operation

Shell

raims simulations charges configure-scenario ID [flags]

--action string default: empty
- Set JSON body field action (string, required in the body)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for configure-scenario
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--outcome string default: empty
- Set JSON body field outcome (string, required in the body)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations charges configure-scenario ID --data-file request.json --dry-run
raims simulations charges configure-scenario ID --action="boleto_issuance" --outcome="failed" --dry-run

`raims simulations charges confirm-payment`

Confirm a simulated payment

Shell

raims simulations charges confirm-payment ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for confirm-payment
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations charges confirm-payment ID --dry-run

`raims simulations charges fail-payment`

Simulate a failed payment

Shell

raims simulations charges fail-payment ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for fail-payment
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations charges fail-payment ID --dry-run

`raims simulations charges issue-payment`

Issue a simulated payment for a charge

Shell

raims simulations charges issue-payment ID [flags]

--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for issue-payment
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--payment-method integer default: 0
- Set JSON body field payment_method (integer, required in the body)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations charges issue-payment ID --data-file request.json --dry-run
raims simulations charges issue-payment ID --payment-method=2 --dry-run

`raims simulations charges refunds`

Simulate pending refunds for a charge

Shell

raims simulations charges refunds [flags]

--help, -h bool default: false
- help for refunds

Subcommands: raims simulations charges refunds create.

`raims simulations charges refunds create`

Create a pending simulated refund

Shell

raims simulations charges refunds create ID [flags]

--amount-cents integer default: 0
- Set JSON body field amount_cents (integer, required in the body)
--body-null stringArray default: []
- Set a nullable JSON body field to null by its JSON name (repeat for each field; cannot be combined with --data-file)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--description string default: empty
- Set JSON body field description (string, nullable)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for create
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations charges refunds create ID --data-file request.json --dry-run
raims simulations charges refunds create ID --amount-cents=2500 --dry-run

`raims simulations charges resolve-scenario`

Resolve a pending simulated operation

Shell

raims simulations charges resolve-scenario ID [flags]

--action string default: empty
- Set JSON body field action (string, required in the body)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for resolve-scenario
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--outcome string default: empty
- Set JSON body field outcome (string, required in the body)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations charges resolve-scenario ID --data-file request.json --dry-run
raims simulations charges resolve-scenario ID --action="boleto_issuance" --outcome="failed" --dry-run

`raims simulations refunds`

Complete or fail simulated refunds

Shell

raims simulations refunds [flags]

--help, -h bool default: false
- help for refunds

Subcommands: raims simulations refunds complete, raims simulations refunds fail.

`raims simulations refunds complete`

Complete a simulated refund

Shell

raims simulations refunds complete ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for complete
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations refunds complete ID --dry-run

`raims simulations refunds fail`

Simulate a failed refund

Shell

raims simulations refunds fail ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for fail
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json simulations refunds fail ID --dry-run