Consulta os links de pagamento por nome

Esta endpoint oferece a funcionalidade de consultar links de pagamento por nome, permitindo que você localize links específicos com base em um termo de pesquisa.

Esse método recebe um termo de pesquisa como parâmetro e retorna uma lista de links de pagamento que contenham o termo em seu nome.

Requisição

CampoTipoDescriçãoObrigatório
NomeContainsTextoNome ou parte do nome do link de pagamentoNão
StartNúmeroPosição do início da consultaNão
SizeNúmeroQuantidade de itens retornadosNão

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, identificado 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
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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Nome do link de pagamento, aceita consulta parcial

int32

Inicio da consulta

int32

Tamanho da consulta

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