Docs
Verificando conta Raims
Raims CLIComandos da API

raims charges

Gerencie as cobranças e seus dados de pagamento.

Do comando ao resultado

Crie uma cobrança para um cliente existente e acompanhe o ID retornado. Substitua CUSTOMER_ID e revise o vencimento Unix em segundos antes do envio; os valores abaixo são ilustrativos.

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. Revise a criação

    Shell
    raims charges create --customer-id CUSTOMER_ID --amount-cents 10000 --due-date 1893456000 --dry-run

    A prévia mostra método, URL e corpo, sem credencial. Confira cliente, valor em centavos e vencimento.

  2. Envie uma vez

    Shell
    raims --profile sandbox --output json charges create --customer-id CUSTOMER_ID --amount-cents 10000 --due-date 1893456000 --idempotency-key pedido_123

    Use uma chave de idempotência estável para esta intenção e preserve-a ao repetir a mesma entrada. Guarde data.id; HTTP 202 continua pendente.

  3. Acompanhe a cobrança

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

    Use o ID retornado, no mesmo ambiente. Consulte status e instruções disponíveis antes de repetir a criação. payment, boleto e receipt têm finalidades e condições próprias.

Escolha o comando

ComandoFinalidade
raims charges boletoConsulte os dados para baixar o boleto.
raims charges createCrie uma cobrança.
raims charges getConsulte uma cobrança.
raims charges listListe as cobranças.
raims charges paymentConsulte os dados de pagamento de uma cobrança.
raims charges receiptConsulte os dados para baixar o comprovante de pagamento.
raims charges refund-eligibilityConfira se uma cobrança pode ser estornada.
raims charges refunds createSolicite um estorno de uma cobrança.
raims charges refunds listListe os estornos de uma cobrança.
raims charges revokeRevogue uma cobrança.
raims charges statisticsConsulte as estatísticas de cobranças de um período.
raims charges updateAtualize uma cobrança.

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 charges

Gerencie as cobranças e seus dados de pagamento.

Shell
raims 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 charges boleto, raims charges create, raims charges get, raims charges list, raims charges payment, raims charges receipt, raims charges refund-eligibility, raims charges refunds, raims charges revoke, raims charges statistics, raims charges update.

raims charges boleto

Consulte os dados para baixar o boleto.

Shell
raims charges boleto ID [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

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

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 boleto.
  • --save string padrão: vazio
    • Salve o PDF no caminho informado, até 32 MiB; o diretório deve existir e o arquivo deve ser novo.
  • --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 charges create

Crie uma cobrança.

Shell
raims charges create [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 201, 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 charges create --data-file request.json --dry-run

Exemplo 2

Shell
raims charges create --amount-cents=10000 --customer-id="cus_1Q2W3E4R5T6Y7U8I9O0P" --due-date=1893456000 --dry-run

Campos do corpo

  • --amount-cents integer obrigatório no corpo enviado somente se informado
    • Valor da cobrança em centavos de real. Por exemplo, 10000 representa R$ 100,00.
  • --cancel-redirect-url string aceita null enviado somente se informado
    • URL HTTPS do seu site para o pagador voltar pelo checkout. Voltar não cancela a cobrança, o Pix ou o boleto. Não aceita credenciais no endereço, IP literal, localhost ou domínio Raims. Quando preenchida, gera checkout_url mesmo com send_email false. Se omitida, vazia ou null, o retorno não é definido.
  • --create-checkout bool enviado somente se informado
    • Com true, gera o link retornado em checkout_url, sem exigir uma URL de retorno nem solicitar envio de e-mail. Com false, o link ainda é gerado quando send_email é true ou uma URL de retorno é informada.
  • --customer-id string obrigatório no corpo enviado somente se informado
    • ID de um cliente da empresa e do ambiente autenticado. Copie o id retornado no cadastro ou na consulta. Pix direto exige CPF/CNPJ válido. Boleto direto exige nome, e-mail válido, CPF/CNPJ e endereço, incluindo CEP e número; complete esses dados no cadastro do cliente.
  • --description string aceita null enviado somente se informado
    • Descrição da cobrança. Você pode deixar este campo vazio.
  • --due-date integer obrigatório no corpo enviado somente se informado
    • Vencimento em segundos Unix UTC, pelo menos cinco minutos no futuro. A data máxima é hoje mais dez anos, no calendário de São Paulo.
  • --external-reference string aceita null enviado somente se informado
    • Referência do pedido ou da cobrança no seu sistema. Null, vazio ou somente espaços deixam sem referência. Pode ser repetida e não evita cobranças duplicadas. É diferente da referência do cadastro do cliente.
  • --metadata stringArray enviado somente se informado
    • Defina um texto de metadata como CHAVE=VALOR; repita para outras chaves. Pontos nas chaves são literais.
  • --metadata-empty bool enviado somente se informado
    • Envie metadata vazio; na atualização, as chaves existentes são preservadas.
  • --metadata-null stringArray enviado somente se informado
    • Envie null para uma chave de metadata; repita para outras chaves. Na atualização, a chave é removida.
  • --payment-method integer enviado somente se informado
    • Meio da cobrança. Omitir ou enviar 0 permite escolher no checkout. Sem payment_method_types, 1 solicita Pix e 2 solicita boleto na criação, conforme os meios habilitados. Boleto usa o endereço do cliente e completa campos ausentes pelo CEP quando disponíveis. Com lista própria, envie 0 ou omita este campo; a emissão acontece após a escolha no checkout.
  • --payment-method-types integerArray aceita null enviado somente se informado
    • Meios permitidos para a cobrança: 1 para Pix e 2 para boleto. Omitir ou enviar null usa a configuração de checkout herdada. Informe uma lista sem repetições. A configuração própria substitui o padrão da conta; uma configuração do link pode apenas restringir essa lista. Combine com payment_method omitido ou 0. Repita a opção para cada item.
  • --send-email bool enviado somente se informado
    • Com true, solicita o envio da cobrança ao e-mail do cliente e gera checkout_url. Em contas pendentes, o cliente precisa ter o mesmo e-mail principal da conta. Fora dessa condição, um e-mail ausente ou inválido impede o envio, mas permite criar a cobrança quando não houver emissão direta de boleto. Boleto direto exige e-mail válido mesmo com false. A resposta não confirma a entrega da mensagem.
  • --success-redirect-url string aceita null enviado somente se informado
    • URL HTTPS do seu site para retorno após a confirmação do pagamento. O redirecionamento não comprova o pagamento; consulte a cobrança para confirmá-lo. Não aceita credenciais no endereço, IP literal, localhost ou domínio Raims. Quando preenchida, gera checkout_url mesmo com send_email false. Se omitida, vazia ou null, o retorno não é definido.
  • --title string aceita null enviado somente se informado
    • Título da cobrança. 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 charges get

Consulte uma cobrança.

Shell
raims charges get ID [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

Shell
raims --profile PROFILE --output json charges get ID --dry-run

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 get.
  • --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 charges list

Liste as cobranças.

Shell
raims charges list [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

Shell
raims --profile PROFILE --output json charges list --dry-run

Filtros de consulta

  • --after string enviado somente se informado
    • Consulte após este cursor opaco. Não combine com --before.
  • --before string enviado somente se informado
    • Consulte antes deste cursor opaco. Não combine com --after.
  • --created-gte int64 enviado somente se informado
    • Criado a partir desta data Unix, em segundos.
  • --created-lte int64 enviado somente se informado
    • Criado até esta data Unix, em segundos.
  • --customer-id string enviado somente se informado
    • Filtre pelo identificador do cliente.
  • --due-gte int64 enviado somente se informado
    • Vencimento a partir desta data Unix, em segundos.
  • --due-lte int64 enviado somente se informado
    • Vencimento até esta data Unix, em segundos.
  • --email string enviado somente se informado
    • Filtre pelo endereço de e-mail.
  • --external-reference string enviado somente se informado
    • Filtre pela referência externa.
  • --identifier string enviado somente se informado
    • Filtre pelo identificador público do recurso.
  • --page-size int64 enviado somente se informado
    • Quantidade de resultados por página. A API ajusta o tamanho solicitado.
  • --paid-gte int64 enviado somente se informado
    • Pago a partir desta data Unix, em segundos.
  • --paid-lte int64 enviado somente se informado
    • Pago até esta data Unix, em segundos.
  • --payment-method string enviado somente se informado
    • Filtre pelos códigos dos meios de pagamento, separados por vírgula.
  • --sort-key string enviado somente se informado
    • Ordene os resultados por este campo da API.
  • --sort-order string enviado somente se informado
    • Direção da ordenação: asc ou desc.
  • --status string enviado somente se informado
    • Filtre pelos códigos de status das cobranças, separados por vírgula.

Opções de execução

  • --all bool padrão: false
    • Leia todas as páginas como resultados separados. Com --output json, a saída usa JSON Lines.
  • --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 list.
  • --max-pages int padrão: 100
    • Limite de páginas com --all, entre 1 e 10000.
  • --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 charges payment

Consulte os dados de pagamento de uma cobrança.

Shell
raims charges payment ID [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

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

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 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 charges receipt

Consulte os dados para baixar o comprovante de pagamento.

Shell
raims charges receipt ID [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

Shell
raims --profile PROFILE --output json charges receipt ID --dry-run

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 receipt.
  • --save string padrão: vazio
    • Salve o PDF no caminho informado, até 32 MiB; o diretório deve existir e o arquivo deve ser novo.
  • --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 charges refund-eligibility

Confira se uma cobrança pode ser estornada.

Shell
raims charges refund-eligibility ID [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

Shell
raims --profile PROFILE --output json charges refund-eligibility ID --dry-run

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 refund-eligibility.
  • --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 charges refunds

Consulte e solicite estornos de uma cobrança.

Shell
raims 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 charges refunds create, raims charges refunds list.

raims charges refunds create

Solicite um estorno de uma cobrança.

Shell
raims charges refunds create ID [flags]

Ambientes OAuth: Sandbox, Production. 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 charges refunds create ID --data-file request.json --dry-run

Exemplo 2

Shell
raims 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 charges refunds list

Liste os estornos de uma cobrança.

Shell
raims charges refunds list ID [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

Shell
raims --profile PROFILE --output json charges refunds list ID --dry-run

Filtros de consulta

  • --after string enviado somente se informado
    • Consulte após este cursor opaco. Não combine com --before.
  • --before string enviado somente se informado
    • Consulte antes deste cursor opaco. Não combine com --after.
  • --created-gte int64 enviado somente se informado
    • Criado a partir desta data Unix, em segundos.
  • --created-lte int64 enviado somente se informado
    • Criado até esta data Unix, em segundos.
  • --page-size int64 enviado somente se informado
    • Quantidade de resultados por página. A API ajusta o tamanho solicitado.

Opções de execução

  • --all bool padrão: false
    • Leia todas as páginas como resultados separados. Com --output json, a saída usa JSON Lines.
  • --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 list.
  • --max-pages int padrão: 100
    • Limite de páginas com --all, entre 1 e 10000.
  • --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 charges revoke

Revogue uma cobrança.

Shell
raims charges revoke ID [flags]

Ambientes OAuth: Sandbox, Production. 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

Shell
raims --profile PROFILE --output json charges revoke 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 revoke.
  • --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 charges statistics

Consulte as estatísticas de cobranças de um período.

Shell
raims charges statistics [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo

Shell
raims --profile PROFILE --output json charges statistics --dry-run

Filtros de consulta

  • --period string enviado somente se informado
    • Período da consulta: today, last_7_days, last_15_days ou last_30_days.

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 statistics.
  • --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 charges update

Atualize uma cobrança.

Shell
raims charges update ID [flags]

Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.

Exemplo 1

Shell
raims --profile PROFILE --output json charges update ID --data-file request.json --dry-run

Exemplo 2

Shell
raims charges update ID --description="Descrição atualizada da cobrança" --dry-run

Campos do corpo

  • --description string aceita null enviado somente se informado
    • Descrição da cobrança. Omita para manter a descrição atual; envie null ou texto vazio para removê-la.
  • --external-reference string aceita null enviado somente se informado
    • Referência do pedido ou da cobrança no seu sistema. Omita para manter o valor atual; envie null ou texto vazio para removê-lo. Pode ser repetida em outras cobranças e é independente da referência do cliente.
  • --metadata stringArray enviado somente se informado
    • Defina um texto de metadata como CHAVE=VALOR; repita para outras chaves. Pontos nas chaves são literais.
  • --metadata-empty bool enviado somente se informado
    • Envie metadata vazio; na atualização, as chaves existentes são preservadas.
  • --metadata-null stringArray enviado somente se informado
    • Envie null para uma chave de metadata; repita para outras chaves. Na atualização, a chave é removida.
  • --title string aceita null enviado somente se informado
    • Título da cobrança. Omita para manter o título atual; envie null ou texto vazio para removê-lo.

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 update.
  • --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.