Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Criar nova conta

Suggest Edits

Criar a conta (também denomidada Conta Cartão) é o primeiro passo para que possa ser emitido um cartão para seus clientes.

Passos para Integrar

  1. Realizar autenticação na API.
  2. Cadastre a conta, fornecendo as informações necessárias.
  3. 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

{
  "application": {
    "program_id": 1,
    "submit": true,
    "applicant": {
      "personal": {
        "name": "John Doe",
        "printed_name": "John Doe",
        "email": "[email protected]",
        "gender": "M",
        "marital_status": "SINGLE"
      },
      "account": {
        "granted_limit": 1000,
        "limit": 1000,
        "account_type": "PHYSICAL",
        "account_name": "John Doe's Account"
      },
      "document_number": "343354332",
      "birth_date": "1984-11-07",
      "phones": [
        {
          "phone_type": "RESIDENTIAL",
          "country_code": "55",
          "phone": "22222222",
          "area_code": 11
        }
      ],
      "addresses": [
        {
          "address_type": "RESIDENTIAL",
          "address": "Alameda Xingu",
          "number": 350,
          "neighborhood": " Alphaville Industrial",
          "city": "BARUERI",
          "state": "SP",
          "country": "BRAZIL",
          "zip_code": "06455-030",
          "mailing_address": true,
          "complementary_address": "Bloco A"
        }
      ]
    }
  }
}

👍

Sucesso 200

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

Significado dos objetos na requisição

Campo (obrigatórios)TipoDescrição
program_idintId do programa utilizado, informado pela Celcoin, varia de acordo com a característica do cartão, podendo haver mais de um program_id
due_dateintDia fechamento da fatura. Para Pré-Pago pode-se informar uma data qualquer mesmo que não haja geração de fatura
namestring (100)Nome do portador do cartão
emailstring (100)Email do portador do cartão
genderstring (1)Indica o gênero do portador da conta. M para masculino e F para feminino
marital_statusstring (10)Indica o status civil do portador da conta, SINGLE para solteiro, MARRIED para casado, DIVORCED para divorciado e WIDOWER para viúvo
(granted_limit)intLimite concedido para pós-pago (informado pelo cliente)
(limit)intLimite que o cliente definiu para uso, sempre igual ou menor que o granted_limit.
account_typestring (30)Tipo da conta, RESIDENTIAL é PF, COMMERTIAL é PJ e Others
account_namestring (50)Nome do proprietário da conta para identificação
document_numberstring (20)Documento do portador do cartão
birth_datestring (10)Data de nascimento do portador do cartão
phone_typestring (10)Tipo de telefone RESIDENTIAL é para telefone residencial, COMMERTIAL é para telefone comercial e MOBILE para telefone celular.
country_codeintDDI em que o telefone se encontra
phonestring (10)Número do telefone
area_codeintDDD em que o telefone se encontra
address_typestring (10)Tipo de endereço, RESIDENTIAL é residencial, COMMERTIAL é comercial e Others
addressstring (50)Logradouro do endereço
numberintNúmero do endereço
neighborhoodstring (50)Bairro do endereço
citystring (50)Cidade do endereço
statestring (2)Estado do endereço
countrystring (5)País do endereço
zip_codestring (10)CEP do endereço
mailing_addressbooleanIndica se é o endereço para receber correspondência. TRUE pra cadastrar como endereço de correspondência ou FALSE para não cadastrar como endereço de correspondência
complementary_addressstring (100)Complemento de informações para o endereço

🚧

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 -X 'GET' \
  'https://kubernetes-prod.celcoin.dev/api/accounts/{accountId}?accountId=1' \
  -H 'accept: application/json' \
  -H 'Client-Id: 1'

👍

Sucesso 200

{
  "id": 1,
  "programaId": 123,
  "limiteConta": 1000,
  "vencimento": 25,
  "statusConta": "PROSPECT",
  "statusFinanceiro": "NORMAL"
}

Significado dos objetos

CampoTipoDescrição
idintId da conta que foi criada
programidintPrograma em que a conta foi criada
vencimentointData de vencimento para fechamento de faturas
statusContastring (10)Status da conta
statusFinanceirostring (10)Status financeiro. NORMAL sem restrições, ATRASO para contas em atraso ou ACORDO para contas que estão em acordo de dividas

Updated about 15 hours ago