E-mail: suporte@wtrcard.com.br

Web: https://developers.wtrcard.com.br/suporte

Documentação

Seja Bem-vindo!

Conheça nossa documentação e venha crescer com agente!

INTRODUÇÃO

Uma breve introdução

Aqui você encontrará tudo que precisa para ter uma melhor integração possível com as nossas APIs. Venha conosco e conduza seu negócio em parceria com a WTR Card!

O que é a WTR?

Somos uma fintech inovadora criada no polo moveleiro de Ubá.

Estamos revolucionando o sistema de pagamento com cartões para benefícios à funcionários.

Nossas propostas e atuações são reconhecidas entre os empresários para resolver algo essencial, usando a tecnologia para integrar e aproximar pessoas para a democratização dos serviços financeiros nas empresas.

Venha com agente nessa jornada!

Arquivos Json

Para agilizar o desenvolvimento, disponibilizamos alguns exemplos abaixo.

Download Exemplos

Token

Informações
SandBOx
Produção

Nossas APIs possuem autenticação, utilizando o protocolo OAuth 2.0.

Credenciais de Sandbox

Para acessar os endpoints em ambiente de sandbox, utilize a URL base https://sandbox.wtrcard.com.br/.

Para obter suas credenciais, basta solicitá-las ao nosso time de suporte informando o seu CNPJ, Razão Social e qual produto deseja testar. Caso o produto seja QR Code, para receber o retorno dos status, favor informar também a URL, Login e Senha do Webhook referente ao método de autenticação Basic.

Utilize as credenciais abaixo para gerar seu token:

    client_id : 827384729847297he4.teste.wtrapi.v1
    grant_type : fornecedor_credentials
    client_secret: 87dsdwreetyYTu88d653fh0jf8ehfe1sd8a7sd6a7sd6a8s7d6lkjgucx

Credenciais de Produção

Antes de iniciar a integração, é necessário estar com suas chaves de API. Para acessar o ambiente de produção, utilize as seguintes URL base:

    https://api.wtrcard.com.br/

    client_id : Seu identificador único na WTR Card
    grant_type : fornecedor_credentials / Tipo de Acesso
    client_secret: Sua chave de acesso

Realizando a primeira requisição

De posse das credenciais (Sandbox ou Produção), inicie uma transação seguindo o modelo de request(cURL) abaixo.

Em FORM:

 curl --request POST \
      --url https://sandbox.wtrcard.com.br/v1/token/? \
      --header 'accept: application/json' \
      --header 'content-type: multipart/form-data' \
      --form client_id=827384729847297he4.teste.wtrapi.v1 \
      --form grant_type=fornecedor_credentials \
      --form client_secret=87dsdwreetyYTu88d653fh0jf8ehfe1sd8a7sd6a7sd6a8s7d6lkjgucx

Em JSON:

    curl --request POST \
         --url https://sandbox.wtrcard.com.br/token/? \
         --header 'accept: application/json' \
         --header 'content-type: application/json' \
         --data '
        {
        "client_id": "827384729847297he4.teste.wtrapi.v1",
        "grant_type": "fornecedor_credentials",
        "client_secret": "87dsdwreetyYTu88d653fh0jf8ehfe1sd8a7sd6a7sd6a8s7d6lkjgucx"
        }
        '

Após realizar a requisição, se tudo estiver configurado corretamente, você receberá uma resposta HTTP Status 200, com o token de acesso, será retornado um response da seguinte maneira.

{
    "access_token": "osdfhsdfsdyGhJjda9837303h3b3vu33.eyJjbGllbnRfaWQiOiI0MWI0NGFiOWE1NjQ0MC50ZXN0ZS5jZWxjb2luYXBpLnY1IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InRlc3RlIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy91c2VyZGF0YSI6IjljMDlhYzg2NDhmYzQ5NTk4MzQwIiwiZXhwIjoxNjQ1MDE2MjY5LCJpc3MiOiJDZWxjb2luQVBJIiwiYXVkIjoiQ2VsY29pbkFQSSJ9.9gUkSVBF-oCscElluAJE3cspkNaWk1lhqbGN3ZFJnuo",
    "expires_in": 2400,
    "token_type": "bearer"
}

Para utilizar o seu token de acesso nas próximas requisições, você deverá enviar o access_token através do parâmetro header, juntamente com o prefixo "Authorization: Bearer".

O access_token tem a validade de 240 segundos. Ao expirar, você deverá gerar um novo.

Compras no Cartão

Criando uma transação

Essa API efetua o pagamento da transação e retira o saldo do cartão. Orientações:

CaptureTrue 1 vai capturar o saldo do cartão.
CaptureTrue 0 não vai capturar, será necessário uma nova requisição na API Capture.
ExternalNSU preencher com o ID Interno para seu controle e futuras requisições.
ExternalTerminal preencher com o Nome para seu controle e futuras requisições

Em ambiente SandBox não altere o cardNumber, passKey e nem o externalNSU

    curl --request POST \
         --url https://sandbox.wtrcard.com.br/v1/card/new/? \
         --header 'accept: application/json' \
         --header 'authorization: Bearer meutoken' \
         --header 'content-type: application/json' \
         --data '
        {
        "cardNumber": "1445200598",
        "originalValue": "1.00",
        "passKey": "0758",
        "captureTrue": "1",
        "externalNSU": "idInterno",
        "externalTerminal": "Caixa01"
        }
        '

Após realizar a requisição, se tudo estiver configurado corretamente, você receberá uma resposta HTTP Status 200, com o status da transação e informações para gerar o recibo, será retornado um response da seguinte maneira.

{"error":false,"status":"success","data":"2023-04-25","datacredito":"2023-05-03","parcelas":1,"valor":"1.00","tarifa":"0.06","valorcredito":"0.94","nome":"","cartao":"187****9657","bandeira":"WTR","externalTerminal":"ApiCaixa1","externalNSU":"01","idInterno":"ZgQF90iM3VHz4XdqxjYcKNps2DLywbGESrRJtlBoOeIWPaCm8h6kT1f7Anv5QkwE5iI7"}

Ao enviar valores iguais em externalNSU:

{"error":true,"mensagem":"existe uma transacao com essas informacoes"}

Ao enviar um caixa que não foi criado:

{"error":true,"mensagem":"caixa bloqueado"}

Ao enviar um cartão bloqueado / senha incorreta:

{"error":true,"mensagem":"transacao negada"}

Capturar uma transação

CaptureTrue 0 foi recebido e será necessário uma requisição na API para efetuar o pagamento da Transação e retirada do saldo do cartão.

    curl --request POST \
         --url https://sandbox.wtrcard.com.br/v1/card/capture/? \
         --header 'accept: application/json' \
         --header 'authorization: Bearer meutoken' \
         --header 'content-type: application/json' \
         --data '
        {
        "id": "E14-14926-wq-CYBIHJV",
        "originalValue": "1.00",
        "externalNSU": "idInterno",
        "externalTerminal": "Caixa01"
        }
        '

{"error":false,"status":"success","data":"2023-04-25","datacredito":"2023-05-03","parcelas":1,"valor":"1.00","tarifa":"0.06","valorcredito":"0.94","nome":"WERLEY TEIXEIRA RUFINO ","cartao":"187****9657","bandeira":"WTR","externalTerminal":"ApiCaixa1","externalNSU":"01","idInterno":"0RX-59048-vq-NJICFVL"}

Após realizar a requisição, se estiver configurado incorretamente ou já foi capturada, você receberá uma resposta HTTP Status 200, com o status da transação e informações para gerar o recibo, será retornado um response da seguinte maneira.

{"error":true,"mensagem":"nao existe transacao com essas informacoes"}

Estornar uma transação

Nessa API poderá estornar o valor total ou valor parcial informando no originalValue.

    curl --request POST \
         --url https://sandbox.wtrcard.com.br/v1/card/return/? \
         --header 'accept: application/json' \
         --header 'authorization: Bearer meutoken' \
         --header 'content-type: application/json' \
         --data '
        {
        "id": "E14-14926-wq-CYBIHJV",
        "originalValue": "1.00",
        "externalNSU": "idInterno",
        "externalTerminal": "Caixa01"
        }
        '

Após realizar a requisição, se tudo estiver configurado corretamente, você receberá uma resposta HTTP Status 200, com o status da transação, será retornado um response da seguinte maneira.

{"error":false,"status":"success"}

Se a transação já tiver sido estornada ou paga ao fornecedor, será retornado um response da seguinte maneira.

{"error":false,"status":"solicite a wtr o estorno caso ainda nao tenha feito"}

Autenticação

Para emissão da segunda via da autenticação utilize a API abaixo.

    curl --request POST \
         --url https://sandbox.wtrcard.com.br/v1/card/aut/? \
         --header 'accept: application/json' \
         --header 'authorization: Bearer meutoken' \
         --header 'content-type: application/json' \
         --data '
        {
        "id": "E14-14926-wq-CYBIHJV",
        "externalNSU": "idInterno",
        "externalTerminal": "Caixa01"
        }
        '

Após realizar a requisição, se tudo estiver configurado corretamente, você receberá uma resposta HTTP Status 200, com a autenticação da transação, será retornado um response da seguinte maneira.

{"error":false,"status":"confirmed","data":"2023-04-23","datacredito":"2023-04-30","parcelas":1,"valor":"100.00","tarifa":"0.10","valorcredito":"99.90","nome":"JOSE DA SILVA ROCHA","cartao":"11****1234","datacredito":"2023-04-30","bandeira":"WTR","datacredito":"2023-04-30","externalTerminal":"externalTerminal","externalNSU":"externalNSU","idInterno":"HIBtz47LypcrwCs3ieXg5Dmvo0Eh1WVPxb69SMA2NaG8kORKZfJlnQFjTdYqHeXwTR8x"}

Status da Transação

Para conferir o status da transação, pendente, capturada, estornada parcial, estornada total utilize a API abaixo.

    curl --request POST \
         --url https://sandbox.wtrcard.com.br/v1/card/status/? \
         --header 'accept: application/json' \
         --header 'authorization: Bearer meutoken' \
         --header 'content-type: application/json' \
         --data '
        {
        "id": "E14-14926-wq-CYBIHJV",
        "externalNSU": "idInterno",
        "externalTerminal": "Caixa01"
        }
        '

Após realizar a requisição, se tudo estiver configurado corretamente e a transação estiver confirmada você receberá uma resposta HTTP Status 200, com o status da transação, será retornado um response da seguinte maneira.

{"error":"false","status":"confirmed"}

Após realizar a requisição, se tudo estiver configurado corretamente e a transação estiver cancelada você receberá uma resposta HTTP Status 200, com o status da transação, será retornado um response da seguinte maneira.

{"error":"false","status":"canceled"}

Após realizar a requisição, se tudo estiver configurado corretamente e a transação estiver sido paga você receberá uma resposta HTTP Status 200, com o status da transação, será retornado um response da seguinte maneira.

{"error":"false","status":"payment"}