Consultando dados de uma Conta Cartão
Existem duas maneiras para se consultar as informações de uma conta, independente do tipo de programa:
- Buscar dados de uma conta - Retorna exatamente a conta referente ao accountId informado. Este accountId é obtido atraves do webhook de
account-created. - Buscar conta - Retorna uma lista de contas, pois um mesmo documento pode estar vinculado a mais de um programa. Caso o webhook
account-creatednão seja recebido, utilize este endpoint para localizar o portador.
Para pesquisar de outras formas utilize a documentação da API.
Significado dos objetos
| Campos (obrigatórios) | Tipo | Descrição |
|---|---|---|
| program | list | Lista dos programas aos quais a conta faz parte. |
| dueDate | list | Data de vencimento da fatura do cliente. |
| name | string (100) | Nome do titular do cartão |
| string (100) | E-mail do titular da conta | |
| gender | string (1) | Gênero do titular. M para masculino, F para feminino |
| maritalStatus | string (10) | Status civil do titular. SINGLE (solteiro), MARRIED (casado), DIVORCED (divorciado), WIDOWER (viúvo) |
| (grantedLimit) | int | Limite concedido para pós-pago (informado pelo cliente) - obrigatório apenas para programas de crédito, incluindo cartões pré-pago que transacionam na trilha do crédito |
| (limit) | int | Limite que o cliente definiu para uso, sempre igual ou menor que o granted_limit. -opcional |
| accountType | string (30) | Tipo de conta. Sempre preencher com PHYSICAL. |
| accountName | string (50) | Nome do proprietário da conta para identificação |
| documentNumber | string (20) | Documento do portador do cartão (CPF ou CNPJ) |
| birthDate | string (10) | Data de nascimento do portador do cartão |
| phoneType | string (10) | Tipo de telefone. RESIDENTIAL (residencial), COMMERTIAL (comercial), MOBILE (celular) |
| countryCode | int | DDI em que o telefone se encontra |
| phone | string (10) | Número do telefone |
| areaCode | int | DDD em que o telefone se encontra |
| addressType | string (10) | Tipo de endereço. RESIDENTIAL (residencial), COMMERTIAL (comercial), Others |
| address | string (50) | Logradouro do endereço |
| number | int | Número do endereço |
| neighborhood | string (50) | Bairro do endereço |
| city | string (50) | Cidade do endereço |
| state | string (2) | Estado do endereço |
| country | string (5) | País do endereço |
| zipCode | string (10) | CEP do endereço |
| mailingAddress | boolean | Indica se é o endereço de entrega e correspondência. |
| complementaryAddress | string (100) | Complemento de informações para o endereço |
Updated about 3 hours ago