Cria método de pagamento

POST 
/v1/payment-methods

Cria um método de pagamento.

Request

Query Parameters

expand string
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Example: data.loan
fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

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]

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]

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

]

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.

Responses

201

Retorna o objeto PaymentMethod se a criação for bem-sucedida. Retorna erro para parâmetros inválidos.

application/json

Schema

Schema

id string
Identificador exclusivo para o objeto.
Example: pm_62d988d3946dedfcbe98bb1e
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.

createdAt date-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAt date-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deleted boolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "id": "pm_62d988d3946dedfcbe98bb1e",
  "status": "verification_failed",
  "method": "bank_account",
  "methodData": {},
  "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"
  }
}

Loading...