Criando uma transação

Estrutura para geração de boletos com carteiras sem ou com registro.

Particulariedades:

  • O campo deve ser preenchido apenas com a sigla do Estado;
  • O campo deve conter até 8 dígitos;
  • Importante a utilização do recurso de Campainha, para atualização dos pedidos no Ecommerce;

REQUISIÇÃO

Para enviar a transação, utilize o método POST.

Para autenticação, enviar login e senha no HEADER:

Campo Descrição
usuario Login do estabelecimento
senha Senha do estabelecimento
Campo Descrição Tipo Tamanho Obrigatório
codigoEstabelecimento Código que identifica o estabelecimento dentro do Yapay (fornecido pelo gateway) Numérico 13 dígitos Sim
codigoFormaPagamento Código da forma de pagamento      
Numérico Até 3 dígitos Sim    
transacao Nó reservado para informações da transação - - -
itensDoPedido Nó reservado para informações dos produtos - - -
dadosCobranca Nó reservado para informações dos dados de cobrança - - -
telefone Nó reservado para informações de telefone - - -
dadosEntrega Nó reservado para informações de dados de entrega - - -

transacao

Campo Descrição Tipo Tamanho Obrigatório
numeroTransacao Código que identifica a transação dentro do Yapay Numérico Até 19 dígitos Sim
codigoEstabelecimento Código que identifica o estabelecimento dentro do Yapay (fornecido pelo gateway) Numérico 13 dígitos Sim
codigoFormaPagamento Código da forma de pagamento Numérico Até 3 dígitos Sim
valor Valor da transação. Deve ser enviado sem pontos ou vírgulas Numérico Até 10 dígitos Sim
valorDesconto Valor do desconto da transação. Campo apenas informativo Numérico Até 10 dígitos Sim
urlCampainha URL será sempre acionada quando o status do pedido mudar. Deve estar preparada para receber dados de campainha Alfa Numérico Até 250 caracteres Sim
dataVencimentoBoleto Data de vencimento do boleto, se não enviado será utilizado os dias da configuração Alfa Numérico Até 10 caracteres Não
urlResultado Para o modelo de pagamento redirect, O Yapay redirecionará para essa URL Alfa Numérico Até 250 caracteres Para pagamentos redirecionáveis é obrigatório
ip Número do IP do usuário final/cliente. Formato xxx.xxx.xxx.xxx Alfa Numérico Até 15 caracteres Não
idioma 1 - Português 2 - Inglês 3 - Espanhol Numérico - Sim
campoLivre1 Campo Livre 1 Alfa Numérico Até 16 caracteres Não
campoLivre2 Campo Livre 2 Alfa Numérico Até 16 caracteres Não
campoLivre3 Campo Livre 3 Alfa Numérico Até 16 caracteres Não
campoLivre4 Campo Livre 4 Alfa Numérico Até 16 caracteres Não
campoLivre5 Campo Livre 5 Alfa Numérico Até 16 caracteres Não

dadosCobranca

Campo Descrição Tipo Tamanho Obrigatório
nome Nome do comprador Alfa Numérico Até 100 caracteres Sim
documento Documento principal do comprado Alfa Numérico 30 caracteres Sim
documento2 Documento principal do comprado Alfa Numérico 30 caracteres Não
email E-mail do comprador Alfa Numérico 20 caracteres Sim
codigoCliente Código do Comprador Alfa Numérico 20 caracteres Não
dataNascimento Data Nascimento Comprador Alfa Numérico 10 caracteres Não
sexo Sexo Comprador Alfa Numérico 2 caracteres Não
tipoCliente Tipo do Cliente - 1 - Pessoa Física 2 - Pessoa Jurídica Numérico Até 8 dígitos Sim
endereco Nó reservado para dados de endereço do comprador - - -
telefone Nó reservado para dados de telefone do comprador - - -

endereco

Campo Descrição Tipo Obrigatório
logradouro Endereço do comprador Alfa Numérico Sim
numero Número do comprador Alfa Numérico Sim
bairro Bairro do comprador Alfa Numérico Sim
complemento Complemento do endereço Alfa Numérico Não
cidade Cidade do comprador Alfa Numérico Sim
estado Estado do comprador Alfa Numérico Sim
cep CEP do comprador Alfa Numérico Sim
pais País do comprador Alfa Numérico Não

telefone

Campo Descrição Tipo Obrigatório
tipoTelefone 1 = Outros / 2 = Residencial / 3 = Comercial / 4 = Recados / 5 = Cobrança / 6 = Temporário Numérico Sim
ddi Código DDI do telefone Alfa Numérico Não
ddd Código DDD do telefone Alfa Numérico Não
telefone Número do telefone Alfa Numérico Não

dadosEntrega

Campo Descrição Tipo Tamanho Obrigatório
nome Nome do comprador Alfa Numérico 20 caracteres Não
email E-mail do comprador Alfa Numérico 20 caracteres Não
endereco Nó reservado para dados de endereço do comprador - - -
telefone Nó reservado para dados de telefone do comprador - - -

RESPOSTA

Para geração da transferência, o eCommerce deverá redirecionar o consumidor para a URl retornada no campo

Campo Descrição Tipo Tamanho
numeroTransacao Código que identifica a transação dentro do Yapay Numérico Até 19 dígitos
codigoEstabelecimento Código que identifica o estabelecimento dentro do Yapay Numérico 13 dígitos
codigoFormaPagamento Código da forma de pagamento Numérico Até 3 dígitos
valor Valor da transação. Numérico Até 10 dígitos
valorDesconto Valor desconto Numérico Até 10 dígitos
taxaEmbarque Valor taxa embarque Numérico Até 10 dígitos
parcelas Quantidade de parcelas da transação Numérico Até 2 dígitos
urlPagamento Para o modelo redirect. Essa será a URL de redirecionamento da operação Alfa Numérico Até 500 caracteres
statusTransacao Status atual da transação Numérico Até 2 dígitos
autorizacao Retornado “0” para transferência Numérico Até 20 dígitos
codigoTransacaoOperadora Retornado “0” para transferência Numérico Até 20 dígitos
dataAprovacaoOperadora Retornado em branco para transferência Alfa Numérico Até 10 dígitos
numeroComprovanteVenda Retornado em branco para transferência Alfa Numérico Até 20 dígitos
mensagemVenda Retornado em branco para transferência Alfa Numérico Até 50 dígitos

Ao lado você pode visualizar um exemplo de retorno da transação.

curl
  --request POST https://sandbox.gateway.yapay.com.br/checkout/api/v3/transacao
  --header "Content-Type: application/json"
  --header "--curl -u usuario:senha .........
  --data-binary
  {
    "codigoEstabelecimento" : 1000000000000,
    "codigoFormaPagamento" : 16,
    "transacao" : {
        "numeroTransacao" : 1234,
        "valor" : 2000,
        "valorDesconto" : 0,
        "parcelas" : 1,
        "urlCampainha" : "http://seusite.com.br/campainha",
        "urlResultado" : "http://seusite.com.br/retorno",
        "ip" : "192.168.12.110",
        "idioma" : 1
    },
    "itensDoPedido" : [
    {
        "codigoProduto" : 1,
        "nomeProduto" : "Produto 1",
        "codigoCategoria" : 1,
        "nomeCategoria" : "categoria",
        "quantidadeProduto" : 1,
        "valorUnitarioProduto" : 2000
    }
    ],
    "dadosCobranca" : {
        "codigoCliente" : 1,
        "tipoCliente" : 1,
        "nome" : "Teste 123",
        "email" : "teste@teste.com",
        "dataNascimento" : "10/01/1975",
        "sexo" : "M",
        "documento" : "123.123.123-12",
        "endereco" : {
          "logradouro" : "Rua",
          "numero" : "123",
          "complemento" : "",
          "cep" : "12345-678",
          "bairro" : "Bairro",
          "cidade" : "Cidade",
          "estado" : "SP",
          "pais" : "BR"
          },
        "telefone" : [
          {
          "tipoTelefone" : "1",
          "ddi" : "55",
          "ddd" : "12",
          "telefone" : "1234-5678"
          }
        ]
    },
    "dadosEntrega" : { 
        "nome" : "Teste 123",
        "endereco" : {
          "logradouro" : "Rua",
          "numero" : "123",
          "complemento" : "",
          "cep" : "12345-678",
          "bairro" : "Bairro",
          "cidade" : "Cidade",
          "estado" : "SP",
          "pais" : "BR"
          },
        "telefone" : [
          {
          "tipoTelefone" : "1",
          "ddi" : "55",
          "ddd" : "12",
          "telefone" : "1234-5678"
          }
        ]
    }
  }


--header "Content-Type: application/json"
  {  "numeroTransacao": 1234,
    "codigoEstabelecimento": "1000000000000",
    "codigoFormaPagamento": 16,
    "valor": 2000, 
    "valorDesconto": 0, 
    "parcelas": 1, 
    "statusTransacao": 8,
    "autorizacao": "0",
    "codigoTransacaoOperadora": "0",
    "dataAprovacaoOperadora": "", 
    "numeroComprovanteVenda": "", 
    "nsu": "",
    "mensagemVenda": "",
    "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/PagamentoIatuShopLine/PagamentoItauShopLine.do?cod=132971582229c00506d-e84d-4526-b902-92190d5aa808"
  }