Intenção de Venda
Para realizar uma intenção de venda é necessário enviar um POST para o seguinte recurso:
POST
/v1/intention
REQUISIÇÃO
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) |
description | Texto | 300 | Não | Descrição da transação. |
postBackUrl | Texto | — | Sim | URL onde o GATE2all notificará eventuais status da trancação para o lojista notificação |
redirectUrl | Texto | — | Não | URL onde o GATE2all redirecionará o comprador após o processamento da transação. |
dtExpiration | Texto | 20 | Não | Data da expiração da intenção. Formato 2021-01-25T18:10:53 |
customer.name | Texto | 100 | Sim | Nome do portador do cartão. |
customer.document | Texto | 18 | Sim | Número do CPF/CNPJ do portador do cartão. |
customer.email | Texto | 100 | Sim | Email do portador do cartão. |
customer.phoneNumber | Texto | 18 | Não | Número de telefone do cliente. |
address.address | Texto | 60 | Sim | Endereço do comprador. |
address.number | Texto | 10 | Sim | Número do endereço 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.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.installments | Número | 2 | Sim | Número de parcelas. |
card.fixedInstallments | Booleano | - | Não | Default: false - True = não permite que o comprador selecione a quantidade de parcelas no formulário de pagamento. |
card.interestType | Número | 1 | Não | Default: 3 - Operações disponíveis: 3. Parcelado Loja 4. Parcelado Administrador |
card.authenticate | Número | 1 | Não | Default: 3 - Opções disponíveis: 1. Autorizar só transações autenticadas 2. Autorizar transações autenticadas ou não autenticadas 3. Autorizar sem autenticação |
card.softDescriptor | Texto | 22 | Não | Texto a ser exibido na fatura do portador do cartão.SoftDescriptor |
card.saveCard | Booleano | — | Não | Configura salvar o cartão (tokenização). |
card.recurrent | Booleano | — | Não | Informa se a transação é recorrente. |
electronicTransfer.provider | Texto | 20 | Sim | Nome da instituição financeira: ITAU |
bankSlip.expirationDate | Texto | 20 | Sim | Data de vencimento do boleto. formato YYYY-MM-DD |
bankSlip.instructions | Texto | 300 | Sim | Instruções do boleto. Para o Itaú a quantidade máxima de caracteres será: 180, e o texto será truncado em 3 partes de 60 caracteres. |
bankSlip.guarantor | Texto | 45 | Sim | Nome do avalista. |
bankSlip.provider | Texto | 20 | Sim | Nome da instituição financeira: BRADESCO ITAU * SANTANDER |
pix.provider | Texto | 20 | Não | Nome da instituição financeira: C6BANK ITAU |
pix.key | Texto | 20 | Não | Campos utilizados para o Pix: RANDOM_KEY DOCUMENT PHONE |
pix.expirationDateTime | Texto | 20 | Não | Data da expiração da qrcode. Formato 2021-01-25T18:10:53 |
{
"referenceId": "19893211234",
"amount": "1000",
"description": "Mouse sem fio",
"postBackUrl": "http://url-notificacao",
"redirectUrl": "http://url-redirect",
"dtExpiration": "2020-12-25T18:10:53",
"customer": {
"name": "Comprador Teste",
"document": "12345678909",
"email": "[email protected]",
"phoneNumber": "1199922322322",
"address": {
"address": "Endereco",
"number": "100",
"complement": "Apartamento 22",
"district": "Vila Olimpia",
"zipcode": "09878675",
"city": "Sao Paulo",
"state": "SP"
}
},
"payment": {
"card": {
"type": 0,
"capture": false,
"installments": "2",
"fixedInstallments": false,
"interestType": "3",
"authenticate": "3",
"softDescriptor": "GATE2all",
"saveCard": true,
"recurrent": false
},
"electronicTransfer": {
"provider": "Bradesco"
},
"bankSlip": {
"expirationDate": "2020-12-30",
"instructions": "Aceitar somente até a data de vencimento, após essa data juros de 1% dia",
"guarantor": "Comprador Teste",
"provider": "Bradesco"
},
"pix": {
"provider": "C6BANK",
"key": [ "RANDOM_KEY" ],
"expirationDateTime": "2021-12-25T18:10:53"
}
}
}
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;
URL obj = new URL("https://api.gate2all.com.br/v1/intention");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
con.setRequestProperty("content-type", "application/json");
con.setRequestProperty("authenticationApi", "demo");
con.setRequestProperty("authenticationKey", "demo");
String body = "{"
+ "\"referenceId\": \"19893211234\","
+ "\"amount\": \"1000\","
+ "\"description\": \"Mouse sem fio\","
+ "\"postBackUrl\": \"http://url-notificacao\","
+ "\"redirectUrl\": \"http://url-redirect\","
+ "\"dtExpiration\": \"2021-12-25T18:10:53\","
+ " \"customer\": {"
+ " \"name\": \"Comprador Teste\","
+ " \"document\": \"12345678909\","
+ " \"email\": \"[email protected]\","
+ " \"address\": {"
+ " \"address\": \"Endereco\","
+ " \"number\": \"100\","
+ " \"district\": \"Vila Olimpia\","
+ " \"complement\": \"Apartamento 22\","
+ " \"zipcode\": \"09878675\","
+ " \"city\": \"Sao Paulo\","
+ " \"state\": \"SP\""
+ " }"
+ " },"
+ " \"payment\": {"
+ " \"card\": {"
+ " \"type\": 0,"
+ " \"capture\": false,"
+ " \"installments\": \"2\","
+ " \"fixedInstallments\": false,"
+ " \"interestType\": \"4\","
+ " \"authenticate\": \"3\","
+ " \"softDescriptor\": \"GATE2all\","
+ " \"saveCard\": true,"
+ " \"recurrent\": true"
+ " },"
+ " \"electronicTransfer\": {"
+ " \"provider\": \"Bradesco\""
+ " },"
+ " \"bankSlip\": {"
+ " \"expirationDate\": \"2020-12-30\","
+ " \"instructions\": \"Aceitar somente ate a data de vencimento, apes essa data juros de 1% dia\","
+ " \"guarantor\": \"Comprador Teste\","
+ " \"provider\": \"Bradesco\""
+ " }"
+ " \"pix\": {"
+ " \"provider\": \"C6BANK\","
+ " \"key\": [\"RANDOM_KEY\"], "
+ " \"expirationDateTime\": '2021-12-25T18:10:53' "
+ " }"
+ " }"
+ "}";
con.setDoOutput(true);
DataOutputStream dos = new DataOutputStream(con.getOutputStream());
dos.writeBytes(body);
dos.flush();
dos.close();
Scanner scanner = new Scanner(new BufferedReader(new InputStreamReader(con.getInputStream())));
String response = scanner.nextLine();
scanner.close();
System.out.println(response);
Caso a intenção de venda com pagamento em boleto ou Pix possuem a data de expiração inferior a data atual, não serão exibidas as respectivas opções para pagamento.
RESPOSTA SUCESSO
Status : 201
PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
---|---|---|---|
transactionId | Texto | 36 | Identificador da transação do GATE2all. |
url | Texto | 150 | URL da intenção. |
{
"transactionId": "b9bb32a8-401e-41a0-a9ee-af9e8ab0de92",
"url": "https://api.gate2all.com.br/v1/payment/b9bb32a8-401e-41a0-a9ee-af9e8ab0de92"
}
RESPOSTA ERRO
Status : 400
PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
---|---|---|---|
DESCRIÇÃO | Texto | 50 | Texto informando o erro na geração da Intenção de Venda. |
{
"error": {
"message": "amount nao pode ser vazio"
}
}
Redirecione o comprador para a URL da resposta.
Updated about 1 year ago