Criar nova conta
Criar a conta (também denominada Conta Cartão) é o primeiro passo para que possa ser emitido um cartão para seus clientes.
Para criar uma conta cartão, obrigatoriamente, o cliente deverá ter uma conta BaaS Celcoin criada e ativa.
Por padrão, cada cliente (CPF/CNPJ) pode ter apenas uma conta de cartão por tipo de produto (pré-pago ou pós-pago). Isso significa que o mesmo cliente pode possuir um cartão pré-pago e outro pós-pago, mas não pode ter duas contas ativas para o mesmo tipo de cartão.
É possível ter mais de uma conta de cartão por tipo de produto (pré-pago ou pós-pago), desde que seja informado em tempo de onboarding para que a Celcoin realize essa parametrização.
Passos para Integrar
- Realizar autenticação na API.
- Cadastre a conta, fornecendo as informações necessárias.
- Receba as informações da conta cadastrada via webhook e realize as validações.
Se houver demora na resposta ou no recebimento do webhook, consulte o estado da conta no ambiente.
Criar nova conta
Para realizar a criação de uma conta, após a autenticação, é necessário realizar a seguinte requisição:
cURL da chamada
curl --request POST \
--url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts \
--header 'Authorization: Bearer {TOKEN}' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/10.0.0' \
--data '{
"application": {
"applicant": {
"submit": false,
"personal": {
"name": "Marcia Ferreira Costa",
"email": "[email protected]",
"gender": "F",
"printedName": "Marcia F Costa",
"maritalStatus": "SINGLE",
"mothersName": "Nome da Mãe"
},
"account": {
"accountType": "PHYSICAL",
"accountName": "Nome da Conta 34",
"grantedLimit": 1000,
"limit": 100
},
"documentNumber": "23703908165",
"birthDate": "1969-09-09",
"addresses": [
{
"addressType": "OTHER",
"address": "Avenida dos Cocais",
"number": 150,
"country": "Brasil",
"neighborhood": "Fonte Nova",
"city": "Santana",
"state": "AP",
"zipCode": "68928244",
"mailingAddress": true
}
],
"phones": [
{
"phone": "989898990",
"phoneType": "MOBILE",
"countryCode": "55",
"areaCode": 83
}
]
},
"accountBaas": "3332212331",
"programId": 21
,"dueDate": 25
}
}'
Sucesso 200
{
"version": 1,
"status": 200
}
Atenção!
O campo number é obrigatório. Caso o endereço não tenha número, informar o número "0" na requisição.
Atenção!
Os caracteres especiais e acentuações dos dados preenchidos nos campos printedName e em todos os campos relacionados ao endereço, quando este for indicado como mailingAddress, serão ajustados para evitar erros no processo de embossing do cartão físico.
Significado dos objetos na requisição
| Campos (obrigatórios) | Tipo | Descrição |
|---|---|---|
| programId | int | Id do programa utilizado, informado pela Celcoin, varia de acordo com a característica do cartão, podendo haver mais de um program_id |
| dueDate | int | Dia fechamento da fatura. Para Pré-Pago pode-se informar uma data qualquer pois não haverá geração de fatura |
| name | string (100) | Nome do portador do cartão |
| string (100) | E-mail do portador do cartão | |
| gender | string (1) | Indica o gênero do portador da conta. M para masculino e F para feminino |
| maritalStatus | string (10) | Indica o status civil do portador da conta, SINGLE para solteiro, MARRIED para casado, DIVORCED para divorciado e WIDOWER para 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 grantedlimit. - _opcional |
| accountType | string (30) | Tipo da conta, RESIDENTIAL é PF, COMMERTIAL é PJ e Others |
| 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 é para telefone residencial, COMMERTIAL é para telefone comercial e MOBILE para telefone 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 e 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. TRUE pra cadastrar como endereço de correspondência ou FALSE para não cadastrar como endereço de correspondência |
| complementaryAddress | string (100) | Complemento de informações para o endereço |
| accountBaas | string | É o número da conta do cliente no Baas |
Atenção!
Não há descrição dos campos retornados por essa funcionalidade, pois o processo de criação de conta é assíncrono, e o resultado do cadastro é enviado por meio de um webhook. Para mais informações, acesse: webhook
Buscar dados de uma conta
Para obter informações de uma conta criada, autentique-se e envie a seguinte requisição:
cURL da chamada
curl --request GET \
--url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/{accountId} \
--header 'Authorization: Bearer {TOKEN}' \
--header 'User-Agent: insomnia/10.0.0' \
Sucesso 200
{
"version": false,
"status": 200,
"body": {
"id": 298,
"programId": 21,
"customers": [
{
"id": 183,
"name": "Marcia Ferreira Costa",
"email": "[email protected]",
"documentNumber": "23703908165",
"owner": true,
"dateOfBirth": "1969-09-09",
"createdAt": "2024-09-26 00:00:00"
}
],
"addresses": [
{
"id": 286,
"addressType": "RESIDENTIAL",
"address": "Avenida dos Cocais",
"number": "150",
"complement": null,
"neighborhood": "Fonte Nova",
"city": "Santana",
"state": "AP",
"country": "Brasil",
"zipAddress": "68928244",
"active": true,
"mailingAddress": true,
"createdAt": "2024-09-26 00:00:00"
}
],
"phones": [
{
"id": 183,
"type": "MOBILE",
"countryCode": 55,
"areaCode": 83,
"phone": "989898990",
"extension": "83",
"createdAt": "2024-09-26 00:00:00"
}
],
"accountLimit": {
"accountId": 298,
"totalCreditLimit": 100,
"maximumCreditLimit": 1000,
"totalOverdraftLimit": 0,
"totalCreditWithdrawalLimit": 10,
"percentageOverLimit": 0,
"totalCrteditInstallmentLimit": 0
},
"dueDate": null,
"accountStatus": "NORMAL",
"financialStatus": "NORMAL"
}
}
Significado dos objetos
| Campos (obrigatórios) | Tipo | Descrição |
|---|---|---|
| programId | int | Id do programa utilizado, informado pela Celcoin, varia de acordo com a característica do cartão, podendo haver mais de um program_id |
| dueDate | int | Dia fechamento da fatura. Para Pré-Pago pode-se informar uma data qualquer pois não haverá geração de fatura. |
| name | string (100) | Nome do portador do cartão |
| string (100) | E-mail do portador do cartão | |
| gender | string (1) | Indica o gênero do portador da conta. M para masculino e F para feminino |
| maritalStatus | string (10) | Indica o status civil do portador da conta, SINGLE para solteiro, MARRIED para casado, DIVORCED para divorciado e WIDOWER para 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 grantedlimit. - _opcional |
| accountType | string (30) | Tipo da conta, RESIDENTIAL é PF, COMMERTIAL é PJ e Others |
| 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 é para telefone residencial, COMMERTIAL é para telefone comercial e MOBILE para telefone 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 e 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. TRUE pra cadastrar como endereço de correspondência ou FALSE para não cadastrar como endereço de correspondência |
| complementaryAddress | string (100) | Complemento de informações para o endereço |
Updated 3 months ago