PixKey

As chaves PIX são formas de receber um PIX em objetos do tipo Customer ou Company.

keyTypestringrequired

Possible values: [document, email, phone, random]

keyValuestringrequired

accountHolderNamestringrequired

O nome da pessoa ou empresa que possui a conta bancária. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

accountHolderDocumentstringrequired

O documento da entidade que detém a conta. Pode ser CPF ou CNPJ. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

accountHolderTypestringrequired

O tipo de entidade que detém a conta. Pode ser pessoa física ou empresa. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

Possible values: [individual, company]

createdAtdate-time

bankCodestring

Número do banco

Example: 104

branchstring

O número da agência bancária associada à conta.

Example: 4289

digitstring

O dígito verificador da conta.

Example: 8

numberstring

O número da conta.

Example: 01300005670

accountTypestring

O tipo de conta

Possible values: [current, savings]

Example: current

existsboolean

Um indicador booleano que informa se existe ou não.

Example: true

bankNamestring

O nome da instituição financeira

Example: Banco S.A.

validboolean

Um indicador booleano que informa se é válida ou não.

Example: true

ispbstring

O número do Identificador de Sistema de Pagamentos Brasileiro (ISPB) da instituição financeira.

Example: 360305

PixKey

{
  "keyType": "document",
  "keyValue": "string",
  "accountHolderName": "string",
  "accountHolderDocument": "string",
  "accountHolderType": "individual",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "bankCode": "104",
  "branch": "4289",
  "digit": "8",
  "number": "01300005670",
  "accountType": "current",
  "exists": true,
  "bankName": "Banco S.A.",
  "valid": true,
  "ispb": "360305"
}