Víncular método de pagamento

Víncula um método de pagamento com uma empresa ou um usuário.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Chave única de idempotência para evitar duplicação de requisições.

Path Parameters

id

string

required

• O ID do object

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.

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Vínculo entre uma conta e um cliente ou empresa

owner

string

required

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.

Response

200 - application/json

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.

method

enum<string>

required

Available options:

bank_account,

pix_key

methodData

object

required

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

• BankAccount
• PixKey

Show child attributes

id

string

Identificador exclusivo para o objeto.

status

string

Status do método de pagamento

links

object[]

Show child attributes

verifiedAt

string

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

string

Data de criação do objeto

updatedAt

string

Data de alteração do objeto

deleted

boolean

default: false

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