Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Realizar uma recarga

Suggest Edits

Essas funcionalidades permitem que os clientes BaaS da Celcoin realizem recargas de crédito para operadoras ou recargas digitais que retornam um PIN para ser inserido na plataforma digital.

Pré requisitos para implementação:

  • Possuir uma chave api da Celcoin, para mais informações acessar esse link

  • Ter familiaridade com o padrão REST usando o protocolo OAuth 2.0.

  • Ter o produto/solução contratado e habilitado em produção.

    • Caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.

  • Possuir uma conta no BaaS da Celcoin (Conta essa responsável por receber o valor da cobrança)

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Realizar o pagamento da recarga -

Caso seja necessário, é possível realizar a consulta do pagamento da recarga manualmente.

  • Consultar o pagamento da recarga


Pagamento da recarga

Após obter as informações de operadora e valores é possível a iniciação de uma recarga para obter crédito ou um PIN em uma plataforma digital.

cURL da chamada

curl -X 'POST' \
  'https://https://sandbox.celcoin.com.br/baas/v2/topup' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 13,
  "providerId": 2087,
  "account": "300543550143",
  "clientRequestId": "a1f57ab9-67a5-4580-a98d-09c355c02852",
  "signerCode": "+5518978675583",
  "tags": [
    {
      "key": "III",
      "value": "multi-byte"
    }
  ],
  "topupData": {
    "countryCode": 55,
    "number": "994114386",
    "stateCode": 11
  }
}'

👍

Sucesso 200

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
  "amount": 13,
  "providerId": 2087,
  "account": "300543550143",
  "clientRequestId": "a1f57ab9-67a5-4580-a98d-09c355c02852",
  "signerCode": "+5518978675583",
  "tags": [
    {
      "key": "III",
      "value": "multi-byte"
    }
  ],
  "topupData": {
    "countryCode": 55,
    "number": "975725533",
    "stateCode": 18
  }
}
}
CampoTipoDescrição
idstringid da recarga gerada.
documentNumberstringDocumento da conta.
providerDescriptionstringDescrição breve da operadora.
signerCodestringCódigo do assinante, retornado somente para recargas de TV.
accountintNúmero da conta.
clientRequestIdstringIdentificador fornecido pelo cliente no momento do request.
amountdoubleValor da Recarga.
providerIdintCódigo da operadora que deve ser informado na requisição.
keystringIdentificador fornecido pelo cliente no momento do request.
valuestringidentificador fornecido pelo cliente no momento do request.
countryCodeintDDI fornecido no momento da requisição.
numberintNúmero de celular fornecido no momento da requisição.
stateCodeintDDD fornecido no momento da requisição.

❗

Error 400

{
  "errorCode": "ITBE001",
  "message": "É obrigatório informar o campo account."
}

Tabela de erros

ErrorCodeDescrição
ITBE001Necessário informar o transactionId ou o clientRequestId.
ITBE002Não foi encontrado registro para o identificador informado.
ITBE003clientRequestId é obrigatório.
ITBE005É obrigatório informar o campo providerId.
ITBE006É obrigatório informar o campo topupData.countryCode.
ITBE007É obrigatório informar o campo topupData.stateCode.
ITBE008É obrigatório informar o campo topupData.number.
ITBE011Já existe uma recarga com o mesmo clientRequestId.
ITBE012Para esse tipo de recarga é obrigatório informar o campo topupData.
ITBE013signerCode é obrigatório e deve ser um CPF válido.
ITBE014signerCode é obrigatório e deve ser um telefone válido.
ITBE017O campo account ultrapassou os 20 caracteres permitidos.
ITBE018O campo clientRequestId não pode conter mais de 200 caracteres.
ITBE019Existem tags com keys duplicadas.
ITBE020Número da conta não localizada ou inativa.
ITBE021Existem tags com keys nulas ou vazias.
ITBE022Existem tags com values nulos ou vazios.
ITBE024O campo topupData.number está inválido.
ITBE025A quantidade máxima de tags é 20.
ITBE045O valor da recarga está invalido. Favor consultar os valores permitidos.

Consulta da recarga

Essa funcionalidade permite que os clientes BaaS da Celcoin consigam consultar recargas realizadas que ainda não receberam o webhook ou retornou algum erro inesperado.

cURL da chamada

curl -X 'GET' \
  'https://sandbox.celcoin.com.br/baas/v2/topup?TransactionId=8292f923-df12-494a-8bc8-6de9ad420cb4&ClientRequestId=5555' \
  -H 'accept: application/json'

👍

Sucesso 200

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "id": "string",
    "documentNumber": "string",
    "providerDescription": "string",
    "signerCode": "string",
    "account": "333333",
    "clientRequestId": "5555",
    "amount": 59.9,
    "providerId": 2086,
    "status": "INITIATED",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "topupData": {
      "countryCode": 55,
      "number": "999999999",
      "stateCode": 11
    },
    "topupInfo": {
      "authenticationApi": {
        "bloco1": "string",
        "bloco2": "string",
        "blocoCompleto": "string"
      },
      "receipt": {
        "receiptData": "string",
        "receiptformatted": "string",
        "urlreceipt": "string"
      }
    },

Status disponíveis:

StatusDescrição
INITIATEDRecarga iniciada
PROCESSINGRecarga em processamento
CONFIRMEDRecarga concluída .
ERRORErro no processamento da recarga

❗

Error 400

{
  "errorCode": "ITBE028",
  "message": " Necessário informar o transactionId ou o clientRequestId."
}

Tabela de erros

ErrorCodeDescrição
ITBE028Necessário informar o transactionId ou o clientRequestId.
ITBE029Não foi encontrado registro para o identificador informado.

Updated 4 days ago