Realizar uma recarga
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
- Realizar autenticação na API - [API Reference]
- 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
}
}
}
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | id da recarga gerada. |
| documentNumber | string | Documento da conta. |
| providerDescription | string | Descrição breve da operadora. |
| signerCode | string | Código do assinante, retornado somente para recargas de TV. |
| account | int | Número da conta. |
| clientRequestId | string | Identificador fornecido pelo cliente no momento do request. |
| amount | double | Valor da Recarga. |
| providerId | int | Código da operadora que deve ser informado na requisição. |
| key | string | Identificador fornecido pelo cliente no momento do request. |
| value | string | identificador fornecido pelo cliente no momento do request. |
| countryCode | int | DDI fornecido no momento da requisição. |
| number | int | Número de celular fornecido no momento da requisição. |
| stateCode | int | DDD fornecido no momento da requisição. |
Error 400
{
"errorCode": "XXX001",
"message": "Ocorreu um erro interno durante a chamada da api."
}
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:
| Status | Descrição |
|---|---|
| INITIATED | Recarga iniciada |
| PROCESSING | Recarga em processamento |
| CONFIRMED | Recarga concluída . |
| ERROR | Erro no processamento da recarga |
Error 400
{
"errorCode": "XXX001",
"message": "Ocorreu um erro interno durante a chamada da api."
}
Updated about 2 months ago