Listar Links
GET/v1/paymentlink/list?initialPaymentDate={initialPaymentDate}&finalPaymentDate={finalPaymentDate}&status={status}&pageNumber={pageNumber}&pageSize={pageSize}&columnOrder={columnOrder}&sortDirection={sortDirection}
É possível pesquisar e obter uma lista de todos os links de pagamento gerados pela sua conta, bastando fazer um GET conforme abaixo:
Dicionário de dados - Query Parameters
Exemplo de requisição
curl --request GET \
--url 'https://api.sopague.com.br/gateway/v1/paymentlink/list?initialPaymentDate=2024-01-01&finalPaymentDate=2024-12-31&status=1&pageNumber=1&pageSize=10&columnOrder=operationDate&sortDirection=desc' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json'Exemplo de resposta
{
"paginacao": {
"numeroPagina": 1,
"qtdeItensPagina": 1,
"tamanhoPagina": 10,
"totalPaginas": 1,
"qtdeItensTotal": 1
},
"itens": [
{
"id": "aed32670-c3e5-4192-8ab0-0e96f92e3408",
"description": "Teste",
"value": 10.50,
// Apenas um dos campos abaixo vai estar preenchido: qttyInstallments ou qttyInstallmentsCustom
"qttyInstallments": 12,
"qttyInstallmentsCustom": [3, 6, 9, 12],
"qttyInstallmentsIntFree": 6,
"installmentsFee": 1.5,
"status": 9,
"statusFormat": "Desativado",
"operationDate": "2024-09-02T11:55:58.7093323",
"paymentDate": null,
"payer": null,
"paymentResultId": "020080286103040952150000006201850000000000"
}
]
}