Introdução

As APIs do RVHub são organizadas em padrão REST. Nossas APIs possuem URLs previsíveis orientadas a recursos, aceitam no corpo das solicitações mensagens do tipo JSON, e retornam as respostas em JSON, usando os códigos de status padrão HTTP, juntamente com os verbos.

Você pode usar as APIs do RVHub em nosso sandbox para realizar os seus testes, o que não afetará seus dados ou o seu saldo real. Para isto, basta acessar o Portal do Desenvolvedor, se cadastrar ou acessar caso ja tenha cadastro no portal para realizar os testes em nossas APIs disponíveis. O client_id e client_secret encontrados no Portal do Desenvolvedor são usados na autenticação para determinar se as requisições estão no modo ativo ou no modo de sandbox.

A API do RVHub é diferente para todas as contas, à medida que lançamos novas versões e adaptamos a funcionalidade. Faça login no Portal do Desenvolvedor para ver os documentos personalizados para sua versão da API e suas credenciais.

Credenciamento

As APIs do RVHub usam credenciais para autenticar as solicitações. Você pode visualizar e gerenciar suas credenciais do RVHub através do Meu Painel após acessar Portal do Desenvolvedor, caso não tenha um cadastro você pode se cadastrar aqui.

                    Suas credenciais possuem muitos privilégios, portanto, mantenha elas protegidas! 
Não compartilhe suas credenciais da API em áreas publicamente acessíveis, como 
GitHub, código do cliente e assim por diante.

A autenticação para nossas APIs seguem dois passos, o primeiro passo que chamamos de autenticação e o segundo autorização

Autenticação

Para se autenticar você deve gerar um Token JWT via basic authentication informando um hash do seu client_id e client_secret no formato base64

Autorização

Para poder utilizar as APIs do RVHub você deve utilizar o Token JWT obtido através do processo de autenticação. Desta forma, ao utilizar quaisquer das APIs do RVHub você deve adicionar em sua requisição um campo no cabeçalho HTTP (header) cujo a chave é Authorization e o valor Bearer: {Seu Token JWT} obtendo como resultado Authorization: Bearer {Seu Token JWT}

                    Todas as solicitações para a API devem ser feitas por HTTPS. 
As chamadas feitas através de HTTP simples falharão. 
Solicitações de API sem autenticação também falharão.

Exemplo de criação de base64

LINGUAGEM: CURL


              
              $(echo -n "SEU_CLIENT_ID:SEU_CLIENT_SECRET" | base64)

COPIADO!

Exemplo de requisição de autenticação

LINGUAGEM: CURL


              
              curl --request POST "https://auth.sbx.rvhub.com.br/oauth2/token?grant_type=client_credentials" \
            

              
              --header 'Content-Type: application/x-www-form-urlencoded' \
            

              
              --header 'Authorization: Basic 4eC39HqLyjWDarjtT1zdp7dc'

COPIADO!

Exemplo de resposta de autenticação

LINGUAGEM: JSON


              
              {
            

              
                  "access_token": "4eC39HqLyjWDarjtT1zdp7dc.4eC39HqLyjWDarjtT1zdp7dc.4eC39HqLyjWDarjtT1zdp7dc",
            

              
                  "expires_in": 3600,
            

              
                  "token_type": "Bearer"
            

              
              }

COPIADO!

Exemplo de requisição com header de autorização

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de uma resposta autorizada

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
            

              
                      "product_id": "1",
            

              
                      "area_code": "11",
            

              
                      "cell_phone_number": "99991111",
            

              
                      "status": "authorized",
            

              
                      "created_at": "2020-05-06T13:26:31.211Z",
            

              
                      "updated_at": "2020-05-06T13:26:31.560Z",
            

              
                      "nsu": "000016838",
            

              
                      "authorization_code": 16838,
            

              
                      "face_amount": 3000,
            

              
                      "due_date": "2020-05-11T00:00:00.000Z",
            

              
                      "message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
            

              
                      "authorized_at": "2020-05-06T00:00:00.000Z",
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-05-06T13:26:31.570Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/cellphone-topups/transactions/1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          },
            

              
                          {
            

              
                              "href": "/cellphone-topups/transactions/1f3bef20-71cb-0138-b3e9-2e4c008d14ca/capture",
            

              
                              "rel": "capture",
            

              
                              "type": "POST"
            

              
                          },
            

              
                          {
            

              
                              "href": "/cellphone-topups/transactions/1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
            

              
                              "rel": "refund",
            

              
                              "type": "DELETE"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Requisições idempotentes

As nossas APIs suportam idempotência para repetir com segurança solicitações sem executar acidentalmente a mesma operação duas vezes. Isso é útil quando uma chamada de API é interrompida em trânsito e você não recebe uma resposta. Por exemplo, se uma solicitação para criar uma recarga não responder devido a um erro de conexão de rede, você poderá tentar novamente a solicitação com a mesma chave de idempotência para garantir que não seja criada mais de uma cobrança.

Para executar uma solicitação idempotente, forneça um cabeçalho HTTP (header) X-Idempotency-Key: <key> adicional à solicitação.

A idempotência do RVHub funciona salvando o código de status resultante e o corpo da primeira solicitação feita para qualquer chave de idempotência, independentemente de ter sido bem-sucedida ou falhada. Solicitações subsequentes com a mesma chave retornam o mesmo resultado, incluindo um erro 500.

Uma chave de idempotência é um valor exclusivo gerado pelo cliente que o servidor usa para reconhecer tentativas subsequentes da mesma solicitação. Você decide como criar chaves exclusivas, mas sugerimos o uso de UUIDs V4 ou outra sequência aleatória com entropia suficiente para evitar colisões.

As chaves são elegíveis para serem removidas do sistema após pelo menos 24 horas e uma nova solicitação será gerada se uma chave for reutilizada após a remoção do original. A camada de idempotência compara os parâmetros recebidos com os da solicitação e erros originais, a menos que sejam os mesmos para evitar uso indevido acidental.

                    A maioria das solicitações POST aceitam chaves de 
idempotência. O envio de 
chaves de idempotência
 em solicitações GET, UPDATE e 
DELETE não tem efeito e deve ser evitado, pois essas solicitações
são idempotentes por definição.

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \

COPIADO!

Erros

O RVHub usa os codigos de resposta HTTP para indicar o sucesso ou a falha de uma requisição na API. Geralmente, codigos no intervalo 2xx indicam sucesso. Codigos no intervalo 4xx indicam algum erro na origem da requisição seguidos de uma informação sobre o erro que houve. Erros no intervalo 5xx são de origem do RVHub.

Na tabela Lista de Codigo de Status HTTP nós temos a lista de códigos que são retornados em uma requisição. E na tabela Tipos de Erros nós temos as mensagens retornadas em cada um dos erros.

Além disso, quando um erro ocorrer, o atributo see será retornado. O link dentro do atributo see serve para obtermos maiores detalhes sobre o erro retornado, tornando mais rápido o seu esclarecimento.

Exemplo de resposta `4xx`

LINGUAGEM: JSON


              
              {
            

              
                "status": 422,
            

              
                "code": "transition_not_accepted",
            

              
                "message": "The requested transition of status is not accepted",
            

              
                "see": "https://docs.rvhub.com.br/erros#transition_not_accepted"
            

              
              }

COPIADO!

Lista de Codigo de Status HTTP

200 - OK

Tudo funcionando como esperado

201 - Created

Quando um novo item é criado com sucesso

400 - Bad Request

Quando é enviado um parâmentro no formato errado ou quando não é enviado um parâmentro obrigatório

401 - Unauthorized

Indica que a solicitação não foi efetuada pois suas credenciais estão erradas ou não foram enviadas

403 - Forbidden

Você não tem os privilégios necessários para efetuar a chamada a este recurso

404 - Not Found

Quando um item não é encontrado

422 - Unprocessable Entity

Indica que o servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.

500, 502 - Server Errors

Quando aconteceu algo de errado no RVHub

Tipos de Erros

400 - validation_error

Um ou mais campos são necessários e/ou em formato inválido

404 - item_not_found_error

O item solicitado não foi encontrado

404 - invalid_merchant_account_error

A conta da loja não foi encontrada

422 - transition_not_accepted_error

A transição solicitada de status não é aceita

422 - idempotency_key_not_present_error

O campo de cabeçalho HTTP (header) X-Idempotency-Key é necessário

500 - internal_server_error

Erro interno no servidor

502 - bad_gateway_error

Um erro inesperado ocorreu

Chaves de acesso

Para utilizar nossas APIs, você precisará de duas chaves de acesso o client_id e o client_secret, as duas chaves são encontradas no Meu Painel dentro do Portal do Desenvolvedor.

                    As credenciais encontradas no Portal do Desenvolvedor servem apenas como teste no 
ambiente do Sandbox, para conseguir suas credenciais de produção, você deve entrar
em contato com a área comercial da RV Tecnologia

client_id e client_secret

                    Atenção!!! Mantenha seu client_id e client_secret
em sigilo, não compartilhe com ninguém pois trata-se de dados sensíveis e apenas você deve ter acesso.

Sandbox

O RVHub é uma plataforma feita por desenvolvedores, para desenvolvedores. Acreditamos que nenhuma API é melhor do que sua documentação e sua capacidade de simular todas as situações que acontecem no ambiente de produção. Para isso, disponibilizamos o nosso sandbox.

O ambiente de sandbox do RVHub tem como objetivo proporcionar uma ótima experiência de integração ao desenvolvedor, disponibilizando uma série de funcionalidades, conforme descrito abaixo:

URL

Para garantir agilidade na integração disponibilizamos uma URL exclusiva para os desenvolvedores. Através desta URL o desenvolvedor tem acesso a todas as APIs em um ambiente segregado, estável e atualizado.

Dados para teste

A simulação de alguns erros nem sempre é simples, para isso criamos uma série de gatilhos para que você possa simular os erros e efetuar o tratamento adequado em seu código.

Além disso, para simplificar o processo você pode efetuar credenciamento para obter suas chaves de acesso, entender o nosso fluxo de transações, analisar os erros mais comuns e entender questões como paginação e versionamento.

Dados para teste

Conforme avançando em nossos testes e integração com as APIs disponíveis, precisaremos realizar mais e mais testes para melhor eficiência do serviço que pretendemos entregar para o usuário final, ou seja nossos clientes. Separamos nossos dados de teste por serviços e abaixo temos as tabelas que podem ser usadas para realizar seus testes.

Dados de recargas

Tendo isso em mente, criamos alguns gatilhos que possibilitarão testar diversos cenários de possíveis erros que nossa API poderá retornar. O gatilho esta ligado com o número de telefone informado no corpo da requisição, basta você realizar a requisição POST informando todos os campos obrigatórios (product_id, area_code) e no campo cell_phone_number informar um dos números listados abaixo para receber o erro, veja o exemplo ao lado para melhor compreensão.

Lista de números e Erros

Número	`status_reason`	Erro
`999990002`	`insufficient_credit_limit`	Limite de Crédito Insuficiente
`999990003`	`insufficient_inventory`	Estoque Insuficiente
`999990004`	`unauthorized_cell_phone_number`	Telefone não autorizado
`999990004`	`unauthorized_signer_code`	Cliente não autorizado. *(Apenas em recargas de TV)*
`999990005`	`invalid_password`	Senha Inválida
`999990006`	`maximum_number_of_connections_reached`	Número máximo de conexões atingidas
`999990007`	`system_in_maintenance`	Sistema em Manutenção
`999990011`	`timeout`	Timeout
`999990013`	`expired_purchase`	Compra Expirada
`999990014`	`nonexistent_purchase`	Compra inexistente
`999990017`	`purchase_already_confirmed`	Compra já confirmada
`999990022`	`user_without_access_level`	Usuário sem nível de acesso
`999990023`	`charge_not_yet_viewed`	Cobrança ainda não visualizada
`999990024`	`transaction_not_allowed`	Transação não permitida
`999990025`	`subdistribution_not_allowed`	Sub-distribuição não permitida
`999991400`	`phone_locked_for_recharge`	Telefone bloqueado para recarga
`999991401`	`operation_not_performed_generic_provider_error`	Operação não efetuada (erro genérico da operadora)
`999991402`	`invalid_client_code`	Código de cliente inválido
`999991403`	`amount_not_allowed`	Valor não permitido
`999991405`	`blocked_establishment`	Estabelecimento bloqueado
`999991406`	`signer_code_required`	Quando o cliente possui mais de uma assinatura por CPF. *(Apenas em recargas de TV)*
`999990099`	`other_errors`	Outros erros
`999991407`	`provider_changed_to_claro`	A operadora relacionada ao número foi alterada para a operadora Claro
`999991408`	`provider_changed_to_tim`	A operadora relacionada ao número foi alterada para a operadora Tim
`999991409`	`provider_changed_to_vivo`	A operadora relacionada ao número foi alterada para a operadora Vivo

Em algumas situações, você pode enviar dados “supostamente” corretos ao RVHub, no entanto, o fornecedor de recargas pode não aceitar pois, por exemplo, o número do telefone não é da operadora de celular ou até o valor da recarga no produto não é compatível com o valor enviado. Desta forma, quando erros acontecerem nos provedores a transação será negada (status denied) e o motivo será demonstrado no campo status_reason. Você pode observar os possíveis erros que acontecem nos fornecedores na tabela abaixo:

Erro	`status_reason`	Forma de testar
Fone Incompleto / Invalido	`incomplete_or_invalid_cell_phone_number`	Informando um telefone incompleto
Operadora / Produto não encontrado	`provider_or_product_not_found`	Informando um produto inexistente
Valor Inválido	`invalid_amount`	Informando um valor de recarga inválido

POST

/cellphone-topups/transactions

Exemplo do corpo da requisição

LINGUAGEM: JSON


              
              {
            

              
              	"product_id": "1",
            

              
              	"area_code": "11",
            

              
              	"cell_phone_number": "999990002"
            

              
              }

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "55e0f600-791a-0138-fb37-427e4842ab95",
            

              
                  "product_id": "1",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999990002",
            

              
                  "status": "denied",
            

              
                  "created_at": "2020-05-15T20:41:11.271Z",
            

              
                  "updated_at": "2020-05-15T20:41:11.876Z",
            

              
                  "status_reason": "insufficient_credit_limit",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "denied",
            

              
                          "created_at": "2020-05-15T20:41:11.888Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/cellphone-topups/transactions/55e0f600-791a-0138-fb37-427e4842ab95",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Dados de pagamentos

Abaixo seguem as tabelas com os dados para testes nas APIs de pagamento de contas. A tabela Dados para casos de sucesso se refere aos códigos de boletos utilizados para conseguir replicar os testes que necessitam de duas etapas (Solicitar pagamento e Aprovar pagamento). A tabela Dados para casos de erros se refere aos dados e formas de como devem ser realizados os testes.

Dados para casos de sucesso

Tipo de conta	`barcode`	`digitable_line`
Título	033980000000 00000009492836981 922600010320102	033994928136 9819226060010 32010268000
Título	318938356000 00199920005050500 512130020771772	318900050250 5005121370020 7717729383560000019992
Título	376918356000 00200970001000100 030411057053923	376900010400 1000304101057 0539238183560000020097
Título	033918356000 10000009204153700 100232075880101	033992041553 7001002322075 8801011183560001000000
Título	376948357000 00142760001000100 030411057233778	376900010400 1000304101057 2337789483570000014276
Tributos	818100000018 16057012008310100 162699890029900	818100000014 8160570120058 31010016261998900299000
Tributos	818700000018 16057012008310100 162699810029976	818700000015 8160570120058 31010016261998100299766
Tributos	818000000020 09657012008310100 162699930029922	818000000020 0096570120028 31010016261999300299229
Tributos	818900000018 16057012008310100 162699870029905	818900000019 8160570120058 31010016261998700299058
Consumo	826800000004 56000970080025637 540552002112008	826800000000 4560009700810 02563754056520021120081
Consumo	826100000007 13800970080013706 628352002112008	826100000007 7138009700870 01370662833520021120081
Consumo	826200000000 78700970080090377 854952002112008	826200000006 0787009700860 09037785491520021120081
Consumo	826600000000 23300970080037350 818252002112008	826600000002 0233009700860 03735081824520021120081
Consumo	826600000007 90600970080074278 609852002112008	826600000002 7906009700870 07427860981520021120081

                    Observação: Na coluna Dados os códigos 
que representam uma linha digitável não devem conter espaços.
No momento em que for realizar uma requisição.

Dados para casos de erros

Dados	`status_reason`	Forma de testar
`084945010100859 974552000000167 17900000000000000`	`double_payment_not_allowed`	Título não permite pagamento duplicado. Teste realizado no campo `digitable_line` para pagamento de Título(boleto)
`487958362000002 024200010033437 00105734100184`	`invalid_barcode_or_digitable_line`	Dados de entrada do código de barras ou linha digitável inválida. Teste realizado no campo `digitable_line` para pagamento de qualquer tipo de conta
`"9999"`	`invalid_collection_check_digit`	Digito verificador inválido. Teste realizado no campo `fgts.collection.check_digit` para pagamento de FGTS
`858000000013672 506287021943708 202410567939054100`	`invalid_das`	Este pagamento é uma DAS. Não é necessário informar os campos de FGTS e DARF no body da requisição. Teste realizado para pagamento de DAS
`1990-01-01`	`invalid_determination_period`	Campo Período Apuração inválido. Teste realizado no campo `determination_period` para pagamento de qualquer tributo (DAMSP, DAS, DARF, FGTS)
`Qualquer documento invalido.`	`invalid_document`	Campo CPF ou CNPJ inválido. Teste realizado no campo `darf.taxpayer.document` para pagamento de DARF
`69000`	`invalid_fine`	Campo Valor Multa inválido. Teste realizado no campo `fine` para pagamento de qualquer tributo (DAMSP, DAS, DARF, FGTS)
`69000`	`invalid_main_amount`	Campo Valor Principal inválido. Teste realizado no campo `main_amount` para pagamento de qualquer tributo (DAMSP, DAS, DARF, FGTS)
`69000`	`invalid_paid_amount`	Dados de entrada do valor de pagamento inválidos. Teste realizado no campo `paid_amount` para pagamento de qualquer tipo de conta
`"1234567890"`	`invalid_full_name`	Dados de entrada em Nome não pode ser vazio. Teste realizado no campo `darf.taxpayer.full_name` para pagamento de DARF
`3`	`invalid_taxpayer_identification_type`	Dados de entrada do Tipo Identificacao Contribuinte inválidos. Teste realizado no campo `fgts.taxpayer_identification_type` para pagamento de FGTS
`858000000013672 5062870219437082 02410562222222222`	`not_allowed_diverging_value`	Valor de pagamento não confere com o valor total a ser pago. Teste realizado no campo `digitable_line` para pagamento de qualquer tipo de conta
`743957278000002 0490348402052578 9591100830880`	`not_found_on_cip`	Título não encontrado na CIP. Teste realizado no campo `barcode` para pagamento de Título(boleto)
`900000`	`paid_amount_beyond_limits`	O valor de pagamento deste convênio ultrapassa o limite da instituição. Teste realizado no campo `paid_amount` para pagamento de Consumo(Convênio)
`058000000013672 5062870219437082 02410561111111111`	`payment_not_allowed_outside_timetable`	Horário para pagamentos de titulos excedido. Teste realizado no campo `digitable_line` para pagamento de qualquer tipo de conta
`824910000000000 0000450100081092 4550000010662`	`bill_kind_not_allowed`	Convênio não cadastrado, não é possível realizar o pagamento. Teste realizado no campo `barcode` para pagamento de Consumo(Convênio)

Paginação

Todas as APIs baseadas em recursos do RVHub (por exemplo: /transactions) têm suporte para buscas em massa por meio de métodos que retornam uma listas de objetos.

Você pode determinar o número de itens por página e a página a ser consultada a partir dos parâmetros de URL:

per_page - Informa o número de itens por página da consulta
page - Informa a página que a consulta deverá retornar

Caso os parâmetros per_page e page não sejam informados, o RVHub assumirá como padrão os valores page=1 e per_page=25

                    Observação: A primeira página de qualquer consulta é sempre 1 (e não 0).

Para auxiliar na construção correta de paginação do lado do cliente, ao efetuar a consulta a um recurso de API que retorna uma lista, o cliente receberá na resposta 3 cabeçalhos HTTP (headers):

X-Total-Items - Este cabeçalho HTTP (header) informa o número total de itens da consulta completa (Não apenas da página visualizada)

X-Total-Pages - Este cabeçalho HTTP (header) informa o número total de páginas da consulta completa (usando a fórmula: Número total de items / per_page)

Link - Este cabeçalho HTTP (header), especificado pela RFC 8288, informa:

O link absoluto da primeira página da consulta
O link absoluto da página anterior (quando pertinente)
O link absoluto da próxima página (quanto pertinente)
O link absoluto da última página

Exemplo

Dado que uma consulta a transações de recargas de celular retornará 65 objetos

GET

https://api.sbx.rvhub.com.br/cellphone-topups/transactions?page=2&per_page=25

Então os seguinte cabeçalhos HTTP (headers) serão retornados na resposta da consulta:

X-Total-Items:65
X-Total_Pages:3
Link:<https://api.sbx.rvhub.com.br/cellphone-topups/transactions?page=1&per_page=25>; rel="first", <https://api.sbx.rvhub.com.br/cellphone-topups/transactions?page=2&per_page=25>; rel="prev", <https://api.sbx.rvhub.com.br/cellphone-topups/transactions?page=3&per_page=25>; rel="next", <https://api.sbx.rvhub.com.br/cellphone-topups/transactions?page=3&per_page=25>; rel="last"

HATEOAS

A essa altura, imaginamos que você já tenha percebido que a experiência do desenvolvedor é um assunto que levamos muito a sério quando criamos o RVHub. E, com este intuito, decidimos adotar uma abordagem HATEOAS na arquitetura de nossas APIs.

HATEOAS é um acrônimo para Hypermedia as the Engine of Application State (algo como hipermedia como o motor de estado da aplicação) e, de forma simples, permite um entendimento mais rápido de como navegar nos demais recursos de APIs do RVHub. Ou seja, após efetuar uma requisição a uma de nossas APIs, caso seja pertinente, nossas APIs retornarão através do nó “links” quais são os outros recursos que poderão lhe ser útil após essa chamada. Por exemplo, ao efetuar uma solicitação de recarga de celular teremos uma resposta conforme exemplo:

Perceba que a resposta de uma transação de solicitação de recarga efetuada com sucesso (status: authorized) retorna uma Collection com o nome “links” e cada objeto possui os seguintes atributos:

rel - Identifica a ação que a chamada descrita por esse link (hipermídia). Por exemplo: através do “self” você pode efetuar uma consulta do objeto criado, “capture” permite efetuar a confirmação desta transação e “refund” pode ser utilizado para efetuar o desfazimento da transação.
href - URL relativa de uma nova chamada identificada por “rel”
type - O método HTTP utilizado para efetuar a nova chamada identificada por “rel”

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "c6ed1b40-7b47-0138-ad95-6a7a823bbaf7",
            

              
                  "status": "authorized",
            

              
                  //… demais elementos JSON
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/cellphone-topups/transactions/c6ed1b40-7b47-0138-ad95-6a7a823bbaf7",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/cellphone-topups/transactions/c6ed1b40-7b47-0138-ad95-6a7a823bbaf7/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/cellphone-topups/transactions/c6ed1b40-7b47-0138-ad95-6a7a823bbaf7",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Ambientes

Atualmente trabalhamos com dois ambientes. O primeiro é o o sandbox, onde nossos parceiros podem usar para realizar os primeiros testes e conhecer nossas ferramentas, o segundo ambiente é o de produção, onde efetivamente nossos parceiros irão usufruir dos nossos produtos.

URL SANDBOX

Com essas URLs é possível acessar qualquer endpoint disponível para o público, apenas realizando o cadastro em nosso Portal do Desenvolvedor.

                    API: https://api.sbx.rvhub.com.br/


Autenticação: https://auth.sbx.rvhub.com.br/

URL PRODUÇÃO

Essas URLs estarão acessíveis mediante chave de autenticação em ambiente de produção.

                    API: https://api.rvhub.com.br/


Autenticação: https://auth.rvhub.com.br/

Homologação

Antes de nossos clientes serem habilitados para utilizar o sistema RVHub em produção, realizamos uma última etapa que é a homologação da integração do sistema dos nossos clientes. A homologação para o caso em que o cliente deseja transacionar os produtos de celular, PIN e TV consiste em sete passos, onde iremos verificar:

Passo 1 - 3 transações de recarga de celular
Passo 2 - 3 transações de recarga de PIN
Passo 3 - 3 transações de recarga de TV
Passo 4 - 1 transações de recarga com valor variável
Passo 5 - 3 transações de recargas canceladas
Passo 6 - 1 comprovante de recarga de celular
Passo 7 - 1 comprovante de recarga de PIN

Para os casos em que se deseje transacionar apenas determinados tipos de produtos, a homologação é feita somente validando transações dos tipos desejados.

                    Para cada passo seguido, o cliente deverá enviar o authorization_code
como comprovante para a equipe de suporte, para que seja feita a validação 
das transações. 
O authorization_code é encontrado nos 
retornos das APIs.

Passo 1

Será necessário que o cliente realize 3 transações de recarga de celular completas, passando pela solicitação e confirmação.

Passo 2

Será necessário que o cliente realize 3 transações de recarga de PIN completas, passando pela solicitação e confirmação.

Passo 3

Será necessário que o cliente realize 3 transações de recarga de TV completas, passando pela solicitação e confirmação.

Passo 4

Será necessário que o cliente realize uma transação de recarga de um produto de valor variável a sua escolha. Neste caso também precisaremos da Solicitação e Confirmação

Passo 5

Será necessário que o cliente realize 3 solicitações de recargas, uma para cada tipo (Celular, PIN e TV). E logo após essas solicitações deverão ser desfeitas.

Passo 6

Será necessário que o cliente envie a imagem de um comprovante de recarga de celular ou TV, contendo as seguintes informações:

Telefone
DDD
Data
Hora
Operadora
Valor
NSU
autorization_code

Abaixo temos um exemplo de comprovante de recarga de celular

recarga de celular

Passo 7

Será necessário que o cliente envie a imagem de um comprovante de recarga de PIN, contendo as seguintes informações:

código do PIN
Operadora
Data
Hora
Valor
PIN
autorization_code

Abaixo temos um exemplo de comprovante de recarga de PIN

recarga de tv

Caso o cliente tenha passado por todos os passos corretamente, será necessário entrar em contato com nossa área responsável pela integração através do e-mail: integracoes@rvtecnologia.com.br. Então serão geradas as credenciais desse cliente para o ambiente de produção, para que possa efetivamente utilizar todos os produtos contratados com a RV Digital

Regras de estorno

De modo geral, o estorno só será possível caso o PIN não tenha sido resgatado

REGRAS DE ESTORNO - VERTICAIS
JOGOS E APLICATIVOS	Formato	Estorno	Observação
AIRBNB	PIN	Sim	Caso não utilizado
APPLE	PIN	Sim	Caso não utilizado
FREE FIRE	PIN	Sim	6 meses, caso não utilizado
GOOGLE PLAY	PIN	Sim	Caso não utilizado
LEAGUE OF LEGENDS	PIN	Sim	12 meses, caso não utilizado
LEVEL UP	PIN	Sim	6 meses, caso não utilizado
MC DONALDS	PIN	Não	Produto não permite reembolso/cancelamento
MICROSOFT 365	PIN	Sim	Caso não utilizado
MINECOINS	PIN	Não	Produto não permite reembolso/cancelamento
MINECRAFT	PIN	Não	Produto não permite reembolso/cancelamento
NETFLIX	PIN	Sim	Caso não utilizado
NINTENDO	PIN	Não	Produto não permite reembolso/cancelamento
PLAYSTATION	PIN	Não	Produto não permite reembolso/cancelamento
RAPPI	PIN	Sim	3 meses, caso não utilizado
RAZER GOLD	PIN	Não	Produto não permite reembolso/cancelamento
ROBLOX	PIN	Sim	Caso não utilizado
SPOTIFY	PIN	Sim	12 meses, caso não utilizado
STEAM	PIN	Sim	Caso não utilizado
UBER	PIN	Sim	Caso não utilizado
VALORANT	PIN	Sim	12 meses, caso não utilizado
XBOX	PIN	Não	Produto não permite reembolso/cancelamento
ZÉ DELIVERY	PIN	Não	Produto não permite reembolso/cancelamento

CONTEÚDOS VAREJO	Formato	Estorno	Observação
ABBRACCIO	PIN	Sim	12 meses, caso não utilizado
ANACAPRI	PIN	Sim	6 meses, caso não utilizado
AO GOSTO	PIN	Sim	6 meses, caso não utilizado
APPLEBEES	PIN	Sim	6 meses, caso não utilizado
AREZZO	PIN	Sim	6 meses, caso não utilizado
AUSSIE GRILL	PIN	Sim	12 meses, caso não utilizado
BACIO DI LATTE	PIN	Sim	6 meses, caso não utilizado
BAGAGGIO	PIN	Sim	3 meses, caso não utilizado
BOBS	PIN	Sim	6 meses, caso não utilizado
BRASIL CACAU	PIN	Sim	6 meses, caso não utilizado
BRÁZ PIZZARIA	PIN	Sim	6 meses, caso não utilizado
BRINQUEDOS ESTRELA	PIN	Sim	6 meses, caso não utilizado
C&A	PIN	Sim	12 meses, caso não utilizado
CAFÉ ORFEU	PIN	Sim	6 meses, caso não utilizado
CAMARADA CAMARÃO	PIN	Sim	8 meses, caso não utilizado
CASAS BAHIA	PIN	Sim	12 meses, caso não utilizado
CENTAURO	PIN	Sim	12 meses, caso não utilizado
CHILLI BEANS	PIN	Sim	12 meses, caso não utilizado
COCO BAMBU	PIN	Sim	6 meses, caso não utilizado
CROCS	PIN	Sim	3 meses, caso não utilizado
DEMOCRATA	PIN	Sim	6 meses, caso não utilizado
DENGO CHOCOLATES	PIN	Sim	6 meses, caso não utilizado
DI PAOLO	PIN	Sim	6 meses, caso não utilizado
DUFRY	PIN	Sim	12 meses, caso não utilizado
EUDORA	PIN	Sim	6 meses, caso não utilizado
EURO RELÓGIOS	PIN	Sim	3 meses, caso não utilizado
FARMÁCIAS NISSEI	PIN	Sim	6 meses, caso não utilizado
FOGO DE CHÃO	PIN	Sim	6 meses, caso não utilizado
FOSSIL	PIN	Sim	3 meses, caso não utilizado
FUEL	PIN	Sim	6 meses, caso não utilizado
GNC CINEMAS	PIN	Sim	12 meses, caso não utilizado
GRANADO	PIN	Sim	6 meses, caso não utilizado
GRUPO TAG	PIN	Sim	6 meses, caso não utilizado
GURUMÊ	PIN	Sim	3 meses, caso não utilizado
HAVAIANAS	PIN	Sim	6 meses, caso não utilizado
HERING BRASIL	PIN	Sim	6 meses, caso não utilizado
IMAGINARIUM	PIN	Sim	12 meses, caso não utilizado
JERONIMO	PIN	Sim	12 meses, caso não utilizado
JOHNNY JOY	PIN	Sim	6 meses, caso não utilizado
KOPENHAGEN	PIN	Sim	6 meses, caso não utilizado
LOJAS BESNI	PIN	Sim	12 meses, caso não utilizado
LOJAS MM	PIN	Sim	6 meses, caso não utilizado
LOUGERIE	PIN	Sim	3 meses, caso não utilizado
MADERO	PIN	Sim	12 meses, caso não utilizado
MONTE CARLO	PIN	Sim	12 meses, caso não utilizado
NETSHOES	PIN	Sim	6 meses, caso não utilizado
NIKE	PIN	Sim	12 meses, caso não utilizado
NOSSO PAY	PIN	Sim	12 meses, caso não utilizado
OSCAR CALÇADOS	PIN	Sim	12 meses, caso não utilizado
OUTBACK STEAKHOUSE	PIN	Sim	12 meses, caso não utilizado
PETLOVE	PIN	Sim	6 meses, caso não utilizado
POBRE JUAN	PIN	Sim	6 meses, caso não utilizado
PRIMEPASS CINEMA	PIN	Sim	Caso não utilizado
RESERVA	PIN	Sim	6 meses, caso não utilizado
RIACHUELO	PIN	Sim	12 meses, caso não utilizado
SANTA LOLLA	PIN	Sim	6 meses, Caso não utilizado
SANTA LUZIA	PIN	Sim	12 meses, Caso não utilizado
SCHUTZ	PIN	Sim	6 meses, caso não utilizado
SÍ SEÑOR	PIN	Sim	6 meses, caso não utilizado
SUPERMERCADOS BH	PIN	Sim	6 meses, caso não utilizado
SUSHITO	PIN	Sim	8 meses, caso não utilizado
TALCHÁ	PIN	Sim	12 meses, caso não utilizado
TECHNOS	PIN	Sim	3 meses, caso não utilizado
TINDER	PIN	Sim	1 mês, caso não utilizado
TIP TOP	PIN	Sim	12 meses, caso não utilizado
TNG	PIN	Sim	6 meses, caso não utilizado
TOKSTOK	PIN	Sim	12 meses, caso não utilizado
VANS	PIN	Sim	6 meses, caso não utilizado
VILA ROMANA	PIN	Sim	6 meses, caso não utilizado
WE COFFEE	PIN	Sim	6 meses, caso não utilizado
ZATTINI	PIN	Sim	12 meses, caso não utilizado
ZIFT	PIN	Sim	12 meses, caso não utilizado
ZZ MALL	PIN	Sim	6 meses, caso não utilizado

TV PRÉ-PAGA	Formato	Estorno	Observação
CLARO TV	ONLINE	Não	Cliente deve direcionar-se a operadora.
CLARO TV+	ONLINE	Sim	6 meses, caso não utilizado.
SKY	ONLINE	Não	Cliente deve direcionar-se a operadora.
SKY+	ONLINE	Não	Cliente deve direcionar-se a operadora.
OI TV	ONLINE	Não	Cliente deve direcionar-se a operadora.

TELEFONIA	Formato	Estorno	Observação
ALGAR CEL	ONLINE	Não	Cliente deve direcionar-se a operadora.
ALGAR FIXA	ONLINE	Não	Cliente deve direcionar-se a operadora.
CLARO FIXO	ONLINE	Não	Cliente deve direcionar-se a operadora.
CORREIOS CELULAR	ONLINE	Não	Cliente deve direcionar-se a operadora.
EMBRATEL	ONLINE	Não	Cliente deve direcionar-se a operadora.
OI FIXA	ONLINE	Não	Cliente deve direcionar-se a operadora.
SERCOMTEL CEL	ONLINE	Não	Cliente deve direcionar-se a operadora.
SERCOMTEL FIXA	ONLINE	Não	Cliente deve direcionar-se a operadora.
SURF TELECOM	ONLINE	Não	Cliente deve direcionar-se a operadora.

CERTIFICADOS E APOSTAS	Formato	Estorno
AMAZONAS DA SORTE	ONLINE	Não
BAHIA DA SORTE	ONLINE	Não
CARIMBO DA SORTE	ONLINE	Não
MARACAP	ONLINE	Não
PINPAY BETSUL	ONLINE	Não
TELE SENA	ONLINE	Não

OUTROS SERVIÇOS	Formato	Estorno	Observação
SPC	ONLINE	Não

Fluxos

Nesta sessão iremos mostrar de forma mais simples, como funciona o fluxo de cada produto que oferecemos.

Fluxo de recargas

As transações do RVHub possuem cinco estados:

Autorizada (authorized)
Confirmada (captured)
Cancelada (canceled)
Negada (denied)
Estornada (refunded)

                    As transações de Solicitação, Confirmação e Desfazimento são de 
implantação obrigatória. Pois serão solicitadas no momento da homologação.

Autorizada

Toda transação em seu estado inicial, ou seja quando é criada, é considerada como authorized.

POST

/cellphone-topups/transactions

Confirmada

Quando a transação for criada de forma correta e for solicitado a confirmação através de uma requisição ela assume o estado de captured.

POST

/cellphone-topups/transactions/{transaction_id}/capture

Cancelada

Quando a transação está autorizada pelo RVHub e foi cancelada pelo portal do cliente ou o tempo máximo de confirmação excedeu, a transação assume o estado de canceled.

                    Se a transação de confirmação (captured) não for enviada até 23:45 do dia da solicitação, 
a transação será cancelada automaticamente.

Negada

As transações que apresentarem algum tipo de erro, tais como número de celular incorreto, número de celular na Black List, produto inexistente e etc. Esta transação assume o estado de denied.

Estornada

Se após a criação de uma transação for solicitado o cancelamento (desfazimento), a transação assume o estado de refunded.

DELETE

/cellphone-topups/transactions/{transaction_id}

Fluxo de pagamentos

As transações de pagamentos de contas do RVHub possuem cinco estados:

Aguardando pagamento (awaiting_payment)
Aguardando processamento (awaiting_processing)
Aprovada (approved)
Cancelada (canceled)
Negada (denied)
Confirmada (captured)
Estornada (refunded)

Aguardando pagamento

Para iniciar o fluxo de pagamento de conta o usuário deverá informar o código de barras ou a linha digitável, esse processo criará uma transação de pagamento de conta com estado awaiting_payment (aguardando pagamento).

POST

/bills/payments

Aprovada

Após o usuário confirmar a transação e não ocorrer erros de validação, a transação vai para o estado approved (aprovada), esse estado é transitório pois exige a confirmação da instituição financeira.

POST

/bills/payments/{id_bill_payment}/capture

Aguardando processamento

Esse status informa que a transação está em fase de processamento, senão ocorrer erros de validação, a transação vai para o estado approved (aprovada).

POST

/bills/payments/{id_bill_payment}/capture

Cancelada

O cancelamento da transação de pagamento cancelled (cancelada), pode ocorrer de duas maneiras: de forma ativa, quando o usuário cancela uma transação que está em awaiting_payment (aguardando pagamento),
ou se excedido o tempo máximo para o usuário confirmar a transação, que é de 24hs após a criação da transação.

DELETE

/bills/payments/{transaction_id}

                    Se o usuário não confirmar a transação dentro de 24 horas, 
a transação será cancelada automaticamente.

Negado

A transação de pagamento que apresentar algum tipo de erro, tal como código de barra ou linha digitável incorretos, assume o estado de denied (negada).

Confirmada

Após a instituição financeira confirmar a efetivação do pagamento, a transação irá para o estado captured (confirmada).

                    A efetivação é realizada de forma assíncrona. De 15 em 15 minutos 
verificamos o estado do pagamento na instituíção financeira, caso 
seja efetivado, confirmamos a transação.

Estornado

Se no processo de confirmação junto à instituíção financeira, a mesma não aceitar o pagamento,
a transação será estornada. (refunded)

Recarga de celular

Esta API é responsável por todas as movimentações referentes a recargas de celular.

Serviços disponíveis

POST

/cellphone-topups/transactions

POST

/cellphone-topups/transactions/{id_transaction}/capture

DELETE

/cellphone-topups/transactions/{id_transaction}

GET

/cellphone-topups/transactions/{id_transaction}

GET

/cellphone-topups/transactions

Solicitação de recarga

Com esta API é possível realizar novas solicitações de recarga para celular.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

product_id(string) - Informar o código do produto
area_code(string) - Informar o DDD do celular
cell_phone_number(string) - Informar o numero do celular
amount(int) [opcional] - Deve ser informado o valor da recarga em formato inteiro sem pontuação
affiliation_key(string) - Informar a chave do parceiro (Ex. Software House). Para contas vinculadas a um parceiro esse campo é obrigatório.
metadata(object) [opcional] - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) [opcional] - Informar a sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) [opcional] - Informar o código do terminal que está realizando a venda.
metadata. local_user (string) [opcional] - Informar o código ou Login do usuário local (na rede do cliente) que efetuou a transação, para registro no relatório de compras.

                    Alguns produtos possuem valor variável, neste caso deve ser usado o campo amount
com o valor que será recarregado, sempre obedecendo o valor mínimo e máximo do produto.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/cellphone-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
              	"product_id": "1",
            

              
              	"area_code": "11",
            

              
              	"cell_phone_number": "999995555",
            

              
              	"amount": 5000,
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  }
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "4eb02850-7911-0138-1c2a-1a6802ff9bdd",
            

              
                  "product_id": "1",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999995555",
            

              
                  "status": "authorized",
            

              
                  "created_at": "2020-05-15T19:36:33.736Z",
            

              
                  "updated_at": "2020-05-15T19:36:34.122Z",
            

              
                  "nsu": "000011260",
            

              
                  "authorization_code": 11260,
            

              
                  "face_amount": 3000,
            

              
                  "due_date": "2020-05-20T00:00:00.000Z",
            

              
                  "message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
            

              
                  "authorized_at": "2020-05-15T00:00:00.000Z",
            

              
                  "charged_amount": 2850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-15T19:36:34.136Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/4eb02850-7911-0138-1c2a-1a6802ff9bdd",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/4eb02850-7911-0138-1c2a-1a6802ff9bdd/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/4eb02850-7911-0138-1c2a-1a6802ff9bdd",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Confirmação de recarga

Após solicitar a recarga, será preciso confirmar sua solicitação, para fazer isso basta chamar esta requisição informando o id_transaction.

Neste caso não será necessário enviar o corpo(body) da requisição, apenas informar o parametro na URL juntamente com o sufixo /capture não se esquecendo que o verbo HTTP desta requisição continua a ser o POST conforme demonstrado no exemplo.

                    Após confirmação da recarga, o cancelamento não será mais possível.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

                    Note que conforme são alterados os status da solicitação, serão acrescentados
no campo statuses como forma de histórico para a sua solicitação

POST

/cellphone-topups/transactions/{id_transaction}/capture

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions/47f9e5b0-7b45-0138-ae54-0e952cca23cd/capture' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "captured",
            

              
                  "id": "47f9e5b0-7b45-0138-ae54-0e952cca23cd",
            

              
                  "product_id": "1",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999995555",
            

              
                  "created_at": "2020-05-18T14:53:38.631Z",
            

              
                  "updated_at": "2020-05-18T17:52:08.006Z",
            

              
                  "nsu": "000011492",
            

              
                  "authorization_code": 11492,
            

              
                  "face_amount": 3000,
            

              
                  "due_date": "2020-05-23T00:00:00.000Z",
            

              
                  "message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
            

              
                  "authorized_at": "2020-05-18T00:00:00.000Z",
            

              
                  "charged_amount": 2850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-18T14:53:38.854Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "captured",
            

              
                          "created_at": "2020-05-18T17:52:08.027Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/47f9e5b0-7b45-0138-ae54-0e952cca23cd",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Desfazimento de recarga

Para cancelar uma solicitação de recarga, é preciso chamar a requisição de desfazimento, bastando apenas enviar o id_transaction na URL da requisição pelo verbo HTTP DELETE. Veja o exemplo para compreender melhor.

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação
não será mais possível desfazer esta solicitação.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/cellphone-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request DELETE 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions/80d39510-6ac3-0138-4336-56e1314b0560' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "refunded",
            

              
                  "id": "6fb56fb0-7b36-0138-675e-26d6d98705df",
            

              
                  "product_id": "2",
            

              
                  "amount": 3000,
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "994145350",
            

              
                  "created_at": "2020-05-18T13:07:22.840Z",
            

              
                  "updated_at": "2020-05-18T13:07:32.588Z",
            

              
                  "nsu": "000011392",
            

              
                  "authorization_code": 11392,
            

              
                  "face_amount": 3000,
            

              
                  "due_date": "2020-05-23T00:00:00.000Z",
            

              
                  "message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO FIXO",
            

              
                  "authorized_at": "2020-05-18T00:00:00.000Z",
            

              
                  "charged_amount": 2850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-18T13:07:23.175Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "refunded",
            

              
                          "created_at": "2020-05-18T13:07:32.609Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/6fb56fb0-7b36-0138-675e-26d6d98705df",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta de recarga

Para consultar suas transações, basta invocar este serviço e informar o id_transaction na URL.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/cellphone-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions/d70603c0-6ac0-0138-d1f7-6a4d3f76afc8' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "6fb56fb0-7b36-0138-675e-26d6d98705df",
            

              
                  "product_id": "2",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999995555",
            

              
                  "amount": 3000,
            

              
                  "status": "refunded",
            

              
                  "created_at": "2020-05-18T13:07:22.840Z",
            

              
                  "updated_at": "2020-05-18T13:07:32.588Z",
            

              
                  "nsu": "000011392",
            

              
                  "authorization_code": 11392,
            

              
                  "face_amount": 3000,
            

              
                  "due_date": "2020-05-23T00:00:00.000Z",
            

              
                  "message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO FIXO",
            

              
                  "authorized_at": "2020-05-18T00:00:00.000Z",
            

              
                  "charged_amount": 2850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-18T13:07:23.175Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "refunded",
            

              
                          "created_at": "2020-05-18T13:07:32.609Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/6fb56fb0-7b36-0138-675e-26d6d98705df",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Lista de recarga

Para listar todas as suas transações, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(authorized, captured, refunded ou denied) da recarga.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/cellphone-topups/transactions?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/cellphone-topups/transactions?statuses=authorized,captured

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/cellphone-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
            

              
                      "product_id": "1",
            

              
                      "area_code": "11",
            

              
                      "cell_phone_number": "999995555",
            

              
                      "status": "canceled",
            

              
                      "created_at": "2020-05-06T13:26:31.211Z",
            

              
                      "updated_at": "2020-05-15T14:15:11.718Z",
            

              
                      "nsu": "000016838",
            

              
                      "authorization_code": 16838,
            

              
                      "face_amount": 3000,
            

              
                      "due_date": "2020-05-11T00:00:00.000Z",
            

              
                      "message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
            

              
                      "authorized_at": "2020-05-06T00:00:00.000Z",
            

              
                      "charged_amount": 2850,
            

              
                      "affiliation_key": "12345",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-05-06T13:26:31.570Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "canceled",
            

              
                              "created_at": "2020-05-15T14:15:11.741Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "id": "d4b8b4e0-71d0-0138-5223-3acfbc91fe00",
            

              
                      "product_id": "1",
            

              
                      "area_code": "11",
            

              
                      "cell_phone_number": "999994444",
            

              
                      "status": "authorized",
            

              
                      "created_at": "2020-05-06T14:07:23.180Z",
            

              
                      "updated_at": "2020-05-06T14:07:23.495Z",
            

              
                      "nsu": "000017384",
            

              
                      "authorization_code": 17384,
            

              
                      "face_amount": 3000,
            

              
                      "due_date": "2020-05-11T00:00:00.000Z",
            

              
                      "message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
            

              
                      "authorized_at": "2020-05-06T00:00:00.000Z",
            

              
                      "charged_amount": 2850,
            

              
                      "affiliation_key": "12345",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-05-06T14:07:23.506Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/d4b8b4e0-71d0-0138-5223-3acfbc91fe00",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          },
            

              
                          {
            

              
                              "href": "/transactions/d4b8b4e0-71d0-0138-5223-3acfbc91fe00/capture",
            

              
                              "rel": "capture",
            

              
                              "type": "POST"
            

              
                          },
            

              
                          {
            

              
                              "href": "/transactions/d4b8b4e0-71d0-0138-5223-3acfbc91fe00",
            

              
                              "rel": "refund",
            

              
                              "type": "DELETE"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Recarga de PIN

Esta API é responsável por todas as movimentações referentes a recargas de PIN.

Serviços disponíveis

POST

/pin-topups/transactions

POST

/pin-topups/transactions/{id_transaction}/capture

DELETE

/pin-topups/transactions/{id_transaction}

GET

/pin-topups/transactions/{id_transaction}

GET

/pin-topups/transactions

Solicitação de recarga

Com esta API é possível realizar novas solicitações de recarga com PIN.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

product_id(string) - Informar o código do produto.
amount(string) - Informar o valor. Utilizado apenas no caso de produtos de valor variável.

Parâmetros Opcionais

area_code(string) - Informar o DDD do celular
cell_phone_number(string) - Informar o numero do celular
affiliation_key(string) - Informar a chave do parceiro (Ex. Software House). Para contas vinculadas a um parceiro esse campo é obrigatório.

metadata(object) [opcional] - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) [opcional] - Informar a sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) [opcional] - Informar o código do terminal que está realizando a venda.
metadata. local_user (string) [opcional] - Informar o código ou Login do usuário local (na rede do cliente) que efetuou a transação, para registro no relatório de compras.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
authorized_at(string) - Data que a transação foi autorizada
pin(string) - Informa o PIN a ser impresso no ticket e que será usado pelo cliente para inserir seus créditos.
lot(string) - Numero do lote do PIN para impressão no ticket
serial_number(string) - Numero de série do PIN para impressão no ticket
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
metadata. snb (string) [opcional] - Código do snb para as compras de cartão presente Centauro, Riachuelo, Zatini e Netshoes.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/pin-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/pin-topups/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                  "product_id": "3",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999996666",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  }
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "a81c51a0-80c1-0138-e78e-560cf8ddddce",
            

              
                  "product_id": "3",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999996666",
            

              
                  "status": "authorized",
            

              
                  "created_at": "2020-05-25T14:26:33.326Z",
            

              
                  "updated_at": "2020-05-25T14:26:33.636Z",
            

              
                  "authorization_code": 15467,
            

              
                  "face_amount": 1000,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "authorized_at": "2020-05-25T14:26:33.000Z",
            

              
                  "pin": "1FF1-A09B-9CCD-9619",
            

              
                  "lot": "0",
            

              
                  "serial_number": "15467",
            

              
                  "charged_amount": 950,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE",
            

              
                      "snb": "167456"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T14:26:33.650Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Confirmação de recarga

Após solicitar o PIN, será preciso confirmar sua solicitação, para fazer isso basta chamar esta requisição informando o id_transaction.

                    Após confirmação do PIN, o cancelamento não será mais possível.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
amount(int) - Valor da recarga
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
authorized_at(string) - Data que a transação foi autorizada
pin(string) - Informa o PIN a ser impresso no ticket e que será usado pelo cliente para inserir seus créditos.
lot(string) - Numero do lote do PIN para impressão no ticket
serial_number(string) - Numero de série do PIN para impressão no ticket
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/pin-topups/transactions/{id_transaction}/capture

Exemplo de requisição

LINGUAGEM: CURL


              
              curl  --request POST 'https://api.sbx.rvhub.com.br/pin-topups/transactions/fb4bb6a0-80b3-0138-bada-3eb142fe6ec7/capture' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "captured",
            

              
                  "id": "a81c51a0-80c1-0138-e78e-560cf8ddddce",
            

              
                  "product_id": "3",
            

              
                  "amount": 3000,
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999996666",
            

              
                  "created_at": "2020-05-25T12:48:39.933Z",
            

              
                  "updated_at": "2020-05-25T13:20:45.615Z",
            

              
                  "authorization_code": 14751,
            

              
                  "face_amount": 1000,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "authorized_at": "2020-05-25T12:48:40.000Z",
            

              
                  "pin": "3AE1-A750-F96B-1D99",
            

              
                  "lot": "0",
            

              
                  "serial_number": "14751",
            

              
                  "charged_amount": 950,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T12:48:40.177Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "captured",
            

              
                          "created_at": "2020-05-25T13:20:45.636Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/fb4bb6a0-80b3-0138-bada-3eb142fe6ec7",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Desfazimento de recarga

Para cancelar uma solicitação de PIN, é preciso chamar a requisição de desfazimento, bastando apenas enviar o id_transaction na URL da requisição pelo verbo HTTP DELETE. Veja o exemplo para compreender melhor.

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação
não será mais possível desfazer esta solicitação.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
authorized_at(string) - Data que a transação foi autorizada
pin(string) - Informa o PIN a ser impresso no ticket e que será usado pelo cliente para inserir seus créditos.
lot(string) - Numero do lote do PIN para impressão no ticket
serial_number(string) - Numero de série do PIN para impressão no ticket
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/pin-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request DELETE 'https://api.sbx.rvhub.com.br/pin-topups/transactions/fb4bb6a0-80b3-0138-bada-3eb142fe6ec7' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "refunded",
            

              
                  "id": "8267c060-80bd-0138-af18-2a64cea8d0cb",
            

              
                  "product_id": "3",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999996666",
            

              
                  "created_at": "2020-05-25T13:56:52.080Z",
            

              
                  "updated_at": "2020-05-25T13:57:03.596Z",
            

              
                  "authorization_code": 15266,
            

              
                  "face_amount": 1000,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "authorized_at": "2020-05-25T13:56:52.000Z",
            

              
                  "pin": "34DC-E6A5-97D7-9268",
            

              
                  "lot": "0",
            

              
                  "serial_number": "15266",
            

              
                  "charged_amount": 950,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T13:56:52.384Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "refunded",
            

              
                          "created_at": "2020-05-25T13:57:03.616Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/8267c060-80bd-0138-af18-2a64cea8d0cb",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta de recarga

Para consultar suas transações, basta invocar este serviço e informar o id_transaction na URL.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
authorized_at(string) - Data que a transação foi autorizada
pin(string) - Informa o PIN a ser impresso no ticket e que será usado pelo cliente para inserir seus créditos.
lot(string) - Numero do lote do PIN para impressão no ticket
serial_number(string) - Numero de série do PIN para impressão no ticket
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/pin-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/pin-topups/transactions/fb4bb6a0-80b3-0138-bada-3eb142fe6ec7' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "a81c51a0-80c1-0138-e78e-560cf8ddddce",
            

              
                  "product_id": "3",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999996666",
            

              
                  "status": "authorized",
            

              
                  "created_at": "2020-05-25T14:26:33.326Z",
            

              
                  "updated_at": "2020-05-25T14:26:33.636Z",
            

              
                  "authorization_code": 15467,
            

              
                  "face_amount": 1000,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "authorized_at": "2020-05-25T14:26:33.000Z",
            

              
                  "pin": "1FF1-A09B-9CCD-9619",
            

              
                  "lot": "0",
            

              
                  "serial_number": "15467",
            

              
                  "charged_amount": 950,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T14:26:33.650Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Lista de recarga

Para listar todas as suas transações de recarga de PIN, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(authorized, captured, refunded ou denied) da recarga.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/pin-topups/transactions?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/pin-topups/transactions?statuses=authorized,captured

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
authorized_at(string) - Data que a transação foi autorizada
pin(string) - Informa o PIN a ser impresso no ticket e que será usado pelo cliente para inserir seus créditos.
lot(string) - Numero do lote do PIN para impressão no ticket
serial_number(string) - Numero de série do PIN para impressão no ticket
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/pin-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/pin-topups/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "728d1190-774c-0138-b3a2-6a6da5842074",
            

              
                      "product_id": "3",
            

              
                      "area_code": "11",
            

              
                      "cell_phone_number": "999996666",
            

              
                      "status": "captured",
            

              
                      "created_at": "2020-05-13T13:34:51.886Z",
            

              
                      "updated_at": "2020-05-13T13:35:25.696Z",
            

              
                      "authorization_code": 5931,
            

              
                      "face_amount": 1000,
            

              
                      "due_date": "2020-05-18T00:00:00.000Z",
            

              
                      "authorized_at": "2020-05-13T00:00:00.000Z",
            

              
                      "pin": "054C-2C08-AA9E-6164",
            

              
                      "lot": "0",
            

              
                      "serial_number": "5931",
            

              
                      "charged_amount": 950,
            

              
                      "affiliation_key": "12345",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-05-13T13:34:52.396Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "captured",
            

              
                              "created_at": "2020-05-13T13:35:25.725Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/728d1190-774c-0138-b3a2-6a6da5842074",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "id": "de1751f0-774c-0138-b3a3-6a6da5842074",
            

              
                      "product_id": "3",
            

              
                      "area_code": "11",
            

              
                      "cell_phone_number": "999995555",
            

              
                      "status": "refunded",
            

              
                      "created_at": "2020-05-13T13:37:52.308Z",
            

              
                      "updated_at": "2020-05-13T13:38:19.197Z",
            

              
                      "authorization_code": 5932,
            

              
                      "face_amount": 1000,
            

              
                      "due_date": "2020-05-18T00:00:00.000Z",
            

              
                      "authorized_at": "2020-05-13T00:00:00.000Z",
            

              
                      "pin": "5BD8-F0D9-F2AC-F5D9",
            

              
                      "lot": "0",
            

              
                      "serial_number": "5932",
            

              
                      "charged_amount": 950,
            

              
                      "affiliation_key": "12345",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-05-13T13:37:52.612Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "refunded",
            

              
                              "created_at": "2020-05-13T13:38:19.217Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/de1751f0-774c-0138-b3a3-6a6da5842074",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Recarga de TV

Esta API é responsável por todas as movimentações referentes a recargas de TV.

Serviços disponíveis

POST

/tv-topups/transactions

POST

/tv-topups/transactions/{id_transaction}/capture

DELETE

/tv-topups/transactions/{id_transaction}

GET

/tv-topups/transactions/{id_transaction}

GET

/tv-topups/transactions

Solicitação de recarga

Com esta API é possível realizar novas solicitações de recarga para TV.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

product_id(string) - Informar o código do produto
signer_code(string) - Informar o código ou CPF do assinante

                    Caso o assinante possua mais de uma assinatura na mesma operadora, então 
se torna obrigatório o envio do Código do Assinante. Caso seja enviado o 
CPF do assinante e ele possua mais de uma assinatura vinculada ao seu CPF, 
o erro signer_code_required será retornado.

affiliation_key(string) - Informar a chave do parceiro (Ex. Software House). Para contas vinculadas a um parceiro esse campo é obrigatório.
metadata(object) [opcional] - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) [opcional] - Informar a sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) [opcional] - Informar o código do terminal que está realizando a venda.
metadata. local_user (string) [opcional] - Informar o código ou Login do usuário local (na rede do cliente) que efetuou a transação, para registro no relatório de compras.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
signer_code(string) - Informa o código do assinante do serviço de TV.
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/tv-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/tv-topups/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                  "product_id": "5",
            

              
                  "signer_code": "12345678910",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  }
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
            

              
                  "product_id": "5",
            

              
                  "status": "authorized",
            

              
                  "created_at": "2020-05-25T15:13:11.163Z",
            

              
                  "updated_at": "2020-05-25T15:13:11.357Z",
            

              
                  "nsu": "000015471",
            

              
                  "authorization_code": 15471,
            

              
                  "face_amount": 1990,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
            

              
                  "authorized_at": "2020-05-25T15:13:11.000Z",
            

              
                  "signer_code": "12345678910",
            

              
                  "charged_amount": 1850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T15:13:11.362Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Confirmação de recarga

Após solicitar a recarga de TV, será preciso confirmar sua solicitação, para fazer isso basta chamar esta requisição informando o id_transaction.

                    Após confirmação da recarga de TV, o cancelamento não será mais possível.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
signer_code(string) - Informa o código do assinante do serviço de TV.
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/tv-topups/transactions/{id_transaction}/capture

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/tv-topups/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff/capture' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "captured",
            

              
                  "id": "2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
            

              
                  "product_id": "5",
            

              
                  "signer_code": "12345678910",
            

              
                  "created_at": "2020-05-25T15:13:11.163Z",
            

              
                  "updated_at": "2020-05-25T16:10:19.634Z",
            

              
                  "nsu": "000015471",
            

              
                  "authorization_code": 15471,
            

              
                  "face_amount": 1990,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
            

              
                  "authorized_at": "2020-05-25T15:13:11.000Z",
            

              
                  "charged_amount": 1850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T15:13:11.362Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "captured",
            

              
                          "created_at": "2020-05-25T16:10:19.655Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Desfazimento de recarga

Para cancelar uma solicitação de recarga de TV, é preciso chamar a requisição de desfazimento, bastando apenas enviar o id_transaction na URL da requisição pelo verbo HTTP DELETE. Veja o exemplo para compreender melhor.

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação
não será mais possível desfazer esta solicitação.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
signer_code(string) - Informa o código do assinante do serviço de TV.
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/tv-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request DELETE 'https://api.sbx.rvhub.com.br/tv-topups/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "refunded",
            

              
                  "id": "7c93b490-80d3-0138-82fe-3a4157b7b374",
            

              
                  "product_id": "5",
            

              
                  "signer_code": "12345678910",
            

              
                  "created_at": "2020-05-25T16:34:11.230Z",
            

              
                  "updated_at": "2020-05-25T16:34:26.636Z",
            

              
                  "nsu": "000015472",
            

              
                  "authorization_code": 15472,
            

              
                  "face_amount": 1990,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
            

              
                  "authorized_at": "2020-05-25T16:34:11.000Z",
            

              
                  "charged_amount": 1850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T16:34:11.575Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "refunded",
            

              
                          "created_at": "2020-05-25T16:34:26.658Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/7c93b490-80d3-0138-82fe-3a4157b7b374",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta de recarga

Para consultar suas transações de recarga para TV, basta invocar este serviço e informar o id_transaction na URL.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
signer_code(string) - Informa o código do assinante do serviço de TV.
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/tv-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/tv-topups/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "61741d70-80e0-0138-6759-1eb0fbb10474",
            

              
                  "product_id": "5",
            

              
                  "status": "captured",
            

              
                  "created_at": "2020-05-25T18:06:29.182Z",
            

              
                  "updated_at": "2020-05-25T18:06:35.954Z",
            

              
                  "nsu": "000015473",
            

              
                  "authorization_code": 15473,
            

              
                  "face_amount": 1990,
            

              
                  "due_date": "2020-05-30T00:00:00.000Z",
            

              
                  "message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
            

              
                  "authorized_at": "2020-05-25T18:06:29.000Z",
            

              
                  "signer_code": "12345678910",
            

              
                  "charged_amount": 1850,
            

              
                  "affiliation_key": "12345",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-05-25T18:06:29.535Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "captured",
            

              
                          "created_at": "2020-05-25T18:06:35.982Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/61741d70-80e0-0138-6759-1eb0fbb10474",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Lista de recarga

Para listar todas as suas transações de recarga de TV, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(authorized, captured, refunded ou denied) da recarga.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/tv-topups/transactions?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/tv-topups/transactions?statuses=authorized,captured

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
signer_code(string) - Informa o código do assinante do serviço de TV.
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/tv-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/tv-topups/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "ac4d9db0-7752-0138-8428-0a492e938315",
            

              
                      "product_id": "3",
            

              
                      "status": "denied",
            

              
                      "created_at": "2020-05-13T14:19:25.758Z",
            

              
                      "updated_at": "2020-05-13T14:19:29.284Z",
            

              
                      "status_reason": "operator_or_product_not_found",
            

              
                      "signer_code": "12345678910",
            

              
                      "charged_amount": 1850,
            

              
                      "affiliation_key": "12345",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "denied",
            

              
                              "created_at": "2020-05-13T14:19:29.301Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/ac4d9db0-7752-0138-8428-0a492e938315",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "id": "b9d9e130-7752-0138-8429-0a492e938315",
            

              
                      "product_id": "5",
            

              
                      "status": "captured",
            

              
                      "created_at": "2020-05-13T14:19:48.488Z",
            

              
                      "updated_at": "2020-05-13T14:21:42.516Z",
            

              
                      "nsu": "000006049",
            

              
                      "authorization_code": 6049,
            

              
                      "face_amount": 1990,
            

              
                      "due_date": "2020-05-18T00:00:00.000Z",
            

              
                      "message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
            

              
                      "authorized_at": "2020-05-13T00:00:00.000Z",
            

              
                      "signer_code": "10987654321",
            

              
                      "affiliation_key": "12345",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-05-13T14:19:48.752Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "captured",
            

              
                              "created_at": "2020-05-13T14:21:42.521Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/b9d9e130-7752-0138-8429-0a492e938315",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Recarga de transporte

Esta API é responsável por todas as movimentações referentes a recargas de transporte.

Serviços disponíveis

POST

/transport-topups/transactions

POST

/transport-topups/transactions/{id_transaction}/capture

DELETE

/transport-topups/transactions/{id_transaction}

GET

/transport-topups/transactions/{id_transaction}

GET

/transport-topups/transactions

Solicitação de recarga

Com esta API é possível realizar novas solicitações de recarga para transporte.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

product_id(string) - Informar o código do produto
amount(int) - Deve ser informado o valor da recarga em formato inteiro sem pontuação
card_number(string) - Informar o numero do cartão de transporte do usuário
affiliation_key(string) [opcional] - Informar a chave do parceiro (Ex. Software House). Para contas vinculadas a um parceiro esse campo é obrigatório.
metadata(object) [opcional] - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) [opcional] - Informar a sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) [opcional] - Informar o código do terminal que está realizando a venda.
metadata. local_user (string) [opcional] - Informar o código ou Login do usuário local (na rede do cliente) que efetuou a transação, para registro no relatório de compras.

                    Alguns produtos possuem valor variável, neste caso deve ser usado o campo amount
com o valor que será recarregado, sempre obedecendo o valor mínimo e máximo do produto.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
card_number(string) - Numero do cartão do usuário
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/transport-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/transport-topups/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                  "product_id": "70",
            

              
                  "amount": "9999",
            

              
                  "card_number": "1234",
            

              
                  "metadata": {
            

              
                      "terminal_state": "MG",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  }
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "18cbce30-e945-0138-c761-628b9885fbe6",
            

              
                  "product_id": "70",
            

              
                  "amount": 9999,
            

              
                  "status": "authorized",
            

              
                  "created_at": "2020-10-05T14:29:27.381Z",
            

              
                  "updated_at": "2020-10-05T14:29:27.879Z",
            

              
                  "nsu": "000076066",
            

              
                  "authorization_code": "76066",
            

              
                  "face_amount": 9999,
            

              
                  "due_date": "2020-10-10T00:00:00.000Z",
            

              
                  "message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
            

              
                  "authorized_at": "2020-10-05T14:29:27.000Z",
            

              
                  "charged_amount": 9499,
            

              
                  "card_number": "1234",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-10-05T14:29:27.894Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/18cbce30-e945-0138-c761-628b9885fbe6",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/18cbce30-e945-0138-c761-628b9885fbe6/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/18cbce30-e945-0138-c761-628b9885fbe6",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Confirmação de recarga

Após solicitar a recarga, será preciso confirmar sua solicitação, para fazer isso basta chamar esta requisição informando o id_transaction.

                    Após confirmação da recarga, o cancelamento não será mais possível.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
amount(int) - Valor da recarga
card_number(string) - Numero do cartão do usuário
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

                    Note que conforme são alterados os status da solicitação, serão acrescentados
no campo statuses como forma de histórico para a sua solicitação

POST

/transport-topups/transactions/{id_transaction}/capture

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/transport-topups/transactions/18cbce30-e945-0138-c761-628b9885fbe6/capture' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "captured",
            

              
                  "id": "18cbce30-e945-0138-c761-628b9885fbe6",
            

              
                  "product_id": "70",
            

              
                  "amount": 9999,
            

              
                  "card_number": "1234",
            

              
                  "created_at": "2020-10-05T14:29:27.381Z",
            

              
                  "updated_at": "2020-10-05T17:26:26.441Z",
            

              
                  "nsu": "000076066",
            

              
                  "authorization_code": "76066",
            

              
                  "face_amount": 9999,
            

              
                  "due_date": "2020-10-10T00:00:00.000Z",
            

              
                  "message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
            

              
                  "authorized_at": "2020-10-05T14:29:27.000Z",
            

              
                  "charged_amount": 9499,
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-10-05T14:29:27.894Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "captured",
            

              
                          "created_at": "2020-10-05T17:26:26.457Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/18cbce30-e945-0138-c761-628b9885fbe6",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Desfazimento de recarga

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação
não será mais possível desfazer esta solicitação.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
amount(int) - Valor da recarga
card_number(string) - Numero do cartão do usuário
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/transport-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request DELETE 'https://api.sbx.rvhub.com.br/transport-topups/transactions/4b3ee1d0-e95e-0138-0ad1-32726f22dc1b' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "refunded",
            

              
                  "id": "4b3ee1d0-e95e-0138-0ad1-32726f22dc1b",
            

              
                  "product_id": "70",
            

              
                  "amount": 9999,
            

              
                  "card_number": "1234",
            

              
                  "created_at": "2020-10-05T17:29:49.440Z",
            

              
                  "updated_at": "2020-10-05T17:29:54.121Z",
            

              
                  "nsu": "000076305",
            

              
                  "authorization_code": "76305",
            

              
                  "face_amount": 9999,
            

              
                  "due_date": "2020-10-10T00:00:00.000Z",
            

              
                  "message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
            

              
                  "authorized_at": "2020-10-05T17:29:49.000Z",
            

              
                  "charged_amount": 9499,
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-10-05T17:29:49.838Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "refunded",
            

              
                          "created_at": "2020-10-05T17:29:54.128Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/4b3ee1d0-e95e-0138-0ad1-32726f22dc1b",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta de recarga

Para consultar suas transações, basta invocar este serviço e informar o id_transaction na URL.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
card_number(string) - Numero do cartão do usuário
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/transport-topups/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/transport-topups/transactions/4b3ee1d0-e95e-0138-0ad1-32726f22dc1b' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "4b3ee1d0-e95e-0138-0ad1-32726f22dc1b",
            

              
                  "product_id": "70",
            

              
                  "amount": 9999,
            

              
                  "status": "refunded",
            

              
                  "created_at": "2020-10-05T17:29:49.440Z",
            

              
                  "updated_at": "2020-10-05T17:29:54.121Z",
            

              
                  "nsu": "000076305",
            

              
                  "authorization_code": "76305",
            

              
                  "face_amount": 9999,
            

              
                  "due_date": "2020-10-10T00:00:00.000Z",
            

              
                  "message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
            

              
                  "authorized_at": "2020-10-05T17:29:49.000Z",
            

              
                  "charged_amount": 9499,
            

              
                  "card_number": "1234",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE"
            

              
                  },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2020-10-05T17:29:49.838Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "refunded",
            

              
                          "created_at": "2020-10-05T17:29:54.128Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/4b3ee1d0-e95e-0138-0ad1-32726f22dc1b",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Lista de recarga

Para listar todas as suas transações, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(authorized, captured, refunded ou denied) da recarga.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/transport-topups/transactions?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/transport-topups/transactions?statuses=authorized,captured

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
card_number(string) - Numero do cartão do usuário
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/transport-topups/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/transport-topups/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "c29b7f00-de6b-0138-8574-72321ff82fe6",
            

              
                      "product_id": "70",
            

              
                      "amount": 9999,
            

              
                      "status": "authorized",
            

              
                      "created_at": "2020-09-21T19:08:30.363Z",
            

              
                      "updated_at": "2020-09-21T19:08:30.679Z",
            

              
                      "nsu": "000071835",
            

              
                      "authorization_code": "71835",
            

              
                      "face_amount": 9999,
            

              
                      "due_date": "2020-09-26T00:00:00.000Z",
            

              
                      "message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
            

              
                      "authorized_at": "2020-09-21T19:08:30.000Z",
            

              
                      "charged_amount": 9499,
            

              
                      "card_number": "1234",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-09-21T19:08:30.684Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/c29b7f00-de6b-0138-8574-72321ff82fe6",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          },
            

              
                          {
            

              
                              "href": "/transactions/c29b7f00-de6b-0138-8574-72321ff82fe6/capture",
            

              
                              "rel": "capture",
            

              
                              "type": "POST"
            

              
                          },
            

              
                          {
            

              
                              "href": "/transactions/c29b7f00-de6b-0138-8574-72321ff82fe6",
            

              
                              "rel": "refund",
            

              
                              "type": "DELETE"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "id": "47247030-de6d-0138-8575-72321ff82fe6",
            

              
                      "product_id": "70",
            

              
                      "amount": 9999,
            

              
                      "status": "authorized",
            

              
                      "created_at": "2020-09-21T19:19:22.216Z",
            

              
                      "updated_at": "2020-09-21T19:19:26.042Z",
            

              
                      "nsu": "000071836",
            

              
                      "authorization_code": "71836",
            

              
                      "face_amount": 9999,
            

              
                      "due_date": "2020-09-26T00:00:00.000Z",
            

              
                      "message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
            

              
                      "authorized_at": "2020-09-21T19:19:25.000Z",
            

              
                      "charged_amount": 9499,
            

              
                      "card_number": "1234",
            

              
                      "metadata": {
            

              
                          "terminal_state": "SP",
            

              
                          "terminal_id": "123",
            

              
                          "local_user": "TESTE"
            

              
                      },
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "authorized",
            

              
                              "created_at": "2020-09-21T19:19:26.048Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/47247030-de6d-0138-8575-72321ff82fe6",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          },
            

              
                          {
            

              
                              "href": "/transactions/47247030-de6d-0138-8575-72321ff82fe6/capture",
            

              
                              "rel": "capture",
            

              
                              "type": "POST"
            

              
                          },
            

              
                          {
            

              
                              "href": "/transactions/47247030-de6d-0138-8575-72321ff82fe6",
            

              
                              "rel": "refund",
            

              
                              "type": "DELETE"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Recarga One Shot

Esta API é responsável por realizar recargas do tipo One Shot, que são operações únicas e imediatas, sem a necessidade de confirmação posterior. Onde todo o processo de confirmação é feito após o pagamento.

Serviços disponíveis

POST

/one-shot/transactions

Solicitação de Recarga

Com esta API é possível realizar uma recarga única e imediata.

Parâmetros

product_id(string) - Informar o código do produto.
amount(int) - Valor da recarga em formato inteiro sem pontuação quando o produto é variável.
area_code(string) - Código de área do telefone celular.
cell_phone_number(string) - Número do telefone celular.
document(string) - Documento do cliente.
callback_notification(object) - Objeto com os dados de endpoint e senha, criados pelo parceiro para receber nosso retorno via POST. Para saber mais, consulte a sessão Contrato do Web Hook (Callback).
callback_notification.url(string) - Informar o endpoint para retorno do status da solicitação.
callback_notification.secret(string) - Informar uma senha do tipo string.

Retorno

id(string) - Identificador único da recarga baseado em UUIDs V4.
area_code(string) - Código de área do telefone celular.
cell_phone_number(string) - Número do telefone celular.
document(string) - Documento do cliente.
product_id(string) - Código do produto enviado na requisição.
amount(int) - Valor da recarga em centavos.
kind(string) - Tipo de recarga realizada.
status(string) - Status da recarga.
notification_url(string) - Endpoint enviado na solicitação.
notification_secret(string) - Senha enviada na solicitação.
qrcode(string) - Código QR gerado para pagamento.
payer_name(string) - Nome do pagador.
expiration_date(string) - Data de expiração do pagamento no formato ISO 8601.
created_at(string) - Data da criação da transação.
updated_at(string) - Data que a transação sofreu alguma atualização.

Contrato do Web Hook (Callback)

O parceiro irá informar através da URL na solicitação da transação, um endpoint criado por ele mesmo, para receber nosso retorno via POST com os seguintes dados:

                    Para garantir que seja uma requisição válida da RV, enviaremos no HTTP (header) com o nome X-Token, seu conteúdo será um token One-time password (OTP)  de 6 dígitos gerado com a expiração de 60 segundos .
O cliente deve verificar a validade do token, gerando o mesmo com o uso da secret enviada na criação da transação e o id da transação (Id Transaction + secret enviado).

Parâmetros

uuid(string) - Identificador único da transação retornado no momento em que é criado a solicitação.
status(string) - Status atual da transação, podendo ser captured (confirmado) ou failed (cancelado).
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação.
product_id(string) - Código do produto enviado na requisição.
area_code(string) - Indica o DDD do celular.
cell_phone_number(string) - Indica o número do celular.
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
created_at(string) - Data da criação da transação.
message(string) - Mensagem de ativação enviada pela operadora.
amount(string) - Valor da recarga.
pin(string) - Informa o PIN a ser impresso no ticket e que será usado pelo cliente para inserir seus créditos.
serial_number(string) - Numero de série do PIN para impressão no ticket.
product_name(string) - Informa o nome do produto.
provider_id(string) - Código da operadora enviada na transação.
provider_name(string) - Informa o nome da operadora.

Retorno

Em caso de recebimento com sucesso, deve ser retornado o HTTP Code 200 (OK). Caso não seja retornado, o sistema irá reenviar a solicitação.

POST

/one-shot/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/one-shot/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                  "product_id": "3",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "999996666",
            

              
                  "amount": "30000",
            

              
                  "document": "99999999999",
            

              
                  "callback_notification": {
            

              
                    "url": "https://docs.rvhub.com.br",
            

              
                    "secret": "123456"
            

              
              	  }
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                "area_code": "11",
            

              
                "cell_phone_number": "999996666",
            

              
                "document": "99999999999",
            

              
                "product_id": "3",
            

              
                "amount": 30000,
            

              
                "kind": "cellphone",
            

              
                "status": "created",
            

              
                "notification_url": "https://docs.rvhub.com.br",
            

              
                "notification_secret": "123456",
            

              
                "created_at": "2025-04-11T18:12:31.741Z",
            

              
                "updated_at": "2025-04-11T18:12:42.554Z",
            

              
                "id": "75acd2f0-f92e-013d-3129-3445063783b3",
            

              
                "qrcode": "00020101021226870014br.gov.bcb.pix2565qrcodepix-h.bb.com.br/pix/v2/3b1f447d-4e1d-4d39-bc24-1ea3e73a7be9520400005303986540537.005802BR5921PAPELARIA LEITE CUNHA6008BRASILIA62070503***6304001D",
            

              
                "payer_name": "ONE SHOT",
            

              
                "expiration_date": "2023-07-06T09:32:08.000Z"
            

              
              }

COPIADO!

Esim

Esta API é responsável por todas as movimentações referentes as transações de esim.

Serviços disponíveis

GET

/esim/providers

GET

/esim/providers/{id}

GET

/esim/plans?provider_id={id}

GET

/esim/available-cellphone-brands

GET

/esim/available-cellphone-brands/{id}/models

POST

/esim/transactions

GET

/esim/transactions/{id}

GET

/esim/transactions

Lista de operadoras

Com esta API é possível realizar a consulta das operadoras disponíveis para o esim, basta invocar este serviço e você receberá um array com todas as operadoras.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
name(string) - Nome da operadora
states(array) - Retorna os estados disponíveis da operadora.
states. name (string) - Nome do estado
states. code (string) - Código do estado
states. area_codes (string) - DDDs disponíveis no estado

GET

/esim/providers

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/esim/providers' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "9faac280-e62c-013c-102b-6a9418ba6c55",
            

              
                      "name": "TIM",
            

              
                      "states": [
            

              
                          {
            

              
                              "name": "Rio de Janeiro",
            

              
                              "code": "RJ",
            

              
                              "area_codes": [
            

              
                                  21,
            

              
                                  22
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "São Paulo",
            

              
                              "code": "SP",
            

              
                              "area_codes": [
            

              
                                  11,
            

              
                                  12
            

              
                              ]
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "id": "112a8270-e63a-013c-e9ed-4a8857830e47",
            

              
                      "name": "Claro",
            

              
                      "states": [
            

              
                          {
            

              
                              "name": "São Paulo",
            

              
                              "code": "SP",
            

              
                              "area_codes": [
            

              
                                  11,
            

              
                                  13,
            

              
                                  14,
            

              
                                  15,
            

              
                                  16,
            

              
                                  17,
            

              
                                  18,
            

              
                                  19
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Rio de Janeiro",
            

              
                              "code": "RJ",
            

              
                              "area_codes": [
            

              
                                  21,
            

              
                                  22,
            

              
                                  24
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Espírito Santo",
            

              
                              "code": "ES",
            

              
                              "area_codes": [
            

              
                                  27,
            

              
                                  28
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Minas Gerais",
            

              
                              "code": "MG",
            

              
                              "area_codes": [
            

              
                                  31,
            

              
                                  32,
            

              
                                  33,
            

              
                                  34,
            

              
                                  35,
            

              
                                  37,
            

              
                                  38
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Paraná",
            

              
                              "code": "PR",
            

              
                              "area_codes": [
            

              
                                  41,
            

              
                                  42,
            

              
                                  43,
            

              
                                  44,
            

              
                                  45,
            

              
                                  46
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Santa Catarina",
            

              
                              "code": "SC",
            

              
                              "area_codes": [
            

              
                                  47,
            

              
                                  48,
            

              
                                  49
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Rio Grande do Sul",
            

              
                              "code": "RS",
            

              
                              "area_codes": [
            

              
                                  51,
            

              
                                  53,
            

              
                                  54,
            

              
                                  55
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Distrito Federal",
            

              
                              "code": "DF",
            

              
                              "area_codes": [
            

              
                                  61
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Goiás",
            

              
                              "code": "GO",
            

              
                              "area_codes": [
            

              
                                  62,
            

              
                                  64
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Tocantins",
            

              
                              "code": "TO",
            

              
                              "area_codes": [
            

              
                                  63
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Mato Grosso",
            

              
                              "code": "MT",
            

              
                              "area_codes": [
            

              
                                  65,
            

              
                                  66
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Mato Grosso do Sul",
            

              
                              "code": "MS",
            

              
                              "area_codes": [
            

              
                                  67
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Acre",
            

              
                              "code": "AC",
            

              
                              "area_codes": [
            

              
                                  68
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Rondônia",
            

              
                              "code": "RO",
            

              
                              "area_codes": [
            

              
                                  69
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Bahia",
            

              
                              "code": "BA",
            

              
                              "area_codes": [
            

              
                                  71,
            

              
                                  73,
            

              
                                  74,
            

              
                                  75,
            

              
                                  77
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Sergipe",
            

              
                              "code": "SE",
            

              
                              "area_codes": [
            

              
                                  79
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Pernambuco",
            

              
                              "code": "PE",
            

              
                              "area_codes": [
            

              
                                  81,
            

              
                                  87
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Alagoas",
            

              
                              "code": "AL",
            

              
                              "area_codes": [
            

              
                                  82
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Paraíba",
            

              
                              "code": "PB",
            

              
                              "area_codes": [
            

              
                                  83
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Rio Grande do Norte",
            

              
                              "code": "RN",
            

              
                              "area_codes": [
            

              
                                  84
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Ceará",
            

              
                              "code": "CE",
            

              
                              "area_codes": [
            

              
                                  85,
            

              
                                  88
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Piauí",
            

              
                              "code": "PI",
            

              
                              "area_codes": [
            

              
                                  86,
            

              
                                  89
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Pará",
            

              
                              "code": "PA",
            

              
                              "area_codes": [
            

              
                                  91,
            

              
                                  93,
            

              
                                  94
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Amazonas",
            

              
                              "code": "AM",
            

              
                              "area_codes": [
            

              
                                  92,
            

              
                                  97
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Roraima",
            

              
                              "code": "RR",
            

              
                              "area_codes": [
            

              
                                  95
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Amapá",
            

              
                              "code": "AP",
            

              
                              "area_codes": [
            

              
                                  96
            

              
                              ]
            

              
                          },
            

              
                          {
            

              
                              "name": "Maranhão",
            

              
                              "code": "MA",
            

              
                              "area_codes": [
            

              
                                  98,
            

              
                                  99
            

              
                              ]
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Consulta operadora

Com esta API é possível realizar a consulta da operadora disponíveis para o esim.

Parâmetros

id(string) - Identificador único da operadora.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
name(string) - Nome da operadora
states(array) - Retorna os estados disponíveis da operadora.
states. name (string) - Nome do estado
states. code (string) - Código do estado
states. area_codes (string) - DDDs disponíveis no estado

GET

/esim/providers/{id}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/esim/providers/112a8270-e63a-013c-e9ed-4a8857830e47' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "112a8270-e63a-013c-e9ed-4a8857830e47",
            

              
                  "name": "Claro",
            

              
                  "states": [
            

              
                      {
            

              
                          "name": "São Paulo",
            

              
                          "code": "SP",
            

              
                          "area_codes": [
            

              
                              11,
            

              
                              13,
            

              
                              14,
            

              
                              15,
            

              
                              16,
            

              
                              17,
            

              
                              18,
            

              
                              19
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Rio de Janeiro",
            

              
                          "code": "RJ",
            

              
                          "area_codes": [
            

              
                              21,
            

              
                              22,
            

              
                              24
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Espírito Santo",
            

              
                          "code": "ES",
            

              
                          "area_codes": [
            

              
                              27,
            

              
                              28
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Minas Gerais",
            

              
                          "code": "MG",
            

              
                          "area_codes": [
            

              
                              31,
            

              
                              32,
            

              
                              33,
            

              
                              34,
            

              
                              35,
            

              
                              37,
            

              
                              38
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Paraná",
            

              
                          "code": "PR",
            

              
                          "area_codes": [
            

              
                              41,
            

              
                              42,
            

              
                              43,
            

              
                              44,
            

              
                              45,
            

              
                              46
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Santa Catarina",
            

              
                          "code": "SC",
            

              
                          "area_codes": [
            

              
                              47,
            

              
                              48,
            

              
                              49
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Rio Grande do Sul",
            

              
                          "code": "RS",
            

              
                          "area_codes": [
            

              
                              51,
            

              
                              53,
            

              
                              54,
            

              
                              55
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Distrito Federal",
            

              
                          "code": "DF",
            

              
                          "area_codes": [
            

              
                              61
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Goiás",
            

              
                          "code": "GO",
            

              
                          "area_codes": [
            

              
                              62,
            

              
                              64
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Tocantins",
            

              
                          "code": "TO",
            

              
                          "area_codes": [
            

              
                              63
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Mato Grosso",
            

              
                          "code": "MT",
            

              
                          "area_codes": [
            

              
                              65,
            

              
                              66
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Mato Grosso do Sul",
            

              
                          "code": "MS",
            

              
                          "area_codes": [
            

              
                              67
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Acre",
            

              
                          "code": "AC",
            

              
                          "area_codes": [
            

              
                              68
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Rondônia",
            

              
                          "code": "RO",
            

              
                          "area_codes": [
            

              
                              69
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Bahia",
            

              
                          "code": "BA",
            

              
                          "area_codes": [
            

              
                              71,
            

              
                              73,
            

              
                              74,
            

              
                              75,
            

              
                              77
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Sergipe",
            

              
                          "code": "SE",
            

              
                          "area_codes": [
            

              
                              79
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Pernambuco",
            

              
                          "code": "PE",
            

              
                          "area_codes": [
            

              
                              81,
            

              
                              87
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Alagoas",
            

              
                          "code": "AL",
            

              
                          "area_codes": [
            

              
                              82
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Paraíba",
            

              
                          "code": "PB",
            

              
                          "area_codes": [
            

              
                              83
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Rio Grande do Norte",
            

              
                          "code": "RN",
            

              
                          "area_codes": [
            

              
                              84
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Ceará",
            

              
                          "code": "CE",
            

              
                          "area_codes": [
            

              
                              85,
            

              
                              88
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Piauí",
            

              
                          "code": "PI",
            

              
                          "area_codes": [
            

              
                              86,
            

              
                              89
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Pará",
            

              
                          "code": "PA",
            

              
                          "area_codes": [
            

              
                              91,
            

              
                              93,
            

              
                              94
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Amazonas",
            

              
                          "code": "AM",
            

              
                          "area_codes": [
            

              
                              92,
            

              
                              97
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Roraima",
            

              
                          "code": "RR",
            

              
                          "area_codes": [
            

              
                              95
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Amapá",
            

              
                          "code": "AP",
            

              
                          "area_codes": [
            

              
                              96
            

              
                          ]
            

              
                      },
            

              
                      {
            

              
                          "name": "Maranhão",
            

              
                          "code": "MA",
            

              
                          "area_codes": [
            

              
                              98,
            

              
                              99
            

              
                          ]
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta planos

Com esta API é possível realizar a consulta dos planos disponíveis para o esim, basta invocar este serviço e você receberá um array com todos os planos.

Parâmetros

id(string) - Identificador único da operadora.
ddd(string) - DDD do esim.

Retorno

internet(string) - Identificador único da transação baseado em UUIDs V4
internet(string) - Internet do plano
amount(int) - Valor do plano
id(string) - Id do plano
name(string) - Nome do plano
recharge(int) - Recarga do plano

GET

/esim/plans?area_code={ddd}&provider_id={id}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/esim/plans?area_code=11&provider_id=112a8270-e63a-013c-e9ed-4a8857830e47' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "internet": "12GB",
            

              
                      "amount": "3499",
            

              
                      "id": "vtxprepagochipom12tiktok",
            

              
                      "name": "Claro Pré-pago Oferta mensal + TikTok",
            

              
                      "recharge": "3500"
            

              
                  },
            

              
                  {
            

              
                      "internet": "12GB",
            

              
                      "amount": "2999",
            

              
                      "id": "vtxprepagochipom12",
            

              
                      "name": "Claro Pré-pago Oferta mensal + YouTube",
            

              
                      "recharge": "3000"
            

              
                  },
            

              
                  {
            

              
                      "internet": "12GB",
            

              
                      "amount": "3499",
            

              
                      "id": "vtxprepagochipom12freefire",
            

              
                      "name": "Claro Pré-pago Oferta mensal + Free Fire",
            

              
                      "recharge": "3500"
            

              
                  },
            

              
                  {
            

              
                      "internet": "9GB",
            

              
                      "amount": "2499",
            

              
                      "id": "vtxprepagochipom9",
            

              
                      "name": "Claro Pré-pago Oferta mensal",
            

              
                      "recharge": "2500"
            

              
                  },
            

              
                  {
            

              
                      "internet": "0",
            

              
                      "amount": "0",
            

              
                      "id": "vtxprepagochip",
            

              
                      "name": "Claro Pré-pago",
            

              
                      "recharge": "0"
            

              
                  },
            

              
                  {
            

              
                      "internet": "15GB",
            

              
                      "amount": "2999",
            

              
                      "id": "vtxflex8",
            

              
                      "name": "Claro Flex",
            

              
                      "recharge": "3000"
            

              
                  }
            

              
              ]

COPIADO!

Consulta fabricantes

Com esta API é possível realizar a consulta dos fabricantes disponíveis para o esim.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
name(string) - Nome do fabricante

GET

/esim/available-cellphone-brands

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/esim/available-cellphone-brands' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "0d337940-e604-013c-5c61-46f7dfc99006",
            

              
                      "name": "Xaiomi"
            

              
                  },
            

              
                  {
            

              
                      "id": "b6b09220-e60a-013c-a8ea-5ebea035c7ff",
            

              
                      "name": "Apple 2"
            

              
                  }
            

              
              ]

COPIADO!

Consulta smartphones

Com esta API é possível consultar os modelos de smartphones disponível para o esim.

Parâmetros

id(string) - Identificador único do fabricante, retornado no momento em que é feito a consulta de fabricantes.

Retorno

cellphone_models(array) - Retorna os modelos de smartphones
cellphone_models. name (string) - Modelo do smartphone

GET

/esim/available-cellphone-brands/{id}/models

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/esim/0d337940-e604-013c-5c61-46f7dfc99006/models' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "cellphone_models": [
            

              
                      {
            

              
                          "name": "Redmi 13C"
            

              
                      },
            

              
                      {
            

              
                          "name": "Xiaomi 14"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Solicitar Esim

Com esta API é possível realizar novas solicitações de esim.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

document(string) - Informar CPF do solicitante
name(string) - Informar o nome do solicitante
email(string) - Informar o email do solicitante
date_birth(string) - Informar a data de nascimento do solicitante
area_code(string) - Informar o DDD do telefone do solicitante
cell_phone_number(string) - Informar o telefone do solicitante
plan_id(string) - Informar o plano do esim
address(object) - Objeto com os dados do endereço do solicitante
address. zip_code (string) - Informar o CEP do solicitante
address. street (string) - Informar o endereço do solicitante
address. neighborhood (string) - Informar o bairro do solicitante
address. city (string) - Informar a cidade do solicitante
address. number (string) - Informar o número do endereço do solicitante
address. complement (string) - Informar o complemento do solicitante
address. reference (string) - Informar a referência do endereço do solicitante
address. state (string) - Informar o estado do solicitante
callback(object) - Objeto com os dados de endpoint e senha, criados pelo parceiro para receber nosso retorno via POST. Para saber mais, consulte a sessão Contrato do Web Hook (Callback).
callback. url (string) - Informar o endpoint para retorno do status da solicitação.
callback. secret (string) - Informar uma senha do tipo string

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
plan_id(string) - Plano do esim enviado na requisição
face_amount(int) - Valor de face do produto
amount(int) - Valor do produto
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
status(string) - Status da transação
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
date_birth(string) - Data de aniversário do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
zip_code(string) - Cep do solicitante enviado na requisição
street(string) - Endereço do solicitante enviado na requisição
neighborhood(string) - Bairro do solicitante enviado na requisição
city(string) - Cidade do solicitante enviado na requisição
number(string) - Número do endereço do solicitante enviado na requisição
complement(string) - Complemento do endereço do solicitante enviado na requisição
reference(string) - Referência do endereço do solicitante enviado na requisição

state(string) - Estado do solicitante enviado na requisição
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

Contrato do Web Hook (Callback)

O parceiro irá informar através da URL na solicitação de esim, um endpoint criado por ele mesmo, para receber nosso retorno via POST com os seguintes dados:

                    Para garantir que seja uma requisição válida da RV, enviaremos no HTTP (header) com o nome X-Token, seu conteúdo será um token One-time password (OTP)  de 6 dígitos gerado com a expiração de 60 segundos .
O cliente deve verificar a validade do token, gerando o mesmo com o uso da secret enviada na criação da transação e o id da transação (secret + iD Transaction).

Parâmetros

id(string) - Identificador único da transação retornado no momento em que é criado a solicitação.
status(string) - Status atual da transação, podendo ser captured (confirmado) ou denied (cancelado).
esim(string) - È um base64 do e-sim quer será ativado.
status_reason(string) - Motivo do status denied.

Retorno

Em caso de recebimento com sucesso, deve ser retornado o HTTP Code 200 (OK). Caso não seja retornado, o sistema irá reenviar a solicitação.

POST

/esim/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/esim/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                "document": "83311694090",
            

              
                "name": "teste",
            

              
                "email": "email@teste.com",
            

              
                "date_birth": "13-11-1997",
            

              
                "area_code": "21",
            

              
                "cell_phone_number": "991827362",
            

              
                "plan_id": "vtxprepagochipom9",
            

              
                "address": {
            

              
                  "zip_code": "22873182",
            

              
                  "street": "Rua",
            

              
                  "neighborhood": "Bairro",
            

              
                  "city": "Cidade",
            

              
                  "number": "105",
            

              
                  "complement": "Complemento",
            

              
                  "reference": "Referência",
            

              
                  "state": "RJ"
            

              
                },
            

              
                "callback": {
            

              
                  "url": "http://demo0744785.mockable.io/teste",
            

              
                  "secret": "TESTE"
            

              
                }
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "00a19480-f50e-013c-4a0b-1a6d5179c077",
            

              
                  "plan_id": "vtxprepagochipom9",
            

              
                  "reference": "Referencia",
            

              
                  "face_amount": 2000,
            

              
                  "amount": 2499,
            

              
                  "charged_amount": 1980,
            

              
                  "authorization_code": "3027848569",
            

              
                  "status": "processing",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "processing",
            

              
                          "created_at": "2024-05-15T17:25:14.388Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/00a19480-f50e-013c-4a0b-1a6d5179c077",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ],
            

              
                  "document": "83311694090",
            

              
                  "name": "teste",
            

              
                  "email": "email@teste.com",
            

              
                  "date_birth": "1997-11-13T00:00:00.000Z",
            

              
                  "area_code": "21",
            

              
                  "cell_phone_number": "991827362",
            

              
                  "zip_code": "22873182",
            

              
                  "street": "Rua",
            

              
                  "neighborhood": "Bairro",
            

              
                  "city": "Cidade",
            

              
                  "number": "105",
            

              
                  "complement": "Complemento",
            

              
                  "state": "RJ"
            

              
              }

COPIADO!

Consulta Esim

Para consultar suas transações, basta invocar este serviço e informar o id na URL.

Parâmetros

id(string) - Identificador único da transação retornado no momento em que é criado a solicitação.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
plan_id(string) - Plano do esim enviado na requisição
face_amount(int) - Valor de face do produto
amount(int) - Valor do produto
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
status(string) - Status da transação
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
date_birth(string) - Data de aniversário do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
zip_code(string) - Cep do solicitante enviado na requisição
street(string) - Endereço do solicitante enviado na requisição
neighborhood(string) - Bairro do solicitante enviado na requisição
city(string) - Cidade do solicitante enviado na requisição
number(string) - Número do endereço do solicitante enviado na requisição
complement(string) - Complemento do endereço do solicitante enviado na requisição
reference(string) - Referência do endereço do solicitante enviado na requisição

state(string) - Estado do solicitante enviado na requisição
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/esim/transactions/{id}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/esim/transactions/a68a7480-c9f2-013c-1712-06516b73870d' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "00a19480-f50e-013c-4a0b-1a6d5179c077",
            

              
                  "plan_id": "vtxprepagochipom9",
            

              
                  "face_amount": 2000,
            

              
                  "amount": 2499,
            

              
                  "charged_amount": 1980,
            

              
                  "authorization_code": "3027848569",
            

              
                  "status": "processing",
            

              
                  "idempotency_key": "$1715793908",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "processing",
            

              
                          "created_at": "2024-05-15T17:25:14.388Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/00a19480-f50e-013c-4a0b-1a6d5179c077",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ],
            

              
                  "document": "83311694090",
            

              
                  "name": "teste",
            

              
                  "email": "email@teste.com",
            

              
                  "date_birth": "1997-11-13T00:00:00.000Z",
            

              
                  "area_code": "21",
            

              
                  "cell_phone_number": "991827362",
            

              
                  "zip_code": "22873182",
            

              
                  "street": "Rua",
            

              
                  "neighborhood": "Bairro",
            

              
                  "city": "Cidade",
            

              
                  "number": "105",
            

              
                  "complement": "Complemento",
            

              
                  "reference": "Referencia",
            

              
                  "state": "RJ"
            

              
              }

COPIADO!

Lista de Esim

Para listar todas as suas transação de Esim, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(awaiting_customer_information, awaiting_electricity_bill, processing, in_review, reviewed, activated, cancelled ou denied) da transação.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/esim?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/esim?statuses=cancelled,activated

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
plan_id(string) - Plano do esim enviado na requisição
face_amount(int) - Valor de face do produto
amount(int) - Valor do produto
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
status(string) - Status da transação
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
date_birth(string) - Data de aniversário do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
zip_code(string) - Cep do solicitante enviado na requisição
street(string) - Endereço do solicitante enviado na requisição
neighborhood(string) - Bairro do solicitante enviado na requisição
city(string) - Cidade do solicitante enviado na requisição
number(string) - Número do endereço do solicitante enviado na requisição
complement(string) - Complemento do endereço do solicitante enviado na requisição
reference(string) - Referência do endereço do solicitante enviado na requisição

state(string) - Estado do solicitante enviado na requisição
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/esim/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/esim/transactions \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "5768d690-f4f1-013c-60cf-529e702787dd",
            

              
                      "plan_id": "vtxprepagochipom12",
            

              
                      "reference": "Referencia",
            

              
                      "face_amount": 2000,
            

              
                      "amount": 2999,
            

              
                      "charged_amount": 1980,
            

              
                      "authorization_code": "3027848569",
            

              
                      "status": "processing",
            

              
                      "idempotency_key": "$1715781594",
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "processing",
            

              
                              "created_at": "2024-05-15T14:00:08.690Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/5768d690-f4f1-013c-60cf-529e702787dd",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ],
            

              
                      "document": "83311694090",
            

              
                      "name": "Nome",
            

              
                      "email": "email@teste.com",
            

              
                      "date_birth": "1997-11-13T00:00:00.000Z",
            

              
                      "area_code": "21",
            

              
                      "cell_phone_number": "991827362",
            

              
                      "zip_code": "22873182",
            

              
                      "street": "Rua",
            

              
                      "neighborhood": "Bairro",
            

              
                      "city": "Cidade",
            

              
                      "number": "105",
            

              
                      "complement": "Complemento",
            

              
                      "state": "RJ"
            

              
                  },
            

              
                  {
            

              
                      "id": "99de1c50-f507-013c-b8aa-7249b235b715",
            

              
                      "plan_id": "vtxprepagochipom12",
            

              
                      "reference": "Referencia",
            

              
                      "face_amount": 2000,
            

              
                      "amount": 2999,
            

              
                      "charged_amount": 1980,
            

              
                      "authorization_code": "3027848569",
            

              
                      "status": "processing",
            

              
                      "idempotency_key": "$1715791159",
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "processing",
            

              
                              "created_at": "2024-05-15T16:39:25.701Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/transactions/99de1c50-f507-013c-b8aa-7249b235b715",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ],
            

              
                      "document": "83311694090",
            

              
                      "name": "Nome",
            

              
                      "email": "email@teste.com",
            

              
                      "date_birth": "1997-11-13T00:00:00.000Z",
            

              
                      "area_code": "21",
            

              
                      "cell_phone_number": "991827362",
            

              
                      "zip_code": "22873182",
            

              
                      "street": "Rua",
            

              
                      "neighborhood": "Bairro",
            

              
                      "city": "Cidade",
            

              
                      "number": "105",
            

              
                      "complement": "Complemento",
            

              
                      "state": "RJ"
            

              
                  }    
            

              
              ]

COPIADO!

Energia

Esta API é responsável por todas as movimentações referentes aos serviços de energia.

Serviços disponíveis

POST

/energy-credits/proposals

POST

/energy-credits/proposals/{id_proposal}/customer-informations

POST

/energy-credits/proposals/{id_proposal}/electricity-bill

POST

/energy-credits/proposals/{id_proposal}/confirm

DELETE

/energy-credits/proposals/{id_proposal}

GET

/energy-credits/proposals/{id_proposal}

GET

/energy-credits/proposals

Criação do solicitante

Com esta API é possível realizar a criação do solicitante para energia.

Os inputs de dados são realizados na sua plataforma e processados pela nossa api.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

kind(string) - Informar o tipo de energia
document(string) - Informar CPF do solicitante

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
document(string) - CPF do solicitante enviado na requisição
status(string) - Status da proposta
kind(string) - Tipo de energia enviado na requisição
statuses(array) - Retorna os status que a transação passou
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/energy-credits/proposals

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/energy-credits/proposals' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                  "kind": "solar",
            

              
                  "document": "14743467071"
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                  "document": "14743467071",
            

              
                  "status": "awaiting_customer_information",
            

              
                  "kind": "solar",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_customer_information",
            

              
                          "created_at": "2024-03-21T18:22:26.277Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d/customer-informations",
            

              
                          "rel": "customer_informations",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "cancel",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Informações do solicitante

Com esta API é possível adicionar informações complementares do solicitante em energia.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

name(string) - Informar o nome do solicitante
cell_phone(object) - Objeto com os dados de contato do solicitante
cell_phone. area_code (string) - Informar o DDD do telefone do solicitante
cell_phone. number (string) - Informar número do telefone do solicitante
email(string) - Informar o email do solicitante
birth_date(string) - Informar a data de nascimento do solicitante
employment(string) - Informar a profissão do solicitante
marital_status(string) - Informar o estado civil do solicitante

Retorno

name(string) - Nome do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
birth_date(string) - Data de aniversário do solicitante enviado na requisição
employment(string) - Profissão do solicitante enviado na requisição
marital_status(string) - Estado civil do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
status(string) - Status da proposta
id(string) - Identificador único da transação baseado em UUIDs V4
document(string) - CPF do solicitante enviado na requisição
kind(string) - Tipo de energia enviado na requisição
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/energy-credits/proposals/{id_proposal}/customer-informations

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/energy-credits/proposals/a68a7480-c9f2-013c-1712-06516b73870d/customer-informations' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                  "name": "Solicitante",
            

              
                  "cell_phone": {
            

              
                      "area_code": "11",
            

              
              	    "number": "319887654"
            

              
                  },
            

              
                  "email": "mail@mail.com",
            

              
                  "birth_date": "1987-05-21", 
            

              
                  "employment": "Professor",
            

              
                  "marital_status": "Casado"
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "name": "Solicitante",
            

              
                  "email": "mail@mail.com",
            

              
                  "birth_date": "1987-05-21",
            

              
                  "employment": "Professor",
            

              
                  "marital_status": "Casado",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "319887654",
            

              
                  "status": "awaiting_electricity_bill",
            

              
                  "id": "a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                  "document": "14743467071",
            

              
                  "kind": "solar",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_customer_information",
            

              
                          "created_at": "2024-03-21T19:07:53.601Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "awaiting_electricity_bill",
            

              
                          "created_at": "2024-03-21T19:10:49.238Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/proposals/3e33f7f0-c9e4-013c-18cd-7a17a1941042",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/proposals/3e33f7f0-c9e4-013c-18cd-7a17a1941042/electricity-bill",
            

              
                          "rel": "electricity_bill",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/proposals/3e33f7f0-c9e4-013c-18cd-7a17a1941042",
            

              
                          "rel": "cancel",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Envio da conta de energia

Com esta API é possível enviar informações da conta de energia do solicitante, nós recebemos os dados e enviamos via API para o nosso parceiro.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

installation_number(string) - Informar o número de instalação da conta de energia
networks_class(string) - Informar o tipo de classificação da rede de energia
classification(string) - Informar o tipo de classificação da conta de energia
average_consumption(string) - Informar a média de consumo mensal de energia
extension(string) - Informar a extensão do arquivo enviado
file(string) - Enviar arquivo em base64

Retorno

installation_number(string) - Número da instalação da conta do solicitante enviado na requisição
networks_class(string) - Classificação da rede de energia do solicitante informado na requisição
classification(string) - Classificação da conta de energia do solicitante informado na requisição
average_consumption(string) - Média de consumo mensal de energia do solicitante informado na requisição
nationality(string) - Nacionalidade do solicitante
status(string) - Status da proposta
id(string) - Identificador único da transação baseado em UUIDs V4
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
birth_date(string) - Data de aniversário do solicitante enviado na requisição
kind(string) - Tipo de energia
employment(string) - Profissão do solicitante enviado na requisição
marital_status(string) - Estado civil do solicitante enviado na requisição
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/energy-credits/proposals/{id_proposal}/electricity-bill

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/energy-credits/proposals/a68a7480-c9f2-013c-1712-06516b73870d/electricity-bill' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                  "installation_number": "111111", 
            

              
                  "networks_class": "Monofásico", 
            

              
                  "classification": "Residencial", 
            

              
                  "average_consumption": "10.0", 
            

              
                  "extension": "jpg",
            

              
                  "file": "JVBERi0xLjMNCiXi48/TDQolUlNUWFBERjMgUGFyYW1ldGVyczogRFJT..."
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "installation_number": "111111",
            

              
                  "networks_class": "Monofásico",
            

              
                  "classification": "Residencial",
            

              
                  "average_consumption": 10.0,
            

              
                  "nationality": "Brasileiro",
            

              
                  "status": "processing",
            

              
                  "id": "a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                  "document": "14743467071",
            

              
                  "name": "Solicitante",
            

              
                  "consultant_id": "1",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "319887654",
            

              
                  "email": "mail@mail.com.br",
            

              
                  "birth_date": "1987-05-21",
            

              
                  "kind": "solar",
            

              
                  "employment": "Professor",
            

              
                  "marital_status": "Casado",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_customer_information",
            

              
                          "created_at": "2024-03-21T20:51:01.628Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "awaiting_electricity_bill",
            

              
                          "created_at": "2024-03-21T20:52:39.645Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "processing",
            

              
                          "created_at": "2024-03-21T20:53:36.371Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "cancel",
            

              
                          "type": "DELETE"
            

              
                      },
            

              
                      {
            

              
                          "href": "https://api-energy-credits-file/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "electricity-bill",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Confirmação da proposta

Após processar os dados de energia, será preciso confirmar sua solicitação, para fazer isso basta chamar esta requisição informando o id_proposal.

Neste caso não será necessário enviar o corpo(body) da requisição, apenas informar o parametro na URL juntamente com o sufixo /confirm não se esquecendo que o verbo HTTP desta requisição continua a ser o POST conforme demonstrado no exemplo.

                    Após confirmação, o cancelamento não será mais possível.

A finalização da proposta e contato com o solicitante fica sob responsabilidade do parceiro.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
birth_date(string) - Data de aniversário do solicitante enviado na requisição

status(string) - Status da proposta

kind(string) - Tipo de energia
employment(string) - Profissão do solicitante enviado na requisição
marital_status(string) - Estado civil do solicitante enviado na requisição
nationality(string) - Nacionalidade do solicitante

installation_number(string) - Número da instalação da conta do solicitante enviado na requisição
networks_class(string) - Classificação da rede de energia do solicitante informado na requisição
classification(string) - Classificação da conta de energia do solicitante informado na requisição
average_consumption(string) - Média de consumo mensal de energia do solicitante informado na requisição
lead_id(string) - Código do usuário na Evolua
estimated_amount(string) - Valor estimado de economia de energia
consumer_unit(string) - Código de energia da unidade do consumidor
discount_percentage(string) - Percentual de desconto de energia
provider(string) - Nome da empresa fornecedora de energia
monthly_economy(string) - Valor mensal de economia de energia
annual_economy(string) - Valor anual de economia de energia
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/energy-credits/proposals/{id_proposal}/confirm

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/energy-credits/proposals/a68a7480-c9f2-013c-1712-06516b73870d/confirm' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                  "document": "14743467071",
            

              
                  "name": "Solicitante",
            

              
                  "consultant_id": "1",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "319887654",
            

              
                  "email": "mail@mail.com.br",
            

              
                  "birth_date": "1987-05-21",
            

              
                  "status": "processing",
            

              
                  "kind": "solar",
            

              
                  "employment": "Professor",
            

              
                  "marital_status": "Casado",
            

              
                  "nationality": "Brasileiro",
            

              
                  "installation_number": "111111",
            

              
                  "networks_class": "Monofásico",
            

              
                  "classification": "Residencial",
            

              
                  "average_consumption": 10.0,
            

              
                  "lead_id": "00QHZ000006FX6j2AG",
            

              
                  "estimated_amount": 344.25,
            

              
                  "consumer_unit": "UC-53793",
            

              
                  "discount_percentage": 10.0,
            

              
                  "provider": "CEMIG",
            

              
                  "monthly_economy": 4253,
            

              
                  "annual_economy": 51037,
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_customer_information",
            

              
                          "created_at": "2024-03-21T20:51:01.628Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "awaiting_electricity_bill",
            

              
                          "created_at": "2024-03-21T20:52:39.645Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "processing",
            

              
                          "created_at": "2024-03-21T20:53:36.371Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "cancel",
            

              
                          "type": "DELETE"
            

              
                      },
            

              
                      {
            

              
                          "href": "https://api-energy-credits-file/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "electricity-bill",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Desfazimento da proposta

Para cancelar uma solicitação de recarga, é preciso chamar a requisição de desfazimento, bastando apenas enviar o id_proposal na URL da requisição pelo verbo HTTP DELETE. Veja o exemplo para compreender melhor.

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação não será mais possível desfazer esta solicitação.

Parâmetros

id_proposal(string) - Identificador único da transação retornado no momento em que é criado a solicitação.

Retorno

status(string) - Status da proposta
id(string) - Identificador único da transação baseado em UUIDs V4
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
birth_date(string) - Data de aniversário do solicitante enviado na requisição
kind(string) - Tipo de energia
employment(string) - Profissão do solicitante enviado na requisição
marital_status(string) - Estado civil do solicitante enviado na requisição
nationality(string) - Nacionalidade do solicitante

installation_number(string) - Número da instalação da conta do solicitante enviado na requisição
networks_class(string) - Classificação da rede de energia do solicitante informado na requisição
classification(string) - Classificação da conta de energia do solicitante informado na requisição
average_consumption(string) - Média de consumo mensal de energia do solicitante informado na requisição
lead_id(string) - Código do usuário na Evolua
estimated_amount(string) - Valor estimado de economia de energia
consumer_unit(string) - Código de energia da unidade do consumidor
discount_percentage(string) - Percentual de desconto de energia
provider(string) - Nome da empresa fornecedora de energia
monthly_economy(string) - Valor mensal de economia de energia
annual_economy(string) - Valor anual de economia de energia
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/energy-credits/proposals/{id_proposal}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/energy-credits/proposals/a68a7480-c9f2-013c-1712-06516b73870d' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "cancelled",
            

              
                  "id": "a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                  "document": "14743467071",
            

              
                  "name": "Solicitante",
            

              
                  "consultant_id": "1",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "319887654",
            

              
                  "email": "mail@mail.com.br",
            

              
                  "birth_date": "1987-05-21",
            

              
                  "kind": "solar",
            

              
                  "employment": "Professor",
            

              
                  "marital_status": "Casado",
            

              
                  "nationality": "Brasileiro",
            

              
                  "installation_number": "111111",
            

              
                  "networks_class": "Monofásico",
            

              
                  "classification": "Residencial",
            

              
                  "average_consumption": 10.0,
            

              
                  "lead_id": "00QHZ000006FX6j2AG",
            

              
                  "estimated_amount": 344.25,
            

              
                  "consumer_unit": "UC-53793",
            

              
                  "discount_percentage": 10.0,
            

              
                  "provider": "CEMIG",
            

              
                  "monthly_economy": 4253,
            

              
                  "annual_economy": 51037,
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_customer_information",
            

              
                          "created_at": "2024-03-21T20:51:01.628Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "awaiting_electricity_bill",
            

              
                          "created_at": "2024-03-21T20:52:39.645Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "processing",
            

              
                          "created_at": "2024-03-21T20:53:36.371Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "cancel",
            

              
                          "type": "DELETE"
            

              
                      },
            

              
                      {
            

              
                          "href": "https://api-energy-credits-file/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "electricity-bill",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta proposta

Para consultar suas transações, basta invocar este serviço e informar o id_proposal na URL.

Parâmetros

id_proposal(string) - Identificador único da proposta retornado no momento em que é criado a solicitação.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
birth_date(string) - Data de aniversário do solicitante enviado na requisição
status(string) - Status da proposta
kind(string) - Tipo de energia
employment(string) - Profissão do solicitante enviado na requisição
marital_status(string) - Estado civil do solicitante enviado na requisição
nationality(string) - Nacionalidade do solicitante

installation_number(string) - Número da instalação da conta do solicitante enviado na requisição
networks_class(string) - Classificação da rede de energia do solicitante informado na requisição
classification(string) - Classificação da conta de energia do solicitante informado na requisição
average_consumption(string) - Média de consumo mensal de energia do solicitante informado na requisição
lead_id(string) - Código do usuário na Evolua
estimated_amount(string) - Valor estimado de economia de energia
consumer_unit(string) - Código de energia da unidade do consumidor
discount_percentage(string) - Percentual de desconto de energia
provider(string) - Nome da empresa fornecedora de energia
monthly_economy(string) - Valor mensal de economia de energia
annual_economy(string) - Valor anual de economia de energia
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/energy-credits/proposals/{id_proposal}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/energy-credits/proposals/a68a7480-c9f2-013c-1712-06516b73870d' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                  "document": "14743467071",
            

              
                  "name": "Solicitante",
            

              
                  "consultant_id": "1",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "319887654",
            

              
                  "email": "mail@mail.com.br",
            

              
                  "birth_date": "1987-05-21",
            

              
                  "status": "cancelled",
            

              
                  "kind": "solar",
            

              
                  "employment": "Professor",
            

              
                  "marital_status": "Casado",
            

              
                  "nationality": "Brasileiro",
            

              
                  "installation_number": "111111",
            

              
                  "networks_class": "Monofásico",
            

              
                  "classification": "Residencial",
            

              
                  "average_consumption": 10.0,
            

              
                  "lead_id": "00QHZ000006FX6j2AG",
            

              
                  "estimated_amount": 344.25,
            

              
                  "consumer_unit": "UC-53793",
            

              
                  "discount_percentage": 10.0,
            

              
                  "provider": "CEMIG",
            

              
                  "monthly_economy": 4253,
            

              
                  "annual_economy": 51037,
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_customer_information",
            

              
                          "created_at": "2024-03-21T20:51:01.628Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "awaiting_electricity_bill",
            

              
                          "created_at": "2024-03-21T20:52:39.645Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "processing",
            

              
                          "created_at": "2024-03-21T20:53:36.371Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/proposals/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "https://api-energy-credits-file/a68a7480-c9f2-013c-1712-06516b73870d",
            

              
                          "rel": "electricity-bill",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Lista de proposta

Para listar todas as suas proposta de Energia, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(awaiting_customer_information, awaiting_electricity_bill, processing, in_review, reviewed, activated, cancelled ou denied) da proposta.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/energy-credits/proposals?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/energy-credits/proposals?statuses=cancelled,activated

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
document(string) - CPF do solicitante enviado na requisição
name(string) - Nome do solicitante enviado na requisição
area_code(string) - DDD do telefone do solicitante enviado na requisição
cell_phone_number(string) - Telefone do solicitante enviado na requisição
email(string) - Email do solicitante enviado na requisição
birth_date(string) - Data de aniversário do solicitante enviado na requisição
status(string) - Status da proposta
kind(string) - Tipo de energia
employment(string) - Profissão do solicitante enviado na requisição
marital_status(string) - Estado civil do solicitante enviado na requisição
nationality(string) - Nacionalidade do solicitante

installation_number(string) - Número da instalação da conta do solicitante enviado na requisição
networks_class(string) - Classificação da rede de energia do solicitante informado na requisição
classification(string) - Classificação da conta de energia do solicitante informado na requisição
average_consumption(string) - Média de consumo mensal de energia do solicitante informado na requisição
lead_id(string) - Código do usuário na Evolua
estimated_amount(string) - Valor estimado de economia de energia
consumer_unit(string) - Código de energia da unidade do consumidor
discount_percentage(string) - Percentual de desconto de energia
provider(string) - Nome da empresa fornecedora de energia
monthly_economy(string) - Valor mensal de economia de energia
annual_economy(string) - Valor anual de economia de energia
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/energy-credits/proposals

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/energy-credits/proposals/a68a7480-c9f2-013c-1712-06516b73870d' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "13569490-c20e-013c-c388-3279aff0e0a9",
            

              
                      "document": "30714903051",
            

              
                      "name": "Carlos Silva",
            

              
                      "area_code": "12",
            

              
                      "cell_phone_number": "999999999",
            

              
                      "email": "teste@teste.com",
            

              
                      "birth_date": "1987-05-21",
            

              
                      "status": "in_review",
            

              
                      "kind": "solar",
            

              
                      "employment": "Dentista",
            

              
                      "marital_status": "Solteiro(a)",
            

              
                      "nationality": "Brasileiro",
            

              
                      "installation_number": "111111",
            

              
                      "networks_class": "Monofásico",
            

              
                      "classification": "Residencial",
            

              
                      "average_consumption": 10.0,
            

              
                      "lead_id": "00QHZ000006FX6j2AG",
            

              
                      "estimated_amount": 344.25,
            

              
                      "consumer_unit": "UC-53793",
            

              
                      "discount_percentage": 10.0,
            

              
                      "provider": "CEMIG",
            

              
                      "monthly_economy": 4253,
            

              
                      "annual_economy": 51037,
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "awaiting_customer_information",
            

              
                              "created_at": "2024-03-11T19:47:11.248Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "awaiting_electricity_bill",
            

              
                              "created_at": "2024-03-11T19:47:18.564Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "processing",
            

              
                              "created_at": "2024-03-11T19:47:35.841Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "in_review",
            

              
                              "created_at": "2024-03-11T19:47:38.203Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/proposals/13569490-c20e-013c-c388-3279aff0e0a9",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          },
            

              
                          {
            

              
                              "href": "https://api-energy-credits-file/13569490-c20e-013c-c388-3279aff0e0a9",
            

              
                              "rel": "electricity-bill",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "id": "74380b40-c29e-013c-74f4-4247bed9852e",
            

              
                      "document": "30714903051",
            

              
                      "status": "awaiting_customer_information",
            

              
                      "kind": "solar",
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "awaiting_customer_information",
            

              
                              "created_at": "2024-03-12T13:00:41.322Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/proposals/74380b40-c29e-013c-74f4-4247bed9852e",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          },
            

              
                          {
            

              
                              "href": "/proposals/74380b40-c29e-013c-74f4-4247bed9852e/customer-informations",
            

              
                              "rel": "customer_informations",
            

              
                              "type": "POST"
            

              
                          },
            

              
                          {
            

              
                              "href": "/proposals/74380b40-c29e-013c-74f4-4247bed9852e",
            

              
                              "rel": "cancel",
            

              
                              "type": "DELETE"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Sorteios e Apostas

Esta API é responsável por todas as movimentações referentes a recargas de sorteios e apostas.

Serviços disponíveis

POST

/raffles/transactions

POST

/raffles/transactions/{id_transaction}/capture

DELETE

/raffles/transactions/{id_transaction}

GET

/raffles/transactions/{id_transaction}

GET

/raffles/transactions

Solicitação de recarga

Com esta API é possível realizar novas solicitações de recarga para sorteios e apostas.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

product_id(string) - Informar o código do produto
area_code(string) - Informar o DDD do celular
cell_phone_number(string) - Informar o numero do celular
signer_code(string) - CPF do comprador
accepted(boolean) - Informa que aceita os termos e condições
titles(string) - Informar um array de títulos a serem ativados (Ex. ["03001116394227", "03001116394228"]). Para contas vinculadas a um parceiro esse campo é obrigatório.
affiliation_key(string) - Informar a chave do parceiro (Ex. Software House). Para contas vinculadas a um parceiro esse campo é obrigatório.
metadata(object) - Objeto representativo de metadados sobre a transação.
metadata. raffle_serial_number (string) - Número da cartela. Obrigatório no caso de produtos de ativação para cartelas específicas.
metadata. terminal_state (string) [opcional] - Informar a sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) [opcional] - Informar o código do terminal que está realizando a venda.
metadata. local_user (string) [opcional] - Informar o código ou Login do usuário local (na rede do cliente) que efetuou a transação, para registro no relatório de compras.
metadata. accept (boolean) [opcional] - Informa que aceita os termos e condições.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
signer_code(string) - Indica o CPF do comprador
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
titles(array) - Array de títulos a serem ativados
drawing_number(object) - Objeto opcional representativo de dados sobre os números do sorterio
drawing_number. ticket (int) - Código do ticket.
drawing_number. maracap_numbers (string) - Números do sorterio.
award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio.
award. number (int) - Código indentificador do prêmio.
award. award (string) - Prêmio.
award. description (int) - Descrição do prêmio.
award. net_value (int) - Valor líquido do prêmio.
award. gross_value (string) - Valor bruto do prêmio.
electronic_award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio eletrõnico.
electronic_award. number (int) - Código indentificador do prêmio.
electronic_award. description (int) - Descrição do prêmio.
electronic_award. net_value (int) - Valor líquido do prêmio.
electronic_award. gross_value (string) - Valor bruto do prêmio.
stage(object) - Objeto opcional representativo de dados sobre a etapa.
electronic_award. description (string) - Descrição da etapa.
electronic_award. start_eligibility (string) - Data de início da etapa.
electronic_award. end_eligibility (string) - Data de fim da etapa.
electronic_award. stage (string) - Código da etapa.
electronic_award. code_susep (string) - Código susep.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
metadata. accept (boolean) - Informa que aceita os termos e condições.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/raffles/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/raffles/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
              	"product_id": "1",
            

              
              	"area_code": "11",
            

              
              	"cell_phone_number": "999995555",
            

              
              	"titles": ["03001116394227"],
            

              
              	"signer_code": "11111111111",
            

              
                  "metadata": {
            

              
                      "terminal_state": "SP",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "TESTE",
            

              
                      "accept": true
            

              
                  }
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                  "product_id": "116",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "994145351",
            

              
                  "status": "authorized",
            

              
                  "created_at": "2021-05-20T19:36:36.136Z",
            

              
                  "updated_at": "2021-05-20T19:36:36.556Z",
            

              
                  "nsu": "000000002",
            

              
                  "authorization_code": "11421",
            

              
                  "face_amount": 1200,
            

              
                  "due_date": "2021-05-25T00:00:00.000Z",
            

              
                  "message": "Lideranca Capitalizacao S/A. | CNPJ: 60.853.264/0001-10 |18-03-2021 09:33:05POS: 593913 |N. do Pedido: 493-1992250-3 |Este é o comprovante de aquisição da sua Tele Sena digital. | Não é o titulo de capitalizaçao. | Para visualiza-lo acesse o site www.telesena.com.br | Este comprovante não tem valor comercial | Confira seus dados:@ | CPF: 2374242000 | Cliente: NOME DO CLIENTE | Telefone: 32-94874564 || TELE SENA DE PASC0A/2021 | Proc. SUSEP N.: 13454.600644/2021-41 | Data de Resgate: 14/03/2022 | Produto: 3 | Série: 201 | Título: 3850052 | | Quantidade: 1 | Valor Total: 12.00 | | Aprovado pela Superintendencia de Seguros Privados - SUSEP. Consulte as condicões gerais e preencha a Ficha de Cadastro obrigatória no site www.telesena.com.br | | Acesse o link abaixo ou utilize o QR Code para conferir as suas Tele Senas. https://stg.telesena.digital/kBKhnB | |",
            

              
                  "authorized_at": "2021-05-20T19:36:36.000Z",
            

              
                  "signer_code": "2374242000",
            

              
                  "charged_amount": 1140,
            

              
                  "titles": [
            

              
                    "03001116394227"
            

              
                  ],
            

              
                  "metadata": {
            

              
                      "terminal_state": "MG",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "User",
            

              
                      "accept": true
            

              
                  },
            

              
                  "drawing_number": [
            

              
                      {
            

              
                          "ticket": 400078,
            

              
                          "maracap_numbers": "03-07-14-15-19-20-22-26-28-30-31-34-38-40-41-43-45-46-55-57"
            

              
                      }
            

              
                    ],
            

              
                    "award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "award": "R$ 10.000,00",
            

              
                          "description": "10 mil reais",
            

              
                          "gross_value": 10000,
            

              
                          "net_value": 10000
            

              
                      }
            

              
                    ],
            

              
                    "electronic_award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "description": "RODADA DA SORTE R$ 500,00",
            

              
                          "gross_value": 500,
            

              
                          "net_value": 500,
            

              
                          "observation": null
            

              
                      }
            

              
                    ],
            

              
                    "stage": {
            

              
                      "description": "ED 87 - DIA DO TRABALHADOR",
            

              
                      "start_eligibility": "25/04/2022",
            

              
                      "end_eligibility": "30/04/2022",
            

              
                      "stage": 87,
            

              
                      "code_susep": "15414.617352/2020-66"
            

              
                    },
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2021-05-20T19:36:36.590Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Confirmação de recarga

Após solicitar a recarga, será preciso confirmar sua solicitação, para fazer isso basta chamar esta requisição informando o id_transaction.

                    Após confirmação da recarga, o cancelamento não será mais possível.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
signer_code(string) - Indica o CPF do comprador
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
drawing_number(object) - Objeto opcional representativo de dados sobre os números do sorterio
drawing_number. ticket (int) - Código do ticket.
drawing_number. maracap_numbers (string) - Números do sorterio.
award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio.
award. number (int) - Código indentificador do prêmio.
award. award (string) - Prêmio.
award. description (int) - Descrição do prêmio.
award. net_value (int) - Valor líquido do prêmio.
award. gross_value (string) - Valor bruto do prêmio.
electronic_award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio eletrõnico.
electronic_award. number (int) - Código indentificador do prêmio.
electronic_award. description (int) - Descrição do prêmio.
electronic_award. net_value (int) - Valor líquido do prêmio.
electronic_award. gross_value (string) - Valor bruto do prêmio.
stage(object) - Objeto opcional representativo de dados sobre a etapa.
stage. description (string) - Descrição da etapa.
stage. start_eligibility (string) - Data de início da etapa.
stage. end_eligibility (string) - Data de fim da etapa.
stage. stage (string) - Código da etapa.
stage. code_susep (string) - Código susep.
titles(object) - Objeto opcional representativo de dados sobre a etapa.
titles. product (string) - Código produto.
titles. serie (string) - Serie produto.
titles. title (string) - Title codigo.
titles. title_verifier_digit (string) - Title codigo verificador.
titles. fantasy (string) - Codigo fantasia.
titles. fantasy_verifier_digit (string) - Codigo verificador fantasia.
protocol(string) - Protocolo gerado telesana ativavel.
order(string) - Numero da ordem.
price(string) - Preço.
total(string) - valor total.
order_date(string) - Data da ordem.
rescue_date(string) - Data de resgate.
company_name(string) - Nome da empresa.
company_code(string) - CNPJ da empresa.
event_code(string) - Código do evento.
event_name(string) - Nome do evento.
susep(string) - Numero susep.
url(string) - Url para consulta.
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
metadata. accept (boolean) - Informa que aceita os termos e condições.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

                    Note que conforme são alterados os status da solicitação, serão acrescentados
no campo statuses como forma de histórico para a sua solicitação

POST

/raffles/transactions/{id_transaction}/capture

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/raffles/transactions/47f9e5b0-7b45-0138-ae54-0e952cca23cd/capture' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "captured",
            

              
                  "id": "ff16dcd0-9bcd-0139-694a-42149c6a7a78",
            

              
                  "product_id": "116",
            

              
                  "amount": 1200,
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "994145351",
            

              
                  "created_at": "2021-05-20T19:17:52.279Z",
            

              
                  "updated_at": "2021-05-20T19:18:47.384Z",
            

              
                  "nsu": "000009126",
            

              
                  "authorization_code": "11420",
            

              
                  "face_amount": 1200,
            

              
                  "due_date": "2021-05-25T00:00:00.000Z",
            

              
                  "message": "Lideranca Capitalizacao S/A. | CNPJ: 60.853.264/0001-10 |18-03-2021 09:33:05POS: 593913 |N. do Pedido: 493-1992250-3 |Este é o comprovante de aquisição da sua Tele Sena digital. | Não é o titulo de capitalizaçao. | Para visualiza-lo acesse o site www.telesena.com.br | Este comprovante não tem valor comercial | Confira seus dados:@ | CPF: 2374242001 | Cliente: NOME DO CLIENTE | Telefone: 32-94874564 || TELE SENA DE PASC0A/2021 | Proc. SUSEP N.: 13454.600644/2021-41 | Data de Resgate: 14/03/2022 | Produto: 3 | Série: 201 | Título: 3850052 | | Quantidade: 1 | Valor Total: 12.00 | | Aprovado pela Superintendencia de Seguros Privados - SUSEP. Consulte as condicões gerais e preencha a Ficha de Cadastro obrigatória no site www.telesena.com.br | | Acesse o link abaixo ou utilize o QR Code para conferir as suas Tele Senas. https://stg.telesena.digital/kBKKnB | |",
            

              
                  "authorized_at": "2021-05-20T19:36:36.000Z",
            

              
                  "signer_code": "2374242000",
            

              
                  "charged_amount": 1140,
            

              
                  "metadata": {
            

              
                      "terminal_state": "MG",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "User",
            

              
                      "accept": true
            

              
                  },
            

              
                  "drawing_number": [
            

              
                      {
            

              
                          "ticket": 400078,
            

              
                          "maracap_numbers": "03-07-14-15-19-20-22-26-28-30-31-34-38-40-41-43-45-46-55-57"
            

              
                      }
            

              
                    ],
            

              
                    "award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "award": "R$ 10.000,00",
            

              
                          "description": "10 mil reais",
            

              
                          "gross_value": 10000,
            

              
                          "net_value": 10000
            

              
                      }
            

              
                    ],
            

              
                    "electronic_award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "description": "RODADA DA SORTE R$ 500,00",
            

              
                          "gross_value": 500,
            

              
                          "net_value": 500,
            

              
                          "observation": null
            

              
                      }
            

              
                    ],
            

              
                    "stage": {
            

              
                      "description": "ED 87 - DIA DO TRABALHADOR",
            

              
                      "start_eligibility": "25/04/2022",
            

              
                      "end_eligibility": "30/04/2022",
            

              
                      "stage": 87,
            

              
                      "code_susep": "15414.617352/2020-66"
            

              
                    },
            

              
                  "titles": [
            

              
                    {
            

              
                      "product": "08",
            

              
                      "serie": "0010",
            

              
                      "title": "40280620",
            

              
                      "title_verifier_digit": "8",
            

              
                      "fantasy": "2453392",
            

              
                      "fantasy_verifier_digit": "9"
            

              
                    }
            

              
                  ],
            

              
                  "protocol": "1BD347EE-B531-498D-BC2A-3FEDDBFC461A",
            

              
                  "order": "614-7811625-6",
            

              
                  "price": 1500,
            

              
                  "total": 3000,
            

              
                  "order_date": "2022-09-01T09:41:07.000Z",
            

              
                  "rescue_date": "2023-09-01",
            

              
                  "company_name": "Liderança Capitalização S/A.",
            

              
                  "company_code": "60.853.264/0001-10",
            

              
                  "event_code": "614",
            

              
                  "event_name": "INDEPENDÊNCIA/2022",
            

              
                  "susep": "15414.614043/2022-04",
            

              
                  "url": "https://telesena.me/0500312345678",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2021-05-20T19:17:52.494Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "captured",
            

              
                          "created_at": "2021-05-20T19:18:47.405Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/ff16dcd0-9bcd-0139-694a-42149c6a7a78",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Desfazimento de recarga

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação
não será mais possível desfazer esta solicitação.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
signer_code(string) - Indica o CPF do comprador
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
drawing_number(object) - Objeto opcional representativo de dados sobre os números do sorterio
drawing_number. ticket (int) - Código do ticket.
drawing_number. maracap_numbers (string) - Números do sorterio.
award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio.
award. number (int) - Código indentificador do prêmio.
award. award (string) - Prêmio.
award. description (int) - Descrição do prêmio.
award. net_value (int) - Valor líquido do prêmio.
award. gross_value (string) - Valor bruto do prêmio.
electronic_award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio eletrõnico.
electronic_award. number (int) - Código indentificador do prêmio.
electronic_award. description (int) - Descrição do prêmio.
electronic_award. net_value (int) - Valor líquido do prêmio.
electronic_award. gross_value (string) - Valor bruto do prêmio.
stage(object) - Objeto opcional representativo de dados sobre a etapa.
electronic_award. description (string) - Descrição da etapa.
electronic_award. start_eligibility (string) - Data de início da etapa.
electronic_award. end_eligibility (string) - Data de fim da etapa.
electronic_award. stage (string) - Código da etapa.
electronic_award. code_susep (string) - Código susep.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
metadata. accept (boolean) - Informa que aceita os termos e condições.
titles(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/raffles/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request DELETE 'https://api.sbx.rvhub.com.br/raffles/transactions/80d39510-6ac3-0138-4336-56e1314b0560' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "refunded",
            

              
                  "id": "95663e60-9bd1-0139-6b54-2260ff18e351",
            

              
                  "product_id": "116",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "934145351",
            

              
                  "created_at": "2021-05-20T19:43:32.948Z",
            

              
                  "updated_at": "2021-05-20T19:43:53.337Z",
            

              
                  "nsu": "000009820",
            

              
                  "authorization_code": "11422",
            

              
                  "face_amount": 1200,
            

              
                  "due_date": "2021-05-25T00:00:00.000Z",
            

              
                   "message": "Lideranca Capitalizacao S/A. | CNPJ: 60.853.264/0001-10 |18-03-2021 09:33:05POS: 593913 |N. do Pedido: 493-1992250-3 |Este é o comprovante de aquisição da sua Tele Sena digital. | Não é o titulo de capitalizaçao. | Para visualiza-lo acesse o site www.telesena.com.br | Este comprovante não tem valor comercial | Confira seus dados:@ | CPF: 2374242001 | Cliente: NOME DO CLIENTE | Telefone: 32-94874564 || TELE SENA DE PASC0A/2021 | Proc. SUSEP N.: 13454.600644/2021-41 | Data de Resgate: 14/03/2022 | Produto: 3 | Série: 201 | Título: 3850052 | | Quantidade: 1 | Valor Total: 12.00 | | Aprovado pela Superintendencia de Seguros Privados - SUSEP. Consulte as condicões gerais e preencha a Ficha de Cadastro obrigatória no site www.telesena.com.br | | Acesse o link abaixo ou utilize o QR Code para conferir as suas Tele Senas. https://stg.telesena.digital/kBKKnB | |",
            

              
                  "authorized_at": "2021-05-20T19:36:36.000Z",
            

              
                  "signer_code": "2374242000",
            

              
                  "charged_amount": 1140,
            

              
                  "metadata": {
            

              
                      "terminal_state": "MG",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "User",
            

              
                      "accept": true
            

              
                  },
            

              
                  "drawing_number": [
            

              
                      {
            

              
                          "ticket": 400078,
            

              
                          "maracap_numbers": "03-07-14-15-19-20-22-26-28-30-31-34-38-40-41-43-45-46-55-57"
            

              
                      }
            

              
                    ],
            

              
                    "award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "award": "R$ 10.000,00",
            

              
                          "description": "10 mil reais",
            

              
                          "gross_value": 10000,
            

              
                          "net_value": 10000
            

              
                      }
            

              
                    ],
            

              
                    "electronic_award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "description": "RODADA DA SORTE R$ 500,00",
            

              
                          "gross_value": 500,
            

              
                          "net_value": 500,
            

              
                          "observation": null
            

              
                      }
            

              
                    ],
            

              
                    "stage": {
            

              
                      "description": "ED 87 - DIA DO TRABALHADOR",
            

              
                      "start_eligibility": "25/04/2022",
            

              
                      "end_eligibility": "30/04/2022",
            

              
                      "stage": 87,
            

              
                      "code_susep": "15414.617352/2020-66"
            

              
                    },
            

              
                  "titles": [
            

              
                    "03001116394227"
            

              
                  ],
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2021-05-20T19:43:37.363Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "refunded",
            

              
                          "created_at": "2021-05-20T19:43:53.355Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/95663e60-9bd1-0139-6b54-2260ff18e351",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta de recarga

Para consultar suas transações, basta invocar este serviço e informar o id_transaction na URL.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
signer_code(string) - Indica o CPF do comprador
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
drawing_number(object) - Objeto opcional representativo de dados sobre os números do sorterio
drawing_number. ticket (int) - Código do ticket.
drawing_number. maracap_numbers (string) - Números do sorterio.
award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio.
award. number (int) - Código indentificador do prêmio.
award. award (string) - Prêmio.
award. description (int) - Descrição do prêmio.
award. net_value (int) - Valor líquido do prêmio.
award. gross_value (string) - Valor bruto do prêmio.
electronic_award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio eletrõnico.
electronic_award. number (int) - Código indentificador do prêmio.
electronic_award. description (int) - Descrição do prêmio.
electronic_award. net_value (int) - Valor líquido do prêmio.
electronic_award. gross_value (string) - Valor bruto do prêmio.
stage(object) - Objeto opcional representativo de dados sobre a etapa.
electronic_award. description (string) - Descrição da etapa.
electronic_award. start_eligibility (string) - Data de início da etapa.
electronic_award. end_eligibility (string) - Data de fim da etapa.
electronic_award. stage (string) - Código da etapa.
electronic_award. code_susep (string) - Código susep.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
metadata. accept (boolean) - Informa que aceita os termos e condições.
titles(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
protocol(string) - Protocolo gerado telesana ativavel.
order(string) - Numero da ordem.
price(string) - Preço.
total(string) - valor total.
order_date(string) - Data da ordem.
rescue_date(string) - Data de resgate.
company_name(string) - Nome da empresa.
company_code(string) - CNPJ da empresa.
event_code(string) - Código do evento.
event_name(string) - Nome do evento.
susep(string) - Numero susep.
url(string) - Url para consulta.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/raffles/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/raffles/transactions/d70603c0-6ac0-0138-d1f7-6a4d3f76afc8' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                  "product_id": "116",
            

              
                  "area_code": "11",
            

              
                  "cell_phone_number": "994145351",
            

              
                  "status": "authorized",
            

              
                  "created_at": "2021-05-20T19:36:36.136Z",
            

              
                  "updated_at": "2021-05-20T19:36:36.556Z",
            

              
                  "nsu": "000000002",
            

              
                  "authorization_code": "11421",
            

              
                  "face_amount": 1200,
            

              
                  "due_date": "2021-05-25T00:00:00.000Z",
            

              
                  "message": "Lideranca Capitalizacao S/A. | CNPJ: 60.853.264/0001-10 |18-03-2021 09:33:05POS: 593913 |N. do Pedido: 493-1982150-3 |Este é o comprovante de aquisição da sua Tele Sena digital. | Não é o titulo de capitalizaçao. | Para visualiza-lo acesse o site www.telesena.com.br | Este comprovante não tem valor comercial | Confira seus dados:@ | CPF: 2374242000 | Cliente: NOME DO CLIENTE | Telefone: 32-94874564 || TELE SENA DE PASC0A/2021 | Proc. SUSEP N.: 13454.600644/2021-41 | Data de Resgate: 14/03/2022 | Produto: 3 | Série: 201 | Título: 3850052 | | Quantidade: 1 | Valor Total: 12.00 | | Aprovado pela Superintendencia de Seguros Privados - SUSEP. Consulte as condicões gerais e preencha a Ficha de Cadastro obrigatória no site www.telesena.com.br | | Acesse o link abaixo ou utilize o QR Code para conferir as suas Tele Senas. https://stg.telesena.digital/kBKhnB | |",
            

              
                  "authorized_at": "2021-05-20T19:36:36.000Z",
            

              
                  "signer_code": "2374242000",
            

              
                  "charged_amount": 1140,
            

              
                  "metadata": {
            

              
                      "terminal_state": "MG",
            

              
                      "terminal_id": "123",
            

              
                      "local_user": "User",
            

              
                      "accept": true
            

              
                  },
            

              
                  "drawing_number": [
            

              
                      {
            

              
                          "ticket": 400078,
            

              
                          "maracap_numbers": "03-07-14-15-19-20-22-26-28-30-31-34-38-40-41-43-45-46-55-57"
            

              
                      }
            

              
                    ],
            

              
                    "award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "award": "R$ 10.000,00",
            

              
                          "description": "10 mil reais",
            

              
                          "gross_value": 10000,
            

              
                          "net_value": 10000
            

              
                      }
            

              
                    ],
            

              
                    "electronic_award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "description": "RODADA DA SORTE R$ 500,00",
            

              
                          "gross_value": 500,
            

              
                          "net_value": 500,
            

              
                          "observation": null
            

              
                      }
            

              
                    ],
            

              
                    "stage": {
            

              
                      "description": "ED 87 - DIA DO TRABALHADOR",
            

              
                      "start_eligibility": "25/04/2022",
            

              
                      "end_eligibility": "30/04/2022",
            

              
                      "stage": 87,
            

              
                      "code_susep": "15414.617352/2020-66"
            

              
                    },
            

              
                  "titles": [
            

              
                    {
            

              
                      "product": "08",
            

              
                      "serie": "0010",
            

              
                      "title": "41074766",
            

              
                      "title_verifier_digit": "8",
            

              
                      "fantasy": "2453392",
            

              
                      "fantasy_verifier_digit": "9"
            

              
                    }
            

              
                  ],
            

              
                   "protocol": "1BD347EE-B531-498D-BC2A-3FEDDBFC461A",
            

              
                  "order": "614-7811625-6",
            

              
                  "price": 1500,
            

              
                  "total": 3000,
            

              
                  "order_date": "2022-09-01T09:41:07.000Z",
            

              
                  "rescue_date": "2023-09-01",
            

              
                  "company_name": "Liderança Capitalização S/A.",
            

              
                  "company_code": "60.853.264/0001-10",
            

              
                  "event_code": "614",
            

              
                  "event_name": "INDEPENDÊNCIA/2022",
            

              
                  "susep": "15414.614043/2022-04",
            

              
                  "url": "https://telesena.me/0500312345678",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "authorized",
            

              
                          "created_at": "2021-05-20T19:36:36.590Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996/capture",
            

              
                          "rel": "capture",
            

              
                          "type": "POST"
            

              
                      },
            

              
                      {
            

              
                          "href": "/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                          "rel": "refund",
            

              
                          "type": "DELETE"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Lista de recarga

Para listar todas as suas transações, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(authorized, captured, refunded ou denied) da recarga.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/raffles/transactions?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/raffles/transactions?statuses=authorized,captured

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
signer_code(string) - Indica o CPF do comprador
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Mensagem de ativação enviada pela operadora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
drawing_number(object) - Objeto opcional representativo de dados sobre os números do sorterio
drawing_number. ticket (int) - Código do ticket.
drawing_number. maracap_numbers (string) - Números do sorterio.
award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio.
award. number (int) - Código indentificador do prêmio.
award. award (string) - Prêmio.
award. description (int) - Descrição do prêmio.
award. net_value (int) - Valor líquido do prêmio.
award. gross_value (string) - Valor bruto do prêmio.
electronic_award(object) - Objeto opcional representativo de dados sobre os prêmios do sorterio eletrõnico.
electronic_award. number (int) - Código indentificador do prêmio.
electronic_award. description (int) - Descrição do prêmio.
electronic_award. net_value (int) - Valor líquido do prêmio.
electronic_award. gross_value (string) - Valor bruto do prêmio.
stage(object) - Objeto opcional representativo de dados sobre a etapa.
electronic_award. description (string) - Descrição da etapa.
electronic_award. start_eligibility (string) - Data de início da etapa.
electronic_award. end_eligibility (string) - Data de fim da etapa.
electronic_award. stage (string) - Código da etapa.
electronic_award. code_susep (string) - Código susep.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
metadata. accept (boolean) - Informa que aceita os termos e condições.
titles(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
protocol(string) - Protocolo gerado telesana ativavel.
order(string) - Numero da ordem.
price(string) - Preço.
total(string) - valor total.
order_date(string) - Data da ordem.
rescue_date(string) - Data de resgate.
company_name(string) - Nome da empresa.
company_code(string) - CNPJ da empresa.
event_code(string) - Código do evento.
event_name(string) - Nome do evento.
susep(string) - Numero susep.
url(string) - Url para consulta.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/raffles/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/raffles/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                 {
            

              
                    "id":"9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                    "product_id":"116",
            

              
                    "area_code":"11",
            

              
                    "cell_phone_number":"994145351",
            

              
                    "status":"authorized",
            

              
                    "created_at":"2021-05-20T19:36:36.136Z",
            

              
                    "updated_at":"2021-05-20T19:36:36.556Z",
            

              
                    "nsu":"000000002",
            

              
                    "authorization_code":"11421",
            

              
                    "face_amount":1200,
            

              
                    "due_date":"2021-05-25T00:00:00.000Z",
            

              
                    "message":"Lideranca Capitalizacao S/A. | CNPJ: 60.853.264/0001-10 |18-03-2021 09:33:05POS: 593913 |N. do Pedido: 493-1982150-3 |Este é o comprovante de aquisição da sua Tele Sena digital. | Não é o titulo de capitalizaçao. | Para visualiza-lo acesse o site www.telesena.com.br | Este comprovante não tem valor comercial | Confira seus dados:@ | CPF: 2374242000 | Cliente: NOME DO CLIENTE | Telefone: 32-94874564 || TELE SENA DE PASC0A/2021 | Proc. SUSEP N.: 13454.600644/2021-41 | Data de Resgate: 14/03/2022 | Produto: 3 | Série: 201 | Título: 3850052 | | Quantidade: 1 | Valor Total: 12.00 | | Aprovado pela Superintendencia de Seguros Privados - SUSEP. Consulte as condicões gerais e preencha a Ficha de Cadastro obrigatória no site www.telesena.com.br | | Acesse o link abaixo ou utilize o QR Code para conferir as suas Tele Senas. https://stg.telesena.digital/kBKhnB | |",
            

              
                    "authorized_at":"2021-05-20T19:36:36.000Z",
            

              
                    "signer_code":"2374242000",
            

              
                    "charged_amount":1140,
            

              
                    "drawing_number": [
            

              
                      {
            

              
                          "ticket": 400078,
            

              
                          "maracap_numbers": "03-07-14-15-19-20-22-26-28-30-31-34-38-40-41-43-45-46-55-57"
            

              
                      }
            

              
                    ],
            

              
                    "award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "award": "R$ 10.000,00",
            

              
                          "description": "10 mil reais",
            

              
                          "gross_value": 10000,
            

              
                          "net_value": 10000
            

              
                      }
            

              
                    ],
            

              
                    "electronic_award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "description": "RODADA DA SORTE R$ 500,00",
            

              
                          "gross_value": 500,
            

              
                          "net_value": 500,
            

              
                          "observation": null
            

              
                      }
            

              
                    ],
            

              
                    "stage": {
            

              
                      "description": "ED 87 - DIA DO TRABALHADOR",
            

              
                      "start_eligibility": "25/04/2022",
            

              
                      "end_eligibility": "30/04/2022",
            

              
                      "stage": 87,
            

              
                      "code_susep": "15414.617352/2020-66"
            

              
                    },
            

              
                    "titles": [
            

              
                      {
            

              
                          "product": "08",
            

              
                          "serie": "0010",
            

              
                          "title": "41074766",
            

              
                          "title_verifier_digit": "8",
            

              
                          "fantasy": "2453392",
            

              
                          "fantasy_verifier_digit": "9"
            

              
                      }
            

              
                    ],
            

              
                    "protocol": "1BD347EE-B531-498D-BC2A-3FEDDBFC461A",
            

              
                    "order": "614-7811625-6",
            

              
                    "price": 1500,
            

              
                    "total": 3000,
            

              
                    "order_date": "2022-09-01T09:41:07.000Z",
            

              
                    "rescue_date": "2023-09-01",
            

              
                    "company_name": "Liderança Capitalização S/A.",
            

              
                    "company_code": "60.853.264/0001-10",
            

              
                    "event_code": "614",
            

              
                    "event_name": "INDEPENDÊNCIA/2022",
            

              
                    "susep": "15414.614043/2022-04",
            

              
                    "url": "https://telesena.me/0500312345678",
            

              
                    "statuses":[
            

              
                       {
            

              
                          "status":"authorized",
            

              
                          "created_at":"2021-05-20T19:36:36.590Z"
            

              
                       }
            

              
                    ],
            

              
                    "links":[
            

              
                       {
            

              
                          "href":"/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                          "rel":"self",
            

              
                          "type":"GET"
            

              
                       },
            

              
                       {
            

              
                          "href":"/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996/capture",
            

              
                          "rel":"capture",
            

              
                          "type":"POST"
            

              
                       },
            

              
                       {
            

              
                          "href":"/transactions/9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                          "rel":"refund",
            

              
                          "type":"DELETE"
            

              
                       }
            

              
                    ]
            

              
                 },
            

              
                 {
            

              
                    "status":"refunded",
            

              
                    "id":"95663e60-9bd1-0139-6b54-2260ff18e351",
            

              
                    "product_id":"116",
            

              
                    "area_code":"11",
            

              
                    "cell_phone_number":"934145351",
            

              
                    "created_at":"2021-05-20T19:43:32.948Z",
            

              
                    "updated_at":"2021-05-20T19:43:53.337Z",
            

              
                    "nsu":"000009820",
            

              
                    "authorization_code":"11422",
            

              
                    "face_amount":1200,
            

              
                    "due_date":"2021-05-25T00:00:00.000Z",
            

              
                    "message":"Lideranca Capitalizacao S/A. | CNPJ: 60.853.264/0001-10 |18-03-2021 09:33:05POS: 593913 |N. do Pedido: 493-1982150-3 |Este é o comprovante de aquisição da sua Tele Sena digital. | Não é o titulo de capitalizaçao. | Para visualiza-lo acesse o site www.telesena.com.br | Este comprovante não tem valor comercial | Confira seus dados:@ | CPF: 2374242001 | Cliente: NOME DO CLIENTE | Telefone: 32-94874564 || TELE SENA DE PASC0A/2021 | Proc. SUSEP N.: 13454.600644/2021-41 | Data de Resgate: 14/03/2022 | Produto: 3 | Série: 201 | Título: 3850052 | | Quantidade: 1 | Valor Total: 12.00 | | Aprovado pela Superintendencia de Seguros Privados - SUSEP. Consulte as condicões gerais e preencha a Ficha de Cadastro obrigatória no site www.telesena.com.br | | Acesse o link abaixo ou utilize o QR Code para conferir as suas Tele Senas. https://stg.telesena.digital/kBKKna | |",
            

              
                    "authorized_at":"2021-05-20T19:36:36.000Z",
            

              
                    "signer_code":"2374242000",
            

              
                    "charged_amount":1140,
            

              
                    "drawing_number": [
            

              
                      {
            

              
                          "ticket": 400078,
            

              
                          "maracap_numbers": "03-07-14-15-19-20-22-26-28-30-31-34-38-40-41-43-45-46-55-57"
            

              
                      }
            

              
                    ],
            

              
                    "award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "award": "R$ 10.000,00",
            

              
                          "description": "10 mil reais",
            

              
                          "gross_value": 10000,
            

              
                          "net_value": 10000
            

              
                      }
            

              
                    ],
            

              
                    "electronic_award": [
            

              
                      {
            

              
                          "number": 1,
            

              
                          "description": "RODADA DA SORTE R$ 500,00",
            

              
                          "gross_value": 500,
            

              
                          "net_value": 500,
            

              
                          "observation": null
            

              
                      }
            

              
                    ],
            

              
                    "stage": {
            

              
                      "description": "ED 87 - DIA DO TRABALHADOR",
            

              
                      "start_eligibility": "25/04/2022",
            

              
                      "end_eligibility": "30/04/2022",
            

              
                      "stage": 87,
            

              
                      "code_susep": "15414.617352/2020-66"
            

              
                    },
            

              
                    "titles": [
            

              
                      "03001116394227"
            

              
                    ],
            

              
                    "statuses":[
            

              
                       {
            

              
                          "status":"authorized",
            

              
                          "created_at":"2021-05-20T19:43:37.363Z"
            

              
                       },
            

              
                       {
            

              
                          "status":"refunded",
            

              
                          "created_at":"2021-05-20T19:43:53.355Z"
            

              
                       }
            

              
                    ],
            

              
                    "links":[
            

              
                       {
            

              
                          "href":"/transactions/95663e60-9bd1-0139-6b54-2260ff18e351",
            

              
                          "rel":"self",
            

              
                          "type":"GET"
            

              
                       }
            

              
                    ]
            

              
                 }
            

              
              ]

COPIADO!

Seguros

Esta API é responsável por todas as movimentações referentes a seguros.

Serviços disponíveis

POST

/insurances/transactions

POST

/insurances/transactions/{id_transaction}/capture

DELETE

/insurances/transactions/{id_transaction}

GET

/insurances/transactions/{id_transaction}

GET

/insurances/transactions

Solicitação de recarga

Com esta API é possível realizar novas solicitações referentes a seguros. Uma particularidade desta API é que o retorno do campo message traz um link para a conclusão do cadastro junto à seguradora.

                    Para esta requisição é obrigatório o envio do cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

product_id(string) - Informar o código do produto
area_code(string) - Informar o DDD do celular
cell_phone_number(string) - Informar o número do celular
signer_code(string) - CPF do usuário
birth_date(string) [opcional] - Data de nascimento do solicitante, formato YYYYMMDD.
affiliation_key(string) [opcional] - Informar a chave do parceiro (Ex. Software House). Para contas vinculadas a um parceiro esse campo é obrigatório.
metadata(object) [opcional] - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) [opcional] - Informar a sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) [opcional] - Informar o código do terminal que está realizando a venda.
metadata. local_user (string) [opcional] - Informar o código ou Login do usuário local (na rede do cliente) que efetuou a transação, para registro no relatório de compras.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Retorna o link para a conclusão do cadastro na seguradora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
signer_code(string) - CPF do usuário
affiliation_key(string) - Chave do parceiro (Ex. Software House).
birth_date(string) - Data de nascimento do solicitante.
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
metadata. qrcode_data (string) - Link para termino do cadastro
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/insurances/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/insurances/transactions' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
                "product_id": "6615",
            

              
                "area_code": "32",
            

              
                "cell_phone_number": "994145351",
            

              
                "signer_code": "11111111111",
            

              
                "birth_date": "19870521"
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
              	"id": "2eed2f10-92fc-013d-6427-623e4ec8c5dc",
            

              
              	"product_id": "100210",
            

              
              	"area_code": "32",
            

              
              	"cell_phone_number": "994145351",
            

              
              	"status": "authorized",
            

              
              	"created_at": "2024-12-02T16:55:39.605Z",
            

              
              	"updated_at": "2024-12-02T16:55:40.138Z",
            

              
              	"nsu": "000005533",
            

              
              	"authorization_code": "55473",
            

              
              	"face_amount": 3990,
            

              
              	"due_date": "2024-12-07T00:00:00.000Z",
            

              
              	"authorized_at": "2024-12-02T16:55:39.000Z",
            

              
              	"signer_code": "11111111111",
            

              
              	"charged_amount": 3790,
            

              
              	"affiliation_key": "",
            

              
              	"application_id": 1,
            

              
              	"birth_date": "1987-05-21",
            

              
              	"accepted": false,
            

              
              	"statuses": [
            

              
              		{
            

              
              			"status": "authorized",
            

              
              			"created_at": "2024-12-02T16:55:40.154Z"
            

              
              		}
            

              
              	],
            

              
              	"links": [
            

              
              		{
            

              
              			"href": "/transactions/2eed2f10-92fc-013d-6427-623e4ec8c5dc",
            

              
              			"rel": "self",
            

              
              			"type": "GET"
            

              
              		},
            

              
              		{
            

              
              			"href": "/transactions/2eed2f10-92fc-013d-6427-623e4ec8c5dc/capture",
            

              
              			"rel": "capture",
            

              
              			"type": "POST"
            

              
              		},
            

              
              		{
            

              
              			"href": "/transactions/2eed2f10-92fc-013d-6427-623e4ec8c5dc",
            

              
              			"rel": "refund",
            

              
              			"type": "DELETE"
            

              
              		}
            

              
              	]
            

              
              }

COPIADO!

Confirmação de recarga

Após solicitar a recarga, será preciso confirmar sua solicitação, para fazer isso basta chamar esta requisição informando o id_transaction.

                    Após confirmação da recarga, o cancelamento não será mais possível.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
signer_code(string) - CPF do usuário
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Retorna o link para a conclusão do cadastro na seguradora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

                    Note que conforme são alterados os status da solicitação, serão acrescentados
no campo statuses como forma de histórico para a sua solicitação

POST

/insurances/transactions/{id_transaction}/capture

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/insurances/transactions/2eed2f10-92fc-013d-6427-623e4ec8c5dc/capture' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
              	"status": "captured",
            

              
              	"id": "2eed2f10-92fc-013d-6427-623e4ec8c5dc",
            

              
              	"product_id": "100210",
            

              
              	"area_code": "32",
            

              
              	"cell_phone_number": "994145351",
            

              
              	"created_at": "2024-12-02T16:55:39.605Z",
            

              
              	"updated_at": "2024-12-02T16:58:51.209Z",
            

              
              	"nsu": "000005533",
            

              
              	"authorization_code": "55473",
            

              
              	"face_amount": 3990,
            

              
              	"due_date": "2024-12-07T00:00:00.000Z",
            

              
              	"authorized_at": "2024-12-02T16:55:39.000Z",
            

              
              	"signer_code": "11111111111",
            

              
              	"charged_amount": 3790,
            

              
              	"affiliation_key": "",
            

              
              	"application_id": 1,
            

              
              	"birth_date": "1987-05-21",
            

              
              	"accepted": false,
            

              
              	"statuses": [
            

              
              		{
            

              
              			"status": "authorized",
            

              
              			"created_at": "2024-12-02T16:55:40.154Z"
            

              
              		},
            

              
              		{
            

              
              			"status": "captured",
            

              
              			"created_at": "2024-12-02T16:58:51.230Z"
            

              
              		}
            

              
              	],
            

              
              	"links": [
            

              
              		{
            

              
              			"href": "/transactions/2eed2f10-92fc-013d-6427-623e4ec8c5dc",
            

              
              			"rel": "register",
            

              
              			"type": "GET"
            

              
              		}
            

              
              	]
            

              
              }

COPIADO!

Desfazimento de recarga

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação
não será mais possível desfazer esta solicitação.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

status(string) - Status da transação
id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
signer_code(string) - CPF do usuário
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Retorna o link para a conclusão do cadastro na seguradora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/insurances/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request DELETE 'https://api.sbx.rvhub.com.br/insurances/transactions/d7285bd0-92fc-013d-2491-1eb8c56e3742' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
              	"status": "refunded",
            

              
              	"id": "d7285bd0-92fc-013d-2491-1eb8c56e3742",
            

              
              	"product_id": "100210",
            

              
              	"area_code": "32",
            

              
              	"cell_phone_number": "994145351",
            

              
              	"created_at": "2024-12-02T17:00:21.850Z",
            

              
              	"updated_at": "2024-12-02T17:00:53.119Z",
            

              
              	"nsu": "000006271",
            

              
              	"authorization_code": "55474",
            

              
              	"face_amount": 3990,
            

              
              	"due_date": "2024-12-07T00:00:00.000Z",
            

              
              	"authorized_at": "2024-12-02T17:00:22.000Z",
            

              
              	"signer_code": "11111111111",
            

              
              	"charged_amount": 3790,
            

              
              	"affiliation_key": "",
            

              
              	"application_id": 1,
            

              
              	"birth_date": "1987-05-21",
            

              
              	"accepted": false,
            

              
              	"statuses": [
            

              
              		{
            

              
              			"status": "authorized",
            

              
              			"created_at": "2024-12-02T17:00:22.353Z"
            

              
              		},
            

              
              		{
            

              
              			"status": "refunded",
            

              
              			"created_at": "2024-12-02T17:00:53.144Z"
            

              
              		}
            

              
              	],
            

              
              	"links": [
            

              
              		{
            

              
              			"href": "/transactions/d7285bd0-92fc-013d-2491-1eb8c56e3742",
            

              
              			"rel": "self",
            

              
              			"type": "GET"
            

              
              		}
            

              
              	]
            

              
              }

COPIADO!

Consulta de recarga

Para consultar suas transações, basta invocar este serviço e informar o id_transaction na URL.

Parâmetros

id_transaction(string) - Identificador único da transação retornado no momento em que é solicitado uma recarga.

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
area_code(string) - DDD enviado no corpo da requisição
cell_phone_number(string) - Número do telefone enviado no corpo da requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Retorna o link para a conclusão do cadastro na seguradora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
signer_code(string) - CPF do usuário
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/insurances/transactions/{id_transaction}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/insurances/transactions/2eed2f10-92fc-013d-6427-623e4ec8c5dc' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
              	"id": "2eed2f10-92fc-013d-6427-623e4ec8c5dc",
            

              
              	"product_id": "100210",
            

              
              	"area_code": "32",
            

              
              	"cell_phone_number": "994145351",
            

              
              	"status": "captured",
            

              
              	"created_at": "2024-12-02T16:55:39.605Z",
            

              
              	"updated_at": "2024-12-02T16:58:51.209Z",
            

              
              	"nsu": "000005533",
            

              
              	"authorization_code": "55473",
            

              
              	"face_amount": 3990,
            

              
              	"due_date": "2024-12-07T00:00:00.000Z",
            

              
              	"authorized_at": "2024-12-02T16:55:39.000Z",
            

              
              	"signer_code": "11111111111",
            

              
              	"charged_amount": 3790,
            

              
              	"affiliation_key": "",
            

              
              	"application_id": 1,
            

              
              	"birth_date": "1987-05-21",
            

              
              	"accepted": false,
            

              
              	"statuses": [
            

              
              		{
            

              
              			"status": "authorized",
            

              
              			"created_at": "2024-12-02T16:55:40.154Z"
            

              
              		},
            

              
              		{
            

              
              			"status": "captured",
            

              
              			"created_at": "2024-12-02T16:58:51.230Z"
            

              
              		}
            

              
              	],
            

              
              	"links": [
            

              
              		{
            

              
              			"href": null,
            

              
              			"rel": "register",
            

              
              			"type": "GET"
            

              
              		}
            

              
              	]
            

              
              }

COPIADO!

Lista de recarga

Para listar todas as suas transações, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(authorized, captured, refunded ou denied) da recarga.
start_date(string) - Informar a data inicial no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 00:00:00
end_date(string) - Informar a data final no seguinte padrão: DD-MM-YYYYT-HH:MM:SS. Caso a data seja enviada como DD-MM-YYYY, a data será considerada com a seguinte hora: 23:59:59

                    Caso não seja informado o periodo, start_date e end_date, a API retornará as transações das últimas cinco horas. Desencorajamos buscas com periodo acima de sete dias, caso necessário, entrar em contato com st@rvdigitalbrasil.com.br para possível solução.

                    Todos as datas e horas do sistema são armazenadas no fuso horário UTC 0

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/insurances/transactions?statuses=denied

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/insurances/transactions?statuses=authorized,captured

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
amount(int) - Valor da recarga
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
nsu(string) - Informa o NSU (número sequencial único) da recarga retornada pela operadora para impressão no ticket.
authorization_code(string) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
face_amount(int) - Valor de face do produto
due_date(string) - Data do vencimento da transação (pagamento da loja para a RV Tecnologia), conforme prazos de pagamentos cadastrado na loja
message(string) - Retorna o link para a conclusão do cadastro na seguradora
authorized_at(string) - Data que a transação foi autorizada
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
signer_code(string) - CPF do usuário
affiliation_key(string) - Chave do parceiro (Ex. Software House).
metadata(object) - Objeto opcional representativo de dados sobre o terminal do cliente.
metadata. terminal_state (string) - Sigla do estado em que o terminal está instalado.
metadata. terminal_id (string) - Código do terminal que está realizando a venda.
metadata. local_user (string) - Código ou Login do usuário local (na rede do cliente) que efetuou a transação.
statuses(array) - Retorna os status que a transação passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/insurances/transactions

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/insurances/transactions' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
              	{
            

              
              		"id": "2eed2f10-92fc-013d-6427-623e4ec8c5dc",
            

              
              		"product_id": "100210",
            

              
              		"area_code": "32",
            

              
              		"cell_phone_number": "994145351",
            

              
              		"status": "captured",
            

              
              		"created_at": "2024-12-02T16:55:39.605Z",
            

              
              		"updated_at": "2024-12-02T16:58:51.209Z",
            

              
              		"nsu": "000005533",
            

              
              		"authorization_code": "55473",
            

              
              		"face_amount": 3990,
            

              
              		"due_date": "2024-12-07T00:00:00.000Z",
            

              
              		"authorized_at": "2024-12-02T16:55:39.000Z",
            

              
              		"signer_code": "11111111111",
            

              
              		"charged_amount": 3790,
            

              
              		"affiliation_key": "",
            

              
              		"application_id": 1,
            

              
              		"birth_date": "1987-05-21",
            

              
              		"accepted": false,
            

              
              		"statuses": [
            

              
              			{
            

              
              				"status": "authorized",
            

              
              				"created_at": "2024-12-02T16:55:40.154Z"
            

              
              			},
            

              
              			{
            

              
              				"status": "captured",
            

              
              				"created_at": "2024-12-02T16:58:51.230Z"
            

              
              			}
            

              
              		],
            

              
              		"links": [
            

              
              			{
            

              
              				"href": null,
            

              
              				"rel": "register",
            

              
              				"type": "GET"
            

              
              			}
            

              
              		]
            

              
              	},
            

              
              	{
            

              
              		"id": "d7285bd0-92fc-013d-2491-1eb8c56e3742",
            

              
              		"product_id": "100210",
            

              
              		"area_code": "32",
            

              
              		"cell_phone_number": "994145351",
            

              
              		"status": "refunded",
            

              
              		"created_at": "2024-12-02T17:00:21.850Z",
            

              
              		"updated_at": "2024-12-02T17:00:53.119Z",
            

              
              		"nsu": "000006271",
            

              
              		"authorization_code": "55474",
            

              
              		"face_amount": 3990,
            

              
              		"due_date": "2024-12-07T00:00:00.000Z",
            

              
              		"authorized_at": "2024-12-02T17:00:22.000Z",
            

              
              		"signer_code": "11111111111",
            

              
              		"charged_amount": 3790,
            

              
              		"affiliation_key": "",
            

              
              		"application_id": 1,
            

              
              		"birth_date": "1987-05-21",
            

              
              		"accepted": false,
            

              
              		"statuses": [
            

              
              			{
            

              
              				"status": "authorized",
            

              
              				"created_at": "2024-12-02T17:00:22.353Z"
            

              
              			},
            

              
              			{
            

              
              				"status": "refunded",
            

              
              				"created_at": "2024-12-02T17:00:53.144Z"
            

              
              			}
            

              
              		],
            

              
              		"links": [
            

              
              			{
            

              
              				"href": "/transactions/d7285bd0-92fc-013d-2491-1eb8c56e3742",
            

              
              				"rel": "self",
            

              
              				"type": "GET"
            

              
              			}
            

              
              		]
            

              
              	}
            

              
              ]

COPIADO!

Portfólio

Esta API é responsável por informar os produtos e operadoras disponíveis.

Serviços disponíveis

GET

/portfolio/providers

GET

/portfolio

GET

/portfolio/providers/{product_name}/additional-information

Operadoras

Este serviço retornará todas as operadoras disponíveis em sua conta. Com estes dados em mãos, você poderá consultar os produtos disponíveis em sua conta, para então conseguir realizar uma transação de recarga.

                    A habilitação das operadoras deverá ocorrer diretamente com a RV Tecnologia

Retorno

provider(string) - Nome da operadora
kind(string) - Tipo da operadora
links(array) - Retorna os links das ações possíveis a serem realizadas com a transação partir do status atual dela.
links. rel (string) - Identificação da ação executada pelo href.
links. href (string) - Link de orientação
links. type (string) - Verbo HTTP a ser usado

GET

/portfolio/providers

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/portfolio/providers' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "provider": "GOOGLE PLAY",
            

              
                      "kind": "pin",
            

              
                      "links": [
            

              
                          {
            

              
                              "rel": "products",
            

              
                              "href": "/portfolio?provider=GOOGLE%20PLAY&kinds=pin",
            

              
                              "type": "get"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "provider": "SKY",
            

              
                      "kind": "tv",
            

              
                      "links": [
            

              
                          {
            

              
                              "rel": "products",
            

              
                              "href": "/portfolio?provider=SKY&kinds=tv",
            

              
                              "type": "get"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "provider": "VIVO",
            

              
                      "kind": "cellphone",
            

              
                      "links": [
            

              
                          {
            

              
                              "rel": "products",
            

              
                              "href": "/portfolio?provider=VIVO&kinds=cellphone",
            

              
                              "type": "get"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Produtos

Este serviço irá retornar uma lista de produtos, no qual você irá usar para realizar suas recargas. Você também poderá refinar sua busca utilizando alguns parâmetros na URL se assim desejar. Abaixo listamos os possíveis parâmetros para esta busca:

Parâmetros Opcionais

kinds(string) - Informar o tipo de produto. É possível passar mais de um separados por vírgula.
provider(string) - Informar o nome da operadora
area_code(string) - Informar o DDD no qual deseja realizar a busca
one_page(boolean) - Informar true para desabilitar a paginação padrão de 25 itens e retornar todos os produtos.

                    Alguns produtos possuem valor variável, neste caso deve ser usado o campo amount
com o valor que será recarregado, sempre obedecendo o valor mínimo e máximo do produto.

Retorno

provider(string) - Nome da operadora
kind(string) - Tipo de serviço de recarga que a operadora exerce
product_id(string) - Código do produto
name(string) - Nome do produto
amount(int) - Valor da recarga
expires_in(int) - Validada da recarga (em dias)
minimum_amount(int) - Valor mínimo variável
maximum_amount(int) - Valor máximo variável
incremental_rate(int) - Valor incremental da recarga, quando ela for variável.
fixed_amount(boolean) - Informa se é um produto de valor variável
area_codes(string) - Códigos de área (DDD) que o produto atua

GET

/portfolio

GET

/portfolio?kinds={kind1,kind2}&provider={provider}&area_code={area_code}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --location --request GET 'https://api.sbx.rvhub.com.br/portfolio?kinds=cellphone&area_code=22&provider=vivo' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "provider": "VIVO",
            

              
                      "kind": "cellphone",
            

              
                      "product_id": "1",
            

              
                      "name": "VIVO R$30",
            

              
                      "amount": 3000,
            

              
                      "expires_in": 30,
            

              
                      "minimum_amount": 3000,
            

              
                      "maximum_amount": 3000,
            

              
                      "incremental_rate": 0,
            

              
                      "fixed_amount": true,
            

              
                      "area_codes": [
            

              
                        "11",
            

              
                        "22",
            

              
                        "31"
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "provider": "VIVO",
            

              
                      "kind": "cellphone",
            

              
                      "product_id": "1",
            

              
                      "name": "VIVO R$30",
            

              
                      "amount": 3000,
            

              
                      "expires_in": 30,
            

              
                      "minimum_amount": 3000,
            

              
                      "maximum_amount": 3000,
            

              
                      "incremental_rate": 0,
            

              
                      "fixed_amount": true,
            

              
                      "area_codes": [
            

              
                        "11",
            

              
                        "22",
            

              
                        "31"
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Informações adicionais

Este serviço irá retornar as informações adicionais das operadoras sobre o produto informado.

Parâmetros

product_name(string) - Informar o nome da operadora

Retorno

name(string) - Nome do produto
description(string) - Descrição das informações
terms_and_conditions(string) - Termos e condições informados pela operadora
redemption_instructions(string) - Instruções para o usuário enviado pela operadora
logo(int) - Imagem em Base64 informada para auxílio das informações.
id(string) - Identificador único da conta baseado em UUIDs V4

GET

/portfolio/providers/{product_name}/additional-information

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --location --request GET 'https://api.sbx.rvhub.com.br/portfolio/providers/vivo/additional-information' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA=='

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "name": "Spotify",
            

              
                  "description": "Pague sua própria assinatura ou presenteie alguém especial.",
            

              
                  "terms_and_conditions": "Resgatável somente para os meses de assinatura Premium individual de valor cheio via spotify.com. Indisponível para resgates de assinaturas com desconto ou de grupo. Não pode ser resgatada em espécie ou via crédito, e não pode ser retornada ou revendida (exceto quando solicitado por lei). Você deve cadastrar ou ter uma conta Spotify, ser maior de 16 anos e residir no país da compra. Uso único: o valor nominal total para uma conta individual é descontado no momento do resgate e nenhum resgate adicional é permitido. O Spotify não se responsabiliza por nenhuma perda ou dano que resulte de uso perdido, roubado ou não autorizado. Os termos completos se aplicam, visite www.spotify.com/gift-card. Fornecido por Spotify AB, número de registro 556786-5729. Deve ser resgatado dentro de 12 mês após a compra. Após esse período, o PIN expirará.",
            

              
                  "redemption_instructions": "Para resgatar, insira o PIN em spotify.com/redeem.",
            

              
                  "logo": "/9j/7AARRHVja3kAAQAEAAAAUAAA/+4ADkFkb2JlAGTAAAAAAf",
            

              
                  "id": "663d0070-c50c-0138-27e5-5a5b2dd7b91d"
            

              
              }

COPIADO!

Consulta de saldos

Utilizando este serviço você terá acesso ao saldo atual da sua conta. Podendo então controlar corretamente suas requisições.

Retorno

store(string) - Nome da loja
balance(array) - Objeto referente ao saldo da loja
balance. credit_limit (int) - Limite de crédito cadastrado para a loja
balance. available_limit (int) - Limite disponível na loja
balance. antecipated (int) - Crédito antecipado da loja
balance. open_amount (int) - Valores em aberto da loja (compras não pagas, inclusive a vencer)

GET

/accounts

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --location --request GET 'https://api.sbx.rvhub.com.br/accounts' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "store": "rvhub",
            

              
                  "balance": {
            

              
                      "credit_limit": 0,
            

              
                      "available_limit": 0,
            

              
                      "antecipated": 176817,
            

              
                      "open_amount": 0
            

              
                  }
            

              
              }

COPIADO!

Boletos

Esta API é responsável pela criação e listagem de boletos. O pagamento destes boletos adicionará saldo a conta, e este saldo poderá ser usado nas Recargas de Celular, Recargas de PIN e Recargas de TV.

Serviços disponíveis

POST

/account-topups/bills/cash-in

GET

/account-topups/bills

Emissão de boletos antecipados

Com esta API é possível criar um boleto antecipado (pré-pago) para adicionar saldo na conta, para ser utilizado na Recargas de Celular, Recargas de PIN e Recargas de TV, além do Pagamento de Contas.

Parâmetros

amount(int) - Deve ser informado o valor do boleto em formato inteiro sem pontuação

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4
issuer_name(string) - Nome da instituição financeira emissora
issuer_code(string) - Código da instituição financeira emissora
amount(int) - Valor enviado no corpo da requisição
due_date(string) - Data de vencimento do boleto
issue_date(string) - Data de emissão do boleto
our_number(string) - Código de controle que permite à instituição destinatária e ao beneficiário identificar os dados da cobrança que deu origem ao Boleto de Pagamento. Esta verificação é feita junto as instituições financeiras.
issuer_branch(string) - Agência da instituição financeira que gerou a cobrança
issuer_wallet(string) - Carteira da instituição financeira
digitable_line(string) - Linha digitável
barcode(string) - Código de barras
kind(string) - Tipo da transação onde pode ser prepaid (clientes com limite pré-pago) ou pospaid (clientes com limite pós-pago)
informations(array) - Informações enviadas pela instituição finaneira.

POST

/account-topups/bills/cash-in

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST 'https://api.sbx.rvhub.com.br/account-topups/bills/cash-in' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
              	"amount": 5000
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "ed3481d0-b3d8-0138-fc5f-126d5814f6d5",
            

              
                  "issuer_name": "BRADESCO",
            

              
                  "issuer_code": 237,
            

              
                  "amount": 80000,
            

              
                  "due_date": "2020-08-03T00:00:00.000Z",
            

              
                  "issue_date": "2020-07-29T00:00:00.000Z",
            

              
                  "our_number": 9,
            

              
                  "issuer_branch": "1234-3/0012345-5",
            

              
                  "issuer_wallet": "9",
            

              
                  "digitable_line": "23791.23405 90000.000241 63001.234507 6 83360000080000",
            

              
                  "barcode": "23796833600000800001234090000000246300123450",
            

              
                  "kind": "prepaid",
            

              
                  "informations": [
            

              
                      "Pagável na rede bancária até a data de vencimento.",
            

              
                      "MULTA MORA 2% JUROS 5% a.m."
            

              
                  ]
            

              
              }

COPIADO!

Recuperar boletos

Para listar todos os seus boletos, basta invocar este serviço e você receberá um array com todos os boletos em aberto.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

issue_date(string) - Informar a data de emissão no seguite padrão DD-MM-YYYY
amount(int) - Informar o valor do boleto.

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/account-topups/bills/cash-in?amount=5000

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
issuer_name(string) - Nome da instituição financeira emissora
issuer_code(string) - Código da instituição financeira emissora
amount(int) - Valor do boleto
due_date(string) - Data de vencimento do boleto
issue_date(string) - Data de emissão do boleto
our_number(string) - Código de controle que permite à instituição destinatária e ao beneficiário identificar os dados da cobrança que deu origem ao Boleto de Pagamento. Esta verificação é feita junto as instituições financeiras.
issuer_branch(string) - Agência da instituição financeira que gerou a cobrança
issuer_wallet(string) - Carteira da instituição financeira
digitable_line(string) - Linha digitável
barcode(string) - Código de barras
kind(string) - Tipo da transação onde pode ser prepaid (clientes com limite pré-pago) ou pospaid (clientes com limite pós-pago)
informations(array) - Informações enviadas pela instituição finaneira.

GET

/account-topups/bills

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/account-topups/bills/cash-in' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "id": "c3b22d80-aced-0138-e6cc-5a9c85a494fb",
            

              
                      "issuer_name": "BRADESCO",
            

              
                      "issuer_code": 237,
            

              
                      "amount": 5000,
            

              
                      "due_date": "2020-10-10T00:00:00.000Z",
            

              
                      "issue_date": "2020-07-20T00:00:00.000Z",
            

              
                      "our_number": 9,
            

              
                      "issuer_branch": "1234-3/0012345-5",
            

              
                      "issuer_wallet": "9",
            

              
                      "digitable_line": "23791.23405 90000.000142 77001.234507 3 84040000005000",
            

              
                      "barcode": "23793840400000050001234090000000147700123450",
            

              
                      "kind": "postpaid",
            

              
                      "informations": [
            

              
                          "Pagável na rede bancária até a data de vencimento.",
            

              
                          "MULTA MORA 2% JUROS 5% a.m."
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "id": "ed3481d0-b3d8-0138-fc5f-126d5814f6d5",
            

              
                      "issuer_name": "BRADESCO",
            

              
                      "issuer_code": 237,
            

              
                      "amount": 80000,
            

              
                      "due_date": "2020-08-03T00:00:00.000Z",
            

              
                      "issue_date": "2020-07-29T00:00:00.000Z",
            

              
                      "our_number": 9,
            

              
                      "issuer_branch": "1234-3/0012345-5",
            

              
                      "issuer_wallet": "9",
            

              
                      "digitable_line": "23791.23405 90000.000241 63001.234507 6 83360000080000",
            

              
                      "barcode": "23796833600000800001234090000000246300123450",
            

              
                      "kind": "prepaid",
            

              
                      "informations": [
            

              
                          "Pagável na rede bancária até a data de vencimento.",
            

              
                          "MULTA MORA 2% JUROS 5% a.m."
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Pagamento de contas

Esta API é responsável por todas as operações referentes a pagamento de contas. Para realizar o pagamento de contas deve haver saldo pré pago disponível.

Serviços disponíveis

POST

/bills/payments

POST

/bills/payments/{id_bill_payment}/capture

DELETE

/bills/payments/{id_bill_payment}

GET

/bills/payments/{id_bill_payment}

GET

/bills/payments

Solicitar pagamento

A primeira etapa do pagamento de conta é solicitar o pagamento, informando o código de barras barcode ou a linha digitável digitable_line no corpo da requisição.

                    Para esta requisição é obrigatório o envio do 
cabeçalho HTTP (header) 
X-Idempotency-Key

Parâmetros

barcode(string) - Informar o código de barras da conta

                    Para solicitar o pagamento de uma conta pela linha digitável, deve-se substituir o campo barcode pelo campo digitable_line
no body da requisição.

Retorno

digitable_line(string) - Representação numérica (linha digitável) do boleto
status(string) - Status do pagamento
amount(int) - Valor nominal definido para pagamento
created_at(string) - Data da criação do pagamento
updated_at(string) - Data que o pagamento sofreu alguma atualização
discount(int) - Valor do desconto com data pré definida
interest_rate(int) - Valor do juros após validade do boleto
due_date(string) - Data de vencimento
payee_document(string) - Documento do beneficiário
payer_document(string) - Documento do pagador
payee_name(string) - Nome do beneficiário
payee_company_name(string) - Nome da empresa do beneficiário
payer_name(string) - Nome do pagador
additional_information(string) - Informações adicionais do pagamento
fine(int) - Soma de valores por atraso no pagamento
total_amount_can_be_changed(boolean) - Permite ajuste na instrução do boleto
partial_payment(boolean) - Permite realizar pagamentos com valores parciais do nominal do boleto
bill_type(string) - Identifica o tipo de cobrança como boleto
duplicate_payment_allowed(string) - Indica se está autorizado o pagamento repetido
min_amount(int) - Valor mínimo recebível discriminado no momento da emissão
total_amount(int) - Valor total da fatura com a soma dos encargos
max_amount(int) - Valor máximo recebível discriminado no momento da emissão
other_info(string) - Outras informações
id(string) - Identificador único do pagamento baseado em UUIDs V4
statuses(array) - Retorna os status que o pagamento passou.

statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com o pagamento partir do status atual.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

POST

/bills/payments

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request POST '/bills/payments/payments/{id_bill_payment}/process%%' \
            

              
              --header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \
            

              
              --data-raw '{
            

              
              	"barcode": "34195829300000115651091065407741500052061000"
            

              
              }'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "barcode": "03398000000000000009492836981922600010320102",
            

              
                  "digitable_line": "033994928136981922606001032010268000",
            

              
                  "status": "awaiting_payment",
            

              
                  "amount": 24996,
            

              
                  "due_date": "2020-08-23",
            

              
                  "created_at": "2021-05-19T14:57:50.483Z",
            

              
                  "updated_at": "2021-05-19T14:57:50.483Z",
            

              
                  "payee_document": "90443888000142",
            

              
                  "payer_document": "26541298845",
            

              
                  "discount": 0,
            

              
                  "interest_rate": 0,
            

              
                  "fine": 0,
            

              
                  "payee_name": "SANTANDER CARTAO FREE GOLD MC - 1128",
            

              
                  "payer_name": "NOME DO PAGADOR",
            

              
                  "total_amount_can_be_changed": true,
            

              
                  "partial_payment": true,
            

              
                  "payee_company_name": "SANTANDER CARTAO FREE GOLD MC - 1244",
            

              
                  "payment_kind_allowed": "any_amount",
            

              
                  "bill_type": "Boleto",
            

              
                  "duplicate_payment_allowed": false,
            

              
                  "min_amount": 1,
            

              
                  "total_amount": 24996,
            

              
                  "payment_limit_date": "2029-08-23",
            

              
                  "max_amount": 99999999999900,
            

              
                  "other_info": {},
            

              
                  "payer": {},
            

              
                  "id": "8147fd30-9ae0-0139-81ce-3250f474fbdd",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_payment",
            

              
                          "created_at": "2021-05-19T14:57:50.501Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/payments/8147fd30-9ae0-0139-81ce-3250f474fbdd",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Aprovar pagamento

Após solicitar o pagamento, será preciso aprovar sua solicitação, para fazer isso você deverá chamar esta requisição informando o parâmetro id_bill_payment, que neste caso, é o ID retornado após executar a requisição anterior, Solicitar pagamento.

                    Após confirmação do pagamento, o cancelamento não será mais possível.

Diferentemente de outras requisições, nesta, deveremos identificar qual conta estamos pagando para enviar o body corretamente. Atualmente trabalhamos com Títulos (boletos rigistrados na CIP), Consumo (Contas de luz, água, telefone, etc.) e Tributos (DAMSP, DARF, DAS e FGTS) . Fiquemos atentos, pois para cada um, há pequenas diferenciações no body da requisição:

Títulos e Consumo

LINGUAGEM: JSON


              
              {
            

              
                  "paid_amount": 1000,
            

              
                  "payer": {
            

              
                      "name": "NOME DO PAGADOR", //obrigatório
            

              
                      "document": "26540468545", //obrigatório
            

              
                      "latitude": "19.9868941", //opcional
            

              
                      "longitude": "-43.9482777", //opcional
            

              
                      "device": { //opcional
            

              
                          "id": "234141",
            

              
                          "name": "nome",
            

              
                          "manufacturer": "FABRICANTE",
            

              
                          "version": "VERSAO",
            

              
                          "fingerprint": "IMPRESSAO DIGITAL",
            

              
                          "carrier": "OPERADORA",
            

              
                          "country": "PAIS",
            

              
                          "locale": "LOCAL",
            

              
                          "ip": "192.168.0.1"
            

              
                      }
            

              
                  },
            

              
                  "callback": "https://webhook.site/ba36-fd005744c922", //opcional
            

              
                  "description": "Teste do callback" //opcional
            

              
              }

COPIADO!

DAMSP

LINGUAGEM: JSON


              
              {
            

              
                  "paid_amount": 3733, 
            

              
                  "description": "BHTRANS", //opcional
            

              
                  "revenue": {  //opcional
            

              
                      "code": 3317,
            

              
                      "description": "PAGAMENTO MULTA"
            

              
                  },
            

              
                  "payer": { //opcional
            

              
                      "latitude": "19.9868941",
            

              
                      "longitude": "-43.9482777",
            

              
                      "device": {
            

              
                          "id": "234141",
            

              
                          "name": "nome",
            

              
                          "manufacturer": "FABRICANTE",
            

              
                          "version": "VERSAO",
            

              
                          "fingerprint": "IMPRESSAO DIGITAL",
            

              
                          "carrier": "OPERADORA",
            

              
                          "country": "PAIS",
            

              
                          "locale": "LOCAL",
            

              
                          "ip": "192.168.0.1"
            

              
                      }
            

              
                  },
            

              
                  "callback": "https://webhook.site/ba36-fd005744c922", //opcional
            

              
                  "determination_period": "2020-03-05",
            

              
                  "main_amount": 3733,
            

              
                  "fine": 0 //opcional
            

              
              
            

              
              }

COPIADO!

DARF

LINGUAGEM: JSON


              
              {
            

              
                  "paid_amount": 3733,
            

              
                  "description": "CNH", //opcional
            

              
                  "revenue": {
            

              
                      "code": 3317,
            

              
                      "description": "Renovação da CNH" //opcional
            

              
                  },
            

              
                  "darf": {
            

              
                      "taxpayer": {
            

              
                          "full_name": "José da Silva",
            

              
                          "phone": "31999996666", //opcional
            

              
                          "document": "12345678910"
            

              
                      }
            

              
                  },
            

              
                  "payer": { //opcional
            

              
                      "latitude": "19.9868941",
            

              
                      "longitude": "-43.9482777",
            

              
                      "device": {
            

              
                          "id": "234141",
            

              
                          "name": "nome",
            

              
                          "manufacturer": "FABRICANTE",
            

              
                          "version": "VERSAO",
            

              
                          "fingerprint": "IMPRESSAO DIGITAL",
            

              
                          "carrier": "OPERADORA",
            

              
                          "country": "PAIS",
            

              
                          "locale": "LOCAL",
            

              
                          "ip": "192.168.0.1"
            

              
                      }
            

              
                  },
            

              
                  "callback": "https://webhook.site/ba36-fd005744c922", //opcional
            

              
                  "determination_period": "2020-03-05",
            

              
                  "main_amount": 3733,
            

              
                  "fine": 0 //opcional
            

              
              }

COPIADO!

DAS

LINGUAGEM: JSON


              
              {
            

              
                  "paid_amount": 3733,
            

              
                  "description": "Simples Nacional", //opcional
            

              
                  "determination_period": "2020-03-05",
            

              
                  "main_amount": 3733,
            

              
                  "payer": { //opcional
            

              
                          "latitude": "19.9868941",
            

              
                          "longitude": "-43.9482777",
            

              
                          "device": {
            

              
                              "id": "234141",
            

              
                              "name": "nome",
            

              
                              "manufacturer": "FABRICANTE",
            

              
                              "version": "VERSAO",
            

              
                              "fingerprint": "IMPRESSAO DIGITAL",
            

              
                              "carrier": "OPERADORA",
            

              
                              "country": "PAIS",
            

              
                              "locale": "LOCAL",
            

              
                              "ip": "192.168.0.1"
            

              
                          }
            

              
                      },
            

              
                  "callback": "https://webhook.site/ba36-fd005744c922", //opcional
            

              
                  "fine": 0 //opcional
            

              
              }

COPIADO!

FGTS

LINGUAGEM: JSON


              
              {
            

              
                  "paid_amount": 3733,
            

              
                  "description": "Recolhimento do FGTS", //opcional
            

              
                  "fgts": {
            

              
                      "taxpayer_identification_type": "", //opcional
            

              
                      "collection": { //opcional
            

              
                          "type_registration": "",
            

              
                          "id": "",
            

              
                          "check_digit": "",
            

              
                          "code": ""
            

              
                      }
            

              
                  },
            

              
                  "payer": { //opcional
            

              
                          "latitude": "19.9868941",
            

              
                          "longitude": "-43.9482777",
            

              
                          "device": {
            

              
                              "id": "234141",
            

              
                              "name": "nome",
            

              
                              "manufacturer": "FABRICANTE",
            

              
                              "version": "VERSAO",
            

              
                              "fingerprint": "IMPRESSAO DIGITAL",
            

              
                              "carrier": "OPERADORA",
            

              
                              "country": "PAIS",
            

              
                              "locale": "LOCAL",
            

              
                              "ip": "192.168.0.1"
            

              
                          }
            

              
                      },
            

              
                  "callback": "https://webhook.site/ba36-fd005744c922", //opcional
            

              
                  "determination_period": "2020-03-05",
            

              
                  "main_amount": 3733,
            

              
                  "fine": 0 //opcional
            

              
              }

COPIADO!

Parâmetro na URL

id_bill_payment(string) - Identificador único do pagamento retornado no momento em que é solicitado um pagamento.

Parâmetros no Body

paid_amount(string) - Valor pago no documento.
description(string) - Descrição referente ao pagamento
determination_period(string) - Data de apuração do documento
main_amount(string) - Valor total do documento
fine(string) - Valor referente a multa no documento.
payer(object) - Objeto informado opcionalmente no envio de Títulos e Consumo. Neste campo iremos tratar das informações do usuário que realizou o pagamento.
payer. name (string) - Nome do pagador
payer. document (string) - Documento do pagador
payer. latitude (string) - Latitude do usuário
payer. longitude (string) - Longitude do usuário
payer. device (string) - Objeto referente ao dados do dispositivo do usuário
payer.device id (string) - Id do dispositivo do usuário
payer.device name (string) - Nome do dispositivo do usuário
payer.device manufacturer (string) - Fabricante do dispositivo do usuário
payer.device version (string) - Versão do dispositivo do usuário
payer.device fingerprint (string) - Impressão digital do dispositivo do usuário
payer.device carrier (string) - Operadora do dispositivo do usuário
payer.device country (string) - País do dispositivo do usuário
payer.device locale (string) - Local do dispositivo do usuário
payer.device ip (string) - IP do dispositivo do usuário
callback(string) - Callback refere-se ao campo onde o cliente irá informar um endpoint criado por ele mesmo, para receber nosso retorno via POST (ID do pagamento e o Status do pagamento) após Confirmação ou Desfazimento de Pagamento de contas

revenue(object) - Objeto informado quando o documento for da Receita Federal, informado nos documentos DAMSP e DARF
revenue. code (string) - Código da Receita Federal para esta transação
revenue. description (string) - Descrição da Receita Federal para esta transação
darf(object) - Objeto informado quando o documento for uma DARF
darf. taxpayer (object) - Dados referente ao contribuínte.
darf.taxpayer. full_name (string) - Nome completo do contribuínte
darf.taxpayer. phone (string) - Telefone do contribuínte
darf.taxpayer. document (string) - Documento de identificação do contribuínte, neste caso CPF ou CNPJ. Deve ser informado apenas numeros.
fgts(object) - Objeto informado quando o documento for uma guia de FGTS
fgts. taxpayer_identification_type (string) - Tipo de identificação do contribuínte. 1 - para CPF e 2 - para CNPJ
fgts. collection (object) - Objeto referente ao recolhimento.
fgts.collection. type_registration (string) - Tipo de registro
fgts.collection. id (string) - Código referente ao recolhimento
fgts.collection. check_digit (string) - Dígito verificador referente ao recolhimento.
fgts.collection. code (string) - Código referente ao recolhimento

Retorno

digitable_line(string) - Representação numérica (linha digitável) do boleto
status(string) - Status do pagamento
amount(int) - Valor nominal definido para pagamento
created_at(string) - Data da criação do pagamento
updated_at(string) - Data que o pagamento sofreu alguma atualização
discount(int) - Valor do desconto com data pré definida
interest_rate(int) - Valor do juros após validade do boleto
due_date(string) - Data de vencimento
payee_document(string) - Documento do beneficiário
payer_document(string) - Documento do pagador
payee_name(string) - Nome do beneficiário
payee_company_name(string) - Nome da empresa do beneficiário
payer_name(string) - Nome do pagador
additional_information(string) - Informações adicionais do pagamento
fine(int) - Soma de valores por atraso no pagamento
total_amount_can_be_changed(boolean) - Permite ajuste na instrução do boleto
partial_payment(boolean) - Permite realizar pagamentos com valores parciais do nominal do boleto
bill_type(string) - Identifica o tipo de cobrança como boleto
duplicate_payment_allowed(string) - Indica se está autorizado o pagamento repetido
min_amount(int) - Valor mínimo recebível discriminado no momento da emissão
total_amount(int) - Valor total da fatura com a soma dos encargos
max_amount(int) - Valor máximo recebível discriminado no momento da emissão
other_info(string) - Outras informações
id(string) - Identificador único do pagamento baseado em UUIDs V4
statuses(array) - Retorna os status que o pagamento passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com o pagamento partir do status atual.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

                    Note que conforme são alterados os status da solicitação, serão acrescentados
no campo statuses como forma de histórico para a sua solicitação.

POST

/bills/payments/{id_bill_payment}/capture

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "approved",
            

              
                  "description": "Teste",
            

              
                  "paid_amount": 1153600,
            

              
                  "other_info": {},
            

              
                  "barcode": "65596666600011536000000002208500000001706400",
            

              
                  "digitable_line": "65590000066666660000500017064007483620001153600",
            

              
                  "total_amount": 1153600,
            

              
                  "amount": 1153600,
            

              
                  "due_date": "2020-08-29",
            

              
                  "created_at": "2020-08-27T19:16:18.556Z",
            

              
                  "updated_at": "2020-08-27T19:16:31.767Z",
            

              
                  "payee_document": "12345678910",
            

              
                  "payer_document": "12345678910",
            

              
                  "discount": 0,
            

              
                  "interest_rate": 0,
            

              
                  "fine": 0,
            

              
                  "payee_name": "RV TECNOLOGIA",
            

              
                  "payer_name": "RV TECNOLOGIA",
            

              
                  "total_amount_can_be_changed": false,
            

              
                  "partial_payment": false,
            

              
                  "payee_company_name": "RV TECNOLOGIA",
            

              
                  "payment_kind_allowed": "not_allowed_diverging_value",
            

              
                  "bill_type": "Boleto",
            

              
                  "duplicate_payment_allowed": false,
            

              
                  "min_amount": 0,
            

              
                  "payment_limit_date": "2020-12-27",
            

              
                  "max_amount": 1153600,
            

              
                  "id": "b5587d70-cac7-0138-e27c-429a57666956",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_payment",
            

              
                          "created_at": "2020-08-27T19:16:18.563Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "awaiting_processing",
            

              
                          "created_at": "2020-08-27T19:42:01.412Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "approved",
            

              
                          "created_at": "2020-08-27T19:16:31.774Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/payments/b5587d70-cac7-0138-e27c-429a57666956",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Desfazimento de pagamento

Para cancelar uma solicitação de pagamento, é preciso chamar a requisição de desfazimento, bastando apenas enviar o parâmetro id_bill_payment na URL da requisição pelo verbo HTTP DELETE. Veja o exemplo para compreender melhor.

                    Somente é possível desfazer uma solicitação que ainda não foi confirmada. Após confirmação
não será mais possível desfazer esta solicitação.

Parâmetros

id_bill_payment(string) - Identificador único do pagamento retornado no momento em que é solicitado um pagamento.

Retorno

digitable_line(string) - Representação numérica (linha digitável) do boleto
status(string) - Status do pagamento
amount(int) - Valor nominal definido para pagamento
created_at(string) - Data da criação do pagamento
updated_at(string) - Data que o pagamento sofreu alguma atualização
discount(int) - Valor do desconto com data pré definida
interest_rate(int) - Valor do juros após validade do boleto
due_date(string) - Data de vencimento
payee_document(string) - Documento do beneficiário
payer_document(string) - Documento do pagador
payee_name(string) - Nome do beneficiário
payee_company_name(string) - Nome da empresa do beneficiário
payer_name(string) - Nome do pagador
additional_information(string) - Informações adicionais do pagamento
fine(int) - Soma de valores por atraso no pagamento
total_amount_can_be_changed(boolean) - Permite ajuste na instrução do boleto
partial_payment(boolean) - Permite realizar pagamentos com valores parciais do nominal do boleto
bill_type(string) - Identifica o tipo de cobrança como boleto
duplicate_payment_allowed(string) - Indica se está autorizado o pagamento repetido
min_amount(int) - Valor mínimo recebível discriminado no momento da emissão
total_amount(int) - Valor total da fatura com a soma dos encargos
max_amount(int) - Valor máximo recebível discriminado no momento da emissão
other_info(string) - Outras informações
id(string) - Identificador único do pagamento baseado em UUIDs V4
statuses(array) - Retorna os status que o pagamento passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com o pagamento partir do status atual.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

DELETE

/bills/payments/{id_bill_payment}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request DELETE 'https://api.sbx.rvhub.com.br/bills/payments/80d39510-6ac3-0138-4336-56e1314b0560' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json' \

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "status": "cancelled",
            

              
                  "barcode": "03398000000000000009492836981922600010320102",
            

              
                  "digitable_line": "033994928136981922606001032010268000",
            

              
                  "amount": 24996,
            

              
                  "due_date": "2020-08-23",
            

              
                  "created_at": "2021-05-19T14:57:50.483Z",
            

              
                  "updated_at": "2021-05-19T17:45:40.051Z",
            

              
                  "payee_document": "90400888010142",
            

              
                  "payer_document": "26540498345",
            

              
                  "discount": 0,
            

              
                  "interest_rate": 0,
            

              
                  "fine": 0,
            

              
                  "payee_name": "SANTANDER CARTAO FREE GOLD MC - 2123",
            

              
                  "payer_name": "NOME DO PAGADOR",
            

              
                  "total_amount_can_be_changed": true,
            

              
                  "partial_payment": true,
            

              
                  "payee_company_name": "SANTANDER CARTAO FREE GOLD MC - 3213",
            

              
                  "payment_kind_allowed": "any_amount",
            

              
                  "bill_type": "Boleto",
            

              
                  "duplicate_payment_allowed": false,
            

              
                  "min_amount": 1,
            

              
                  "total_amount": 24996,
            

              
                  "payment_limit_date": "2029-08-23",
            

              
                  "max_amount": 99999999999900,
            

              
                  "other_info": {},
            

              
                  "payer": {},
            

              
                  "id": "8147fd30-9ae0-0139-81ce-3250f474fbdd",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_payment",
            

              
                          "created_at": "2021-05-19T14:57:50.501Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "cancelled",
            

              
                          "created_at": "2021-05-19T17:45:40.064Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/payments/8147fd30-9ae0-0139-81ce-3250f474fbdd",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Consulta de pagamento

Para consultar seus pagamentos, basta invocar este serviço e informar o parâmetro id_bill_payment na URL.

Parâmetros

id_bill_payment(string) - Identificador único do pagamento retornado no momento em que é solicitado um pagamento.

Retorno

digitable_line(string) - Representação numérica (linha digitável) do boleto
status(string) - Status do pagamento
amount(int) - Valor nominal definido para pagamento
created_at(string) - Data da criação do pagamento
updated_at(string) - Data que o pagamento sofreu alguma atualização
discount(int) - Valor do desconto com data pré definida
interest_rate(int) - Valor do juros após validade do boleto
due_date(string) - Data de vencimento
payee_document(string) - Documento do beneficiário
payer_document(string) - Documento do pagador
payee_name(string) - Nome do beneficiário
payee_company_name(string) - Nome da empresa do beneficiário
payer_name(string) - Nome do pagador
additional_information(string) - Informações adicionais do pagamento
fine(int) - Soma de valores por atraso no pagamento
total_amount_can_be_changed(boolean) - Permite ajuste na instrução do boleto
partial_payment(boolean) - Permite realizar pagamentos com valores parciais do nominal do boleto
bill_type(string) - Identifica o tipo de cobrança como boleto
duplicate_payment_allowed(string) - Indica se está autorizado o pagamento repetido
min_amount(int) - Valor mínimo recebível discriminado no momento da emissão
total_amount(int) - Valor total da fatura com a soma dos encargos
max_amount(int) - Valor máximo recebível discriminado no momento da emissão
other_info(string) - Outras informações
id(string) - Identificador único do pagamento baseado em UUIDs V4
statuses(array) - Retorna os status que o pagamento passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com o pagamento partir do status atual.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/bills/payments/{id_bill_payment}

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/bills/payments/d70603c0-6ac0-0138-d1f7-6a4d3f76afc8' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "description": "",
            

              
                  "paid_amount": 3733,
            

              
                  "payer": {},
            

              
                  "authorization_code": "3027848569",
            

              
                  "barcode": "03398000000000000009492836981922600010320102",
            

              
                  "digitable_line": "033994928136981922606001032010268000",
            

              
                  "status": "approved",
            

              
                  "amount": 24996,
            

              
                  "due_date": "2020-08-23",
            

              
                  "created_at": "2021-05-19T17:47:31.146Z",
            

              
                  "updated_at": "2021-05-19T17:47:45.721Z",
            

              
                  "payee_document": "90400288800142",
            

              
                  "payer_document": "26540249845",
            

              
                  "discount": 0,
            

              
                  "interest_rate": 0,
            

              
                  "fine": 0,
            

              
                  "payee_name": "SANTANDER CARTAO FREE GOLD MC - 123213",
            

              
                  "payer_name": "NOME DO PAGADOR",
            

              
                  "total_amount_can_be_changed": true,
            

              
                  "partial_payment": true,
            

              
                  "payee_company_name": "SANTANDER CARTAO FREE GOLD MC - 231321",
            

              
                  "payment_kind_allowed": "any_amount",
            

              
                  "bill_type": "Boleto",
            

              
                  "duplicate_payment_allowed": false,
            

              
                  "min_amount": 1,
            

              
                  "total_amount": 24996,
            

              
                  "payment_limit_date": "2029-08-23",
            

              
                  "max_amount": 99999999999900,
            

              
                  "other_info": {
            

              
                      "determination_period": "2020-03-05",
            

              
                      "main_amount": 3733,
            

              
                      "fine": 0
            

              
                  },
            

              
                  "id": "356de010-9af8-0139-f66e-52f4cf85f143",
            

              
                  "statuses": [
            

              
                      {
            

              
                          "status": "awaiting_payment",
            

              
                          "created_at": "2021-05-19T17:47:31.157Z"
            

              
                      },
            

              
                       {
            

              
                          "status": "awaiting_processing",
            

              
                          "created_at": "2020-08-27T19:42:01.412Z"
            

              
                      },
            

              
                      {
            

              
                          "status": "approved",
            

              
                          "created_at": "2021-05-19T17:47:45.736Z"
            

              
                      }
            

              
                  ],
            

              
                  "links": [
            

              
                      {
            

              
                          "href": "/payments/356de010-9af8-0139-f66e-52f4cf85f143",
            

              
                          "rel": "self",
            

              
                          "type": "GET"
            

              
                      }
            

              
                  ]
            

              
              }

COPIADO!

Lista de pagamento

Para listar todos os seus pagamentos, basta invocar este serviço e você receberá um array com todas as movimentações.

                    Este serviço, por conter uma gama de dados ilimitados no retorno,
suporta o recurso de 
paginação.

Parâmetros Opcionais

statuses(string) - Informar o status(awaiting_payment, denied, approved, cancelled, captured, refunded) do pagamento.
start_date(string) - Informar a data inicial no seguite padrão DD-MM-YYYY
end_date(string) - Informar a data final no seguite padrão DD-MM-YYYY
amount(int) - Informar o valor do boleto.

                    Estes filtros são passados via 
Query String.

Ex. https://api.sbx.rvhub.com.br/bills/payments?statuses=awaiting_payment

                    No filtro statuses é possivel ser enviado mais de um status
separado por virgula.
Ex. https://api.sbx.rvhub.com.br/bills/payments?statuses=awaiting_payment,captured

Retorno

digitable_line(string) - Representação numérica (linha digitável) do boleto
status(string) - Status do pagamento
amount(int) - Valor nominal definido para pagamento
created_at(string) - Data da criação do pagamento
updated_at(string) - Data que o pagamento sofreu alguma atualização
discount(int) - Valor do desconto com data pré definida
interest_rate(int) - Valor do juros após validade do boleto
due_date(string) - Data de vencimento
payee_document(string) - Documento do beneficiário
payer_document(string) - Documento do pagador
payee_name(string) - Nome do beneficiário
payee_company_name(string) - Nome da empresa do beneficiário
payer_name(string) - Nome do pagador
additional_information(string) - Informações adicionais do pagamento
fine(int) - Soma de valores por atraso no pagamento
total_amount_can_be_changed(boolean) - Permite ajuste na instrução do boleto
partial_payment(boolean) - Permite realizar pagamentos com valores parciais do nominal do boleto
bill_type(string) - Identifica o tipo de cobrança como boleto
duplicate_payment_allowed(string) - Indica se está autorizado o pagamento repetido
min_amount(int) - Valor mínimo recebível discriminado no momento da emissão
total_amount(int) - Valor total da fatura com a soma dos encargos
max_amount(int) - Valor máximo recebível discriminado no momento da emissão
other_info(string) - Outras informações
id(string) - Identificador único do pagamento baseado em UUIDs V4
statuses(array) - Retorna os status que o pagamento passou.
statuses. status (string) - Tipo de status
statuses. created_at (string) - Data em que foi criado o status
links(array) - Retorna os links das ações possíveis a serem realizadas com o pagamento partir do status atual.
links. href (string) - Link de orientação
links. rel (string) - Identificação da ação executada pelo href.
links. type (string) - Verbo HTTP a ser usado

GET

/bills/payments

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/bills/payments' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              [
            

              
                  {
            

              
                      "barcode": "03398000000000000009492836981922600010320102",
            

              
                      "digitable_line": "033994928136981922606001032010268000",
            

              
                      "status": "cancelled",
            

              
                      "amount": 24996,
            

              
                      "due_date": "2020-08-23",
            

              
                      "created_at": "2021-05-19T14:57:50.483Z",
            

              
                      "updated_at": "2021-05-19T17:45:40.051Z",
            

              
                      "payee_document": "90400823100142",
            

              
                      "payer_document": "26540468545",
            

              
                      "discount": 0,
            

              
                      "interest_rate": 0,
            

              
                      "fine": 0,
            

              
                      "payee_name": "SANTANDER CARTAO FREE GOLD MC - 2313",
            

              
                      "payer_name": "NOME DO PAGADOR",
            

              
                      "total_amount_can_be_changed": true,
            

              
                      "partial_payment": true,
            

              
                      "payee_company_name": "SANTANDER CARTAO FREE GOLD MC - 2313",
            

              
                      "payment_kind_allowed": "any_amount",
            

              
                      "bill_type": "Boleto",
            

              
                      "duplicate_payment_allowed": false,
            

              
                      "min_amount": 1,
            

              
                      "total_amount": 24996,
            

              
                      "payment_limit_date": "2029-08-23",
            

              
                      "max_amount": 99999999999900,
            

              
                      "other_info": {},
            

              
                      "payer": {},
            

              
                      "id": "8147fd30-9ae0-0139-81ce-3250f474fbdd",
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "awaiting_payment",
            

              
                              "created_at": "2021-05-19T14:57:50.501Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "cancelled",
            

              
                              "created_at": "2021-05-19T17:45:40.064Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/payments/8147fd30-9ae0-0139-81ce-3250f474fbdd",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  },
            

              
                  {
            

              
                      "barcode": "03398000000000000009492836981922600010320102",
            

              
                      "digitable_line": "033994928136981922606001032010268000",
            

              
                      "status": "approved",
            

              
                      "amount": 24996,
            

              
                      "due_date": "2020-08-23",
            

              
                      "created_at": "2021-05-19T17:47:31.146Z",
            

              
                      "updated_at": "2021-05-19T17:47:45.721Z",
            

              
                      "payee_document": "90400888300142",
            

              
                      "payer_document": "26540598845",
            

              
                      "discount": 0,
            

              
                      "interest_rate": 0,
            

              
                      "fine": 0,
            

              
                      "payee_name": "SANTANDER CARTAO FREE GOLD MC - 23132",
            

              
                      "payer_name": "NOME DO PAGADOR",
            

              
                      "total_amount_can_be_changed": true,
            

              
                      "partial_payment": true,
            

              
                      "payee_company_name": "SANTANDER CARTAO FREE GOLD MC - 23132",
            

              
                      "payment_kind_allowed": "any_amount",
            

              
                      "bill_type": "Boleto",
            

              
                      "duplicate_payment_allowed": false,
            

              
                      "min_amount": 1,
            

              
                      "total_amount": 24996,
            

              
                      "payment_limit_date": "2029-08-23",
            

              
                      "max_amount": 99999999999900,
            

              
                      "paid_amount": 3733,
            

              
                      "description": "",
            

              
                      "other_info": {
            

              
                          "determination_period": "2020-03-05",
            

              
                          "main_amount": 3733,
            

              
                          "fine": 0
            

              
                      },
            

              
                      "payer": {},
            

              
                      "authorization_code": "3027848569",
            

              
                      "id": "356de010-9af8-0139-f66e-52f4cf85f143",
            

              
                      "statuses": [
            

              
                          {
            

              
                              "status": "awaiting_payment",
            

              
                              "created_at": "2021-05-19T17:47:31.157Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "awaiting_processing",
            

              
                              "created_at": "2020-08-27T19:42:01.412Z"
            

              
                          },
            

              
                          {
            

              
                              "status": "approved",
            

              
                              "created_at": "2021-05-19T17:47:45.736Z"
            

              
                          }
            

              
                      ],
            

              
                      "links": [
            

              
                          {
            

              
                              "href": "/payments/356de010-9af8-0139-f66e-52f4cf85f143",
            

              
                              "rel": "self",
            

              
                              "type": "GET"
            

              
                          }
            

              
                      ]
            

              
                  }
            

              
              ]

COPIADO!

Consultas de documentos

Esta API é responsável por todas as movimentações referentes a consultas de documentos.

Serviços disponíveis

POST

/identity-verifications

Consulta de documento

Para consultar as informações do documento, basta invocar este serviço e informar document e o product_id na URL.

Parâmetros

document(string) - CPF ou CNPJ que seja ser consultado
product_id(string) - Informar o código do produto

Retorno

id(string) - Identificador único da transação baseado em UUIDs V4 e mesmo parâmetro enviado na URL.
product_id(string) - Código do produto enviado na requisição
status(string) - Status da transação
created_at(string) - Data da criação da transação
updated_at(string) - Data que a transação sofreu alguma atualização
amount(int) - Valor do produto
face_amount(int) - Valor de face do produto
charged_amount(int) - Diferença entre o campo face_amount e a margem configurada para o ponto de venda.
authorization_code(int) - Indica o código da compra no sistema da RV Tecnologia. É a chave primária da transação
document(int) - CPF ou CNPJ consultado
report(array) - Obejto retornado com as informações da consulta

Exemplo de requisição

LINGUAGEM: CURL


              
              curl --request GET 'https://api.sbx.rvhub.com.br/identity-verifications/document='23825695069'&product_id=1' \
            

              
              --header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
            

              
              --header 'Content-Type: application/json'

COPIADO!

Exemplo de resposta

LINGUAGEM: JSON


              
              {
            

              
                  "id": "9cf5d3e0-9bd0-0139-cb65-32150c6e8996",
            

              
                  "product_id": "116",
            

              
                  "status": "success",
            

              
                  "created_at": "2021-05-20T19:36:36.136Z",
            

              
                  "updated_at": "2021-05-20T19:36:36.556Z",
            

              
                  "authorization_code": "11421",
            

              
                  "amount": 1200,
            

              
                  "face_amount": 1200,
            

              
                  "charged_amount": 1140,
            

              
                  "authorized_at": "2021-05-20T19:36:36.000Z",
            

              
                  "document": "13830020708",
            

              
                  "report": {}
            

              
              }

COPIADO!

Biblioteca de erros

A biblioteca de erros é reponsável por trazer todos os erros que nossas APIs podem retornar. Os links contido em cada erro, são apresentados na chave see como guia para o usuário.

Retorno

status(int) - Código do Status HTTP do erro retornado
code(string) - Código interno de referência ao erro ocorrido
message(string) - Mensagem referênte ao erro ocorrido
see(string) - Link de referência do erro para o usuário

LINGUAGEM: JSON


              
              {
            

              
                "status": 400,
            

              
                "code": "validation",
            

              
                "message": "One or more fields are required and / or in an invalid format",
            

              
                "see": "https://docs.rvhub.com.br/#validation_error"
            

              
              }

COPIADO!

`validation_error`

Este erro ocorre quando um ou mais campos que são obrigatórios e não foram enviados ou os campos estão em um formato inválido.

LINGUAGEM: JSON


              
              {
            

              
                "status": 400,
            

              
                "code": "validation",
            

              
                "message": "One or more fields are required and / or in an invalid format",
            

              
                "see": "https://docs.rvhub.com.br/#validation_error"
            

              
              }

COPIADO!

`item_not_found_error`

Este erro ocorre quando um item não é encontrado. Por exemplo, quando você busca por uma recarga inexistente.

LINGUAGEM: JSON


              
              {
            

              
                "status": 404,
            

              
                "code": "item_not_found",
            

              
                "message": "The requested item was not found",
            

              
                "see": "https://docs.rvhub.com.br/#item_not_found_error"
            

              
              }

COPIADO!

`transition_not_accepted_error`

Este erro ocorre quando é feito uma tentativa de mudança de status que não é permitido pelo sistema. Por exemplo, quando você tenta realizar o desfazimento de uma recarga que já foi confirmada.

LINGUAGEM: JSON


              
              {
            

              
                "status": 422,
            

              
                "code": "transition_not_accepted",
            

              
                "message": "The requested transition of status is not accepted",
            

              
                "see": "https://docs.rvhub.com.br/#transition_not_accepted_error"
            

              
              }

COPIADO!

`idempotency_key_not_present_error`

Este erro ocorre quando não é enviado o cabeçado X-Idempotency-Key em uma requisição onde ela é obrigatória. Por exemplo, quando você tenta criar uma solicitação de recarga e não envia a chave de idempotência

LINGUAGEM: JSON


              
              {
            

              
                "status": 422,
            

              
                "code": "idempotency_key",
            

              
                "message": "The custom header field X-Idempotency-Key is required",
            

              
                "see": "https://docs.rvhub.com.br/#idempotency_key_not_present_error"
            

              
              }

COPIADO!

`invalid_merchant_account_error`

Este erro ocorre quando o PDV não é encontrado. Pode ocorrer quando a configuração do RVHub não foi feita corretamente.

LINGUAGEM: JSON


              
              {
            

              
                "status": 404,
            

              
                "code": "invalid_merchant_account",
            

              
                "message": "The Merchant account was not found",
            

              
                "see": "https://docs.rvhub.com.br/#invalid_merchant_account_error"
            

              
              }

COPIADO!

`internal_server_error`

Este erro pode ocorrer quando acontece um erro em nossos servidores.

LINGUAGEM: JSON


              
              {
            

              
                "status": 500,
            

              
                "code": "internal_server_error",
            

              
                "message": "Internal Server Error",
            

              
                "see": "https://docs.rvhub.com.br/#internal_server_error"
            

              
              }

COPIADO!

`bad_gateway_error`

Este erro pode ocorrer quando o sistema de algum parceiro estiver fora do ar ou foi configurado errado

LINGUAGEM: JSON


              
              {
            

              
                "status": 502,
            

              
                "code": "bad_gateway",
            

              
                "message": "Bad gateway",
            

              
                "see": "https://docs.rvhub.com.br/#bad_gateway_error"
            

              
              }

COPIADO!

`invalid_affiliation_key_error`

Este erro pode ocorrer quando a chave do parceiro(Ex. Software House) está configurada de forma errada

LINGUAGEM: JSON


              
              {
            

              
                "status": 500,
            

              
                "code": "invalid_affiliation_key",
            

              
                "message": "Invalid Supplier Key",
            

              
                "see": "https://docs.rvhub.com.br/#invalid_affiliation_key_error"
            

              
              }

COPIADO!

`invalid_amount_error`

Este erro pode ocorrer quando é passado um valor inválido. Os valores aceitos são maiores ou iguais a R$50,00 e menores ou iguais a R$10.000,00

LINGUAGEM: JSON


              
              {
            

              
                "status": 422,
            

              
                "code": "invalid_amount_error",
            

              
                "message": "Invalid Amount",
            

              
                "see": "https://docs.rvhub.com.br/#invalid_amount_error"
            

              
              }

COPIADO!

Perguntas Frequentes

Aqui tentamos responder as perguntas mais frequentes

O que é o RVHub?

Quais são as operadoras disponíveis no RVHub?

Quais são os produtos disponíveis para comercializar pelo RVHub?

Por que nós usamos numeros inteiros nos campos de valores?

Como enviar então os centavos de um valor?

Por que obtenho o mesmo retorno no Swagger ou em minha requisição, mesmo fazendo diferentes solicitações?

O que é chave de idempotência?

Como faço para contratar os serviços do RVHub?

Sobre nós

Aprenda a conectar

Recargas

Portfólio

Recarga de Celular

Recarga de PIN

Recarga de TV

Recarga de Transporte

Recarga One Shot

Serviços Financeiros

Cash-in

Consulta de saldos

Pagamentos

Seguros

Serviços Digitais

Credit Score

Títulos premiáveis

	curl --request POST "https://auth.sbx.rvhub.com.br/oauth2/token?grant_type=client_credentials" \
	--header 'Content-Type: application/x-www-form-urlencoded' \
	--header 'Authorization: Basic 4eC39HqLyjWDarjtT1zdp7dc'

	{
	"access_token": "4eC39HqLyjWDarjtT1zdp7dc.4eC39HqLyjWDarjtT1zdp7dc.4eC39HqLyjWDarjtT1zdp7dc",
	"expires_in": 3600,
	"token_type": "Bearer"
	}

	curl --request GET 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions' \
	--header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
	--header 'Content-Type: application/json'

	[
	{
	"id": "1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
	"product_id": "1",
	"area_code": "11",
	"cell_phone_number": "99991111",
	"status": "authorized",
	"created_at": "2020-05-06T13:26:31.211Z",
	"updated_at": "2020-05-06T13:26:31.560Z",
	"nsu": "000016838",
	"authorization_code": 16838,
	"face_amount": 3000,
	"due_date": "2020-05-11T00:00:00.000Z",
	"message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
	"authorized_at": "2020-05-06T00:00:00.000Z",
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-06T13:26:31.570Z"
	}
	],
	"links": [
	{
	"href": "/cellphone-topups/transactions/1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/cellphone-topups/transactions/1f3bef20-71cb-0138-b3e9-2e4c008d14ca/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/cellphone-topups/transactions/1f3bef20-71cb-0138-b3e9-2e4c008d14ca",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	}
	]

	curl --request POST 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions' \
	--header 'X-Idempotency-Key: 4307d04c-1f48-4318-98c6-0012f4be1b41' \

	{
	"status": 422,
	"code": "transition_not_accepted",
	"message": "The requested transition of status is not accepted",
	"see": "https://docs.rvhub.com.br/erros#transition_not_accepted"
	}

	{
	"product_id": "1",
	"area_code": "11",
	"cell_phone_number": "999990002"
	}

	{
	"id": "55e0f600-791a-0138-fb37-427e4842ab95",
	"product_id": "1",
	"area_code": "11",
	"cell_phone_number": "999990002",
	"status": "denied",
	"created_at": "2020-05-15T20:41:11.271Z",
	"updated_at": "2020-05-15T20:41:11.876Z",
	"status_reason": "insufficient_credit_limit",
	"statuses": [
	{
	"status": "denied",
	"created_at": "2020-05-15T20:41:11.888Z"
	}
	],
	"links": [
	{
	"href": "/cellphone-topups/transactions/55e0f600-791a-0138-fb37-427e4842ab95",
	"rel": "self",
	"type": "GET"
	}
	]
	}

	{
	"id": "c6ed1b40-7b47-0138-ad95-6a7a823bbaf7",
	"status": "authorized",
	//… demais elementos JSON
	"links": [
	{
	"href": "/cellphone-topups/transactions/c6ed1b40-7b47-0138-ad95-6a7a823bbaf7",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/cellphone-topups/transactions/c6ed1b40-7b47-0138-ad95-6a7a823bbaf7/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/cellphone-topups/transactions/c6ed1b40-7b47-0138-ad95-6a7a823bbaf7",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	}

	{
	"id": "4eb02850-7911-0138-1c2a-1a6802ff9bdd",
	"product_id": "1",
	"area_code": "11",
	"cell_phone_number": "999995555",
	"status": "authorized",
	"created_at": "2020-05-15T19:36:33.736Z",
	"updated_at": "2020-05-15T19:36:34.122Z",
	"nsu": "000011260",
	"authorization_code": 11260,
	"face_amount": 3000,
	"due_date": "2020-05-20T00:00:00.000Z",
	"message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
	"authorized_at": "2020-05-15T00:00:00.000Z",
	"charged_amount": 2850,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-15T19:36:34.136Z"
	}
	],
	"links": [
	{
	"href": "/transactions/4eb02850-7911-0138-1c2a-1a6802ff9bdd",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/transactions/4eb02850-7911-0138-1c2a-1a6802ff9bdd/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/transactions/4eb02850-7911-0138-1c2a-1a6802ff9bdd",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	}

	{
	"status": "captured",
	"id": "47f9e5b0-7b45-0138-ae54-0e952cca23cd",
	"product_id": "1",
	"area_code": "11",
	"cell_phone_number": "999995555",
	"created_at": "2020-05-18T14:53:38.631Z",
	"updated_at": "2020-05-18T17:52:08.006Z",
	"nsu": "000011492",
	"authorization_code": 11492,
	"face_amount": 3000,
	"due_date": "2020-05-23T00:00:00.000Z",
	"message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO VARIAVEL",
	"authorized_at": "2020-05-18T00:00:00.000Z",
	"charged_amount": 2850,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-18T14:53:38.854Z"
	},
	{
	"status": "captured",
	"created_at": "2020-05-18T17:52:08.027Z"
	}
	],
	"links": [
	{
	"href": "/transactions/47f9e5b0-7b45-0138-ae54-0e952cca23cd",
	"rel": "self",
	"type": "GET"
	}
	]
	}

	curl --request DELETE 'https://api.sbx.rvhub.com.br/cellphone-topups/transactions/80d39510-6ac3-0138-4336-56e1314b0560' \
	--header 'Authorization: Bearer U0VVX0NMSUVOVF9JRDpTRVVfQ0xJRU5UX1NFQ1JFVA==' \
	--header 'Content-Type: application/json' \

	{
	"status": "refunded",
	"id": "6fb56fb0-7b36-0138-675e-26d6d98705df",
	"product_id": "2",
	"amount": 3000,
	"area_code": "11",
	"cell_phone_number": "994145350",
	"created_at": "2020-05-18T13:07:22.840Z",
	"updated_at": "2020-05-18T13:07:32.588Z",
	"nsu": "000011392",
	"authorization_code": 11392,
	"face_amount": 3000,
	"due_date": "2020-05-23T00:00:00.000Z",
	"message": "CLIENTE VIVO TURBO AGORA TEM WHATSAPP ILIMITADO! LIGUE *9003 E SAIBA MAIS - PRECO FIXO",
	"authorized_at": "2020-05-18T00:00:00.000Z",
	"charged_amount": 2850,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-18T13:07:23.175Z"
	},
	{
	"status": "refunded",
	"created_at": "2020-05-18T13:07:32.609Z"
	}
	],
	"links": [
	{
	"href": "/transactions/6fb56fb0-7b36-0138-675e-26d6d98705df",
	"rel": "self",
	"type": "GET"
	}
	]
	}

	{
	"id": "a81c51a0-80c1-0138-e78e-560cf8ddddce",
	"product_id": "3",
	"area_code": "11",
	"cell_phone_number": "999996666",
	"status": "authorized",
	"created_at": "2020-05-25T14:26:33.326Z",
	"updated_at": "2020-05-25T14:26:33.636Z",
	"authorization_code": 15467,
	"face_amount": 1000,
	"due_date": "2020-05-30T00:00:00.000Z",
	"authorized_at": "2020-05-25T14:26:33.000Z",
	"pin": "1FF1-A09B-9CCD-9619",
	"lot": "0",
	"serial_number": "15467",
	"charged_amount": 950,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE",
	"snb": "167456"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-25T14:26:33.650Z"
	}
	],
	"links": [
	{
	"href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/transactions/a81c51a0-80c1-0138-e78e-560cf8ddddce",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	}

	{
	"status": "refunded",
	"id": "8267c060-80bd-0138-af18-2a64cea8d0cb",
	"product_id": "3",
	"area_code": "11",
	"cell_phone_number": "999996666",
	"created_at": "2020-05-25T13:56:52.080Z",
	"updated_at": "2020-05-25T13:57:03.596Z",
	"authorization_code": 15266,
	"face_amount": 1000,
	"due_date": "2020-05-30T00:00:00.000Z",
	"authorized_at": "2020-05-25T13:56:52.000Z",
	"pin": "34DC-E6A5-97D7-9268",
	"lot": "0",
	"serial_number": "15266",
	"charged_amount": 950,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-25T13:56:52.384Z"
	},
	{
	"status": "refunded",
	"created_at": "2020-05-25T13:57:03.616Z"
	}
	],
	"links": [
	{
	"href": "/transactions/8267c060-80bd-0138-af18-2a64cea8d0cb",
	"rel": "self",
	"type": "GET"
	}
	]
	}

	[
	{
	"id": "728d1190-774c-0138-b3a2-6a6da5842074",
	"product_id": "3",
	"area_code": "11",
	"cell_phone_number": "999996666",
	"status": "captured",
	"created_at": "2020-05-13T13:34:51.886Z",
	"updated_at": "2020-05-13T13:35:25.696Z",
	"authorization_code": 5931,
	"face_amount": 1000,
	"due_date": "2020-05-18T00:00:00.000Z",
	"authorized_at": "2020-05-13T00:00:00.000Z",
	"pin": "054C-2C08-AA9E-6164",
	"lot": "0",
	"serial_number": "5931",
	"charged_amount": 950,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-13T13:34:52.396Z"
	},
	{
	"status": "captured",
	"created_at": "2020-05-13T13:35:25.725Z"
	}
	],
	"links": [
	{
	"href": "/transactions/728d1190-774c-0138-b3a2-6a6da5842074",
	"rel": "self",
	"type": "GET"
	}
	]
	},
	{
	"id": "de1751f0-774c-0138-b3a3-6a6da5842074",
	"product_id": "3",
	"area_code": "11",
	"cell_phone_number": "999995555",
	"status": "refunded",
	"created_at": "2020-05-13T13:37:52.308Z",
	"updated_at": "2020-05-13T13:38:19.197Z",
	"authorization_code": 5932,
	"face_amount": 1000,
	"due_date": "2020-05-18T00:00:00.000Z",
	"authorized_at": "2020-05-13T00:00:00.000Z",
	"pin": "5BD8-F0D9-F2AC-F5D9",
	"lot": "0",
	"serial_number": "5932",
	"charged_amount": 950,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-13T13:37:52.612Z"
	},
	{
	"status": "refunded",
	"created_at": "2020-05-13T13:38:19.217Z"
	}
	],
	"links": [
	{
	"href": "/transactions/de1751f0-774c-0138-b3a3-6a6da5842074",
	"rel": "self",
	"type": "GET"
	}
	]
	}
	]

	{
	"id": "2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
	"product_id": "5",
	"status": "authorized",
	"created_at": "2020-05-25T15:13:11.163Z",
	"updated_at": "2020-05-25T15:13:11.357Z",
	"nsu": "000015471",
	"authorization_code": 15471,
	"face_amount": 1990,
	"due_date": "2020-05-30T00:00:00.000Z",
	"message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
	"authorized_at": "2020-05-25T15:13:11.000Z",
	"signer_code": "12345678910",
	"charged_amount": 1850,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-25T15:13:11.362Z"
	}
	],
	"links": [
	{
	"href": "/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/transactions/2bc05cc0-80c8-0138-0bb8-2ea82e8cddff",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	}

	{
	"status": "refunded",
	"id": "7c93b490-80d3-0138-82fe-3a4157b7b374",
	"product_id": "5",
	"signer_code": "12345678910",
	"created_at": "2020-05-25T16:34:11.230Z",
	"updated_at": "2020-05-25T16:34:26.636Z",
	"nsu": "000015472",
	"authorization_code": 15472,
	"face_amount": 1990,
	"due_date": "2020-05-30T00:00:00.000Z",
	"message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
	"authorized_at": "2020-05-25T16:34:11.000Z",
	"charged_amount": 1850,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-25T16:34:11.575Z"
	},
	{
	"status": "refunded",
	"created_at": "2020-05-25T16:34:26.658Z"
	}
	],
	"links": [
	{
	"href": "/transactions/7c93b490-80d3-0138-82fe-3a4157b7b374",
	"rel": "self",
	"type": "GET"
	}
	]
	}

	{
	"id": "61741d70-80e0-0138-6759-1eb0fbb10474",
	"product_id": "5",
	"status": "captured",
	"created_at": "2020-05-25T18:06:29.182Z",
	"updated_at": "2020-05-25T18:06:35.954Z",
	"nsu": "000015473",
	"authorization_code": 15473,
	"face_amount": 1990,
	"due_date": "2020-05-30T00:00:00.000Z",
	"message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
	"authorized_at": "2020-05-25T18:06:29.000Z",
	"signer_code": "12345678910",
	"charged_amount": 1850,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-25T18:06:29.535Z"
	},
	{
	"status": "captured",
	"created_at": "2020-05-25T18:06:35.982Z"
	}
	],
	"links": [
	{
	"href": "/transactions/61741d70-80e0-0138-6759-1eb0fbb10474",
	"rel": "self",
	"type": "GET"
	}
	]
	}

	[
	{
	"id": "ac4d9db0-7752-0138-8428-0a492e938315",
	"product_id": "3",
	"status": "denied",
	"created_at": "2020-05-13T14:19:25.758Z",
	"updated_at": "2020-05-13T14:19:29.284Z",
	"status_reason": "operator_or_product_not_found",
	"signer_code": "12345678910",
	"charged_amount": 1850,
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "denied",
	"created_at": "2020-05-13T14:19:29.301Z"
	}
	],
	"links": [
	{
	"href": "/transactions/ac4d9db0-7752-0138-8428-0a492e938315",
	"rel": "self",
	"type": "GET"
	}
	]
	},
	{
	"id": "b9d9e130-7752-0138-8429-0a492e938315",
	"product_id": "5",
	"status": "captured",
	"created_at": "2020-05-13T14:19:48.488Z",
	"updated_at": "2020-05-13T14:21:42.516Z",
	"nsu": "000006049",
	"authorization_code": 6049,
	"face_amount": 1990,
	"due_date": "2020-05-18T00:00:00.000Z",
	"message": "Recarga efetuada com sucesso! Agora voce tem 7 dias para aproveitar seus canais.",
	"authorized_at": "2020-05-13T00:00:00.000Z",
	"signer_code": "10987654321",
	"affiliation_key": "12345",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-05-13T14:19:48.752Z"
	},
	{
	"status": "captured",
	"created_at": "2020-05-13T14:21:42.521Z"
	}
	],
	"links": [
	{
	"href": "/transactions/b9d9e130-7752-0138-8429-0a492e938315",
	"rel": "self",
	"type": "GET"
	}
	]
	}
	]

Introdução

Credenciamento

Autenticação

Autorização

Exemplo de criação de base64

Exemplo de requisição de autenticação

Exemplo de resposta de autenticação

Exemplo de requisição com header de autorização

Exemplo de uma resposta autorizada

Requisições idempotentes

Exemplo de requisição

Erros

Exemplo de resposta 4xx

Chaves de acesso

Sandbox

URL

Dados para teste

Dados para teste

Dados de recargas

Lista de números e Erros

Exemplo do corpo da requisição

Exemplo de resposta

Dados de pagamentos

Dados para casos de sucesso

Dados para casos de erros

Paginação

HATEOAS

Exemplo de resposta

Ambientes

URL SANDBOX

URL PRODUÇÃO

Homologação

Passo 1

Passo 2

Passo 3

Passo 4

Passo 5

Passo 6

Passo 7

Regras de estorno

Fluxos

Fluxo de recargas

Autorizada

Confirmada

Cancelada

Negada

Estornada

Fluxo de pagamentos

Aguardando pagamento

Aprovada

Aguardando processamento

Cancelada

Negado

Confirmada

Estornado

Recarga de celular

Serviços disponíveis

Solicitação de recarga

Parâmetros

Retorno

Exemplo de requisição

Exemplo de resposta

Confirmação de recarga

Parâmetros

Retorno

Exemplo de requisição

Exemplo de resposta

Desfazimento de recarga

Parâmetros

Retorno

Exemplo de requisição

Exemplo de resposta

Consulta de recarga

Parâmetros

Retorno

Exemplo de requisição

Exemplo de resposta

Lista de recarga

Parâmetros Opcionais

Retorno

Exemplo de resposta `4xx`

	{
	"id": "18cbce30-e945-0138-c761-628b9885fbe6",
	"product_id": "70",
	"amount": 9999,
	"status": "authorized",
	"created_at": "2020-10-05T14:29:27.381Z",
	"updated_at": "2020-10-05T14:29:27.879Z",
	"nsu": "000076066",
	"authorization_code": "76066",
	"face_amount": 9999,
	"due_date": "2020-10-10T00:00:00.000Z",
	"message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
	"authorized_at": "2020-10-05T14:29:27.000Z",
	"charged_amount": 9499,
	"card_number": "1234",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-10-05T14:29:27.894Z"
	}
	],
	"links": [
	{
	"href": "/transactions/18cbce30-e945-0138-c761-628b9885fbe6",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/transactions/18cbce30-e945-0138-c761-628b9885fbe6/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/transactions/18cbce30-e945-0138-c761-628b9885fbe6",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	}

	{
	"status": "refunded",
	"id": "4b3ee1d0-e95e-0138-0ad1-32726f22dc1b",
	"product_id": "70",
	"amount": 9999,
	"card_number": "1234",
	"created_at": "2020-10-05T17:29:49.440Z",
	"updated_at": "2020-10-05T17:29:54.121Z",
	"nsu": "000076305",
	"authorization_code": "76305",
	"face_amount": 9999,
	"due_date": "2020-10-10T00:00:00.000Z",
	"message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
	"authorized_at": "2020-10-05T17:29:49.000Z",
	"charged_amount": 9499,
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-10-05T17:29:49.838Z"
	},
	{
	"status": "refunded",
	"created_at": "2020-10-05T17:29:54.128Z"
	}
	],
	"links": [
	{
	"href": "/transactions/4b3ee1d0-e95e-0138-0ad1-32726f22dc1b",
	"rel": "self",
	"type": "GET"
	}
	]
	}

	[
	{
	"id": "c29b7f00-de6b-0138-8574-72321ff82fe6",
	"product_id": "70",
	"amount": 9999,
	"status": "authorized",
	"created_at": "2020-09-21T19:08:30.363Z",
	"updated_at": "2020-09-21T19:08:30.679Z",
	"nsu": "000071835",
	"authorization_code": "71835",
	"face_amount": 9999,
	"due_date": "2020-09-26T00:00:00.000Z",
	"message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
	"authorized_at": "2020-09-21T19:08:30.000Z",
	"charged_amount": 9499,
	"card_number": "1234",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-09-21T19:08:30.684Z"
	}
	],
	"links": [
	{
	"href": "/transactions/c29b7f00-de6b-0138-8574-72321ff82fe6",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/transactions/c29b7f00-de6b-0138-8574-72321ff82fe6/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/transactions/c29b7f00-de6b-0138-8574-72321ff82fe6",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	},
	{
	"id": "47247030-de6d-0138-8575-72321ff82fe6",
	"product_id": "70",
	"amount": 9999,
	"status": "authorized",
	"created_at": "2020-09-21T19:19:22.216Z",
	"updated_at": "2020-09-21T19:19:26.042Z",
	"nsu": "000071836",
	"authorization_code": "71836",
	"face_amount": 9999,
	"due_date": "2020-09-26T00:00:00.000Z",
	"message": "Ative sua recarga num VALIDADOR em qualquer estacao do Metro",
	"authorized_at": "2020-09-21T19:19:25.000Z",
	"charged_amount": 9499,
	"card_number": "1234",
	"metadata": {
	"terminal_state": "SP",
	"terminal_id": "123",
	"local_user": "TESTE"
	},
	"statuses": [
	{
	"status": "authorized",
	"created_at": "2020-09-21T19:19:26.048Z"
	}
	],
	"links": [
	{
	"href": "/transactions/47247030-de6d-0138-8575-72321ff82fe6",
	"rel": "self",
	"type": "GET"
	},
	{
	"href": "/transactions/47247030-de6d-0138-8575-72321ff82fe6/capture",
	"rel": "capture",
	"type": "POST"
	},
	{
	"href": "/transactions/47247030-de6d-0138-8575-72321ff82fe6",
	"rel": "refund",
	"type": "DELETE"
	}
	]
	}
	]

	{
	"area_code": "11",
	"cell_phone_number": "999996666",
	"document": "99999999999",
	"product_id": "3",
	"amount": 30000,
	"kind": "cellphone",
	"status": "created",
	"notification_url": "https://docs.rvhub.com.br",
	"notification_secret": "123456",
	"created_at": "2025-04-11T18:12:31.741Z",
	"updated_at": "2025-04-11T18:12:42.554Z",
	"id": "75acd2f0-f92e-013d-3129-3445063783b3",
	"qrcode": "00020101021226870014br.gov.bcb.pix2565qrcodepix-h.bb.com.br/pix/v2/3b1f447d-4e1d-4d39-bc24-1ea3e73a7be9520400005303986540537.005802BR5921PAPELARIA LEITE CUNHA6008BRASILIA62070503***6304001D",
	"payer_name": "ONE SHOT",
	"expiration_date": "2023-07-06T09:32:08.000Z"
	}

	[
	{
	"id": "9faac280-e62c-013c-102b-6a9418ba6c55",
	"name": "TIM",
	"states": [
	{
	"name": "Rio de Janeiro",
	"code": "RJ",
	"area_codes": [
	21,
	22
	]
	},
	{
	"name": "São Paulo",
	"code": "SP",
	"area_codes": [
	11,
	12
	]
	}
	]
	},
	{
	"id": "112a8270-e63a-013c-e9ed-4a8857830e47",
	"name": "Claro",
	"states": [
	{
	"name": "São Paulo",
	"code": "SP",
	"area_codes": [
	11,
	13,
	14,
	15,
	16,
	17,
	18,
	19
	]
	},
	{
	"name": "Rio de Janeiro",
	"code": "RJ",
	"area_codes": [
	21,
	22,
	24
	]
	},
	{
	"name": "Espírito Santo",
	"code": "ES",
	"area_codes": [
	27,
	28
	]
	},
	{
	"name": "Minas Gerais",
	"code": "MG",
	"area_codes": [
	31,
	32,
	33,
	34,
	35,
	37,
	38
	]
	},
	{
	"name": "Paraná",
	"code": "PR",
	"area_codes": [
	41,
	42,
	43,
	44,
	45,
	46
	]
	},
	{
	"name": "Santa Catarina",
	"code": "SC",
	"area_codes": [
	47,
	48,
	49
	]
	},
	{
	"name": "Rio Grande do Sul",
	"code": "RS",
	"area_codes": [
	51,
	53,
	54,
	55
	]
	},
	{
	"name": "Distrito Federal",
	"code": "DF",
	"area_codes": [
	61
	]
	},
	{
	"name": "Goiás",
	"code": "GO",
	"area_codes": [
	62,
	64
	]
	},
	{
	"name": "Tocantins",
	"code": "TO",
	"area_codes": [
	63
	]
	},
	{
	"name": "Mato Grosso",
	"code": "MT",
	"area_codes": [
	65,
	66
	]
	},
	{
	"name": "Mato Grosso do Sul",
	"code": "MS",
	"area_codes": [
	67
	]
	},
	{
	"name": "Acre",
	"code": "AC",
	"area_codes": [
	68
	]
	},
	{
	"name": "Rondônia",
	"code": "RO",
	"area_codes": [
	69
	]
	},
	{
	"name": "Bahia",
	"code": "BA",
	"area_codes": [
	71,
	73,
	74,
	75,
	77
	]
	},
	{
	"name": "Sergipe",
	"code": "SE",
	"area_codes": [
	79
	]
	},
	{
	"name": "Pernambuco",
	"code": "PE",
	"area_codes": [
	81,
	87
	]
	},
	{
	"name": "Alagoas",
	"code": "AL",
	"area_codes": [
	82
	]
	},
	{
	"name": "Paraíba",
	"code": "PB",
	"area_codes": [
	83
	]
	},
	{
	"name": "Rio Grande do Norte",
	"code": "RN",
	"area_codes": [
	84
	]
	},
	{
	"name": "Ceará",
	"code": "CE",
	"area_codes": [
	85,
	88
	]
	},
	{
	"name": "Piauí",
	"code": "PI",
	"area_codes": [
	86,
	89
	]
	},
	{
	"name": "Pará",
	"code": "PA",
	"area_codes": [
	91,
	93,
	94
	]
	},
	{
	"name": "Amazonas",
	"code": "AM",
	"area_codes": [
	92,
	97
	]
	},
	{
	"name": "Roraima",
	"code": "RR",
	"area_codes": [
	95
	]
	},
	{
	"name": "Amapá",
	"code": "AP",
	"area_codes": [
	96
	]
	},
	{
	"name": "Maranhão",
	"code": "MA",
	"area_codes": [
	98,
	99
	]
	}
	]
	}
	]

	[
	{
	"internet": "12GB",
	"amount": "3499",
	"id": "vtxprepagochipom12tiktok",
	"name": "Claro Pré-pago Oferta mensal + TikTok",
	"recharge": "3500"
	},
	{
	"internet": "12GB",
	"amount": "2999",
	"id": "vtxprepagochipom12",
	"name": "Claro Pré-pago Oferta mensal + YouTube",
	"recharge": "3000"
	},
	{
	"internet": "12GB",
	"amount": "3499",
	"id": "vtxprepagochipom12freefire",
	"name": "Claro Pré-pago Oferta mensal + Free Fire",
	"recharge": "3500"
	},
	{
	"internet": "9GB",
	"amount": "2499",
	"id": "vtxprepagochipom9",
	"name": "Claro Pré-pago Oferta mensal",
	"recharge": "2500"
	},
	{
	"internet": "0",
	"amount": "0",
	"id": "vtxprepagochip",
	"name": "Claro Pré-pago",
	"recharge": "0"
	},
	{
	"internet": "15GB",
	"amount": "2999",
	"id": "vtxflex8",
	"name": "Claro Flex",
	"recharge": "3000"
	}
	]

	[
	{
	"id": "0d337940-e604-013c-5c61-46f7dfc99006",
	"name": "Xaiomi"
	},
	{
	"id": "b6b09220-e60a-013c-a8ea-5ebea035c7ff",
	"name": "Apple 2"
	}
	]

	{
	"cellphone_models": [
	{
	"name": "Redmi 13C"
	},
	{
	"name": "Xiaomi 14"
	}
	]
	}

	{
	"id": "00a19480-f50e-013c-4a0b-1a6d5179c077",
	"plan_id": "vtxprepagochipom9",
	"reference": "Referencia",
	"face_amount": 2000,
	"amount": 2499,
	"charged_amount": 1980,
	"authorization_code": "3027848569",
	"status": "processing",
	"statuses": [
	{
	"status": "processing",
	"created_at": "2024-05-15T17:25:14.388Z"
	}
	],
	"links": [
	{
	"href": "/transactions/00a19480-f50e-013c-4a0b-1a6d5179c077",
	"rel": "self",
	"type": "GET"
	}
	],
	"document": "83311694090",
	"name": "teste",
	"email": "email@teste.com",
	"date_birth": "1997-11-13T00:00:00.000Z",
	"area_code": "21",
	"cell_phone_number": "991827362",
	"zip_code": "22873182",
	"street": "Rua",
	"neighborhood": "Bairro",
	"city": "Cidade",
	"number": "105",
	"complement": "Complemento",
	"state": "RJ"
	}

	[
	{
	"id": "5768d690-f4f1-013c-60cf-529e702787dd",
	"plan_id": "vtxprepagochipom12",
	"reference": "Referencia",
	"face_amount": 2000,
	"amount": 2999,
	"charged_amount": 1980,
	"authorization_code": "3027848569",
	"status": "processing",
	"idempotency_key": "$1715781594",
	"statuses": [
	{
	"status": "processing",
	"created_at": "2024-05-15T14:00:08.690Z"
	}
	],
	"links": [
	{
	"href": "/transactions/5768d690-f4f1-013c-60cf-529e702787dd",
	"rel": "self",
	"type": "GET"
	}
	],
	"document": "83311694090",
	"name": "Nome",
	"email": "email@teste.com",
	"date_birth": "1997-11-13T00:00:00.000Z",
	"area_code": "21",
	"cell_phone_number": "991827362",
	"zip_code": "22873182",
	"street": "Rua",
	"neighborhood": "Bairro",
	"city": "Cidade",
	"number": "105",
	"complement": "Complemento",
	"state": "RJ"
	},
	{
	"id": "99de1c50-f507-013c-b8aa-7249b235b715",
	"plan_id": "vtxprepagochipom12",
	"reference": "Referencia",
	"face_amount": 2000,
	"amount": 2999,
	"charged_amount": 1980,
	"authorization_code": "3027848569",
	"status": "processing",
	"idempotency_key": "$1715791159",
	"statuses": [
	{
	"status": "processing",
	"created_at": "2024-05-15T16:39:25.701Z"
	}
	],
	"links": [
	{
	"href": "/transactions/99de1c50-f507-013c-b8aa-7249b235b715",
	"rel": "self",
	"type": "GET"
	}
	],
	"document": "83311694090",
	"name": "Nome",
	"email": "email@teste.com",
	"date_birth": "1997-11-13T00:00:00.000Z",
	"area_code": "21",
	"cell_phone_number": "991827362",
	"zip_code": "22873182",
	"street": "Rua",
	"neighborhood": "Bairro",
	"city": "Cidade",
	"number": "105",
	"complement": "Complemento",
	"state": "RJ"
	}
	]