Atendimento

Listar cobranças

Lista as cobranças do lojista do token, com filtros, paginação e ordenação.

GET
/payments

Lista as cobranças do lojista do token, com filtros, paginação e ordenação.

Autorização

oauth2
headerAutorizaçãoBearer <token>

Token do Keycloak (client credentials), enviado como Authorization: Bearer.

Parâmetros de query

status?array<>

Status da cobrança; repita o parâmetro para mais de um

billingType?array<>

Forma de pagamento; repita o parâmetro para mais de uma

payerDocument?string

CPF (11) ou CNPJ (14) do pagador, só dígitos

Padrão (regex)\d{11}|\d{14}
dueDateFrom?string

Vencimento a partir desta data (inclusive)

Formatodate
dueDateTo?string

Vencimento até esta data (inclusive)

Formatodate
paidOnFrom?string

Pagas a partir desta data, horário de Brasília (inclusive)

Formatodate
paidOnTo?string

Pagas até esta data, horário de Brasília (inclusive)

Formatodate
createdFrom?string

Criadas a partir deste instante (inclusive), ISO-8601

Formatodate-time
createdTo?string

Criadas antes deste instante (exclusivo), ISO-8601

Formatodate-time
page?integer

Página, a partir de 0; padrão 0

Formatoint32
Faixa0 <= value
size?integer

Itens por página, de 1 a 100; padrão 20

Formatoint32
Faixa1 <= value <= 100
sort?string

Campo (createdAt, dueDate, paidOn, amount) e direção (asc, desc); padrão createdAt,desc

Padrão (regex)(createdAt|dueDate|paidOn|amount)(,(asc|desc))?

Corpo da resposta

OK

*/*
  1. response
content?array<>
page?
curl -X GET 'https://api.u2dpay.com.br/payments?status=PENDING&billingType=PIX&payerDocument=12345678901&dueDateFrom=2030-01-01&dueDateTo=2030-01-31&paidOnFrom=2030-01-01&paidOnTo=2030-01-31&createdFrom=2030-01-01T00%3A00%3A00Z&createdTo=2030-02-01T00%3A00%3A00Z&page=0&size=20&sort=dueDate%2Casc'
{  "content": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": "CREATING",      "billingType": "PIX",      "amount": 0,      "dueDate": "2019-08-24",      "description": "string",      "invoiceUrl": "string",      "checkoutUrl": "string",      "fee": 0,      "paidAmount": 0,      "netAmount": 0,      "paidOn": "2019-08-24",      "pix": {        "copyPaste": "string",        "expiresAt": "2019-08-24T14:15:22Z"      },      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "page": {    "number": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0  }}