Pular para o conteúdo principal

Víncular método de pagamento

POST 
/v1/payment-methods/:id/link

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

Request​

Path Parameters

    id stringrequired
    • O ID do object
    Example: obj_5f92f01728e009f403d8502e

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:

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

    Example: id,createdAt

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.

Body

    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

Responses​

Retorna o objeto PaymentMethod para um ID válido.

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

    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

    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
    verifiedAt date-time
Loading...