PaymentMethodCreated

Este objeto representa uma método de pagamento. Ele permite que você crie vínculos empregatícios e rastreie contratos que pertencem a mesma empresa.

idstring

Identificador exclusivo para o objeto.

Example: pm_62d988d3946dedfcbe98bb1e

statusstring

Status do método de pagamento

Possible values: [not_verified, verified, validated, verification_failed, errored, void]

Example: verification_failed

methodstringrequired

Possible values: [bank_account, pix_key]

methodData objectrequired

anyOf

BankAccount

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.

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]

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.

bankCodestringrequired

Código COMPE da Instituição Financeira.

bankNamestring

Nome do banco associado.

branchstringrequired

A agência da conta bancária.

numberstringrequired

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

digitstringrequired

accountTypestringrequired

Possible values: [current, savings]

createdAtdate-time

PixKey

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

links object[]

Array [

ownerstringrequired

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

linkedAtdate-time

Momento em que o vínculo foi realizado.

]

metadataobject

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.

createdAtdate-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAtdate-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deletedboolean

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Default value: false

Example: false

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

PaymentMethodCreated

{
  "id": "pm_62d988d3946dedfcbe98bb1e",
  "status": "verification_failed",
  "method": "bank_account",
  "methodData": {
    "accountHolderName": "string",
    "accountHolderType": "individual",
    "accountHolderDocument": "string",
    "bankCode": "string",
    "bankName": "string",
    "branch": "string",
    "number": "string",
    "digit": "string",
    "accountType": "current",
    "createdAt": "2024-07-29T15:51:28.071Z"
  },
  "links": [
    {
      "owner": "cust_62d988ba99646657fd3efce6",
      "linkedAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}