GET/payments/customers

List

Recovers all created payment customers

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
`name`	string	Filter payment customers by name
`email`	string	Filter payment customers by email
`cpf`	string	Filter payment customers by CPF
`cnpj`	string	Filter payment customers by CNPJ

Responses

200Retrieve a list of all payment customers

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'

Sample response

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