Docs
Verificando conta Raims
Raims CLIComandos da API

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.

  1. Prepare o link

    Shell
    raims payment-links create --charge-id CHARGE_ID --dry-run

    Confira a cobrança e as opções da prévia. Para criar, use o perfil correto e remova --dry-run após a revisão; guarde data.id e data.url.

  2. Confira o link

    Shell
    raims --profile sandbox --output json payment-links get PAYMENT_LINK_ID

    Consulte o ID retornado e as condições atuais da cobrança antes de compartilhar o endereço.

  3. Revise o pedido de e-mail

    Shell
    raims --profile sandbox --output json payment-links send-email PAYMENT_LINK_ID --dry-run

    A prévia não envia e-mail. Remova --dry-run somente 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

ComandoFinalidade
raims payment-links createCrie ou consulte um link de pagamento.
raims payment-links getConsulte um link de pagamento.
raims payment-links listListe os links de pagamento.
raims payment-links send-emailSolicite o envio de um link de pagamento por e-mail.
raims payment-links updateAtualize 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.

Gerencie os links de pagamento.

Shell
raims payment-links [flags]

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.

Crie ou consulte um link de pagamento.

Shell
raims payment-links create [flags]

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

Consulte as opções globais.

Consulte um link de pagamento.

Shell
raims payment-links get ID [flags]

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

Consulte as opções globais.

Liste os links de pagamento.

Shell
raims payment-links list [flags]

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

Consulte as opções globais.

Solicite o envio de um link de pagamento por e-mail.

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

Consulte as opções globais.

Atualize um link de pagamento.

Shell
raims payment-links update ID [flags]

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

Consulte as opções globais.