Raims CLIComandos da API
raims payment-links
Gerencie os links de pagamento.
Consulte a sintaxe, os argumentos e as opções de cada comando. Use raims COMANDO --help para ler a ajuda no terminal.
raims payment-links
Gerencie os links de pagamento.
Shell
raims payment-links [flags]--help,-hboolpadrão: false- Exibe a ajuda de payment-links.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Subcomandos: raims payment-links create, raims payment-links get, raims payment-links list, raims payment-links send-email, raims payment-links update.
raims payment-links create
Crie ou consulte um link de pagamento.
Shell
raims payment-links create [flags]--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.
--cancel-redirect-urlstringpadrão: vazio- Defina cancel_redirect_url no corpo JSON: texto que aceita null.
--charge-idstringpadrão: vazio- Defina charge_id no corpo JSON: texto obrigatório.
--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.
--idempotency-keystringpadrão: vazio- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--payment-method-typesintegerArraypadrão: vazio- Defina payment_method_types no corpo JSON: lista de inteiros que aceita null; repita a opção para cada item.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--success-redirect-urlstringpadrão: vazio- Defina success_redirect_url no corpo JSON: texto que aceita null.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Create or retrieve a payment link.
POST /v1/payment_links
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:
cancel_redirect_url string optional, nullable
charge_id string required
payment_method_types array<integer> optional, nullable; allowed: 1, 2
success_redirect_url 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):
{
"charge_id": "ch_4CnJiWSrsZBoaTg47OcMzD",
"success_redirect_url": "https://loja.example.com/pedido/concluido",
"cancel_redirect_url": "https://loja.example.com/pedido",
"payment_method_types": [
1
]
}
Example values are illustrative. Replace resource IDs and review the request before sending it.Exemplo do comando
Shell
raims --profile PROFILE --output json payment-links create --data-file request.json --dry-run
raims payment-links create --charge-id="ch_4CnJiWSrsZBoaTg47OcMzD" --dry-runraims payment-links get
Consulte um link de pagamento.
Shell
raims payment-links get ID [flags]--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.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Get a payment link.
GET /v1/payment_links/{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.Exemplo do comando
Shell
raims --profile PROFILE --output json payment-links get ID --dry-runraims payment-links list
Liste os links de pagamento.
Shell
raims payment-links list [flags]--afterstringpadrão: vazio- Consulte após este cursor opaco. Não combine com --before.
--allboolpadrão: false- Leia todas as páginas como resultados separados. Com --output json, a saída usa JSON Lines.
--beforestringpadrão: vazio- Consulte antes deste cursor opaco. Não combine com --after.
--charge-idstringpadrão: vazio- Filtre pelo identificador da cobrança.
--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.
--page-sizeint64padrão: 10- Quantidade de resultados por página. A API ajusta o tamanho solicitado.
--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.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
List payment links.
GET /v1/payment_links
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.Exemplo do comando
Shell
raims --profile PROFILE --output json payment-links list --dry-runraims payment-links send-email
Solicite o envio de um link de pagamento por e-mail.
Shell
raims payment-links send-email ID [flags]--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de send-email.
--idempotency-keystringpadrão: vazio- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--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.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Request delivery of a payment link by email.
POST /v1/payment_links/{id}/send_email
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.Exemplo do comando
Shell
raims --profile PROFILE --output json payment-links send-email ID --dry-runraims payment-links update
Atualize um link de pagamento.
Shell
raims payment-links update ID [flags]--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.
--cancel-redirect-urlstringpadrão: vazio- Defina cancel_redirect_url no corpo JSON: texto que aceita null.
--clear-cancel-redirect-urlboolpadrão: false- Defina clear_cancel_redirect_url no corpo JSON: booleano.
--clear-success-redirect-urlboolpadrão: false- Defina clear_success_redirect_url no corpo JSON: booleano.
--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.
--idempotency-keystringpadrão: vazio- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--is-activeboolpadrão: false- Defina is_active no corpo JSON: booleano.
--payment-method-typesintegerArraypadrão: vazio- Defina payment_method_types no corpo JSON: lista de inteiros que aceita null; repita a opção para cada item.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--success-redirect-urlstringpadrão: vazio- Defina success_redirect_url no corpo JSON: texto que aceita null.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Update a payment link.
PATCH /v1/payment_links/{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:
cancel_redirect_url string optional, nullable
clear_cancel_redirect_url boolean optional
clear_success_redirect_url boolean optional
is_active boolean optional
payment_method_types array<integer> optional, nullable; allowed: 1, 2
success_redirect_url 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):
{
"clear_success_redirect_url": true,
"cancel_redirect_url": "https://loja.example.com/pedido"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.Exemplo do comando
Shell
raims --profile PROFILE --output json payment-links update ID --data-file request.json --dry-run
raims payment-links update ID --cancel-redirect-url="https://loja.example.com/pedido" --dry-run