v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
LinkPagamento

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
IdGUIDId do link de pagamento
NomeTextoNome do link de pagamento
TipoValorTextoTipo do valor do link de pagamento
ValorNúmeroValor do link de pagamento
FormasPagamentoTextoFormas de pagamento do link de pagamento
CriacaoTextoData de criação do link de pagamento
ObservacoesTextoObservações do link de pagamento
AtivoBooleanoRetorna true ou false, para identificar do status do link de pagamento
LayoutPaginaInicialTextoLayout da página inicial do link de pagamento
LayoutPaginaCompraTextoLayout da página de compra do link de pagamento
DataExpiracaoTextoData de expiração do link de consulta da compra
LinkReutilizavelBooleanoInforma se o link de pagamento pode ser reutilizado.
ParcelaFixaBooleanoEspecifica se o link de pagamento possui ou não parcelamento de cartão
ParcelaFixaQtdNúmeroDefine o número máximo de parcelas permitido para o link de pagamento
get/api/LinkPagamento/{Id}

Path parameters

Idstring required

Id do link de pagamento

Headers

Aeskeystring required

Response

Link de pagamento consultada

Criacaostring date-time

Data de criação do link de pagamento

Idstring

Id do link de pagamento

Nomestring required

Nome do link de pagamento

TipoValor'fixo' | 'variavel'

Tipo do valor do link de pagamento

Valornumber double

Valor do link de pagamento

FormasPagamento'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta'

Formas de pagamento do link de pagamento

Observacoesstring required

Observações do link de pagamento

Ativoboolean

Indicativo de ativo do link de pagamento

LayoutPaginaInicialstring

Layout da pagina inicial do link de pagamento

LayoutPaginaComprastring

Layout da pagina de compra do link de pagamento

DataExpiracaostring date-time

Data de expiracao do link de pagamento

LinkReutilizavelboolean

Indica se o Link de pagamento é reutilizável após pago

ParcelaFixaboolean

Indica se o Link de pagamento tem parcelamento diferente da configuracao geral

ParcelaFixaQtdinteger

Indica qual o maximo de parcelas o Link de pagamento pode ter