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.
Revise a criação
Shellraims charges create --customer-id CUSTOMER_ID --amount-cents 10000 --due-date 1893456000 --dry-runA prévia mostra método, URL e corpo, sem credencial. Confira cliente, valor em centavos e vencimento.
Envie uma vez
Shellraims --profile sandbox --output json charges create --customer-id CUSTOMER_ID --amount-cents 10000 --due-date 1893456000 --idempotency-key pedido_123Use 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.Acompanhe a cobrança
Shellraims --profile sandbox --output json charges get CHARGE_IDUse o ID retornado, no mesmo ambiente. Consulte status e instruções disponíveis antes de repetir a criação.
payment,boletoereceipttêm finalidades e condições próprias.
Escolha o comando
| Comando | Finalidade |
|---|---|
raims charges boleto | Consulte os dados para baixar o boleto. |
raims charges create | Crie uma cobrança. |
raims charges get | Consulte uma cobrança. |
raims charges list | Liste as cobranças. |
raims charges payment | Consulte os dados de pagamento de uma cobrança. |
raims charges receipt | Consulte os dados para baixar o comprovante de pagamento. |
raims charges refund-eligibility | Confira se uma cobrança pode ser estornada. |
raims charges refunds create | Solicite um estorno de uma cobrança. |
raims charges refunds list | Liste os estornos de uma cobrança. |
raims charges revoke | Revogue uma cobrança. |
raims charges statistics | Consulte as estatísticas de cobranças de um período. |
raims charges update | Atualize 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.
raims charges [flags]Opções de execução
--help,-hboolpadrã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.
raims charges boleto ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges 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.
Baixar boleto
{
"url": "https://files.raims.com/documents/boleto/exemplo.pdf?Expires=1792080180&Signature=EXEMPLO&Key-Pair-Id=EXEMPLO",
"expires_at": 1792080180
}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 boleto.
--savestringpadrão: vazio- Salve o PDF no caminho informado, até 32 MiB; o diretório deve existir e o arquivo deve ser novo.
--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.
Get the boleto download information.
GET /v1/charges/{id}/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, Production.raims charges create
Crie uma cobrança.
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
raims --profile PROFILE --output json charges create --data-file request.json --dry-runExemplo 2
raims charges create --amount-cents=10000 --customer-id="cus_1Q2W3E4R5T6Y7U8I9O0P" --due-date=1893456000 --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Cobrança com emissão Pix pendente
{
"id": "ch_1Q2W3E4R5T6Y7U8I9O0P",
"customer_id": "cus_1Q2W3E4R5T6Y7U8I9O0P",
"status": 0,
"amount_cents": 10000,
"payment_method": 1,
"due_date": 1893456000
}Campos do corpo
--amount-centsintegerobrigatório no corpo enviado somente se informado- Valor da cobrança em centavos de real. Por exemplo, 10000 representa R$ 100,00.
--cancel-redirect-urlstringaceita 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-checkoutboolenviado 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-idstringobrigató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.
--descriptionstringaceita null enviado somente se informado- Descrição da cobrança. Você pode deixar este campo vazio.
--due-dateintegerobrigató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-referencestringaceita 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.
--metadatastringArrayenviado somente se informado- Defina um texto de metadata como CHAVE=VALOR; repita para outras chaves. Pontos nas chaves são literais.
--metadata-emptyboolenviado somente se informado- Envie metadata vazio; na atualização, as chaves existentes são preservadas.
--metadata-nullstringArrayenviado somente se informado- Envie null para uma chave de metadata; repita para outras chaves. Na atualização, a chave é removida.
--payment-methodintegerenviado 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-typesintegerArrayaceita 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-emailboolenviado 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-urlstringaceita 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.
--titlestringaceita null enviado somente se informado- Título da cobrança. 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 charge.
POST /v1/charges
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, Production.
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
cancel_redirect_url string optional, nullable
create_checkout boolean optional
customer_id string required
description string optional, nullable
due_date integer required
external_reference string optional, nullable
metadata object optional, nullable
payment_method integer optional; allowed: 0, 1, 2
payment_method_types array<integer> optional, nullable; allowed: 1, 2
send_email boolean optional
success_redirect_url string optional, nullable
title 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):
{
"customer_id": "cus_1Q2W3E4R5T6Y7U8I9O0P",
"amount_cents": 10000,
"payment_method": 0,
"due_date": 1893456000,
"title": "Serviço contratado",
"description": "Cobrança do serviço",
"send_email": false,
"external_reference": "pedido_12345"
}
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.
Metadata options send a text map: repeat --metadata KEY=VALUE for values, use --metadata-null KEY for a null value, or --metadata-empty for an empty object. Empty text, numeric-looking values and the text null remain strings. Omitted metadata and an empty object preserve existing keys when updating; null values remove individual keys, and --body-null metadata clears the entire map. Do not combine these options with --data-file, or use multiple values for the same key.raims charges get
Consulte uma cobrança.
raims charges get ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges get 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.
Cobrança antes da escolha do meio de pagamento
{
"id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"customer_id": "cus_1AbXiWSrsCBoaTg47OcMzC",
"status": 0,
"amount_cents": 10000,
"payment_method": 0,
"checkout_payment_method": null
}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 get.
--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.
Get a charge.
GET /v1/charges/{id}
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, Production.raims charges list
Liste as cobranças.
raims charges list [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges list --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Cobranças encontradas
{
"list": [
{
"id": "ch_1Q2W3E4R5T6Y7U8I9O0P",
"customer_id": "cus_1Q2W3E4R5T6Y7U8I9O0P",
"amount_cents": 10000,
"payment_method": 0,
"due_date": 1893456000,
"title": "Serviço contratado",
"description": "Cobrança do serviço",
"status": 0,
"created_at": 1791849600,
"checkout_url": null,
"checkout_payment_method": null,
"payment_method_types": null,
"external_reference": "pedido_12345",
"metadata": {}
}
],
"page": {
"page_size": 10,
"has_next": false,
"has_previous": false,
"next_after": null,
"previous_before": null
}
}Filtros de consulta
--afterstringenviado somente se informado- Consulte após este cursor opaco. Não combine com --before.
--beforestringenviado somente se informado- Consulte antes deste cursor opaco. Não combine com --after.
--created-gteint64enviado somente se informado- Criado a partir desta data Unix, em segundos.
--created-lteint64enviado somente se informado- Criado até esta data Unix, em segundos.
--customer-idstringenviado somente se informado- Filtre pelo identificador do cliente.
--due-gteint64enviado somente se informado- Vencimento a partir desta data Unix, em segundos.
--due-lteint64enviado somente se informado- Vencimento até esta data Unix, em segundos.
--emailstringenviado somente se informado- Filtre pelo endereço de e-mail.
--external-referencestringenviado somente se informado- Filtre pela referência externa.
--identifierstringenviado somente se informado- Filtre pelo identificador público do recurso.
--page-sizeint64enviado somente se informado- Quantidade de resultados por página. A API ajusta o tamanho solicitado.
--paid-gteint64enviado somente se informado- Pago a partir desta data Unix, em segundos.
--paid-lteint64enviado somente se informado- Pago até esta data Unix, em segundos.
--payment-methodstringenviado somente se informado- Filtre pelos códigos dos meios de pagamento, separados por vírgula.
--sort-keystringenviado somente se informado- Ordene os resultados por este campo da API.
--sort-orderstringenviado somente se informado- Direção da ordenação: asc ou desc.
--statusstringenviado somente se informado- Filtre pelos códigos de status das cobranças, separados por vírgula.
Opções de execução
--allboolpadrão: false- Leia todas as páginas como resultados separados. Com --output json, a saída usa JSON Lines.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de list.
--max-pagesintpadrão: 100- Limite de páginas com --all, entre 1 e 10000.
--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.
List charges.
GET /v1/charges
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, Production.raims charges payment
Consulte os dados de pagamento de uma cobrança.
raims charges payment ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges 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.
Pagamento Pix com identificador bancário
{
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"customer_id": "cus_1AbXiWSrsCBoaTg47OcMzC",
"amount_cents": 10000,
"payment_method": 1,
"paid_at": 1791878400,
"customer": {
"name": "Cliente Exemplo",
"tax_id": "12345678909"
}
}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 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.
Get payment details for a charge.
GET /v1/charges/{id}/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, Production.raims charges receipt
Consulte os dados para baixar o comprovante de pagamento.
raims charges receipt ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges receipt 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.
Baixar recibo de pagamento
{
"url": "https://files.raims.com/documents/recibo-pagamento/exemplo.pdf?Expires=1792080180&Signature=EXEMPLO&Key-Pair-Id=EXEMPLO",
"expires_at": 1792080180
}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 receipt.
--savestringpadrão: vazio- Salve o PDF no caminho informado, até 32 MiB; o diretório deve existir e o arquivo deve ser novo.
--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.
Get the payment receipt download information.
GET /v1/charges/{id}/receipt
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, Production.raims charges refund-eligibility
Confira se uma cobrança pode ser estornada.
raims charges refund-eligibility ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges refund-eligibility 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.
Cobrança apta a receber pedido de devolução
{
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"eligible": true,
"reason": null,
"refundable_amount_cents": 10000,
"pending_amount_cents": 0,
"max_refund_amount_cents": 10000
}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 refund-eligibility.
--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.
Check whether a charge can be refunded.
GET /v1/charges/{id}/refund_eligibility
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, Production.raims charges refunds
Consulte e solicite estornos de uma cobrança.
raims charges refunds [flags]Opções de execução
--help,-hboolpadrã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.
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
raims --profile PROFILE --output json charges refunds create ID --data-file request.json --dry-runExemplo 2
raims 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.
Request a refund for a charge.
POST /v1/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, Production.
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 charges refunds list
Liste os estornos de uma cobrança.
raims charges refunds list ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges refunds list 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.
Histórico de devoluções parciais
{
"list": [
{
"id": "rf_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"amount_cents": 2500,
"description": "Devolução parcial do serviço",
"status": "accepted",
"created_at": 1791964800,
"completed_at": null,
"failed_at": null,
"failure_reason": null
},
{
"id": "rf_3AbHiWSrsZBoaTg47OcMzD",
"charge_id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"amount_cents": 1000,
"description": "Devolução parcial do serviço",
"status": "completed",
"created_at": 1791878400,
"completed_at": 1791878580,
"failed_at": null,
"failure_reason": null
}
],
"page": {
"page_size": 10,
"has_next": false,
"has_previous": false,
"next_after": null,
"previous_before": null
}
}Filtros de consulta
--afterstringenviado somente se informado- Consulte após este cursor opaco. Não combine com --before.
--beforestringenviado somente se informado- Consulte antes deste cursor opaco. Não combine com --after.
--created-gteint64enviado somente se informado- Criado a partir desta data Unix, em segundos.
--created-lteint64enviado somente se informado- Criado até esta data Unix, em segundos.
--page-sizeint64enviado somente se informado- Quantidade de resultados por página. A API ajusta o tamanho solicitado.
Opções de execução
--allboolpadrão: false- Leia todas as páginas como resultados separados. Com --output json, a saída usa JSON Lines.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de list.
--max-pagesintpadrão: 100- Limite de páginas com --all, entre 1 e 10000.
--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.
List refunds for a charge.
GET /v1/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, Production.raims charges revoke
Revogue uma cobrança.
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
raims --profile PROFILE --output json charges revoke 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.
Revogar cobrança
{
"id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"status": 1,
"revoked": false,
"revocation_pending": true
}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 revoke.
--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.
Revoke a charge.
DELETE /v1/charges/{id}
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, Production.
HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.raims charges statistics
Consulte as estatísticas de cobranças de um período.
raims charges statistics [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json charges statistics --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Cobranças e recebimentos dos últimos 7 dias
{
"period": "last_7_days",
"start_at": 1791428400,
"end_at": 1792033200,
"issued": {
"count": 120,
"amount_cents": 2400000
},
"issued_paid": {
"count": 90,
"amount_cents": 1800000
},
"received": {
"count": 95,
"amount_cents": 1900000
}
}Filtros de consulta
--periodstringenviado somente se informado- Período da consulta: today, last_7_days, last_15_days ou last_30_days.
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 statistics.
--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.
Get charge statistics for a period.
GET /v1/charges/statistics
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, Production.raims charges update
Atualize uma cobrança.
raims charges update ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo 1
raims --profile PROFILE --output json charges update ID --data-file request.json --dry-runExemplo 2
raims charges update ID --description="Descrição atualizada da cobrança" --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Atualizar cobrança existente
{
"id": "ch_3AbHiWSrsZBoaTg47OcMzC",
"customer_id": "cus_1AbXiWSrsCBoaTg47OcMzC",
"status": 0,
"amount_cents": 10000,
"payment_method": 0,
"checkout_payment_method": null
}Campos do corpo
--descriptionstringaceita 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-referencestringaceita 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.
--metadatastringArrayenviado somente se informado- Defina um texto de metadata como CHAVE=VALOR; repita para outras chaves. Pontos nas chaves são literais.
--metadata-emptyboolenviado somente se informado- Envie metadata vazio; na atualização, as chaves existentes são preservadas.
--metadata-nullstringArrayenviado somente se informado- Envie null para uma chave de metadata; repita para outras chaves. Na atualização, a chave é removida.
--titlestringaceita 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-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 update.
--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.
Update a charge.
PATCH /v1/charges/{id}
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, Production.
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:
description string optional, nullable
external_reference string optional, nullable
metadata object optional, nullable
title 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):
{
"title": "Serviço atualizado",
"description": "Descrição atualizada da cobrança",
"external_reference": "pedido_12345_atualizado"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.
Metadata options send a text map: repeat --metadata KEY=VALUE for values, use --metadata-null KEY for a null value, or --metadata-empty for an empty object. Empty text, numeric-looking values and the text null remain strings. Omitted metadata and an empty object preserve existing keys when updating; null values remove individual keys, and --body-null metadata clears the entire map. Do not combine these options with --data-file, or use multiple values for the same key.