Criando uma transação

Através desta funcionalidade, é possível finalizar pagamentos dentro do ambiente seguro do Yapay. O consumidor será redirecionado para o Checkout do Gateway e assim finalizará sua transação. Os meios de pagamentos disponíveis serão todos que estiverem configurados no estabelecimento.

Particulariedades

  • Disponível apenas no Plano Corporativo;
  • Disponível para cartão de crédito;
  • Funcionalidade com redirecionamento;
  • Importante a utilização do recurso de Campainha, para atualização dos pedidos no Ecommerce;
  • Estrutura para utilização de Multiplos Cartões.

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 Obrigatório
codigoEstabelecimento Código único que identifica o estabelecimento dentro do Yapay Numérico Sim
codigoFormaPagamento Código da forma de pagamento - Enviar 997 Numérico Sim

transacao

Campo Descrição Tipo Obrigatório
numeroTransacao Código único que identifica o pedido Numérico Sim
valor Valor da transação. Não utilizar vírgulas ou pontos Numérico Sim
valorDesconto Valor do desconto da transação. Campo apenas informativo Numérico Sim
parcelas Quantidade de parcelas da transação Numérico Sim
urlCampainha URL será sempre acionada quando o status do pedido mudar. Deve estar preparada para receber dados de campainha Alfa Numérico Não
urlResultado Consumidor será redirecionado para esta URL, quando finalizar o pagamento Alfa Numérico Não
idioma 1 - Português 2 - Inglês 3 - Espanhol Numérico Sim
ip Número do IP do usuário final/cliente. Formato xxx.xxx.xxx.xxx Alfa Numérico Caso utilizar antifraude, sim
dataVencimentoBoleto Data do Vencimento do boleto. Formato dd/mm/aaaa Alfa Numérico Não
campoLivre1 Campo Livre 1 Alfa Numérico Não
campoLivre2 Campo Livre 2 Alfa Numérico Não
campoLivre3 Campo Livre 3 Alfa Numérico Não
campoLivre4 Campo Livre 4 Alfa Numérico Não
campoLivre5 Campo Livre 5 Alfa Numérico Não

checkout

Campo Descrição Tipo Obrigatório
processar Enviar 0 - pagamento comum Numérico Sim
tipoPagamento 0 - Todas formas de pagamento; 1 - Cartões de Crédito; 2 - Cartões de Débito; 3 - Boleto; 4 - Transferência; Numérico Sim

itensDoPedido

Campo Descrição Tipo Obrigatório
codigoProduto Código único que identifica o produto Alfa Numérico Caso utilize antifraude, sim
nomeProduto Nome do Produto Alfa Numérico Caso utilize antifraude, sim
quantidadeProduto Quantidade do produto Numérico Sim
valorUnitarioProduto Valor unitário do produto. Deve ser enviado sem pontos ou vírgulas Numérico Sim
codigoCategoria Código que identifica categoria do produto Alfa Numérico Caso utilize antifraude, sim
nomeCategoria Nome da categoria do produto Alfa Numérico Caso utilize antifraude, sim

dadosCobranca

Campo Descrição Tipo Obrigatório
nome Nome do comprador Alfa Numérico 20 caracteres
email E-mail do comprador Alfa Numérico 20 caracteres
documento Documento do Comprador Alfa Numérico 100 caracteres
tipoCliente 1 - Pessoa Física 2 - Pessoa Jurídica Numérico Caso utilize antifraude, 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
nomeEntrega Nome de entegra Alfa Numérico Até 100 caracteres Caso utilize antifraude, sim
emailEntrega Email de entrega Alfa Numérico Até 100 caracteres Caso utilize antifraude, sim
enderecoEntrega Logradouro de entrega Alfa Numérico Até 100 caracteres Caso utilize antifraude, sim
bairroEntrega Bairro de entrega Alfa Numérico Até 50 caracteres Caso utilize antifraude, sim
complementoEntrega Complemento do endereço de entrega Alfa Numérico Até 50 caracteres Não
cidadeEntrega Cidade de entrega Alfa Numérico Até 50 caracteres Caso utilize antifraude, sim
estadoEntrega Estado de entrega Alfa Numérico 2 caracteres Caso utilize antifraude, sim
cepEntrega CEP de entrega. Enviar sem traços ou espaços Alfa Numérico Até 10 caracteres Caso utilize antifraude, sim
paisEntrega Pais de entrega Alfa Numérico Até 50 caracteres Não

RESPOSTA

Campo Descrição
urlPagamento URL para redirecionar o consumidor para o Checkout

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"
      --curl -u usuario:senha .........
      --data-binary
      {
          "codigoEstabelecimento": 1000000000000,
          "codigoFormaPagamento" : 997,
          "transacao": {
              "numeroTransacao": 123,
              "valor": 2000,
              "valorDesconto": 0,
              "dataVencimentoBoleto":,
              "parcelas": 1,
              "urlCampainha": "http://sualoja.com.br_campainha/",
              "urlResultado": "http://sualoja.com.br",
              "ip": "192.168.12.110",
              "idioma": 1
          },
          "checkout": {
              "processar": 0,
              "tipoPagamento" : 0
          },
          "itensDoPedido": [
              {
              "codigoProduto": 1,
              "nomeProduto": "Produto 1",
              "codigoCategoria": 1,
              "nomeCategoria": "categoria",
              "quantidadeProduto": 1,
              "valorUnitarioProduto": 2000
              }
          ]
          "dadosCobranca": {
              "nome": "Teste 123",
              "email": "teste@teste.com",
              "documento": "12345671234",
              "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",
              "email": "teste@teste.com",
              "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"
      {
          "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/checkout/redirecionaPagamento?codigoPagamento=150609150796704e7-5b25-4a41-a753-a09bfb66db8d&tipoPagamento=0&oneClick=false"
      }

Criando transação com Multiplos Cartões

Particulariedades

  • Disponível apenas no Plano Corporativo;
  • Disponível para cartão de crédito;
  • Funcionalidade com redirecionamento;
  • Importante a utilização do recurso de Campainha, para atualização dos pedidos no Ecommerce;
  • Estrutura para utilização de Multiplos Cartões.

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 Obrigatório
codigoEstabelecimento Código único que identifica o estabelecimento dentro do Yapay Numérico Sim
codigoFormaPagamento Código da forma de pagamento - Enviar 997 Numérico Sim

transacao

Campo Descrição Tipo Obrigatório
numeroTransacao Código único que identifica o pedido Numérico Sim
valor Valor da transação. Não utilizar vírgulas ou pontos Numérico Sim
valorDesconto Valor do desconto da transação. Campo apenas informativo Numérico Sim
parcelas Quantidade de parcelas da transação Numérico Sim
urlCampainha URL será sempre acionada quando o status do pedido mudar. Deve estar preparada para receber dados de campainha Alfa Numérico Não
urlResultado Consumidor será redirecionado para esta URL, quando finalizar o pagamento Alfa Numérico Não
idioma 1 - Português 2 - Inglês 3 - Espanhol Numérico Sim
ip Número do IP do usuário final/cliente. Formato xxx.xxx.xxx.xxx Alfa Numérico Caso utilizar antifraude, sim
dataVencimentoBoleto Data do Vencimento do boleto. Formato dd/mm/aaaa Alfa Numérico Não
campoLivre1 Campo Livre 1 Alfa Numérico Não
campoLivre2 Campo Livre 2 Alfa Numérico Não
campoLivre3 Campo Livre 3 Alfa Numérico Não
campoLivre4 Campo Livre 4 Alfa Numérico Não
campoLivre5 Campo Livre 5 Alfa Numérico Não

checkout

Campo Descrição Tipo Obrigatório
processar Enviar 0 - pagamento comum Numérico Sim
tipoPagamento 0 - Todas formas de pagamento; 1 - Cartões de Crédito; 2 - Cartões de Débito; 3 - Boleto; 4 - Transferência; Numérico Sim
multiploCartao Enviar 1 Numérico Sim

itensDoPedido

Campo Descrição Tipo Obrigatório
codigoProduto Código único que identifica o produto Alfa Numérico Caso utilize antifraude, sim
nomeProduto Nome do Produto Alfa Numérico Caso utilize antifraude, sim
quantidadeProduto Quantidade do produto Numérico Sim
valorUnitarioProduto Valor unitário do produto. Deve ser enviado sem pontos ou vírgulas Numérico Sim
codigoCategoria Código que identifica categoria do produto Alfa Numérico Caso utilize antifraude, sim
nomeCategoria Nome da categoria do produto Alfa Numérico Caso utilize antifraude, sim

dadosCobranca

Campo Descrição Tipo Obrigatório
nome Nome do comprador Alfa Numérico 20 caracteres
email E-mail do comprador Alfa Numérico 20 caracteres
documento Documento do Comprador Alfa Numérico 100 caracteres
tipoCliente 1 - Pessoa Física 2 - Pessoa Jurídica Numérico Caso utilize antifraude, 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 Caso utilize antifraude, sim
numero Número do comprador Alfa Numérico Caso utilize antifraude, sim
bairro Bairro do comprador Alfa Numérico Caso utilize antifraude, sim
complemento Complemento do endereço Alfa Numérico Não
cidade Cidade do comprador Alfa Numérico Caso utilize antifraude, sim
estado Estado do comprador Alfa Numérico Caso utilize antifraude, sim
cep CEP do comprador Alfa Numérico Caso utilize antifraude, sim
pais País do comprador Alfa Numérico Caso utilize antifraude, sim

telefone

Campo Descrição Tipo Tamanho Obrigatório
ddd DDD do telefone do comprador Alfa Numérico Até 3 caracteres Caso utilize antifraude, sim
ddi DDI do telefone do comprador Alfa Numérico Até 3 caracteres Caso utilize antifraude, sim
telefone Número do telefone Alfa Numérico Até 10 caracteres Caso utilize antifraude, sim
tipoTelefone 1 - Outros 2 - Residencial 3 - Comercial Numérico Até 2 dígitos Sim

dadosEntrega

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

RESPOSTA

Campo Descrição
urlPagamento URL para redirecionar o consumidor para o Checkout

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"
      --curl -u usuario:senha .........
      --data-binary
      {
          "codigoEstabelecimento": 1000000000000,
          "codigoFormaPagamento" : 997,
          "transacao": {
              "numeroTransacao": 123,
              "valor": 2000,
              "valorDesconto": 0,
              "dataVencimentoBoleto":,
              "parcelas": 1,
              "urlCampainha": "http://sualoja.com.br_campainha/",
              "urlResultado": "http://sualoja.com.br",
              "ip": "192.168.12.110",
              "idioma": 1
          },
          "checkout": {
              "processar": 0,
              "tipoPagamento" : 1,
              "multiploCartao": 1
          },
          "itensDoPedido": [
              {
              "codigoProduto": 1,
              "nomeProduto": "Produto 1",
              "codigoCategoria": 1,
              "nomeCategoria": "categoria",
              "quantidadeProduto": 1,
              "valorUnitarioProduto": 2000
              }
          ]
          "dadosCobranca": {
              "nome": "Teste 123",
              "email": "teste@teste.com",
              "documento": "12345671234",
              "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",
              "email": "teste@teste.com",
              "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"
  {
      "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/checkout/redirecionaPagamento?codigoPagamento=150609150796704e7-5b25-4a41-a753-a09bfb66db8d&tipoPagamento=0&oneClick=false"
  }

Criando transação com um clique

Particulariedades

  • Disponível apenas no Plano Corporativo;
  • Funcionalidade com redirecionamento;
  • Importante a utilização do recurso de Campainha, para atualização dos pedidos no Ecommerce;

Neste modelo os dados de cartão, como nome titular, número e data de validade, são cadastrados no sistema de forma segura e assim o consumidor não precisará incluir estes dados em sua próxima compra, tendo que incluir apenas seu código de segurança para finalizar a transação. Os cartões cadastrados são vinculados ao email do consumidor.

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 Obrigatório
codigoEstabelecimento Código único que identifica o estabelecimento dentro do Yapay Numérico Sim
codigoFormaPagamento Código da forma de pagamento - Enviar 997 Numérico Sim

transacao

Campo Descrição Tipo Obrigatório
numeroTransacao Código único que identifica o pedido Numérico Sim
valor Valor da transação. Não utilizar vírgulas ou pontos Numérico Sim
valorDesconto Valor do desconto da transação. Campo apenas informativo Numérico Sim
parcelas Quantidade de parcelas da transação Numérico Sim
urlCampainha URL será sempre acionada quando o status do pedido mudar. Deve estar preparada para receber dados de campainha Alfa Numérico Não
urlResultado Consumidor será redirecionado para esta URL, quando finalizar o pagamento Alfa Numérico Não
idioma 1 - Português 2 - Inglês 3 - Espanhol Numérico Sim
ip Número do IP do usuário final/cliente. Formato xxx.xxx.xxx.xxx Alfa Numérico Caso utilizar antifraude, sim
dataVencimentoBoleto Data do Vencimento do boleto. Formato dd/mm/aaaa Alfa Numérico Não
campoLivre1 Campo Livre 1 Alfa Numérico Não
campoLivre2 Campo Livre 2 Alfa Numérico Não
campoLivre3 Campo Livre 3 Alfa Numérico Não
campoLivre4 Campo Livre 4 Alfa Numérico Não
campoLivre5 Campo Livre 5 Alfa Numérico Não

checkout

Campo Descrição Tipo Obrigatório
processar Enviar 0 - pagamento comum Numérico Sim
tipoPagamento 0 - Todas formas de pagamento; 1 - Cartões de Crédito; 2 - Cartões de Débito; 3 - Boleto; 4 - Transferência; Numérico Sim
multiploCartao Enviar 1 Numérico Sim

itensDoPedido

Campo Descrição Tipo Obrigatório
codigoProduto Código único que identifica o produto Alfa Numérico Caso utilize antifraude, sim
nomeProduto Nome do Produto Alfa Numérico Caso utilize antifraude, sim
quantidadeProduto Quantidade do produto Numérico Sim
valorUnitarioProduto Valor unitário do produto. Deve ser enviado sem pontos ou vírgulas Numérico Sim
codigoCategoria Código que identifica categoria do produto Alfa Numérico Caso utilize antifraude, sim
nomeCategoria Nome da categoria do produto Alfa Numérico Caso utilize antifraude, sim

dadosCobranca

Campo Descrição Tipo Obrigatório
nome Nome do comprador Alfa Numérico 20 caracteres
email E-mail do comprador Alfa Numérico 20 caracteres
documento Documento do Comprador Alfa Numérico 100 caracteres
tipoCliente 1 - Pessoa Física 2 - Pessoa Jurídica Numérico Caso utilize antifraude, 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 Caso utilize antifraude, sim
numero Número do comprador Alfa Numérico Caso utilize antifraude, sim
bairro Bairro do comprador Alfa Numérico Caso utilize antifraude, sim
complemento Complemento do endereço Alfa Numérico Não
cidade Cidade do comprador Alfa Numérico Caso utilize antifraude, sim
estado Estado do comprador Alfa Numérico Caso utilize antifraude, sim
cep CEP do comprador Alfa Numérico Caso utilize antifraude, sim
pais País do comprador Alfa Numérico Caso utilize antifraude, sim

telefone

Campo Descrição Tipo Tamanho Obrigatório
ddd DDD do telefone do comprador Alfa Numérico Até 3 caracteres Caso utilize antifraude, sim
ddi DDI do telefone do comprador Alfa Numérico Até 3 caracteres Caso utilize antifraude, sim
telefone Número do telefone Alfa Numérico Até 10 caracteres Caso utilize antifraude, sim
tipoTelefone 1 - Outros 2 - Residencial 3 - Comercial Numérico Até 2 dígitos Sim

dadosEntrega

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

RESPOSTA

Campo Descrição
urlPagamento URL para redirecionar o consumidor para o Checkout

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"
      --curl -u usuario:senha .........
      --data-binary
      {
          "codigoEstabelecimento": 1000000000000,
          "codigoFormaPagamento" : 997,
          "transacao": {
              "numeroTransacao": 123,
              "valor": 2000,
              "valorDesconto": 0,
              "dataVencimentoBoleto":,
              "parcelas": 1,
              "urlCampainha": "http://sualoja.com.br_campainha/",
              "urlResultado": "http://sualoja.com.br",
              "ip": "192.168.12.110",
              "idioma": 1
          },
          "checkout": {
              "processar": 1,
              "tipoPagamento" : 1,

          },
          "itensDoPedido": [
              {
              "codigoProduto": 1,
              "nomeProduto": "Produto 1",
              "codigoCategoria": 1,
              "nomeCategoria": "categoria",
              "quantidadeProduto": 1,
              "valorUnitarioProduto": 2000
              }
          ]
          "dadosCobranca": {
              "nome": "Teste 123",
              "email": "teste@teste.com",
              "documento": "12345671234",
              "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",
              "email": "teste@teste.com",
              "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"
      {
          "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/checkout/redirecionaPagamento?codigoPagamento=150609150796704e7-5b25-4a41-a753-a09bfb66db8d&tipoPagamento=0&oneClick=false"
      }

Criando transação com Multiplos Boletos

Particulariedades

  • Disponível apenas no Plano Corporativo;
  • Funcionalidade com redirecionamento;
  • 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 Obrigatório
codigoEstabelecimento Código único que identifica o estabelecimento dentro do Yapay Numérico Sim
codigoFormaPagamento Código da forma de pagamento - Enviar 997 Numérico Sim

transacao

Campo Descrição Tipo Obrigatório
numeroTransacao Código único que identifica o pedido Numérico Sim
valor Valor da transação. Não utilizar vírgulas ou pontos Numérico Sim
valorDesconto Valor do desconto da transação. Campo apenas informativo Numérico Sim
parcelas Quantidade de parcelas da transação Numérico Sim
urlCampainha URL será sempre acionada quando o status do pedido mudar. Deve estar preparada para receber dados de campainha Alfa Numérico Não
urlResultado Consumidor será redirecionado para esta URL, quando finalizar o pagamento Alfa Numérico Não
idioma 1 - Português 2 - Inglês 3 - Espanhol Numérico Sim
ip Número do IP do usuário final/cliente. Formato xxx.xxx.xxx.xxx Alfa Numérico Caso utilizar antifraude, sim
dataVencimentoBoleto Data do Vencimento do boleto. Formato dd/mm/aaaa Alfa Numérico Não
campoLivre1 Campo Livre 1 Alfa Numérico Não
campoLivre2 Campo Livre 2 Alfa Numérico Não
campoLivre3 Campo Livre 3 Alfa Numérico Não
campoLivre4 Campo Livre 4 Alfa Numérico Não
campoLivre5 Campo Livre 5 Alfa Numérico Não

checkout

Campo Descrição Tipo Obrigatório
processar Enviar 0 - pagamento comum Numérico Sim
tipoPagamento 0 - Todas formas de pagamento; 1 - Cartões de Crédito; 2 - Cartões de Débito; 3 - Boleto; 4 - Transferência; Numérico Sim
multiploCartao Enviar 1 Numérico Sim

boletos

Campo Descrição Tipo Obrigatório
valor Valor do boleto Numérico Sim
vencimento Vencimento do boleto. Formato dd/mm/aaaa Alfa Numérico Sim

itensDoPedido

Campo Descrição Tipo Obrigatório
codigoProduto Código único que identifica o produto Alfa Numérico Caso utilize antifraude, sim
nomeProduto Nome do Produto Alfa Numérico Caso utilize antifraude, sim
quantidadeProduto Quantidade do produto Numérico Sim
valorUnitarioProduto Valor unitário do produto. Deve ser enviado sem pontos ou vírgulas Numérico Sim
codigoCategoria Código que identifica categoria do produto Alfa Numérico Caso utilize antifraude, sim
nomeCategoria Nome da categoria do produto Alfa Numérico Caso utilize antifraude, sim

dadosCobranca

Campo Descrição Tipo Obrigatório
nome Nome do comprador Alfa Numérico 20 caracteres
email E-mail do comprador Alfa Numérico 20 caracteres
documento Documento do Comprador Alfa Numérico 100 caracteres
tipoCliente 1 - Pessoa Física 2 - Pessoa Jurídica Numérico Caso utilize antifraude, 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 Caso utilize antifraude, sim
numero Número do comprador Alfa Numérico Caso utilize antifraude, sim
bairro Bairro do comprador Alfa Numérico Caso utilize antifraude, sim
complemento Complemento do endereço Alfa Numérico Não
cidade Cidade do comprador Alfa Numérico Caso utilize antifraude, sim
estado Estado do comprador Alfa Numérico Caso utilize antifraude, sim
cep CEP do comprador Alfa Numérico Caso utilize antifraude, sim
pais País do comprador Alfa Numérico Caso utilize antifraude, sim

telefone

Campo Descrição Tipo Tamanho Obrigatório
ddd DDD do telefone do comprador Alfa Numérico Até 3 caracteres Caso utilize antifraude, sim
ddi DDI do telefone do comprador Alfa Numérico Até 3 caracteres Caso utilize antifraude, sim
telefone Número do telefone Alfa Numérico Até 10 caracteres Caso utilize antifraude, sim
tipoTelefone 1 - Outros 2 - Residencial 3 - Comercial Numérico Até 2 dígitos Sim

dadosEntrega

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

RESPOSTA

Campo Descrição
urlPagamento URL para redirecionar o consumidor para o Checkout

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"
      --curl -u usuario:senha .........
      --data-binary
      {
          "codigoEstabelecimento": 1000000000000,
          "codigoFormaPagamento" : 997,
          "transacao": {
              "numeroTransacao": 123,
              "valor": 10000,
              "valorDesconto": 0,
              "dataVencimentoBoleto":,
              "parcelas": 1,
              "urlCampainha": "http://sualoja.com.br_campainha/",
              "urlResultado": "http://sualoja.com.br",
              "ip": "192.168.12.110",
              "idioma": 1
          },
          "checkout": {
              "processar": 0,
              "tipoPagamento" : 3,
              "multiploBoleto": 1,
              "boletos": [
              {
              "valor": 5000,
              "vencimento": "13/01/2018"
              },
              {
              "valor": 5000,
              "vencimento": "13/02/2018"
              }
              ]
          },
          "itensDoPedido": [
              {
              "codigoProduto": 1,
              "nomeProduto": "Produto 1",
              "codigoCategoria": 1,
              "nomeCategoria": "categoria",
              "quantidadeProduto": 1,
              "valorUnitarioProduto": 10000
              }
          ]
          "dadosCobranca": {
              "nome": "Teste 123",
              "email": "teste@teste.com",
              "documento": "12345671234",
              "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",
              "email": "teste@teste.com",
              "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"
      {
          "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/checkout/redirecionaPagamento?codigoPagamento=150609150796704e7-5b25-4a41-a753-a09bfb66db8d&tipoPagamento=0&oneClick=false"
      }