raims payment-links
Gerencie os links de pagamento.
Do comando ao resultado
Crie o link para uma cobrança existente e escolha separadamente se quer pedir o envio por e-mail. Link criado, pedido de envio aceito e mensagem entregue são resultados distintos.
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.
Prepare o link
Shellraims payment-links create --charge-id CHARGE_ID --dry-runConfira a cobrança e as opções da prévia. Para criar, use o perfil correto e remova
--dry-runapós a revisão; guardedata.idedata.url.Confira o link
Shellraims --profile sandbox --output json payment-links get PAYMENT_LINK_IDConsulte o ID retornado e as condições atuais da cobrança antes de compartilhar o endereço.
Revise o pedido de e-mail
Shellraims --profile sandbox --output json payment-links send-email PAYMENT_LINK_ID --dry-runA prévia não envia e-mail. Remova
--dry-runsomente para solicitar o envio ao destinatário autorizado. HTTP 202 aceita o pedido, sem confirmar entrega; respeite o prazo retornado antes de outro pedido.
Escolha o comando
| Comando | Finalidade |
|---|---|
raims payment-links create | Crie ou consulte um link de pagamento. |
raims payment-links get | Consulte um link de pagamento. |
raims payment-links list | Liste os links de pagamento. |
raims payment-links send-email | Solicite o envio de um link de pagamento por e-mail. |
raims payment-links update | Atualize um link de pagamento. |
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 payment-links
Gerencie os links de pagamento.
raims payment-links [flags]Opções de execução
--help,-hboolpadrão: false- Exibe a ajuda de payment-links.
Consulte as opções globais.
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.
raims payment-links create [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200, 201.
Exemplo 1
raims --profile PROFILE --output json payment-links create --data-file request.json --dry-runExemplo 2
raims payment-links create --charge-id="ch_4CnJiWSrsZBoaTg47OcMzD" --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Link da cobrança
{
"id": "pl_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_4CnJiWSrsZBoaTg47OcMzD",
"url": "https://checkout.raims.com/4ERXvDgy82D8CLNY44AVr6",
"success_redirect_url": null,
"cancel_redirect_url": null,
"payment_method_types": null
}Campos do corpo
--cancel-redirect-urlstringaceita null enviado somente se informado- URL HTTPS para voltar ao seu site. Esse retorno não cancela a cobrança. Omitir, enviar null ou texto vazio preserva a URL existente.
--charge-idstringobrigatório no corpo enviado somente se informado- Identificador da cobrança existente. O link utiliza o cliente, o valor e o vencimento dessa cobrança.
--payment-method-typesintegerArrayaceita null enviado somente se informado- Meios permitidos no link. Omitir preserva a configuração; null remove a configuração própria. Uma lista limita os meios do checkout e não amplia os permitidos pela cobrança. Repita a opção para cada item.
--success-redirect-urlstringaceita null enviado somente se informado- URL HTTPS de retorno após o pagamento confirmado. Omitir, enviar null ou texto vazio preserva a URL existente.
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 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.raims payment-links get
Consulte um link de pagamento.
raims payment-links get ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json payment-links 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.
Link disponível para pagamento
{
"id": "pl_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_4CnJiWSrsZBoaTg47OcMzD",
"url": "https://checkout.raims.com/4ERXvDgy82D8CLNY44AVr6",
"success_redirect_url": null,
"cancel_redirect_url": null,
"payment_method_types": 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 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.raims payment-links list
Liste os links de pagamento.
raims payment-links list [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo
raims --profile PROFILE --output json payment-links 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.
Página de links
{
"list": [
{
"id": "pl_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_4CnJiWSrsZBoaTg47OcMzD",
"url": "https://checkout.raims.com/4ERXvDgy82D8CLNY44AVr6",
"success_redirect_url": null,
"cancel_redirect_url": null,
"payment_method_types": null,
"created_at": 1791936000,
"updated_at": 1791936000,
"is_active": true
}
],
"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.
--charge-idstringenviado somente se informado- Filtre pelo identificador da cobrança.
--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 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.raims payment-links send-email
Solicite o envio de um link de pagamento por e-mail.
raims payment-links send-email ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 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 payment-links send-email 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.
Pedido de envio registrado
{
"id": "pl_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_4CnJiWSrsZBoaTg47OcMzD",
"recipient_email": "cliente@example.com",
"retry_after_seconds": 60,
"retry_after_until": 1791936060
}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 send-email.
--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 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.raims payment-links update
Atualize um link de pagamento.
raims payment-links update ID [flags]Ambientes OAuth: Sandbox, Production. Respostas de sucesso: 200.
Exemplo 1
raims --profile PROFILE --output json payment-links update ID --data-file request.json --dry-runExemplo 2
raims payment-links update ID --cancel-redirect-url="https://loja.example.com/pedido" --dry-runO trecho abaixo mostra o conteúdo de data no CLI. O envelope também informa status_code e o request_id recebido.
Link da cobrança
{
"id": "pl_3AbHiWSrsZBoaTg47OcMzC",
"charge_id": "ch_4CnJiWSrsZBoaTg47OcMzD",
"url": "https://checkout.raims.com/4ERXvDgy82D8CLNY44AVr6",
"success_redirect_url": null,
"cancel_redirect_url": null,
"payment_method_types": null
}Campos do corpo
--cancel-redirect-urlstringaceita null enviado somente se informado- URL HTTPS para voltar ao seu site. Esse retorno não cancela a cobrança. Omitir, enviar null ou texto vazio preserva a URL existente. Para removê-la, use clear_cancel_redirect_url com true, sem informar uma URL preenchida.
--clear-cancel-redirect-urlboolenviado somente se informado- Envie true para remover o destino de voltar ao site. False ou omissão não solicita remoção. Não envie true junto de cancel_redirect_url preenchida.
--clear-success-redirect-urlboolenviado somente se informado- Envie true para remover o destino de retorno após o pagamento. False ou omissão não solicita remoção. Não envie true junto de success_redirect_url preenchida.
--is-activeboolenviado somente se informado- Envie false para pausar o checkout e true para reativar a mesma URL. Omitir preserva o estado atual. A pausa não cancela Pix ou boleto emitidos nem prorroga o vencimento.
--payment-method-typesintegerArrayaceita null enviado somente se informado- Meios permitidos no link. Omitir preserva a configuração; null remove a configuração própria. Uma lista limita os meios do checkout e não amplia os permitidos pela cobrança. Repita a opção para cada item.
--success-redirect-urlstringaceita null enviado somente se informado- URL HTTPS de retorno após o pagamento confirmado. Omitir, enviar null ou texto vazio preserva a URL existente. Para removê-la, use clear_success_redirect_url com true, sem informar uma URL preenchida.
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 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.