Yapay Intermediador - Solução de pagamentos online

Antifraude ClearSale

O gateway fornece a possibilidade de incluir um analisador de fraude para garantir a segurança das transações.

Quando um analisador de fraude/risco é ativado, ele se encaixa depois que a transação é autorizada e antes que a mesma seja capturada. O processo como um todo segue o seguinte fluxo:

Transação é enviada para a operadora /instituição financeira para ser autorizada.
Uma vez autorizada, o gateway envia a transação para análise de fraude.
Caso seja aprovada na análise, a transação entrará em modo de espera para ser enviada para a captura (de forma automática ou manual, de acordo com as configurações do estabelecimento). Caso seja negada na análise, a transação será automaticamente cancelada na operadora.

Sistemas Integrados com a Yapay

O Gateway de Pagamenta Yapay possui integração com o sistema de prevenção de risco e fraude ClearSale, nas seguintes modalidades Total, Total Garantido, Application, RealTime e Start. Caso for utilizado a funcionalidade de Fingerprint da ClearSale, o campo SessionID deverá ser enviado no campoLivre2 da Yapay. Para ter mais informações e receber um contato, sem compromisso de nosso time, acesse: https://lp.br.clear.sale/yapay

Para consultar valores dos planos da ClearSale com condições especiais da parceria, entre em contato através do email: parcerias@clear.sale

Informações para configuração

TOTAL/TOTAL GARANTIDO e APPLICATION

Entity Code

START

Entity Code

Entity Code

Voltar ao topo

Antifraude FControl

O gateway fornece a possibilidade de incluir um analisador de fraude para garantir a segurança das transações.

Quando um analisador de fraude/risco é ativado, ele se encaixa depois que a transação é autorizada e antes que a mesma seja capturada. O processo como um todo segue o seguinte fluxo:

Transação é enviada para a operadora /instituição financeira para ser autorizada.
Uma vez autorizada, o gateway envia a transação para análise de fraude.
Caso seja aprovada na análise, a transação entrará em modo de espera para ser enviada para a captura (de forma automática ou manual, de acordo com as configurações do estabelecimento). Caso seja negada na análise, a transação será automaticamente cancelada na operadora.

Para contratação acesse: https://www.fcontrol.com.br/Integracao/Filas

Informações para configuração

Modalidade Fila

Usuário
Senha

Voltar ao topo

Adquirente Cielo WebService

Contratação e informações meios de pagamento

Na aba lateral direita está disponível exemplos para cada meio de pagamento em XML (para integração REST) e cURL (para integração REST).

Adquirente Cielo

MODALIDADE WEBSERVICE

Contratação

Contratando a solução da CIELO para e-commerce será possível oferecer na sua loja:

Vendas de cŕedito autenticadas (Bandeiras Visa e MasterCard);

Cartão de crédito Amex;
Cartão de crédito Aura;
Cartão de crédito Diners;
Cartão de crédito Discover;
Cartão de crédito Elo;
Cartão de crédito JCB;
Cartão de crédito MasterCard;
Cartão de crédito Visa;
Cartão de débito Maestro;
Cartão de débito Visa Electron;

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação da CIELO no Gateway:

Merchant ID;
Merchant Key;

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Para contratar, acesse aqui.

Particulariedades

Para esta modalidade é necessário certificado SSL de segurança 2048 bits;
Integração na plataforma WebService API 3.0;
Caso o campo <codigoSeguranca> não for enviado ou for enviado com “000”, a transação será encaminhada a Cielo como modelo “Recorrente”, onde este campo não é obrigatório. Lembrando que para esta utilização é preciso habilitar junto a Adquirente. Salientamos que a conversão de seu estabelecimento pode diminuir;
Esta operadora de cartão permite cadastrar uma informação para aparecer na fatura dos clientes quando realizarem compras sua loja, funcionalidade chamada de SoftDescriptor. Esta deverá possuir até 13 caracteres. Caso queira utilizar, envie ao Suporte Yapay o nome desejado para configuração em seu estabelecimento. Também é possível o envio do SoftDescriptor por pedido, para isto solicite ao Suporte a ativação e envie a informação no campoLivre4 de cada transação;
Para transações com cartão de débito ou autenticada, o eCommerce deverá redirecionar o consumidor para a <urlPagamento>, onde o mesmo deverá incluir sua senha ou token no ambiente do banco emissor. Apenas após esta etapa, a transação será concluída.

Processo de Homologação com Adquirente

Após a integração com o Yapay, o estabelecimento deverá configurar as credenciais da Cielo no ambiente de produção do Yapay e apontar sua loja para o ambiente real do Gateway. Após isto, a loja deverá enviar ao Suporte Cielo (cieloecommerce@cielo.com.br) a URL da loja com um produto de teste no valor de R$1,00. O suporte Cielo realizará os testes em ambiente real e caso esteja dentro das conformidades a loja estará apta a realizar vendas em produção.

Exemplos Cartão de Crédito

REQUISIÇÃO

Estrutura simplificada de envio para adquirente Cielo. Caso seu estabelecimento utilize antifraude, seguir a estrutura completa.

RESPOSTA

Estrtura de retorno adquirente Cielo. Os comentários indicam a informação retornada da adquirente em cada campo.

Exemplos Cartão de Débito

REQUISIÇÃO

Estrutura simplificada de envio para adquirente Cielo.

Estrutra simplificada de envio Cielo:

RESPOSTA

Estrtura de retorno adquirente Cielo. Os comentários indicam a informação retornada da adquirente em cada campo.

    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" : 171,
        "transacao" : {
            "numeroTransacao" : 123,
            "valor" : 100,
            "parcelas" : 1,
            "idioma" : 1
        },
        "dadosCartao" : {
            "nomePortador" : "Teste Teste",
            "numeroCartao" : "0000000000000001",
            "codigoSeguranca" : "123",
            "dataValidade" : "12/2030"
        },
        "itensDoPedido" : [
        {
            "quantidadeProduto" : 1,
            "valorUnitarioProduto" : 100
        }
        ],
        "dadosCobranca" : {
            "nome" : "Teste Integração",
            "documento" : "12312312312"
        }
        }

    --header "Content-Type: application/json"
        {
        "numeroTransacao": 123,
        "codigoEstabelecimento": "1000000000000",
        "codigoFormaPagamento": 171,
        "valor": 2000,
        "valorDesconto": 0,
        "parcelas": 1,
        <!--Status que deverá ser tratado pelo eCommerce-->
        "statusTransacao": 1,
        <!--Código de autorização-->
        "autorizacao": "123456",
        <!--Código erro em caso de negação-->
        "codigoTransacaoOperadora": "0",
        <!--Data retorno adquirente-->
        "dataAprovacaoOperadora": "24/05/2030",
        <!--TID-->
        "numeroComprovanteVenda": "10069930690009F2122A",
        "nsu": "428706",
        <!--Mensagem adquirente-->
        "mensagemVenda": "Operation Success",
        "urlPagamento": "https://gateway.yapay.com.br/checkout/PagamentoCielo/PagamentoCielo.do?cod=14956291484887110cf2a-9aeb-4b34-a869-1a61f0611b66",
        "cartoesUtilizados": ["000000*******0001"]
        }

Voltar ao topo

Adquirente Cielo Checkout

MODALIDADE CHECKOUT CIELO (REDIRECIONADO)

Contratação

Contratando a solução da CIELO para e-commerce será possível oferecer os seguintes meios de pagamento na sua loja:

Cartão de crédito Amex;
Cartão de crédito Aura;
Cartão de crédito Diners;
Cartão de crédito Discover;
Cartão de crédito Elo;
Cartão de crédito JCB;
Cartão de crédito MasterCard;
Cartão de crédito Visa;
Cartão de débito Maestro;
Cartão de débito Visa Electron;

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação da CIELO no Gateway:

Código de filiação;
Merchant ID;

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Para contratar, acesse aqui.

Particulariedades

Para utilização correta desta forma de pagamento, deve se enviado ao Suporte Yapay uma URL para redirecionamento do usuário após finalização do pagamento. Esta URL deve ser informada de forma completa, iniciando em HTTP ou HTTPS;
O eCommerce deverá redirecionar o consumidor para a URL retornada no campo <urlPagamento>;
Importante a utilização da campainha para atualização de status no eCommerce após finalização do pagamento;
O eCommerce enviará um único código ao Gateway relacionado ao meio de pagamento Checkout (52) e após a abertura da URL o consumidor escolherá a bandeira de cartão;
Necessário algumas configurações no painel Cielo. Passo a passo no próximo tópico deste documento.

Configuração painel Cielo

Etapas para configuração:

1- Acesse o gerenciador Cielo
2- Clique na aba “Configurações” –> “Configurações da loja”
3- Primeiramente habilite em “Modo de Teste”
4- Inclua as URLs abaixo:

EM TESTES Substituir o valor 10000000000 pelo código de estabelecimento Yapay

Nome do campo	URL
URL Retorno	https://sandbox.gateway.yapay.com.br/checkout/PagamentoCielo/RetornoCheckout?codE=10000000000&acao=retorno
URL Notificação	https://sandbox.gateway.yapay.com.br/checkout/PagamentoCielo/NotificacaoCheckout?codE=10000000000&acao=notificacao
URL de Mudança de Status	https://sandbox.gateway.yapay.com.br/checkout/PagamentoCielo/NotificacaoCheckout?codE=10000000000&acao=mudancaStatus

1- Acesse o gerenciador Cielo
2- Clique na aba “Configurações” –> “Configurações da loja”
3- Primeiramente desabilite em “Modo de Teste”
4- Inclua as URLs abaixo:

EM PRODUÇÃO Substituir o valor 10000000000 pelo código de estabelecimento Yapay

Nome do Campo	URL
URL Retorno	https://gateway.yapay.com.br/checkout/PagamentoCielo/RetornoCheckout?codE=10000000000&acao=retorno
URL Notificação	https://gateway.yapay.com.br/checkout/PagamentoCielo/NotificacaoCheckout?codE=10000000000&acao=notificacao
URL de Mudança de Status	https://gateway.yapay.com.br/checkout/PagamentoCielo/NotificacaoCheckout?codE=10000000000&acao=mudancaStatus

Processo de Homologação com Adquirente

Exemplos

REQUISIÇÃO

Estrutura simplificada de envio para adquirente Cielo. Caso seu estabelecimento utilize antifraude, seguir a estrutura completa.

Estrutra simplificada REST de envio Cielo.

RESPOSTA

Estrtura de retorno adquirente Cielo. Os comentários indicam a informação retornada da adquirente em cada campo.

  curl
        --request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
        --header "Content-Type: application/json"
        --curl -u usuario:senha .........
        --data-binary
        {
        "codigoEstabelecimento" : 1000000000000,
        "codigoFormaPagamento" : 52,
        "transacao" : {
            "numeroTransacao" : 123,
            "valor" : 100,
            "parcelas" : 1,
            "idioma" : 1
        },
        "itensDoPedido" : [
        {
            "quantidadeProduto" : 1,
            "valorUnitarioProduto" : 100
        }
        ],
        "dadosCobranca" : {
            "nome" : "Teste Integração",
            "documento" : "12312312312"
        }
        }

  --header "Content-Type: application/json"
    {
    "numeroTransacao": 123,
    "codigoEstabelecimento": "1000000000000",
    "codigoFormaPagamento": 52,
    "valor": 2000,
    "valorDesconto": 0,
    "parcelas": 1,
    <!--Status que deverá ser tratado pelo eCommerce-->
    "statusTransacao": 5,
    <!--Código de autorização-->
    "autorizacao": "0",
    <!--Código erro em caso de negação-->
    "codigoTransacaoOperadora": "0",
    <!--URL para redirecionar o consumidor-->
    "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/PagamentoCielo/checkout?cod=14956291484887110cf2a-9aeb-4b34-a869-1a61f0611b66"
    }

Estrutura de retorno após a finalização do pagamento. (Consulta do Ecommerce após acionamento de campainha):

    --header "Content-Type: application/json"
    {
    "numeroTransacao":123,"
    codigoEstabelecimento":"1000000000000",
    "codigoFormaPagamento":52,
    "valor":2000,"
    valorDesconto":0,"
    parcelas":2, 
    <!--Status da Transacao-->
    "statusTransacao":1,"
    <!--Data de retorno da operadora-->
    dataAprovacaoOperadora":"04/01/2018 10:39:42",
    <!--Comprovante de venda-->
    "numeroComprovanteVenda":"040120181039401403",
    <!--NSU-->
    "nsu":"d8aa2b2933ca4a63b425a2cf1012c0f0",
    <!-Bandeira escolhida no ambiente Cielo-->
    "bandeira":"Cartão de Crédito - Elo",
    "urlPagamento":"15150694525329e353c97-2477-4df5-943c-6e3600ef3f38"
    }

Voltar ao topo

Adquirente GetNet

Contratação

Contratando a solução da GetNet eCommerce será possível oferecer na sua loja:

Cartão de crédito Visa;
Cartão de crédito MasterCard;

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação da GetNet no Gateway:

Merchant Id;
Terminal Id;
Usuário;
Senha.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui.

Particulariedades

Para esta modalidade é necessário certificado SSL de segurança 2048 bits;
Integração apenas na modalidade WebService.

Exemplos

REQUISIÇÃO

Estrutura simplificada de envio para adquirente GetNet. Caso seu estabelecimento utilize antifraude, seguir a estrutura completa.

Estrutra simplificada REST de envio GetNet:

RESPOSTA

Estrtura de retorno adquirente GetNet. Os comentários indicam a informação retornada da adquirente em cada campo.

    curl
        --request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
        --header "Content-Type: application/json"
        --curl -u usuario:senha .........
        --data-binary
        {
        "codigoEstabelecimento" : 1000000000000,
        "codigoFormaPagamento" : 271,
        "transacao" : {
            "numeroTransacao" : 123,
            "valor" : 500000,
            "parcelas" : 1,
            "idioma" : 1
        },
        "dadosCartao" : {
            "nomePortador" : "Teste Teste",
            "numeroCartao" : "5453010000083303",
            "codigoSeguranca" : "123",
            "dataValidade" : "12/2030"
        },
        "itensDoPedido" : [
        {
            "quantidadeProduto" : 1,
            "valorUnitarioProduto" : 100
        }
        ],
        "dadosCobranca" : {
            "nome" : "Teste Integração",
            "documento" : "12312312312"
        }
        }

    --header "Content-Type: application/json"
        {
        "numeroTransacao": 123,
        "codigoEstabelecimento": "1000000000000",
        "codigoFormaPagamento": 271,
        "valor": 100,
        "valorDesconto": 0,
        "parcelas": 1,
        <!--Status que deverá ser tratado pelo eCommerce-->
        "statusTransacao": 1,
        <!--Código de autorização-->
        "autorizacao": "1234",
        <!--Código retorno GetNet-->
        "codigoTransacaoOperadora": "0",
        <!--Data retorno adquirente-->
        "dataAprovacaoOperadora": "1017",
        <!--TID-->
        "numeroComprovanteVenda": "1662429594",
        "nsu": "",
        <!--Mensagem adquirente-->
        "mensagemVenda": "CAPTURED",
        "urlPagamento": "14956291484887110cf2a-9aeb-4b34-a869-1a61f0611b66",
        "cartoesUtilizados": ["545301******3303"]
        }

Voltar ao topo

Adquirente Bin - First Data

Contratação

Contratando a solução da Bin eCommerce será possível oferecer na sua loja:

Cartão de crédito Visa;
Cartão de crédito MasterCard;
Cartão de crédito Cabal;

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do e-Rede no Gateway:

Store Id;
User Id;
Password;
Arquivo do certificado BIN;
Senha do certificado;
Terminal ID.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui

Particulariedades

Para esta modalidade é necessário certificado SSL de segurança 2048 bits;
Integração apenas na modalidade WebService.

Informações sobre a contratação, acesse aqui.

Particulariedades

Para esta modalidade é necessário certificado SSL de segurança 2048 bits;
Integração apenas na modalidade WebService.

Exemplos

REQUISIÇÃO

Estrutura simplificada de envio para adquirente Bin. Caso seu estabelecimento utilize antifraude, seguir a estrutura completa.

Estrutra simplificada REST de envio Bin:

RESPOSTA

Estrtura de retorno adquirente Bin. Os comentários indicam a informação retornada da adquirente em cada campo

    curl
        --request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
        --header "Content-Type: application/json"
        --curl -u usuario:senha .........
        --data-binary
        {
        "codigoEstabelecimento" : 1000000000000,
        "codigoFormaPagamento" : 381,
        "transacao" : {
            "numeroTransacao" : 123,
            "valor" : 500000,
            "parcelas" : 1,
            "idioma" : 1
        },
        "dadosCartao" : {
            "nomePortador" : "Teste Teste",
            "numeroCartao" : "5547220000000102",
            "codigoSeguranca" : "123",
            "dataValidade" : "12/2030"
        },
        "itensDoPedido" : [
        {
            "quantidadeProduto" : 1,
            "valorUnitarioProduto" : 100
        }
        ],
        "dadosCobranca" : {
            "nome" : "Teste Integração",
            "documento" : "12312312312"
        }
        }

    --header "Content-Type: application/json"
    {
    "numeroTransacao": 123,
    "codigoEstabelecimento": "1000000000000",
    "codigoFormaPagamento": 381,
    "valor": 100,
    "valorDesconto": 0,
    "parcelas": 1,
    <!--Status que deverá ser tratado pelo eCommerce-->
    "statusTransacao": 1,
    <!--Código de autorização-->
    "autorizacao": "657409",
    <!--Código retorno Bin-->
    "codigoTransacaoOperadora": "0",
    <!--Data retorno adquirente-->
    "dataAprovacaoOperadora": "20/10/2030 16:36:43",
    <!--TID-->
    "numeroComprovanteVenda": "Y:657409:4514266711:PPX :632615",
    "nsu": "",
    <!--Mensagem adquirente-->
    "mensagemVenda": "APPROVAL 000009113",
    "urlPagamento": "14956291484887110cf2a-9aeb-4b34-a869-1a61f0611b66",
    "cartoesUtilizados": ["554722******0102"]
    }

Voltar ao topo

Adquirente Stone

Contratação

Contratando a solução da Stone eCommerce será possível oferecer na sua loja:

Cartão de crédito Visa;
Cartão de crédito MasterCard;

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do Stone no Gateway:

Sale affiliation key;
Stone Code;

As credenciais deverão ser solicitadas para ecommerce@stone.com.br ou (11) 3185-5162.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui.

Particulariedades

Para esta modalidade é necessário certificado SSL de segurança 2048 bits;
Integração apenas na modalidade WebService.

Exemplos

REQUISIÇÃO

Estrutura simplificada de envio para adquirente Stone. Caso seu estabelecimento utilize antifraude, seguir a estrutura completa.

Estrutra simplificada REST de envio Stone:

RESPOSTA

Estrtura de retorno adquirente Stone. Os comentários indicam a informação retornada da adquirente em cada campo.

    curl
        --request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
        --header "Content-Type: application/json"
        --curl -u usuario:senha .........
        --data-binary
        {
        "codigoEstabelecimento" : 1000000000000,
        "codigoFormaPagamento" : 351,
        "transacao" : {
            "numeroTransacao" : 123,
            "valor" : 500000,
            "parcelas" : 1,
            "idioma" : 1
        },
        "dadosCartao" : {
            "nomePortador" : "Teste Teste",
            "numeroCartao" : "5431111111111111",
            "codigoSeguranca" : "123",
            "dataValidade" : "12/2030"
        },
        "itensDoPedido" : [
        {
            "quantidadeProduto" : 1,
            "valorUnitarioProduto" : 100
        }
        ],
        "dadosCobranca" : {
            "nome" : "Teste Integração",
            "documento" : "12312312312"
        }
        }

    --header "Content-Type: application/json"
        {
        "numeroTransacao": 123,
        "codigoEstabelecimento": "1000000000000",
        "codigoFormaPagamento": 351,
        "valor": 100,
        "valorDesconto": 0,
        "parcelas": 1,
        <!--Status que deverá ser tratado pelo eCommerce-->
        "statusTransacao": 1,
        <!--Código de autorização-->
        "autorizacao": "1234",
        <!--Código retorno Stone-->
        "codigoTransacaoOperadora": "0",
        <!--Data retorno adquirente-->
        "dataAprovacaoOperadora": "20/10/2030 16:36:43",
        <!--TID-->
        "numeroComprovanteVenda": "1662429594",
        "nsu": "",
        <!--Mensagem adquirente-->
        "mensagemVenda": "Transação Aprovada",
        "urlPagamento": "14956291484887110cf2a-9aeb-4b34-a869-1a61f0611b66",
        "cartoesUtilizados": ["543111******1111"]
        }

Voltar ao topo

Adquirente Rede

MODALIDADE WEBSERVICE

Contratação

Contratando a solução da e-Rede será possível oferecer na sua loja:

Cartão de crédito aunteticado (Bandeiras Visa e MasterCard);

Cartão de crédito aunteticado;
Cartão de crédito Visa;
Cartão de crédito MasterCard;
Cartão de crédito Hiper;
Cartão de crédito HierpCard;
Cartão de crédito JCB;
Cartão de crédito Credz;
Cartão de débito Visa Electron;
Cartão de débito Maestro;

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do e-Rede no Gateway:

Filiação (PV);
Token;

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui.

Particulariedades

Para esta modalidade é necessário certificado SSL de segurança 2048 bits;
Esta operadora de cartão permite cadastrar uma informação para aparecer na fatura dos clientes quando realizarem compras sua loja, funcionalidade chamada de SoftDescriptor. Esta deverá possuir até 13 caracteres. Caso queira utilizar, envie ao Suporte SuperPay o nome desejado para configuração em seu estabelecimento.
Também é possível o envio do SoftDescriptor por pedido, para isto solicite ao Suporte a ativação e envie a informação no campoLivre4 de cada transação;
Para transações com cartão de débito ou autenticada, o eCommerce deverá enviar o “userAgente” (Identificador do browser utilizado pelo comprador no momento da compra) no campo <campoLivre1> e redirecionar o consumidor para o campo <urlPagamento> recebida no retorno, onde o mesmo deverá incluir sua senha ou token no ambiente do banco emissor. Apenas após esta etapa, a transação será concluída.
Para bandeiras de débito (Visa Electron e Maestro) e/ou cartões autenticados (Visa e MasterCard), é preciso a liberação do serviço de 3DS. Portanto, para utilização destas bandeiras solitem a liberação diretamente com a Adquirente Rede.

Exemplos Cartão de Crédito

REQUISIÇÃO

Estrutura simplificada de envio para adquirente Rede. Caso seu estabelecimento utilize antifraude, seguir a estrutura completa.

RESPOSTA

Estrtura de retorno adquirente Rede. Os comentários indicam a informação retornada da adquirente em cada campo.

Exemplos Cartão de Crédito

    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" : 191,
    "transacao" : {
        "numeroTransacao" : 123,
        "valor" : 500000,
        "parcelas" : 1,
        "idioma" : 1
    },
    "dadosCartao" : {
        "nomePortador" : "Teste Teste",
        "numeroCartao" : "5899160000000005",
        "codigoSeguranca" : "123",
        "dataValidade" : "01/2019"
    },
    "itensDoPedido" : [
    {
        "quantidadeProduto" : 1,
        "valorUnitarioProduto" : 500000
    }
    ],
    "dadosCobranca" : {
        "nome" : "Teste Integração",
        "documento" : "12312312312"
    }
    }

    --header "Content-Type: application/json"
    {
    "numeroTransacao": 123,
    "codigoEstabelecimento": "1000000000000",
    "codigoFormaPagamento": 191,
    "valor": 500000,
    "valorDesconto": 0,
    "parcelas": 1,
    <!--Status que deverá ser tratado pelo eCommerce-->
    "statusTransacao": 1,
    <!--Código de autorização-->
    "autorizacao": "123456",
    <!--Código retorno Cielo-->
    "codigoTransacaoOperadora": "0",
    <!--Data retorno adquirente-->
    "dataAprovacaoOperadora": "24/05/2030",
    <!--TID-->
    "numeroComprovanteVenda": "10117092708342800232",
    "nsu": "428706",
    <!--Mensagem adquirente-->
    "mensagemVenda": "00 - Success",
    "urlPagamento": "14956291484887110cf2a-9aeb-4b34-a869-1a61f0611b66",
    "cartoesUtilizados": ["589916******0005"]
    }

    curl
    --request POST https://sandbox.gatway.yapay.com.br/checkout/api/v3/transacao
    --header "Content-Type: application/json"
    --curl -u usuario:senha
    --data-binary
    {
    "codigoEstabelecimento" : 1000000000000,
    "codigoFormaPagamento" : 198,
    "transacao" : {
        "numeroTransacao" : 123,
        "valor" : 511100,
        "parcelas" : 1,
        "idioma" : 1,
        "urlCampainha" : http://seusite.com.br/campainha,
        "urlResultado" : http://seusite.com.br/retorno,
        "campoLivre1" : Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405
    },
    "dadosCartao" : {
        "nomePortador" : "Teste Teste",
        "numeroCartao" : "4002479199570736",
        "codigoSeguranca" : "132",
        "dataValidade" : "01/2019"
    },
    "itensDoPedido" : [
    {
        "quantidadeProduto" : 1,
        "valorUnitarioProduto" : 100
    }
    ],
    "dadosCobranca" : {
        "nome" : "Teste Integração",
        "documento" : "12312312312"
    }
    }

    --header "Content-Type: application/json"
    {
    "numeroTransacao": 123,
    "codigoEstabelecimento": "1000000000000",
    "codigoFormaPagamento": 198,
    "valor": 511100,
    "valorDesconto": 0,
    "parcelas": 1,
    <!--Status que deverá ser tratado pelo eCommerce-->
    "statusTransacao": 8,
    <!--Código de autorização-->
    "autorizacao": "0",
    <!--Código de erro-->
    "codigoTransacaoOperadora": "0",
    <!--Data retorno adquirente-->
    "dataAprovacaoOperadora": "24/05/2030",
    <!--TID-->
    "numeroComprovanteVenda": "10069930690009F2122A",
    "nsu": "0",
    <!--Mensagem adquirente-->
    "mensagemVenda": "00 - Success",
    <!--URL para redirecionar o consumidor para autenticação-->
    "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/erede/pg.do?cod=1506533536609b7edee8b-7549-488a-9ae1-65f9f92a1b4c",
    "cartoesUtilizados": ["400247******0736"]
    }

Voltar ao topo

Banco Banrisul

Contratação

Contratando a solução BanriCompras será possível oferecer na sua loja:

Boleto sem registro;
Pagamento pré datado;
Pagamentos parcelados;
Pagamentos á vista.

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do Banrisul no Gateway:

Código do estabelecimento Banrisul;
Código da rede;
Senha de consulta.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, entre em contato com banrisul_cartoes_atendimento_adquirencia@banrisul.com.br

Particulariedades

Modalidades com redirecionamento;
Para utilização das modalidades Banricompras, todos os campos referente aos dados do cliente devem ser preenchidos;
Se não for informado uma data de vencimento do boleto, a data de vencimento que aparecerá no boleto será os dias de vencimento configurado internamente no Gateway;
Processo de homologação junto ao Banrisul obrigatório para liberação em produção.

Configurações ambiente Banrisul

Para o Gateway de Pagamento funcionar corretamente, é necessário configurar algumas urls no ambiente do Banricompras.

HOMOLOGAÇÃO

POST

Link Painel Banrisul: https://ww4.banrisul.com.br/banricompras/

URL Campainha: https://gateway.sandbox.yapay.com.br/checkout/Banrisul/NotificacaoBanrisul.do

PRODUÇÃO

POST

Link Painel Banrisul: https://ww7.banrisul.com.br/banricompras/

URL Campainha: https://gateway.yapay.com.br/checkout/Banrisul/NotificacaoBanrisul.do

PÁGINAS DE AVISO DE OPERAÇÃO

HOMOLOGAÇÃO

POST

URL Sucesso: https://gateway.sandbox.yapay.com.br/checkout/Banrisul/RedirecionamentoBanrisulOk.do

URL Não Pago: https://gateway.yapay.com.br/yapay/Banrisul/RedirecionamentoBanrisulNoOk.do

PRODUÇÃO

POST

URL Sucesso: https://gateway.yapay.com.br/checkout/Banrisul/RedirecionamentoBanrisulOk.do

URL Não Pago: https://gateway.yapay.com.br/checkout/Banrisul/RedirecionamentoBanrisulNoOk.do

Processo de Homologação

Após realizar a integração com o Yapay em ambiente de testes e configurações no painel Banrisul, enviar para tecnologia_homologacoes@banrisul.com.br o link de acesso a página de testes, bem como o código de usuário e senha para login. Assim que o processo for finalizado pela equipe Banrisul, os mesmos enviarão os dados de produção para o estabelecimento.

Exemplos

REQUISIÇÃO

Estrutura de envio para banco Banrisul.

Estrutra REST de envio Banrisul:

    curl
        --request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
        --header "Content-Type: application/json"
        --curl -u usuario:senha .........
        --data-binary
        {
        codigoEstabelecimento: 1000000000000,
        codigoFormaPagamento: 26,
        transacao: {
            numeroTransacao: 1,
            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,
            dataVencimentoBoleto : "10/10/2018"
        },
        itensDoPedido: [
        {
            codigoProduto: 1,
            nomeProduto: Blusa,
            codigoCategoria: 1,
            nomeCategoria : Roupa,
            quantidadeProduto : 1,
            valorUnitarioProduto : 2000
        }
        ],
        dadosCobranca : {
            codigoCliente : 1,
            tipoCliente : 1,
            nome : Teste Yapay,
            email : teste@teste.com,
            dataNascimento : "",
            sexo : "M",
            documento : "12312321312",
            endereco : {
            logradouro : Rua Teste,
            numero : 123,
            complemento : "",
            cep : 12345-678,
            bairro : Bairro Teste,
            cidade : Cidade Teste,
            estado : SP,
            pais : BR
        },
        telefone : [
        {
            tipoTelefone : 1,
            ddi : 55,
            ddd : 12,
            telefone : 1234-5678
        }
        ]
        },
        dadosEntrega : {
            nome : Teste Yapay,
            email : teste@teste.com,
            endereco : {
            logradouro : Rua teste,
            numero : 123,
            complemento : "",
            cep : 12345-678,
            bairro : Bairro Teste,
            cidade : Cidade Teste,
            estado : SP,
            pais : BR
        },
        telefone : [
        {
            tipoTelefone : 1,
            ddi : 55,
            ddd : 12,
            telefone : 1234-5678
        }
        ]
        }
        }

    --header "Content-Type: application/json"
        {
        "numeroTransacao": 1,
        "codigoEstabelecimento": "1000000000000",
        "codigoFormaPagamento": 26,
        "valor": 2000,
        "valorDesconto": 0,
        "parcelas": 1,
        "statusTransacao": 8,
        "autorizacao": ,
        "codigoTransacaoOperadora": "0",
        "dataAprovacaoOperadora": ,
        "numeroComprovanteVenda": ,
        "nsu": ,
        "mensagemVenda": ,
        "urlPagamento": "https://gateway.yapay.com.br/checkout/Boleto/PagamentoBanrisul.do?cod=141348960683a720e602-5631-4725-8f79-268c06795a3c"
        }

Voltar ao topo

Itaú ShopLine

Contratação

Contratando a solução Itaú ShopLine será possível oferecer na sua loja:

Boleto sem ou com registro, dependendo de seu contrato com o banco;
Transferência eletrônica;

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do Itaú ShopLine no Gateway:

Código da empresa;
Chave de acesso.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui.

Particulariedades

Modalidades com redirecionamento;
O tamanho do número do pedido deverá ser de no máximo 8 dígitos;
Para utilização das modalidades ShopLine, todos os campos referente aos dados do cliente devem ser preenchidos;
Tempo padrão de consulta no banco para atualização do status no Yapay: 120 dias;
Se não for informado uma data de vencimento do boleto, a data de vencimento que aparecerá no boleto será os dias de vencimento configurado internamente no Gateway;

Configurações ambiente Itaú ShopLine

Para o Gateway de Pagamento funcionar corretamente, é necessário configurar URL de retorno no BankLine.
Acesse o BankLine, aba Cobrança > Itaú Shopline > Informações Cadastrais e inclua a URL abaixo no campo “URL Retorno”

URL RETORNO: https://gateway.yapay.com.br/checkout/

Exemplos

REQUISIÇÃO

Estrutura de envio para banco Itaú.

Estrutra REST de envio Itaú:

RESPOSTA

Estrtura de retorno Itaú.

    curl
        --request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
        --header "Content-Type: application/json"
        --curl -u usuario:senha .........
        --data-binary
        {
        codigoEstabelecimento: 1000000000000,
        codigoFormaPagamento: 16,
        transacao: {
            numeroTransacao: 1,
            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: Blusa,
            codigoCategoria: 1,
            nomeCategoria : Roupa,
            quantidadeProduto : 1,
            valorUnitarioProduto : 2000
        }
        ],
        dadosCobranca : {
            codigoCliente : 1,
            tipoCliente : 1,
            nome : Teste Yapay,
            email : teste@teste.com,
            dataNascimento : "",
            sexo : "M",
            documento : "12312321312",
            endereco : {
            logradouro : Rua Teste,
            numero : 123,
            complemento : "",
            cep : 12345-678,
            bairro : Bairro Teste,
            cidade : Cidade Teste,
            estado : SP,
            pais : BR
        },
        telefone : [
        {
            tipoTelefone : 1,
            ddi : 55,
            ddd : 12,
            telefone : 1234-5678
        }
        ]
        },
        dadosEntrega : {
            nome : Teste Yapay,
            email : teste@teste.com,
            endereco : {
            logradouro : Rua teste,
            numero : 123,
            complemento : "",
            cep : 12345-678,
            bairro : Bairro Teste,
            cidade : Cidade Teste,
            estado : SP,
            pais : BR
        },
        telefone : [
        {
            tipoTelefone : 1,
            ddi : 55,
            ddd : 12,
            telefone : 1234-5678
        }
        ]
        }
        }

    --header "Content-Type: application/json"
        {
        "numeroTransacao": 1,
        "codigoEstabelecimento": "1000000000000",
        "codigoFormaPagamento": 16,
        "valor": 2000,
        "valorDesconto": 0,
        "parcelas": 1,
        "statusTransacao": 8,
        "autorizacao": ,
        "codigoTransacaoOperadora": "0",
        "dataAprovacaoOperadora": ,
        "numeroComprovanteVenda": ,
        "nsu": ,
        "mensagemVenda": ,
        "urlPagamento": "https://gateway.yapay.com.br/checkout/PagamentoItauShopline/PagamentoItauShopline.do?cod=141348960683a720e602-5631-4725-8f79-268c06795a3c"
        }

Voltar ao topo

Banco do Brasil Online

Contratação

Contratando a solução BBOnline será possível oferecer na sua loja:

Boleto sem ou com registro, dependendo de seu contrato com o banco;
Transferência Eletrônica.

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do Banco do Brasil Online no Gateway:

Códido do convênio;
Código cobrança.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui

Particulariedades

Modalidades com redirecionamento;
Para utilização das modalidades BBOnline, todos os campos referente aos dados do cliente devem ser preenchidos;
Se não for informado uma data de vencimento do boleto, a data de vencimento que aparecerá no boleto será os dias de vencimento configurado internamente no Gateway;

Exemplos

REQUISIÇÃO

Estrutura de envio para banco do Brasil.

RESPOSTA

Estrtura de retorno BBOnline:

curl
--request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
--header "Content-Type: application/json"
--curl -u usuario:senha .........
--data-binary
{
   codigoEstabelecimento: 1000000000000,
   codigoFormaPagamento: 21,
   transacao: {
    numeroTransacao: 1,
    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: Blusa,
    codigoCategoria: 1,
    nomeCategoria : Roupa,
    quantidadeProduto : 1,
    valorUnitarioProduto : 2000
  }
   ],
   dadosCobranca : {
    codigoCliente : 1,
    tipoCliente : 1,
    nome : Teste Yapay,
    email : teste@teste.com,
    dataNascimento : "",
    sexo : "M",
    documento : "12312321312",
    endereco : {
    logradouro : Rua Teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   },
   dadosEntrega : {
    nome : Teste Yapay,
    email : teste@teste.com,
    endereco : {
    logradouro : Rua teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   }
}

--header "Content-Type: application/json"
{
   "numeroTransacao": 1,
   "codigoEstabelecimento": "1000000000000",
   "codigoFormaPagamento": 21,
   "valor": 2000,
   "valorDesconto": 0,
   "parcelas": 1,
   "statusTransacao": 8,
   "autorizacao": ,
   "codigoTransacaoOperadora": "0",
   "dataAprovacaoOperadora": ,
   "numeroComprovanteVenda": ,
   "nsu": ,
   "mensagemVenda": ,
   "urlPagamento": "https://gateway.yapay.com.br/checkout/PagamentoBBOnline/PagamentoBBOnline.do?cod=147499950329455715d65-621f-4b80-896c-5d1a645fb9e0"
}

Voltar ao topo

Bradesco ShopFácil

BOLETO

Contratação

Contratando a solução Bradesco ShopFácil será possível oferecer na sua loja:

Boleto sem ou com registro, dependendo de seu contrato com o banco;
Transferência eletrônica.

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do ShopFácil no Gateway:

Merchantid;
Email de acesso ao gerenciador;
Chave de Acesso; (Gerada dentro do gerenciador do Bradesco, passo a passo abaixo);
Número da Carteira.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui

Particulariedades

Modalidades com redirecionamento;
Para utilização das modalidades ShopFácil, todos os campos referente aos dados do cliente devem ser preenchidos;
Se não for informado uma data de vencimento do boleto, a data de vencimento que aparecerá no boleto será os dias de vencimento configurado internamente no Gateway;
Sugerimos o envio dos campos de dados do comprador sem acentuação, pois os mesmos poderão ficar mal formatados na impressão do boleto.

Configurações ambiente ShopFácil

Gerando chave de acesso

Procedimento idêntico em ambos ambientes:

Ambiente	URL
HOMOLOGAÇÃO	https://homolog.meiosdepagamentobradesco.com.br/gerenciadorapi
PRODUÇÃO	https://meiosdepagamentobradesco.com.br/gerenciadorapi

Após logar, acesse Configurações > Meios de Pagamento > Boleto Bancário, inclua uma palavra secreta para geração da chave.

Configurando URL de notificação

Após logar, acesse Configuração > Meios de Pagamento > Boleto Bancário, incluir no campo “URL de notificação”:

Ambiente	URL
HOMOLOGAÇÃO	https://sandbox.gateway.yapay.com.br/checkout/bradesco/confirmaBoletoRegistro
PRODUÇÃO	https://gateway.yapay.com.br/checkout/bradesco/confirmaBoletoRegistro

Processo de Homologação

Procedimento deve ser realizado em duas etapas, ambiente de homologação e ambiente de Produção:

Homologação

Realizar as configurações no painel Bradesco conforme informado acima e solicitar ao Suporte Yapay realizar a configuração do meio de pagamento em nosso ambiente de homologação, informando a ele os dados abaixo:

Merchantid;
Email de acesso ao gerenciador de homologação;
Chave de acesso de homologação;
Número da carteira;

A loja virtual deverá estar apontando para o ambiente de homologação e depois disto basta enviar email kit@scopus.com.br com a URL da loja com um produto de R$1,00 disponível para testes e o CNPJ do estabelecimento. Depois que a equipe do Bradesco validar este ambiente, o estabelecimento receberá novos dados, desta vez os dados reais da loja. E o procedimento deverá ser repedito porém desta vez em ambiente de produção.

Produção

Realizar as configurações no painel Bradesco conforme informado acima e solicitar ao Suporte Yapay realizar a configuração do meio de pagamento em nosso ambiente de produção, informando a ele os dados abaixo:

Merchantid;
Email de acesso ao gerenciador de produção;
Chave de acesso de produção;
Número da carteira;

A loja virtual deverá estar apontando para o ambiente de produção e depois disto basta enviar email kit@scopus.com.br com a URL da loja com um produto de R$1,00 disponível para testes e o CNPJ do estabelecimento. Depois que a equipe do Bradesco validar este ambiente, o estabelecimento estará apto a realizar vendas em produção.

Exemplos

REQUISIÇÃO

Estrutura de envio para banco Bradesco.

Estrutra REST de envio Bradesco Transferência:

Estrtura de retorno Bradesco.

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: 18,
   transacao: {
    numeroTransacao: 1,
    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: Blusa,
    codigoCategoria: 1,
    nomeCategoria : Roupa,
    quantidadeProduto : 1,
    valorUnitarioProduto : 2000
  }
   ],
   dadosCobranca : {
    codigoCliente : 1,
    tipoCliente : 1,
    nome : Teste Yapay,
    email : teste@teste.com,
    dataNascimento : "",
    sexo : "M",
    documento : "12312321312",
    endereco : {
    logradouro : Rua Teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   },
   dadosEntrega : {
    nome : Teste Yapay,
    email : teste@teste.com,
    endereco : {
    logradouro : Rua teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   }
}

--header "Content-Type: application/json"
{
   "numeroTransacao": 1,
   "codigoEstabelecimento": "1000000000000",
   "codigoFormaPagamento": 18,
   "valor": 2000,
   "valorDesconto": 0,
   "parcelas": 1,
   "statusTransacao": 8,
   "autorizacao": ,
   "codigoTransacaoOperadora": "0",
   "dataAprovacaoOperadora": ,
   "numeroComprovanteVenda": ,
   "nsu": ,
   "mensagemVenda": ,
   "urlPagamento": "https://gateway.yapay.com.br/checkout/Transferencia/PagamentoBradescoShopFacil.do?cod=141348960683a720e602-5631-4725-8f79-268c06795a3c"
}

Voltar ao topo

Boletos Offlines

BOLETOS REGISTRADOS

Com esta modalidade, os bancos possuem conehcimento do boleto desde sua geração, permitindo o lojista realizar protestos ao cliente caso o pagamento não for realizado.

Para utilização de qualquer boleto com carteira registrada é preciso realizar a abertura de relacionamento entre o banco e VAN homologada com o Yapay.

Santander

agência;
conta;
código do cedente;
número da carteira;
espécie de documento; (Exemplos: DM, RM, ME, NP)
código de transmissão.

Caixa Econômica Federal

agência;
conta;
código do convênio;
número da carteira;
código de operação;
espécie de documento. (Exemplos: DM, RM, ME, NP)

Itaú

agência;
conta;
número da carteira;
espécie de documento. (Exemplos: DM, RM, ME, NP)

Bradesco

agência;
conta;
número da carteira;
espécie de documento. (Exemplos: DM, RM, ME, NP)

Banco do Brasil

agência;
conta;
código do convênio;
número da carteira;
variação da carteira;
espécie de documento. (Exemplos: DM, RM, ME, NP);
client ID;
secret;

Particulariedades

Para a geração de Boleto offlines, todos os campos referente aos dados do cliente devem ser preenchidos;
Arquivo de registro e conciliação com layout de 400 posições para todos os bancos;
Campo <estadoComprador> deve ser preenchido pela sigla;
O tamanho do número do pedido, deverá possuir no máximo 8 dígitos;
Se não for informado uma data de vencimento do boleto na requisição, a data de vencimento que aparecerá no boleto será os dias de vencimento configurados internamente no Gateway;
A URL retornada no campo <urlPagamento>;
A requisição e retorno do Yapay para boletos registrados possuem a mesma estrutura dos sem registro, porém o status a ser retornado será 5 (transação em andamento) ao invés de 8 (aguardando pagamento);
Para ativação do boleto registrado e Módulo de Conciliação entrar em contato com comercial@yapay.com.br;
O Yapay não participa das negociações entre o estabelecimento e bancos/administradoras. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

BOLETOS SEM REGISTROS

O Gateway de Pagamento aceita boletos sem registro emitidos pelos seguintes bancos:

Itaú;
Bradesco;
Banco do Brasil;
Caixa;
Santander.

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação dos boletos no Gateway:

Convênio;
Agência;
Conta;
Número da Carteira;
Espécie de Documento. (Exemplos: DM, RM, ME, NP)

Particulariedades

Para a geração de Boleto offlines, todos os campos referente aos dados do cliente devem ser preenchidos.
Campo <estadoComprador> deve ser preenchido pela sigla;
O tamanho do número do pedido, deverá possuir no máximo 8 dígitos;
Se não for informado uma data de vencimento do boleto na requisição, a data de vencimento que aparecerá no boleto será os dias de vencimento configurados internamente no Gateway;
A URL retornada no campo <urlPagamento>;
Conciliação de boletos não é realizada automaticamente, para tal deve ser contratado o Módulo de Conciliação do Gateway. Para informações entrar em contato com comercial@yapay.com.br;
O Yapay não participa das negociações entre o estabelecimento e bancos/administradoras. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Contratação

Contratando a solução BBOnline será possível oferecer na sua loja:

Boleto sem ou com registro, dependendo de seu contrato com o banco;
Transferência Eletrônica.

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação do e-Rede no Gateway:

Códido do convênio;
Código cobrança.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Informações sobre a contratação, acesse aqui

Particulariedades

Modalidades com redirecionamento;
Para utilização das modalidades BBOnline, todos os campos referente aos dados do cliente devem ser preenchidos;
Se não for informado uma data de vencimento do boleto, a data de vencimento que aparecerá no boleto será os dias de vencimento configurado internamente no Gateway;

Exemplos

REQUISIÇÃO

Estrutura de envio para geração de boletos sem/com registro.

RESPOSTA

Estrtura de retorno Boleto registrado:

curl
--request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
--header "Content-Type: application/json"
--curl -u usuario:senha .........
--data-binary
{
   codigoEstabelecimento: 1000000000000,
   codigoFormaPagamento: 30,
   transacao: {
    numeroTransacao: 1,
    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: Blusa,
    codigoCategoria: 1,
    nomeCategoria : Roupa,
    quantidadeProduto : 1,
    valorUnitarioProduto : 2000
  }
   ],
   dadosCobranca : {
    codigoCliente : 1,
    tipoCliente : 1,
    nome : Teste Yapay,
    email : teste@teste.com,
    dataNascimento : "",
    sexo : "M",
    documento : "12312321312",
    endereco : {
    logradouro : Rua Teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   },
   dadosEntrega : {
    nome : Teste Yapay,
    email : teste@teste.com,
    endereco : {
    logradouro : Rua teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   }
}

--header "Content-Type: application/json"
{
   "numeroTransacao": 1,
   "codigoEstabelecimento": "1000000000000",
   "codigoFormaPagamento": 30,
   "valor": 2000,
   "valorDesconto": 0,
   "parcelas": 1,
   "statusTransacao": 8,
   "autorizacao": ,
   "codigoTransacaoOperadora": "0",
   "dataAprovacaoOperadora": ,
   "numeroComprovanteVenda": ,
   "nsu": ,
   "mensagemVenda": ,
   "urlPagamento": "https://gateway.yapay.com.br/GeradorBoleto.do?cod=1413487983447baddcb56-0126-4353-9253-538f64d"
}

Voltar ao topo

SafetyPay

Com este meio de pagamento é possível trabalhar com transferências entre vários bancos sem possuir contrato com cada um deles.

Contratação

Contratando a solução da SafetyPay para e-commerce será possível oferecer na sua loja:

Transferência entre bancos; Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação dos boletos no Gateway:

API Key;
Signature Key;
Usuário;
Senha.

O Yapay não participa das negociações entre o estabelecimento e bancos/adquirentes. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Para contratar, acesse aqui.

Particulariedades

Modalidade com redirecionamento;
A URL retornada no campo <urlPagamento>;
Enviar todos campos referente aos dados do comprador.

Configuração ambiente SafetyPay

Configurar em seu painel safetyPay a URL de notificação do Gateway + seu código de estabelecimento Yapay:

Ambiente	URL
HOMOLOGAÇÃO	https://gateway.sandbox.yapay.com.br/checkout/SafetyPay/Notificacao?codigoEstabelecimento={CODIGOYAPAY}
PRODUÇÃO	https://gateway.yapay.com.br/checkout/SafetyPay/Notificacao?codigoEstabelecimento={CODIGOYAPAY}

Exemplo URL notificação: https://gateway.yapay.com.br/checkout/SafetyPay/Notificacao?codigoEstabelecimento=1000000000000

Exemplos

REQUISIÇÃO

Estrutura de envio SafetyPay.

RESPOSTA

Estrtura de retorno SafetyPay:

curl
--request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
--header "Content-Type: application/json"
--header "--curl -u usuario:senha .........
--data-binary
{
   codigoEstabelecimento: 1000000000000,
   codigoFormaPagamento: 155,
   transacao: {
    numeroTransacao: 1,
    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: Blusa,
    codigoCategoria: 1,
    nomeCategoria : Roupa,
    quantidadeProduto : 1,
    valorUnitarioProduto : 2000
  }
   ],
   dadosCobranca : {
    codigoCliente : 1,
    tipoCliente : 1,
    nome : Teste Yapay,
    email : teste@teste.com,
    dataNascimento : "",
    sexo : "M",
    documento : "12312321312",
    endereco : {
    logradouro : Rua Teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   },
   dadosEntrega : {
    nome : Teste Yapay,
    email : teste@teste.com,
    endereco : {
    logradouro : Rua teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   }
}

--header "Content-Type: application/json"
{
   "numeroTransacao": 1,
   "codigoEstabelecimento": "1000000000000",
   "codigoFormaPagamento": 155,
   "valor": 2000,
   "valorDesconto": 0,
   "parcelas": 1,
   "statusTransacao": 8,
   "autorizacao": ,
   "codigoTransacaoOperadora": "0",
   "dataAprovacaoOperadora": ,
   "numeroComprovanteVenda": ,
   "nsu": ,
   "mensagemVenda": ,
   "urlPagamento": "https://gateway.yapay.com.br/checkout/PagamentoSafetyPay/PagamentoSafetyPay.do?cod=141348960683a720e602-5631-4725-8f79-268c06795a3c"
}

Intermediário Financeiro

Contratação

Abaixo segue lista de intermediário financeiro disponíveis através do Yapay:

PagSeguro;
PayPal.

Ao final do processo de contratação, deve-se estar de posse das seguintes informações para ativação no Gateway:

PagSeguro

email
token

Contração acesse aqui.

PayPal

assinatura
email
usuário
senha

Contração acesse aqui.

O Yapay não participa das negociações entre o estabelecimento e bancos/administradoras. Desta forma, taxas ou eventuais isenções são tratadas de forma direta entre os envolvidos.

Particulariedades

Modalidade com redirecionamento;
A URL retornada no campo <urlPagamento>;
Enviar todos campos referente aos dados do comprador.

Configuração ambiente PagSeguro

Configurar em seu painel PagSeguro a URL de notificação do Gateway:

HOMOLOGAÇÃO

URL: https://gateway.yapay.com.br/checkout/PagamentoPagSeguro/RetornoPagSeguro.do

PRODUÇÃO

URL: https://ww7.banrisul.com.br/banricompras/

Exemplos

REQUISIÇÃO

Estrutura de envio PayPal.

RESPOSTA

Estrtura de retorno PayPal:

curl
--request POST https://sanbbox.gateway.yapay.com.br/checkout/api/v3/transacao
--header "Content-Type: application/json"
--curl -u usuario:senha .........
--data-binary
{
   codigoEstabelecimento: 1000000000000,
   codigoFormaPagamento: 39,
   transacao: {
    numeroTransacao: 1,
    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: Blusa,
    codigoCategoria: 1,
    nomeCategoria : Roupa,
    quantidadeProduto : 1,
    valorUnitarioProduto : 2000
  }
   ],
   dadosCobranca : {
    codigoCliente : 1,
    tipoCliente : 1,
    nome : Teste Yapay,
    email : teste@teste.com,
    dataNascimento : "",
    sexo : "M",
    documento : "12312321312",
    endereco : {
    logradouro : Rua Teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   },
   dadosEntrega : {
    nome : Teste Yapay,
    email : teste@teste.com,
    endereco : {
    logradouro : Rua teste,
    numero : 123,
    complemento : "",
    cep : 12345-678,
    bairro : Bairro Teste,
    cidade : Cidade Teste,
    estado : SP,
    pais : BR
  },
  telefone : [
  {
    tipoTelefone : 1,
    ddi : 55,
    ddd : 12,
    telefone : 1234-5678
  }
  ]
   }
}

--header "Content-Type: application/json"
{
   "numeroTransacao": 1,
   "codigoEstabelecimento": "1000000000000",
   "codigoFormaPagamento": 39,
   "valor": 2000,
   "valorDesconto": 0,
   "parcelas": 1,
   "statusTransacao": 8,
   "autorizacao": ,
   "codigoTransacaoOperadora": "0",
   "dataAprovacaoOperadora": ,
   "numeroComprovanteVenda": ,
   "nsu": ,
   "mensagemVenda": ,
   "urlPagamento": "https://sandbox.gateway.yapay.com.br/checkout/PagamentoPagSeguro/PagamentoPagSeguro.do?cod=1413489786995834a2f60-aa50-4615-92bd-45c46a7397a5"
}

Voltar ao topo

Sobre

Credenciais de Acesso

Pagamentos com Cartão de Crédito

Pagamentos com Único Clique

Pagamentos com Cartão de Débito

Pagamentos com Boleto

Pagamentos com TEF

Pagamentos Recorrentes

Checkout Yapay

Consultas

Post de Notificação

Códigos da API

Downloads

Funcionalidades

Contratação e informações

Antifraude ClearSale

Antifraude FControl

Adquirente Cielo WebService

Adquirente Cielo Checkout

Adquirente GetNet

Adquirente Bin - First Data

Adquirente Stone

Adquirente Rede

Banco Banrisul

Itaú ShopLine

Banco do Brasil Online

Bradesco ShopFácil

Boletos Offlines

SafetyPay

Intermediário Financeiro