Skip to main content
GET
/
payments
/
{pageNumber}
/
{pageLimit}
Retorna lista de pagamentos agrupados por pedido
curl --request GET \
  --url https://backend-pied-prod.piedadmin.com.br/api/v2/payments/{pageNumber}/{pageLimit} \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "orderId": "<string>",
      "status": "notRequested",
      "payments": {
        "type": "pix",
        "condition": {
          "name": "À vista",
          "quantityOfInstallments": 1,
          "conditionType": "notUpdate",
          "modifierType": "percentage",
          "value": 10
        },
        "transactionStatus": "pending",
        "transactionId": "AAABBB123AA",
        "authorizationNsu": "123123",
        "authorizationCode": "123123",
        "paidAt": "2025-01-01T00:00",
        "creditCard": {
          "brand": "visa",
          "last4digits": "1234",
          "first6digits": "123456",
          "holderName": "John Doe"
        },
        "total": 123,
        "subtotal": 123
      }
    }
  ],
  "meta": {
    "totalItems": 123,
    "itemsPerPage": 123,
    "totalPages": 123,
    "currentPage": 123,
    "links": {
      "first": "<string>",
      "last": "<string>",
      "next": "<string>",
      "previous": "<string>"
    }
  }
}
🚀 API v2 (Recomendada) - Use este endpoint para novos projetos

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pageNumber
integer
required

Determina o número da página a ser retornada.

pageLimit
integer
required

Limita a quantidade de registros retornados por página.

Query Parameters

orderId
string

ID do pedido

orderCode
string

Código do pedido

status
string

Status geral do pagamento

createdBefore
string

A pesquisa retorna registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD).

createdAfter
string

A pesquisa retorna registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

updatedBefore
string

A pesquisa retorna registros atualizados até esta data passada no parâmetro. Formato (AAAA-MM-DD).

updatedAfter
string

A pesquisa retorna registros atualizados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

Response

OK

items
object[]
meta
object