Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Payment Customer

Create

post/payments/customers

Request body

type'INDIVIDUAL' | 'BUSINESS' required

Customer type.

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

Customer name

emailstring

Customer email

cpfstring

Customer CPF. Required when type=INDIVIDUAL.

cnpjstring

Customer CNPJ. Required when type=BUSINESS.

connectorIdnumber

Default connector id to be used in the Pluggy's payment initiation flow (https://pay.pluggy.ai) by the payer.

Example request

{
  "type": "INDIVIDUAL",
  "name": "Marco Silva",
  "email": "msilva@pluggy.ai",
  "cpf": "12345678900"
}

Response

Create a payment customer.

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