Docs
Verificando conta Raims
Raims CLIComandos da API

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.

  1. Confira a operação

    Shell
    raims simulations charges confirm-payment CHARGE_ID --dry-run

    Substitua 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.

  2. Confirme o pagamento simulado

    Shell
    raims --profile sandbox --output json simulations charges confirm-payment CHARGE_ID

    Execute somente com a credencial Sandbox já conferida. Leia o status e duplicate no resultado. Para testar falha, use fail-payment em um cenário separado, sem encadear sucesso e falha na mesma cobrança.

  3. Confira o recurso

    Shell
    raims --profile sandbox --output json charges get CHARGE_ID

    Consulte 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

ComandoFinalidade
raims simulations charges compensate-boletoSimule a compensação de um boleto.
raims simulations charges configure-scenarioConfigure o resultado da próxima simulação.
raims simulations charges confirm-paymentConfirme um pagamento simulado.
raims simulations charges fail-paymentSimule uma falha de pagamento.
raims simulations charges issue-paymentEmita um pagamento simulado para uma cobrança.
raims simulations charges refunds createCrie um estorno simulado pendente.
raims simulations charges resolve-scenarioResolva uma simulação pendente.
raims simulations refunds completeConclua um estorno simulado.
raims simulations refunds failSimule 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.

Shell
raims simulations [flags]

Opções de execução

  • --help, -h bool padrã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.

Shell
raims simulations charges [flags]

Opções de execução

  • --help, -h bool padrã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.

Shell
raims simulations charges compensate-boleto ID [flags]

Ambientes OAuth: Sandbox. Respostas de sucesso: 200.

Exemplo

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

Headers da requisição

  • --idempotency-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de compensate-boleto.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations charges configure-scenario

Configure o resultado da próxima simulação.

Shell
raims simulations charges configure-scenario ID [flags]

Ambientes OAuth: Sandbox. Respostas de sucesso: 200.

Exemplo 1

Shell
raims --profile PROFILE --output json simulations charges configure-scenario ID --data-file request.json --dry-run

Exemplo 2

Shell
raims simulations charges configure-scenario ID --action="boleto_issuance" --outcome="failed" --dry-run

Campos do corpo

  • --action string obrigató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.
  • --outcome string obrigató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-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --data-file string padrão: vazio
    • Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de configure-scenario.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations charges confirm-payment

Confirme um pagamento simulado.

Shell
raims simulations charges confirm-payment ID [flags]

Ambientes OAuth: Sandbox. Respostas de sucesso: 200.

Exemplo

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

Headers da requisição

  • --idempotency-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de confirm-payment.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations charges fail-payment

Simule uma falha de pagamento.

Shell
raims simulations charges fail-payment ID [flags]

Ambientes OAuth: Sandbox. Respostas de sucesso: 200.

Exemplo

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

Headers da requisição

  • --idempotency-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de fail-payment.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations charges issue-payment

Emita um pagamento simulado para uma cobrança.

Shell
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

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

Exemplo 2

Shell
raims simulations charges issue-payment ID --payment-method=2 --dry-run

Campos do corpo

  • --payment-method integer obrigató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-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --data-file string padrão: vazio
    • Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de issue-payment.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations charges refunds

Simule estornos pendentes de uma cobrança.

Shell
raims simulations charges refunds [flags]

Opções de execução

  • --help, -h bool padrã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.

Shell
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

Shell
raims --profile PROFILE --output json simulations charges refunds create ID --data-file request.json --dry-run

Exemplo 2

Shell
raims simulations charges refunds create ID --amount-cents=2500 --dry-run

Campos do corpo

  • --amount-cents integer obrigató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.
  • --description string aceita null enviado somente se informado
    • Descrição da solicitação de devolução. Você pode deixar este campo vazio.

Headers da requisição

  • --idempotency-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --body-null stringArray padrã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-file string padrão: vazio
    • Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de create.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations charges resolve-scenario

Resolva uma simulação pendente.

Shell
raims simulations charges resolve-scenario ID [flags]

Ambientes OAuth: Sandbox. Respostas de sucesso: 200.

Exemplo 1

Shell
raims --profile PROFILE --output json simulations charges resolve-scenario ID --data-file request.json --dry-run

Exemplo 2

Shell
raims simulations charges resolve-scenario ID --action="boleto_issuance" --outcome="failed" --dry-run

Campos do corpo

  • --action string obrigató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.
  • --outcome string obrigató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-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --data-file string padrão: vazio
    • Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de resolve-scenario.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations refunds

Conclua ou simule a falha de estornos.

Shell
raims simulations refunds [flags]

Opções de execução

  • --help, -h bool padrã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.

Shell
raims simulations refunds complete ID [flags]

Ambientes OAuth: Sandbox. Respostas de sucesso: 200.

Exemplo

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

Headers da requisição

  • --idempotency-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de complete.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.

raims simulations refunds fail

Simule uma falha de estorno.

Shell
raims simulations refunds fail ID [flags]

Ambientes OAuth: Sandbox. Respostas de sucesso: 200.

Exemplo

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

Headers da requisição

  • --idempotency-key string enviado somente se informado
    • Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.

Opções de execução

  • --dry-run bool padrão: false
    • Valide e apresente a requisição sem credenciais ou acesso à rede.
  • --help, -h bool padrão: false
    • Exibe a ajuda de fail.
  • --show-headers bool padrão: false
    • Mostre os headers públicos da resposta, sem credenciais ou cookies.
  • --timeout duration padrão: 1m0s
    • Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.

Consulte as opções globais.