v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB

Payment Customer

List

Recovers all created payment customers

get/payments/customers

Query parameters

pageSizenumber double

Page size for the paging request, default: 500

pagenumber double

Page number for the paging request, default: 1

namestring

Filter payment customers by name

emailstring

Filter payment customers by email

cpfstring

Filter payment customers by CPF

cnpjstring

Filter payment customers by CNPJ

Response

Retrieve a list of all payment customers

pagenumber double

totalnumber double

totalPagesnumber double

Example response

{
  "results": [
    {
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "type": "INDIVIDUAL",
      "name": "Marco Silva",
      "email": "msilva@pluggy.ai",
      "cpf": "123.456.789-00",
      "cnpj": null,
      "connector": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}