GET/payments/requests

List

Recovers all created payment requests

Parameters

Query Parameters

Name	Type	Description
`pageSize`	number (double)	Page size for the paging request, default: 500
`page`	number (double)	Page number for the paging request, default: 1
`from`	string (date)	Filter payment requests by start date. Returns only requests created on or after this date.
`to`	string (date)	Filter payment requests by end date. Returns only requests created on or before this date.
`customer`	string	Filter payment requests with one customer attribute (name, email, CPF or CNPJ)
`pixKey`	string	Filter payment requests by Pix Key
`status`	string	Filter payment requests by status `CREATEDIN_PROGRESSCOMPLETEDSCHEDULEDWAITING_PAYER_AUTHORIZATIONERROREXPIREDAUTHORIZEDCANCELED`

Responses

200Retrieve a list of all payment requests

object

pagenumber (double)

totalnumber (double)

totalPagesnumber (double)

resultsobject[]

List of payment requests

itemsobject

Response with information related to a payment request

Example response

json

{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "amount": 100.5,
      "description": "Transferência",
      "status": "CREATED",
      "createdAt": "2023-11-06T13:03:45.689Z",
      "updatedAt": "2023-11-06T13:03:45.689Z",
      "callbackUrls": null,
      "paymentUrl": "https://pay.pluggy.ai/05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "recipient": null,
      "pixQrCode": null,
      "isSandbox": false
    }
  ]
}

curl -X GET \
  'https://api.pluggy.ai/payments/requests' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Sample response

{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "results": [
    {
      "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "amount": 100.5,
      "description": "Transferência",
      "status": "CREATED",
      "createdAt": "2023-11-06T13:03:45.689Z",
      "updatedAt": "2023-11-06T13:03:45.689Z",
      "callbackUrls": null,
      "paymentUrl": "https://pay.pluggy.ai/05c693bf-c196-47ea-a28c-8251d6bb8a06",
      "recipient": null,
      "pixQrCode": null,
      "isSandbox": false
    }
  ]
}