PaymentMethodsCreate

Criar um método de pagamento

status string
Status do método de pagamento
Possible values: [not_verified, verified, validated, verification_failed, errored, void]
Example: verification_failed
method stringrequired

Possible values: [bank_account, pix_key]

methodData

object

required

anyOf

BankAccount

As contas bancárias são formas de receber uma transferência em objetos do tipo Customer ou Company.

accountHolderName stringrequired

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.

accountHolderType stringrequired

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]

accountHolderDocument stringrequired

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.

bankCode stringrequired

Código COMPE da Instituição Financeira.

bankName string

Nome do banco associado.

branch stringrequired

A agência da conta bancária.

number stringrequired

O número da conta bancária. Deve ser uma conta corrente ou conta poupança.

digit stringrequired

accountType stringrequired

Possible values: [current, savings]

createdAt date-time

PixKey

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

keyType stringrequired

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

keyValue stringrequired

accountHolderName stringrequired

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 stringrequired

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 stringrequired

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]

createdAt 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 string

O tipo de conta

Possible values: [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

links

object[]

Array [

owner stringrequired

Cliente proprietário da conta a vincular. Ao realizar um vínculo, é obrigatório enviar ou um cliente, ou uma empresa. Cada instância de um vínculo terá ou um cliente ou uma empresa associado à mesma.

Example: cust_62d988ba99646657fd3efce6

linkedAt date-time

Momento em que o vínculo foi realizado.

]

metadata object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.