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.

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": true,
            "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",
        "debitProgramId": 21,
        "dueDate": 25,
        "isMultiapp": false
    }
}'

👍
Sucesso 200

{
  "version": 1,
  "status": 200
}

Significado dos objetos na requisição

Campos (obrigatórios)	Tipo	Descrição
debitProgramId	int	Id do programa de débito, caso seja um cartão pré-pago.
creditProgramId	int	Id do programa de crédito, caso seja um cartão pós-pago.
isMultiapp	bool	Utilize false.
dueDate	int	Dia fechamento da fatura. Utilizado apenas para conta com cartão pós pago.
name	string (100)	Nome do portador do cartão. Permitido acento e espaços.
email	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
printedName	string (25)	Nome impresso no cartão. Sempre em maiúsculo, sem acentos, números ou caracteres especiais. Exemplo: Marco Antônio Fagundes - Nome impresso: MARCO FAGUNDES
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	Utilizado apenas para conta com cartão pós pago.
limit	int	Utilizado apenas para conta com cartão pós pago.
accountType	string (30)	Tipo da conta, VIRTUAL ou 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 é 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. Caso não tenha número, preencher com 0.
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. Obrigatório que um dos endereços informados estejam com esse campo como TRUE.
complementaryAddress	string (100)	Complemento de informações para o endereço.
accountBaas	string	É o número da conta do cliente no Baas

🚧
Atenção!
O processo de criação de conta é assíncrono onde o resultado do cadastro é enviado por meio de um webhook. Para mais informações, acesse: Cadastrar e Gerenciar Webhooks

Buscar dados de uma conta

Existem duas maneiras para se consultar as informações de uma conta:

accountId - Retorna exatamente a conta referente ao id informado.
Documento - Retorna uma lista de contas, uma vez que um documento pode estar presente em mais de um programa.

Para obter informações de uma conta criada, realize uma chamada no endpoint abaixo utilizando o accountId.

Para pesquisar de outras formas utilize a documentação da API.

Exemplo de chamada buscando por accountId:

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": 256,
            "customers": [
                {
                    "id": 256,
                    "name": "MARCIA FERREIRA COSTA",
                    "email": "[email protected]",
                    "documentNumber": "326055109803",
                    "owner": true,
                    "dateOfBirth": "1984-07-11",
                    "createdAt": "2025-02-04 17:13:44"
                }
            ],
            "addresses": [
                {
                    "id": 256,
                    "addressType": "RESIDENTIAL",
                    "address": "RUA VEREADOR NAPOLEAO NOVISK",
                    "number": "1",
                    "complement": null,
                    "neighborhood": "LOTEAMENTO LOANDA",
                    "city": "ATIBAIA",
                    "state": "SP",
                    "country": "Brasil",
                    "zipAddress": "12945160",
                    "active": true,
                    "mailingAddress": true,
                    "createdAt": "2025-02-04 00:00:00"
                }
            ],
            "phones": [
                {
                    "id": 256,
                    "type": "MOBILE",
                    "countryCode": 55,
                    "areaCode": 11,
                    "number": "999551111",
                    "extension": null,
                    "active": true,
                    "createdAt": "2025-02-04 00:00:00"
                }
            ],
            "accountLimit": [],
            "dueDate": [],
            "accountStatus": "NORMAL",
            "financialStatus": "NORMAL",
            "program": [
                {
                    "programId": 41,
                    "name": "NovoDebito4",
                    "type": "DEBITO",
                    "timezone": "America/Sao_Paulo",
                    "binId": 81373,
                    "startRange": 0,
                    "endRange": 333332,
                    "status": true,
                    "countryCode": "BRA",
                    "avaliableCards": 333332,
                    "currencyCode": "986",
                    "createdAt": "2025-02-04 16:46:17",
                    "updatedAt": "2025-02-04 17:21:48"
                }
            ]
        }
    ]
}

Significado dos objetos

Campos (obrigatórios)	Tipo	Descrição
program	list	Lista de programas ao qual a conta pesquisada faz parte.
dueDate	list	Lista de dias de vencimento para esta conta. Essa lista só é emeitida quando a conta pertence a um programa de crédito.
name	string (100)	Nome do portador do cartão
email	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.
complementaryAddress	string (100)	Complemento de informações para o endereço

Criar nova conta

Passos para Integrar

Criar nova conta

👍
Sucesso 200

🚧
Atenção!

Buscar dados de uma conta

👍
Sucesso 200

Passos para Integrar

Criar nova conta

👍Sucesso 200

🚧Atenção!

Buscar dados de uma conta

👍Sucesso 200

👍
Sucesso 200

🚧
Atenção!

👍
Sucesso 200