raims simulations
Execute as simulações permitidas pela API para a credencial selecionada.
Do comando ao resultado
As simulações exigem credencial e recurso Sandbox. Prepare uma cobrança com pagamento simulável nesse ambiente; dados de Produção não podem ser usados, mesmo que o perfil se chame sandbox.
O perfil e a credencial precisam estar configurados para as consultas reais.
Com chave de API, a chave determina empresa e ambiente. --environment
seleciona o ambiente somente no OAuth.
Confira a operação
Shellraims simulations charges confirm-payment CHARGE_ID --dry-runSubstitua o ID pelo da cobrança Sandbox. No OAuth, acrescente
--environment sandboxà prévia; com chave de API, o ambiente vem da própria chave.Confirme o pagamento simulado
Shellraims --profile sandbox --output json simulations charges confirm-payment CHARGE_IDExecute somente com a credencial Sandbox já conferida. Leia o status e
duplicateno resultado. Para testar falha, usefail-paymentem um cenário separado, sem encadear sucesso e falha na mesma cobrança.Confira o recurso
Shellraims --profile sandbox --output json charges get CHARGE_IDConsulte a cobrança no mesmo ambiente. Os cenários de boleto e estorno têm pré-requisitos próprios; escolha o comando correspondente na referência abaixo.
Escolha o comando
| Comando | Finalidade |
|---|---|
raims simulations charges compensate-boleto | Simule a compensação de um boleto. |
raims simulations charges configure-scenario | Configure o resultado da próxima simulação. |
raims simulations charges confirm-payment | Confirme um pagamento simulado. |
raims simulations charges fail-payment | Simule uma falha de pagamento. |
raims simulations charges issue-payment | Emita um pagamento simulado para uma cobrança. |
raims simulations charges refunds create | Crie um estorno simulado pendente. |
raims simulations charges resolve-scenario | Resolva uma simulação pendente. |
raims simulations refunds complete | Conclua um estorno simulado. |
raims simulations refunds fail | Simule uma falha de estorno. |
As prévias abaixo usam --dry-run e não enviam a requisição. Substitua os placeholders e confira o resultado antes de enviar uma escrita.
Campos de corpo, filtros e headers só são enviados quando informados. Os padrões das opções de execução não preenchem campos da API.
raims simulations
Execute as simulações permitidas pela API para a credencial selecionada.
raims simulations [flags]Opções de execução
--help,-hboolpadrão: false- Exibe a ajuda de simulations.
Consulte as opções globais.
Subcomandos: raims simulations charges, raims simulations refunds.
raims simulations charges
Simule cobranças e pagamentos.
raims simulations charges [flags]Opções de execução
--help,-hboolpadrão: false- Exibe a ajuda de charges.
Consulte as opções globais.
Subcomandos: 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
Simule a compensação de um boleto.
raims simulations charges compensate-boleto ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json simulations charges compensate-boleto ID --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Boleto compensado
{
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"status": 1,
"duplicate": false,
"amount_cents": 10000
}Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de compensate-boleto.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations charges configure-scenario
Configure o resultado da próxima simulação.
raims simulations charges configure-scenario ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200.
Exemplo 1
raims --profile PROFILE --output json simulations charges configure-scenario ID --data-file request.json --dry-runExemplo 2
raims simulations charges configure-scenario ID --action="boleto_issuance" --outcome="failed" --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Cenário configurado
{
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"state": "configured",
"duplicate": false,
"action": "pix_issuance",
"outcome": "pending",
"charge_status": 0
}Campos do corpo
--actionstringobrigatório no corpo enviado somente se informado- Ação a testar: pix_issuance para emissão Pix, boleto_issuance para emissão de boleto ou cancellation para cancelamento. Para cancellation, mantenha a cobrança aberta com Pix ou boleto já emitido, sem confirmar o pagamento.
--outcomestringobrigatório no corpo enviado somente se informado- Resultado da ação: pending mantém a confirmação em aberto; failed apresenta uma falha.
Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--data-filestringpadrão: vazio- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de configure-scenario.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations charges confirm-payment
Confirme um pagamento simulado.
raims simulations charges confirm-payment ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json simulations charges confirm-payment ID --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Simulação aplicada
{
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"status": 4,
"duplicate": false,
"amount_cents": 10000
}Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de confirm-payment.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations charges fail-payment
Simule uma falha de pagamento.
raims simulations charges fail-payment ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json simulations charges fail-payment ID --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Simulação aplicada
{
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"status": 9,
"duplicate": false,
"amount_cents": 10000
}Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de fail-payment.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations charges issue-payment
Emita um pagamento simulado para uma cobrança.
raims simulations charges issue-payment ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200, 202.
HTTP 202 indica um pedido pendente. Consulte o recurso retornado antes de repetir uma escrita; o comando não aguarda a conclusão.
Exemplo 1
raims --profile PROFILE --output json simulations charges issue-payment ID --data-file request.json --dry-runExemplo 2
raims simulations charges issue-payment ID --payment-method=2 --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Emissão Pix pendente
{
"id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"customer_id": "cus_1AbXiWSrsCBoaTg47OcMzC",
"status": 1,
"amount_cents": 10000,
"payment_method": 1,
"checkout_payment_method": 1
}Campos do corpo
--payment-methodintegerobrigatório no corpo enviado somente se informado- Meio a emitir: 1 para Pix ou 2 para boleto. Deve estar habilitado na cobrança.
Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--data-filestringpadrão: vazio- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de issue-payment.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations charges refunds
Simule estornos pendentes de uma cobrança.
raims simulations charges refunds [flags]Opções de execução
--help,-hboolpadrão: false- Exibe a ajuda de refunds.
Consulte as opções globais.
Subcomandos: raims simulations charges refunds create.
raims simulations charges refunds create
Crie um estorno simulado pendente.
raims simulations charges refunds create ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200, 202.
HTTP 202 indica um pedido pendente. Consulte o recurso retornado antes de repetir uma escrita; o comando não aguarda a conclusão.
Exemplo 1
raims --profile PROFILE --output json simulations charges refunds create ID --data-file request.json --dry-runExemplo 2
raims simulations charges refunds create ID --amount-cents=2500 --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Devolução aguardando confirmação
{
"id": "rf_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"status": "accepted",
"amount_cents": 2500,
"description": "Devolução parcial do serviço",
"created_at": 1791964800
}Campos do corpo
--amount-centsintegerobrigatório no corpo enviado somente se informado- Valor solicitado para devolução, em centavos de real. Para devolver tudo, informe o valor restante mostrado na consulta de elegibilidade.
--descriptionstringaceita null enviado somente se informado- Descrição da solicitação de devolução. Você pode deixar este campo vazio.
Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--body-nullstringArraypadrão: []- Envie null em um campo do corpo que aceite esse valor, usando o nome JSON; repita para outros campos e não combine com --data-file.
--data-filestringpadrão: vazio- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de create.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations charges resolve-scenario
Resolva uma simulação pendente.
raims simulations charges resolve-scenario ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200.
Exemplo 1
raims --profile PROFILE --output json simulations charges resolve-scenario ID --data-file request.json --dry-runExemplo 2
raims simulations charges resolve-scenario ID --action="boleto_issuance" --outcome="failed" --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Pendência concluída
{
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"state": "completed",
"duplicate": false,
"action": "pix_issuance",
"outcome": "completed",
"charge_status": 1
}Campos do corpo
--actionstringobrigatório no corpo enviado somente se informado- Ação a testar: pix_issuance para emissão Pix, boleto_issuance para emissão de boleto ou cancellation para cancelamento.
--outcomestringobrigatório no corpo enviado somente se informado- Resultado para a pendência: completed conclui a ação; failed confirma a falha.
Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--data-filestringpadrão: vazio- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de resolve-scenario.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations refunds
Conclua ou simule a falha de estornos.
raims simulations refunds [flags]Opções de execução
--help,-hboolpadrão: false- Exibe a ajuda de refunds.
Consulte as opções globais.
Subcomandos: raims simulations refunds complete, raims simulations refunds fail.
raims simulations refunds complete
Conclua um estorno simulado.
raims simulations refunds complete ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json simulations refunds complete ID --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Concluir estorno simulado
{
"id": "rf_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"status": "completed",
"amount_cents": 2500,
"description": "Devolução parcial do serviço",
"created_at": 1791964800
}Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de complete.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.raims simulations refunds fail
Simule uma falha de estorno.
raims simulations refunds fail ID [flags]Ambientes OAuth: Sandbox. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json simulations refunds fail ID --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Simular falha no estorno
{
"id": "rf_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"status": "failed",
"amount_cents": 2500,
"description": "Devolução parcial do serviço",
"created_at": 1791964800
}Headers da requisição
--idempotency-keystringenviado somente se informado- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
Opções de execução
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de fail.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
Consulte as opções globais.
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.