Consultando uma Transação

Para receber novamente os dados de retorno de uma venda, realize uma consulta.

REQUISIÇÃO

Para consultas, acione o método GET.

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

Campo Descrição
usuario Login do estabelecimento
senha Senha do estabelecimento
Campo Descrição Tipo Tamanho Obrigatório
numeroTransacao Código que identifica a transação dentro do Yapay Numérico Até 8 dígitos Sim
codigoEstabelecimento Código que identifica o estabelecimento dentro do Yapay (fornecido pelo gateway) Numérico 13 dígitos Sim

RESPOSTA

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 Url para autenticação em caso de cartão de débito Alfa Numérico Até 500 caracteres
statusTransacao Status atual da transação Numérico Até 2 dígitos
autorizacao Número de autorização da adquirente Numérico Até 20 dígitos
codigoTransacaoOperadora Código de retorno da adquirente Numérico Até 20 dígitos
dataAprovacaoOperadora Data aprovação Alfa Numérico Até 10 dígitos
numeroComprovanteVenda Número Comprovante de venda Alfa Numérico Até 20 dígitos
mensagemVenda Mensagem de venda Alfa Numérico Até 50 dígitos
cartoesUtilizados Cartões mascarados utilizados na transação Alfa Numérico Até 20 caracteres
curl
  --request GET https://sandbox.gateway.yapay.com.br/checkout/api/v3/transacao/10000000000000/1234
  --header "Content-Type: application/json"
  --curl -u usuario:senha .........
  --data-binary

--header "Content-Type: application/json"
  {   "numeroTransacao": 1234,
      "codigoEstabelecimento": "1000000000000",
      "codigoFormaPagamento": 170, 
      "valor": 2000, 
      "valorDesconto": 0, 
      "parcelas": 1,
      "statusTransacao": 13,
      "autorizacao": "123456",
      "codigoTransacaoOperadora": "0", 
      "dataAprovacaoOperadora": "24/05/2017",
      "numeroComprovanteVenda": "10069930690009F2122A",
      "nsu": "428706",
      "mensagemVenda": "Operation Success",
      "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/PagamentoCielo/PagamentoCielo.do?cod=14956291484887110cf2a-9aeb-4b34-a869-1a61f0611b66",
      "cartoesUtilizados": ["000000*******0001"]
  }

Consulta recorrente

Consulta para receber informações da recorrência e da última cobrança realizada.

REQUISIÇÃO

Para consultas, acione o método GET.

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

Campo Descrição
usuario Login do estabelecimento
senha Senha do estabelecimento
Campo Descrição Tipo Tamanho Obrigatório
numeroRecorrencia Número da Recorrência a ser consultado Numérico Até 8 dígitos Sim
estabelecimento Código que identifica o estabelecimento dentro do Yapay (fornecido pelo gateway) Numérico 3 dígitos Sim

RESPOSTA

Campo Descrição
numeroRecorrencia Número da Recorrência
estabelecimento Código do estabelecimento, fornecido pelo Yapay
valor Valor
statusTransacao Status atual da transação recorrente
numeroPedido Número do Pedido
numeroCobrancaTotal Quantidade total de cobranças pedidas no cadastro. Caso não tenha sido pedido um valor limite, este campo retornará a mensagem: “Sem Limite”
numeroCobrancaRestantes Quantidade restante de cobranças a serem efetuadas.
autorizacao Código de autorização retornado pela operadora. Retornado apenas se alguma cobrança já ocorreu
codigoTransacaoOperadora Código de transação retornado pela operadora. Retornado apenas se alguma cobrança já ocorreu
dataAprovacaoOperadora Data de aprovação retornado pela operadora. Retornado apenas se alguma cobrança já ocorreu
numeroComprovanteVenda Número do comprovante de venda retornado pela operadora. Retornado apenas se alguma cobrança já ocorreu
mensagemVenda Mensagem de venda retornado pela operadora. Retornado apenas se alguma cobrança já ocorreu

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

curl
  --request GET https://sandbox.gateway.yapay.com.br/checkout/api/v3/recorrencia/10000000000000/2
  --header "Content-Type: application/json"
  --curl -u usuario:senha .........
  --data-binary
--header "Content-Type: application/json"
  "recorrencia": {
    "estabelecimento": "1000000000000",
    "numeroRecorrencia": 2,
    "codigoFormaPagamento": 170,
    "valor": 13000,
    "numeroCobrancaTotal": 0,
    "numeroCobrancaRestantes": -1,
    "status": 0,
    "mensagem": "Processamento realizado com sucesso.",
    "numeroPedido": 20001,
    "statusTransacao": 1,
    "autorizacao": "123456",
    "codigoTransacaoOperadora": "00",
    "dataAprovacaoOperadora": "30/05/2017",
    "numeroComprovanteVenda": "1006993069000891071A",
    "mensagemVenda": "Operation Success"
    }

Consultando Token

Funcionalidade disponível para visualizar os dados cadastrados em um Token.

SANDBOX: ttps://sandbox.gateway.yapay.com.br/checkout/api/v3/oneclick/<<token>>

PRODUÇÃO: https://gateway.yapay.com.br/checkout/api/v3/oneclick/<<token>>

REQUISIÇÃO

Para consultas, acione o método GET.

RESPOSTA

Campo Descrição Tipo Tamanho
codigoEstabelecimento Código que identifica o estabelecimento dentro do SuperPay (fornecido pelo gateway) Numérico 13 dígitos
codigoFormaPagamento Código da forma de pagamento Numérico Até 3 dígitos
oneClick Retornará 1 para cadastro criado Numérico 1 dígito
token Token Alfa Numérico Até 60 caracteres
nomeTitularCartao Nome titular do cartão de crédito/débito Alfa Numérico Até 16 caracteres
numeroCartaoCredito Numero do cartão de crédito/débito, sem espaços ou traços Numérico Até 22 dígitos
dataValidadeCartao Data de validade do cartão. Formato mm/yyyy Alfa Numérico 7 caracteres
emailComprador Email do comprador Alfa Numérico 20 caracteres
curl
  --request GET https://sandbox.gateway.yapay.com.br/checkout/api/v3/oneclick/1514483826864c3149224-67db-4557-8950-6a80f708c1c5
  --header "Content-Type: application/json"
  --curl -u usuario:senha
  --data-binary
--header "Content-Type: application/json
  { 
  "codigoEstabelecimento": 1000000000000,
  "codigoFormaPagamento": 170,
  "oneClick": 1,
  "token": "1514483826864c3149224-67db-4557-8950-6a80f708c1c5",
  "nomeTitularCartaoCredito": "Teste OneClick",
  "numeroCartaoCredito": "000000******0002",
  "dataValidadeCartao": "10/2021",
  "emailComprador": "yapay@yapay.com.br"
  }