Consulta

Para realizar uma consulta é necessário realizar uma requisição GET para o seguinte recurso a seguir.

REQUISIÇÃO

👍
GET
/v1/transactions/{{transactionId}}

👍
A fim de garantir unicidade entre as transações, o Gate2all gera um transactionId único.
Esta consulta permite obter os dados da transação fazendo uso do transactionId.

PROPRIEDADE	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
transactionId	Texto	150	Sim	Identificador da transação do GATE2all.

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

URL obj = new URL("https://api.gate2all.com.br/v1/transactions/d31dcd70-6666-40af-85ba-ed1ff23bc293");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
con.setRequestProperty("content-type", "application/json");
con.setRequestProperty("user-agent", "NomeDaAutomacao/1.0");
con.setRequestProperty("authenticationApi", "demo");
con.setRequestProperty("authenticationKey", "demo");

Scanner scanner = new Scanner(new BufferedReader(new InputStreamReader(con.getInputStream())));
String response = scanner.nextLine();
scanner.close();

System.out.println(response);

RESPOSTA

PROPRIEDADE	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
referenceId	Texto	100	Sim	Número de identificação da loja.
amount	Número	16	Sim	Valor da transação sem pontuação. Os dois últimos dígitos são os centavos. (Ex: amount: 100 = R$ 1,00)
status	Número	2	Não	Status da transação retornado pelo gateway. catálogo
customer.name	Texto	100	Sim	Nome do portador do cartão.
customer.document	Texto	18	Não	Número do CPF/CNPJ do portador do cartão.
customer.mail	Texto	40	Não	E-mail do portador do cartão.
address.address	Texto	60	Sim	Endereço do comprador.
address.number	Texto	10	Sim	Número do comprador.
address.complement	Texto	150	Não	Complemento do endereço do comprador.
address.district	Texto	80	Sim	Bairro do comprador.
address.zipcode	Número	8	Sim	CEP do comprador sem formatação. Exemplo: 04549002.
address.city	Texto	30	Sim	Cidade do comprador.
address.state	Texto	2	Sim	Sigla do estado do comprador.
card.type	Número	1	Não	Default*: 0, configura as opcões disponíveis. 1 Configura cartão de crédito. 2 Configura cartão de débito.
card.installments	Número	2	Sim	Número de parcelas.
card.capture	Booleano	—	Sim	True= Autoriza e confirma a transação .false* = Autorização, mas não confirma a transação, necessitando realizar a confirmação (Captura) noutra requisição.
card.authenticate	Número	1	Não	Default: 3* - Opções disponíveis: Autorizar só transações autenticadas Autorizar transações autenticadas ou não autenticadas Autorizar sem autenticação
card.interestType	Número	1	Não	Default: 3* - Operações disponíveis: Parcelado Loja Parcelado Administrador
card.integrationType	Número	1	Sim	Tipo de integração disponível pelo Gate2All: Integrado Loja Direto
card.saveCard	Booleano	—	Sim	Configura salvar o cartão (tokenização).
card.codAuthorization	Texto	100	Não	Codigo de autorização da instituição.
card.providerReference	Texto	100	Não	Referência da instituição.
cardInfo.number	Texto	19	Sim	Número do cartão.
cardInfo.brand	Texto	20	Sim	Bandeira do cartão. Bandeiras.
cardInfo.holderName	Texto	25	Não	Nome do Portador impresso no cartão, só aceita caracteres
bankSlip.emissionDate	Texto	20	Sim	Data de emissão do boleto. formatoYYYY-MM-DD
bankSlip.expirationDate	Texto	20	Sim	Data de vencimento do boleto. formato YYYY-MM-DD
bankSlip.instructions	Texto	300	Sim	Instruções do boleto.
bankSlip.guarantor	Texto	45	Sim	Nome do avalista.
bankSlip.provider	Texto	20	Sim	Nome da instituição financeira: BRADESCO ITAU SANTANDER
bankSlip.paymentDate	Texto	20	Não	Data de pagamento do boleto. formato YYYY-MM-DD
bankSlip.paymentAmount	Número	16	Não	Valor de pagamento do boleto sem pontuação. Os dois últimos dígitos são os centavos. (Ex: amount: 100 = R$ 1,00)
bankSlip.url	Texto	300	Não	Endereço de acesso da transação.
bankSlip.providerReference	Texto	100	Não	Referência da instituição.
electronicTransfer.provider	Texto	20	Não	Nome da instituição financeira: ITAU
electronicTransfer.url	Texto	300	Não	Endereço de acesso da transação.
electronicTransfer.providerReference	Texto	100	Não	Referência da instituição.
pix.provider	Texto	20	Não	Sandbox Nome da instituição financeira: C6BANK ITAU
pix.key	Texto	20	Não	Sandbox Campos para chave do Pix: RANDOM_KEY EMAIL DOCUMENT PHONE
pix.qrCode	Texto		Não	Sandbox Conteúdo para gerar o QRCode a ser pago. Retornado quando o status da transação é 1.
pix.payer			Não	Sandbox Informações do pagador. Retornado quando o status da transação é 6.
pix.providerReference	Texto	32	Não	e2e_id do pagamento PIX (Id fim a fim da transação).
payer.name	Texto		Não	Sandbox Nome do pagador. Retornado quando o status da transação é 6.
payer.document	Texto		Não	Sandbox Número do CPF ou CNPJ do pagador. Retornado quando o status da transação é 6.
payer.provider	Texto		Não	Sandbox Provider utilizado pelo pagador para pagamento do Pix. Retornado quando o status da transação é 6.
pix.expirationDateTime	Texto	20	Não	Sandbox Data da expiração da qrcode. Formato 2021-01-25T18:10:53

Retorno Transação de Crédito.

{
  "transactionId": "62f5a0b2-c632-4e4e-bc51-3b6681a54a3c",
  "referenceId": "1488917347840",
  "amount": "100",
  "status": 9,
  "dtTransaction": "2020-12-07T17:09:07",
  "payment": {
    "card": {
      "type": 1,
      "interestType": 3,
      "integrationType": 1,
      "installments": 1,
      "capture": false,
      "authenticate": 3,
      "codAuthorization": "123456",
      "providerReference": "100699306900094D905A",
      "saveCard": false,
      "recurrent": false,
      "provider": "CIELO",
      "providerVersion": "3.0",
      "cardInfo": {
        "number": "421847******1234",
        "brand": "VISA",
        "holderName": "HOLDER NAME"
      }
    }
  },
  "customer": {
    "name": "HOLDER NAME",
    "document": "23650403811"
  }
}

Retorno Transação com Boleto

{
  "transactionId": "6400d988-cc4b-4084-80ee-d5575dbbed4d",
  "referenceId": "19893211234",
  "amount": "1000",
  "description": "Produto ou serviço",
  "dtTransaction": "2020-12-08T10:46:31-0300",
  "customer": {
    "name": "Comprador",
    "document": "12345678909",
    "email": "[email protected]",
    "address": {
      "address": "Endereco",
      "number": "100",
      "complement": "Apartamento 22",
      "district": "Vila Olimpia",
      "zipcode": "09878675",
      "city": "Sao Paulo",
      "state": "SP"
    }
  },
  "payment": {
    "bankSlip": {
      "providerReference": "20575112",
      "emissionDate": "2020-12-08",
      "expirationDate": "2020-12-10",
      "instructions": "Aceitar somente até a data de vencimento, após essa data juros de 1% dia",
      "guarantor": "Comprador",
      "provider": "ITAU",
      "paymentDate": "2020-12-08",
      "paymentAmount": "100",
      "url": "https://api.gate2all.com.br/v1/payment/6400d988-cc4b-4084-80ee-d5575dbbed4d"
    }
  },
  "status": 0
}

Retorno Transação com Transferência

{
  "transactionId": "6400d988-cc4b-4084-80ee-d5575dbbed4d",
  "referenceId": "19893211234",
  "amount": "1000",
  "description": "Produto ou serviço",
  "dtTransaction": "2020-12-05T16:16:14-0200",
  "customer": {
    "name": "Comprador",
    "document": "12345678909",
    "email": "[email protected]",
    "address": {
      "address": "Endereco 100",
      "number" : "100",
      "complement": "Apartamento 22",
      "district": "Vila Olimpia",
      "zipcode": "05890090",
      "city": "Sao Paulo",
      "state": "SP"
    }
  },
  "payment": {
    "electronicTransfer": {
      "providerReference": "20518839",
      "provider": "Itau",
      "url": "https://api.gate2all.com.br/v1/payment/6400d988-cc4b-4084-80ee-d5575dbbed4d"
    }
  },
  "status": 0
}

Retorno Transação com Pix (status = 1)

{
    "transactionId": "c5c947ba-9584-4903-97f4-9cc7e5a88c18",
    "referenceId": "874a9d71a8fc4663aed24dbb43f45f1b",
    "integrationType": 1,
    "amount": "10000",
    "status": 1,
    "dtTransaction": "2024-09-25T11:03:04",
    "payment": {
        "pix": {
            "provider": "C6BANK",
            "providerReference": "simulated_end_to_end",
            "key": [
                "RANDOM_KEY"
            ],
            "expirationDateTime": "2024-09-25T11:04:16",
                        "qrcode": "conteudo-do-qrcode",
            "paymentDate": "2024-09-25T11:03:36",
            "paymentAmount": "10000"
        }
    }
}

Retorno Transação com Pix (status = 6)

{
    "transactionId": "c5c947ba-9584-4903-97f4-9cc7e5a88c18",
    "referenceId": "874a9d71a8fc4663aed24dbb43f45f1b",
    "integrationType": 6,
    "amount": "10000",
    "status": 1,
    "dtTransaction": "2024-09-25T11:03:04",
    "payment": {
        "pix": {
            "provider": "C6BANK",
            "providerReference": "simulated_end_to_end",
            "key": [
                "RANDOM_KEY"
            ],
            "expirationDateTime": "2024-09-25T11:04:16",
                        "qrcode": "conteudo-do-qrcode",
            "paymentDate": "2024-09-25T11:03:36",
            "paymentAmount": "10000"
        }
    }
}