Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Payment Customer

Retrieve

Recovers the payment customer resource by its id

get/payments/customers/{id}

Path parameters

idstring uuid required

Payment customer primary identifier

Response

Retrieve a customer request.

idstring required

Primary identifier

type'INDIVIDUAL' | 'BUSINESS' required

Customer type.

  • INDIVIDUAL: identified by cpf.
  • BUSINESS: identified by cnpj.
namestring required

Customer name

emailstring

Customer email

cpfstring

Customer CPF

cnpjstring

Customer CNPJ, if type is BUSINESS

createdAtstring date-time required

Date when the customer was created

updatedAtstring date-time required

Date when the customer was last updated

Example response

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