POST/payments/customers

Criar

Request Body

required

object

Body to create a payment customer

typerequiredstring

Customer type. - `INDIVIDUAL`: identified by `cpf`. - `BUSINESS`: identified by `cnpj`.

INDIVIDUALBUSINESS

namerequiredstring

Nome do cliente

emailstring

Email do cliente

cpfstring

CPF do cliente. Obrigatório quando `type=INDIVIDUAL`.

cnpjstring

CNPJ do cliente. Obrigatório quando `type=BUSINESS`.

connectorIdnumber

ID do conector padrão a ser usado no fluxo de iniciação de pagamento do Pluggy (https://pay.pluggy.ai) pelo pagador.

Example

json

{
  "type": "INDIVIDUAL",
  "name": "Marco Silva",
  "email": "marco.silva@example.com",
  "cpf": "12345678900"
}

Responses

200Crie um cliente de pagamento.

object

Response with information related to a payment customer

idrequiredstring

Identificador principal

typerequiredstring

Customer type. - `INDIVIDUAL`: identified by `cpf`. - `BUSINESS`: identified by `cnpj`.

INDIVIDUALBUSINESS

namerequiredstring

Nome do cliente

emailstring

Email do cliente

cpfstring

CPF do Cliente

cnpjstring

CNPJ do cliente, se o tipo for `BUSINESS`

connectorobject

Connector object

idrequirednumber (integer)

Identificador principal

namestring

Nome da instituição

institutionUrlstring

Página inicial da instituição

imageUrlstring

Imagem do logotipo hospedado pelo Pluggy

primaryColorstring

Cor primária

typestring

Tipo de instituição

countrystring

País localizado

credentialsobject[]

Parâmetros necessários para iniciar a conexão

hasMFAboolean

O conector requer um MFA para ser executado?

productsstring[]

Produtos suportados pelo conector

productCoveragestring[]

Which sub-products the institution serves, in the Open Finance directory's own vocabulary (for example INVESTMENTS:TREASURE_TITLES, CREDIT_OPERATIONS:INVOICE_FINANCINGS). Where products says whether the connector serves investments at all, this says which ones: a connector listing INVESTMENTS may serve one of the five investment resources or all five. Absent for direct connectors, which have no Open Finance participant.

oauthboolean

Se 'true', o conector requerirá um fluxo Oauth para ser executado

oauthUrlstring

URL para realizar o fluxo Oauth, se necessário

resetPasswordUrlstring

URL para a instituição financeira para redefinir a senha

healthobject

Connector health status

isOpenFinanceboolean

Indica se o conector utiliza as APIs regulamentadas de Open Finance

isSandboxboolean

Indica se o conector é um conector de sandbox, destinado a testes em vez de uma instituição real

supportsPaymentInitiationboolean

Indica se o conector suporta a API de iniciação de pagamento

supportsScheduledPaymentsboolean

Indica se o conector suporta pagamentos agendados

supportsSmartTransfersboolean

Indica se o conector suporta transferências inteligentes

supportsBoletoManagementboolean

Indica se o conector suporta gerenciamento de boleto

supportsAutomaticPixboolean

Indica se o conector suporta Pix automático

createdAtstring (date-time)

Data de criação

updatedAtstring (date-time)

Data da última modificação

createdAtrequiredstring (date-time)

Data em que o cliente foi criado

updatedAtrequiredstring (date-time)

Data da última atualização do cliente

Example response

json

{
  "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 POST \
  'https://api.pluggy.ai/payments/customers' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'

Resposta de exemplo

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