API
Verificando conta Raims

Recuperar um link de pagamento

Consulte a URL, a configuração e se a cobrança ainda pode ser paga pelo link.

GEThttps://api.raims.com/v1/payment_links/{id}

Consulta um link pelo identificador recebido na criação ou na listagem. O link precisa pertencer à empresa e ao ambiente da sua chave de API.

O campo charge_id identifica a cobrança vinculada. Use esse identificador em Recuperar uma única cobrança para consultar o cliente, o valor, o vencimento, o status e os dados de pagamento disponíveis.

is_active informa se o link está ativo ou pausado. Um link ativo ainda depende das condições da cobrança para aceitar pagamento. is_payable indica se a cobrança ainda pode ser paga por esse link. Uma cobrança já paga, revogada ou vencida, por exemplo, não permite outro pagamento pelo link. Se o valor for false, consulte unavailable_reason.code para entender o motivo. Quando o impedimento for a pausa, o código será PAYMENT_LINK_PAUSED. O link continua consultável e usa a mesma URL após a reativação.

Veja como usar o endereço retornado em Links de pagamento. A consulta não cria ou altera a cobrança nem emite dados de pagamento.

Parâmetros de caminho

Identificador público do link, recebido na criação ou na listagem.

Até 100 caracteres

Respostas

Para os erros gerais, consulte Códigos HTTP das respostas.