Skip to main content

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

​
keyType
enum<string>
required
Available options:
document,
email,
phone,
random
​
keyValue
string
required
​
accountHolderName
string
required

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.

​
accountHolderDocument
string
required

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.

​
accountHolderType
enum<string>
required

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.

Available options:
individual,
company
​
createdAt
string<date-time>
​
bankCode
string

Número do banco

Example:

"104"

​
branch
string

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

Example:

"4289"

​
digit
string

O dígito verificador da conta.

Example:

"8"

​
number
string

O número da conta.

Example:

"01300005670"

​
accountType
enum<string>

O tipo de conta

Available options:
current,
savings
Example:

"current"

​
exists
boolean

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

Example:

true

​
bankName
string

O nome da instituição financeira

Example:

"Banco S.A."

​
valid
boolean

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

Example:

true

​
ispb
string

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

Example:

"360305"

⌘I