GET/payments/requests

Lista

Recupera todas as solicitações de pagamento criadas

Parameters

Query Parameters

Name	Type	Description
`pageSize`	number (double)	Tamanho da página para a solicitação de paginação, padrão: 500
`page`	number (double)	Número da página para a solicitação de paginação, padrão: 1
`from`	string (date)	Filtrar solicitações de pagamento pela data de início. Retorna apenas solicitações criadas nesta data ou depois.
`to`	string (date)	Filtrar solicitações de pagamento pela data final. Retorna apenas solicitações criadas na data ou antes desta data.
`customer`	string	Filtrar solicitações de pagamento com um atributo do cliente (nome, e-mail, CPF ou CNPJ)
`pixKey`	string	Filtrar solicitações de pagamento por Chave Pix
`status`	string	Filtrar solicitações de pagamento por status `CREATEDIN_PROGRESSCOMPLETEDSCHEDULEDWAITING_PAYER_AUTHORIZATIONERROREXPIREDAUTHORIZEDCANCELED`

Responses

200Recuperar uma lista de todas as solicitações de pagamento

object

pagenumber (double)

totalnumber (double)

totalPagesnumber (double)

resultsobject[]

List of payment requests

itemsobject

Resposta com informações relacionadas a uma solicitação de pagamento

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'

Resposta de exemplo

{
  "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
    }
  ]
}