Documentação das APIs

Insere um link de pagamento

Esta API oferece a funcionalidade de criar links de pagamento, permitindo que você gere URLs únicas para receber pagamentos online de forma rápida e segura.
Para criar um link de pagamento, você precisa utilizar o método POST.Esse método recebe um objeto JSON com as informações do link de pagamento como parâmetro e retorna o ID do link criado.

Requisição

CampoTipoDescrição
IdTextoId do link de pagamento (opcional)
NomeTextoNome do link de pagamento
TipoValorTextoTipo do valor do link de pagamento.Podendo ser = fixo, variável (opcional)
ValorNúmeroValor do link de pagamento (opcional)
FormasPagamentoTextoFormas de pagamento do link de pagamento.Podendo ser = Nenhum, Boleto, Cartão, Pix, Manual, Protesto, SaldoWebConta (opcional)
CriacaoTextoData de criação do link de pagamento (opcional)
ObservacoesTextoObservações do link de pagamento
AtivoBoleanoIndicativo de ativo do link de pagamento (opcional)
LayoutPaginaInicialTextoLayout da página inicial do link de pagamento (opcional)
LayoutPaginaCompraTextoLayout da página de compra do link de pagamento (opcional)
DataExpiracaoTextoData de expiração do link de consulta da compra (opcional)

Resposta

CampoTipoDescrição
IdTextoId do link de pagamento
NomeTextoNome do link de pagamento
TipoValorTextoTipo do valor do link de pagamento.Podendo ser = fixo, variável
ValorNúmeroValor do link de pagamento
FormasPagamentoTextoFormas de pagamento do link de pagamento = Nenhum, Boleto, Cartão, Pix, Manual, Protesto, SaldoWebConta
CriacaoTextoData de criação do link de pagamento
ObservacoesTextoObservações do link de pagamento
AtivoBoleanoRetorna 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
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!