GET/payments/customers

Lista

Recupera todos os clientes de pagamento criados

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
`name`	string	Filtrar clientes de pagamento por nome
`email`	string	Filtrar clientes de pagamento por e-mail
`cpf`	string	Filtrar clientes de pagamento por CPF
`cnpj`	string	Filtrar clientes de pagamento por CNPJ

Responses

200Recupere uma lista de todos os clientes de pagamento

object

pagenumber (double)

totalnumber (double)

totalPagesnumber (double)

resultsobject[]

List of payment customers

itemsobject

Response with information related to a payment customer

Example response

json

{
  "page": 0,
  "total": 0,
  "totalPages": 0,
  "results": [
    {
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "type": "INDIVIDUAL",
      "name": "Marco Silva",
      "email": "marco.silva@example.com",
      "cpf": "123.456.789-00",
      "cnpj": null,
      "connector": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}

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

Resposta de exemplo

{
  "page": 0,
  "total": 0,
  "totalPages": 0,
  "results": [
    {
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "type": "INDIVIDUAL",
      "name": "Marco Silva",
      "email": "marco.silva@example.com",
      "cpf": "123.456.789-00",
      "cnpj": null,
      "connector": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}