DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Consulta de operadoras e valores

Suggest Edits

Essas funcionalidades permitem que os clientes BaaS da Celcoin consultem as operadoras disponíveis para uma recarga e seus devidos valores.

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 a consulta das operadoras - [API Reference]

  3. Realizar a consulta dos valores disponibilizados pela operadora - [API Reference]


Consultar operadoras

Para o fluxo de recargas, após a autenticação, é necessário consultar as operadoras disponíveis para recarga.

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/v5/transactions/topups/providers?stateCode=13&type=0&category=0' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw ''

👍

Sucesso 200

{
    "providers": [
        {
            "category": 2,
            "name": "Blizzard",
            "providerId": 2139,
            "RegionaisnameProvider": [],
            "TipoRecarganameProvider": 1,
            "maxValue": 0.0,
            "minValue": 0.0
        },
        {
            "category": 2,
            "name": "Boa Compra",
            "providerId": 2107,
            "RegionaisnameProvider": [],
            "TipoRecarganameProvider": 1,
            "maxValue": 0.0,
            "minValue": 0.0
        }
    ]
}
CampoTipoDescrição
nameString(50)Define o nome do produto/serviço
providerIDintCódigo do serviço
tipoRecarganameProviderString(1)Retorna o tipo da operação:
1 para PIN (Retorna o PIN no comprovante que será utilizado pelo usuário no provedor do serviço)
2 para ONLINE (Recarga convencional, realizada a partir das informações passadas na requisição)
maxValueDoubleValor máximo permitido para
pagamento do título
minValueDoubleValor mínimo permitido para pagamento do título

🚧

Aviso!

Esta requisição não precisa ser realizada toda vez que uma recarga for realizada. Recomendamos realizar a chamada desta funcionalidade uma vez ao dia e armazenar os dados da resposta.

Para essa requisição é necessário informar na querystring a propriedade type(tipo) que pode ser preenchido com:

0 para TODOS
1 para PIN
2 para ONLINE

E a propriedade category(categoria) da recarga poderá ser informada como:

0 para TODOS
1 para TELEFONE
2 para JOGOS
3 para TV
4 para TRANSPORTE
5 para CONTEÚDO DIGITAL

Consultar valores disponíveis

Após realizar a consulta das operadoras disponíveis, é necessário realizar a consulta dos valores disponíveis dentro desta operadora para realização da recarga.

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/v5/transactions/topups/provider-values?stateCode=11&providerId=2125' \
--header 'Content-Type: application/json' \
--header 'Authorization: {access_token}' \
--data-raw ''

👍

Sucesso 200

{
    "value": [
        {
            "properties": null,
            "code": 0,
            "cost": 0.0,
            "detail": "",
            "productName": "R$ 85,99 - Xbox Live 3 meses",
            "checkSum": -18913591,
            "dueProduct": 0,
            "valueBonus": 0.0,
            "maxValue": 85.99,
            "minValue": 85.99
        },
        {
            "properties": null,
            "code": 0,
            "cost": 0.0,
            "detail": "",
            "productName": "R$ 171,98 - Xbox Live 6 meses",
            "checkSum": -2147483640,
            "dueProduct": 0,
            "valueBonus": 0.0,
            "maxValue": 171.89,
            "minValue": 171.98
        },
        {
            "properties": null,
            "code": 0,
            "cost": 0.0,
            "detail": "",
            "productName": "R$ 199,00 - Xbox Live 12 meses",
            "checkSum": -18913591,
            "dueProduct": 0,
            "valueBonus": 0.0,
            "maxValue": 199.0,
            "minValue": 199.0
        }
    ],
    "externalNsuQuery": null,
    "errorCode": "000",
    "message": "SUCESSO",
    "status": 0
}
CampoTipoDescrição
productNameString(50)Retorna as operações válidas (Sugerimos o espelhamento deste campo para o usuário)
valueBonusString(16)Bônus para valor
maxValueDoubleValor máximo permitido para
pagamento do título
minValueDoubleValor mínimo permitido para
pagamento do título

Updated 25 days ago