Consulta o link de pagamento por id

Esta API oferece a funcionalidade de consultar links de pagamento por ID, permitindo que você visualize informações detalhadas sobre um link específico.
Para consultar um link de pagamento por ID, você precisa utilizar o método GET. Esse método recebe o ID do link de pagamento como parâmetro e retorna um objeto com informações detalhadas sobre o link.

Requisição

CampoTipoDescriçãoObrigatório
IdGUIDId do link de pagamentoSim

Resposta

CampoTipoDescrição
IdGUIDIdentificador único do link de pagamento
NomeTextoNome do link de pagamento
TipoValorTextoTipo do valor do link de pagamento
ValorNuméricoValor do link de pagamento
FormasPagamentoTextoFormas de pagamento do link de pagamento
ObservacoesTextoObservações do link de pagamento
CriacaoTextoData de criação do link de pagamento
AtivoBooleanoIndicador se o link de pagamento está ativo
LayoutPaginaInicialTextoLayout da página inicial do link de pagamento
LayoutPaginaCompraTextoLayout da página de compra do link de pagamento
DataExpiracaoDataData de expiração do link de pagamento
LinkReutilizavelBooleanoIndicador se o link de pagamento pode ser reutilizado
ParcelaFixaBooleanoIndicador se o link de pagamento possui ou não parcelamento de cartão
ParcelaFixaQtdNúmeroNúmero máximo de parcelas permitido para o link de pagamento
------
DadosPagamentoObjetoDados do pagamento
IdGUIDIdentificador único do Pagamento
SituacaoTextoSituação do pagamento
DataPagamentoDataData do pagamento
FormaPagamentoTextoForma de pagamento
DadosPagamentoTextoDados do pagamento, ex: número do boleto ou copia e cola do pix
NumeroCobrancasNúmeroNúmero de cobranças vinculadas
ValorPagoNuméricoValor total pago (soma de todas cobranças pagas)
ValorPrincipalNuméricoValor principal total pago
ValorMultaJurosNuméricoValor total de multas/juros
NumeroPagamentoTextoNúmero do pagamento mais recente
ValorTaxasNuméricoValor total das taxas associadas
ValorLiquidoNuméricoValor líquido total
DataDisponibilizacaoDataData de disponibilização mais recente
ReembolsadoAoClienteBooleanoIndicação se algum pagamento foi reembolsado
AntecipadoBooleanoIndicativo se algum pagamento foi antecipado
TransacaoIdGUIDId da Transação mais recente
CobrancaIdGUIDId da Cobrança mais recente paga
NumeroCobrancasPagasNúmeroNúmero de cobranças pagas
NumeroCobrancasPendentesNúmeroNúmero de cobranças pendentes
NumeroCobrancasCanceladasNúmeroNúmero de cobranças canceladas
NumeroCobrancasInadimplentesNúmeroNúmero de cobranças inadimplentes
------
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id do link de pagamento

Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json