VIvindi
payment_profiles

Retorna uma lista de perfis de pagamento.

Utilize este método para listar perfis de pagamento associados à sua conta na Vindi. Leia a documentação sobre paginação e filtros de busca.

Exemplo

Para verificar se determinado cliente possui um cartão de crédito ativo, utilize os seguintes filtros no parâmetro query:

customer_id=[id do cliente] status=active type=PaymentProfile_CreditCard

Atributos para busca

<code>id</code>, <code>customer_id</code>, <code>card_number_first_six</code>, <code>card_number_last_four</code>, <code>card_expiration</code>, <code>payment_company_id</code>, <code>payment_method_id</code>, <code>status</code>, <code>type</code>, <code>created_at</code>, <code>registry_code</code>, <code>bank_account</code>, <code>bank_branch</code> e <code>updated_at</code>.

get/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

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'customer_id' | 'card_number_first_six' | 'card_number_last_four' | 'card_expiration' | 'payment_company_id' | 'payment_method_id' | 'status' | 'type' | 'created_at' | 'registry_code' | 'bank_account' | 'bank_branch' | 'updated_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada 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.