payment_profiles

Cadastra um novo perfil de pagamento para um cliente existente.

O perfil de pagamento representa um cartão de crédito ou uma conta bancária armazenada na plataforma Vindi. Leia mais na documentação.

Exemplo de requisição para cartão de crédito

{
  "holder_name": "José da Silva",
  "card_expiration": "12/2018",
  "card_number": "5167454851671773",
  "card_cvv": "123",
  "payment_method_code": "credit_card",
  "payment_company_code": "mastercard",
  "customer_id": 51
}

Exemplo de requisição para dados bancários

{
  "holder_name": "José da Silva",
  "registry_code": "27721264391",
  "bank_branch": "0964",
  "bank_account": "71233-1",
  "payment_method_code": "bank_debit",
  "payment_company_code": "itau",
  "customer_id": 51
}

Bandeiras e bancos disponíveis

Para uma lista completa de códigos de bancos e bandeiras suportadas pela sua conta, utilize o endpoint GET /payment_methods e verifique o atributo payment_companies.code.

Detecção automática de bandeira

Caso o parâmetro payment_company_code não seja informado, a plataforma irá tentar detectar a bandeira do cartão de crédito através do número informado. Este método não garante a detecção automática de bandeiras sem faixas de BIN/IIN definidas publicamente (Elo, Hipercard, Hiper, etc). Se você pretende utilizar cartões destas bandeiras, solicite a bandeira no seu formulário de pagamento e envie através do parâmetro payment_company_code.

No caso do débito em conta, payment_company_code é obrigatório.

post/v1/payment_profiles

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/payment_profiles
  • Auth
    HTTP basic

Request body

holder_namestring

Nome do titular/portador do perfil de pagamento

registry_codestring

CPF ou CNPJ do titular/portador

bank_branchstring

Agência da conta bancária

bank_accountstring

Número da conta bancária

card_expirationstring

Validade do cartão de crédito no formato MM/AA

allow_as_fallbackstring

Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.

card_numberstring

Número completo do cartão de crédito

card_cvvstring

Código de segurança do cartão de crédito com 3 ou 4 dígitos

payment_method_codestring

Código do método de pagamento

payment_company_codestring

Código do banco ou bandeira

card_renewed_atstring

Data da renovação do cartão de crédito renovado

gateway_tokenstring

Token externo

customer_idinteger required

ID do cliente associado ao perfil de pagamento

Response

Perfil de pagamento cadastrado com sucesso.

idinteger required

ID do perfil de pagamento

status'active' | 'inactive' | 'deleted' required

Status do perfil de pagamento

holder_namestring

Nome do titular/portador do perfil de pagamento

registry_codestring

CPF ou CNPJ do titular/portador

bank_branchstring

Agência da conta bancária

bank_accountstring

Número da conta bancária

card_expirationstring

Validade do cartão de crédito no formato MM/AA

allow_as_fallbackstring

Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.

card_number_first_sixstring

Primeiros 6 dígitos do cartão de crédito (BIN/IIN)

card_number_last_fourstring

Últimos 4 dígitos do cartão de crédito

card_renewed_atstring

Data da renovação do cartão de crédito renovado

tokenstring required

Token para referência do perfil de pagamento

gateway_tokenstring

Token externo

typestring required

Tipo do perfil de pagamento

created_atstring required

Data e hora do cadastro do perfil de pagamento

updated_atstring required

Data e hora da última atualização do perfil de pagamento

Changes

No recorded changes to this operation across all 1 revision of this API.