Api Documentation PIX CASH-IN

  • Início
  • Api Documentation PIX CASH-IN

Introdução

Esta seção descreve: RG PAY : gateway pagamento via API.

RG PAY : API fácil de integrar em seu software. Nossa API tem URLs bem formatadas, aceita solicitações de curl e retorna as respostas do JSON.

Você pode usar a API no modo de teste, o que não afeta seus dados ativos. A chave da API é usada para autenticar a solicitação e determina se a solicitação é um pagamento válido ou não. Para o modo de teste, basta usar a URL do sandbox e, no caso do modo ativo, use a URL ativa da seção Iniciar pagamento .

Moedas suportadas

Esta seção descreve as moedas suportadas por RG PAY

RG PAY permite fazer transações com as moedas abaixo. Qualquer nova moeda pode ser atualizada no futuro.

Nome Moeda Símbolo Moeda Código Moeda
Real Brasileiro R$ BRL

Obtenha a chave da API

Esta seção descreve como você pode obter sua chave de API.

Faça login em : RG PAY na Conta tipo Comerciante. Quer ter acesso ? Clique aqui

O próximo passo é encontrar : Api Key Pix menu na barra lateral do seu painel. Clique no MENU->Api Key Pix.

As chaves da API podem ser encontradas lá: "Public KEY : Chave Pública" e "Secret KEY : Chave Secreta". Use essas CHAVES para iniciar a solicitação da API. Você pode gerar nova chave API clicando no botão MENU->Api Key | PIX API KEY: Gerar Nova Chave | . Lembre-se: Não compartilhe essas chaves com ninguém! JAMAIS!

Iniciar pagamento CASH-IN

Esta seção descreve o processo de "Iniciar o Pagamento CASH-IN".

Para iniciar o pagamento, siga o código de exemplo e tenha cuidado com os parâmetros. Você precisará fazer a solicitação com os seguintes ENDPOINTS da API.

EndPoint Produção (real): Solicitar URL com suporte

EndPoint SandBox (teste demo) : Solicitar URL com suporte

Método de solicitação: POST

Pedido (request) para o EndPoint com os seguintes parâmetros abaixo.

Parâmetro Nome Tipo de parâmetro Descrição
public_key string (50) Obrigatório Sua Chave pública API key
identifier string (20) Obrigatório Identificar o pagamento ao fim do procedimento
details string (100) Obrigatório Detalhes do seu pagamento ou transação.
nickname_connection string (50) Obrigatório Apelido da conexão - No Painel MENU->Webhook e IP se econtra o "Apelido da Conexâo"
public_key string (50) Obrigatório Sua Chave pública API key
name_documentor string (30) Opcional Nome do cliente.
email_documentor string (30) Opcional E-mail válido do cliente.
documentor string (30) Opcional CPF ou CNPJ do cliente.
payment string
currency string (4) Obrigatório Código Moeda: deve estar em maiúsculo, exemplo: BRL
amount decimal Obrigatório Valor do pagamento.
theme string
checkout_theme string Opcional Tema do formulário de checkout: Dark/Light. Tema padrão: Light
site_logo string/url Opcional Seu logotipo do site de negócios.
Requisição JSON

//application/json                                        
{
    "type": "PIX",
    "identifier": "DFU80XZIK4",
    "details": "Detalhe do Cash-In",
    "nickname_connection": "WebHoock",
    "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name_documentor": "Pedro H",
    "email_documentor": "dev@rgpay.com.br",
    "documentor": "12345678901",
    "payment": {
        "currency": "BRL",
        "amount": 0.01
    },
    "theme": {
        "checkout_theme": "dark",
        "site_logo": "https://rgpay.com.br/assets/images/logoIcon/logo.png"
    }
}
Resposta JSON

//application/json  
{  
  "trxid": "s1kL30F846cbDC8Wqh9jlKgQ9NpChR",
  "payerType": "live",
  "type": "PIX",
  "amount": 0.01,
  "dataQR": {
    "paymentCode": "00020126870014br.gov.bcb.pix2565pix.k1.creditag.com.br/qr/v3/at/5a796baa-e943-45cb-8501-114e4985a4fa5204000053039865802BR5925ISABELLE_BERNARDES_DE_ALM6008CAMPINAS62070503***63049E1D",
    "paymentCodeBase64Image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsAQAAAABRBrPYAAAAIGNIUk0AAHomAACAhAAA+gAAAIDoAAB1MAAA6mAAADqYAAAXcJy6UTwAAAACYktHRAAB3YoTpAAACABJREFUaN7FWkmS4zgMxA3fxQ/4ZfyAw1wgq+cwMQcq2lHlsuWUiwuWRIKx/8+j46/AOiLWzl742xWVGSt3np+9I6rqfFB/EdaGnfcVGXkeAfgLtnYf2Lnz/GbzloPa59J5HbUAuA47w8EYMJhzFR9FEJaGHYBh2TXfdT468znvMFP8l+9gWK4zGK4cFgs/XMvKF2zj687UirDC0AnD5a9g+LSwbHpwG/nCo3xgZ4K4FSt77KVxR3Hf13cwXObi8XF2nwOTtRkGCzmTJOzs87n/fDMMGfbbfxjSPZjWZ4as0fhXFx6Xqf98fAV7LVA8t/3+HgADTraMQv7C1T8zxZTfgesijPsc9FE98llHRZZjtYYdU6UH4cN1vJ2mcBz6Kxi89zUiGabNUhZY+NMIK7BMxchjK3R6hUYa9PoCpiHl84Twxpel9xwbQ865QZebzgxjZtxBpIZx92VYI7oIprGV0M/7ZRimtfEF2ABZBeITdwIRgWH0MozbrZDhveeGc1xpTz3rRqv1WiKmY2qYxHlCYmwBr8MeH8CYsZ6pxcVyEsaxLYVw2Gjy90wbMXPTkBFHr8Matg+b4rjaQZd7yRE280fQu8UXHJxLzkOYEtB5eR+WA7MvxM8vvMu0EMBgpKQo9GY4mEgOFnlfh+WMpOignNF4xYSVswvacRkFDHXR8Y/xYoqw7O9gSRieU+/wstbk1QNrUhjYKWa5UxkQfHAzVpFJ3IU5PtMjuaTeyBwjkCWQ/4HUYcDMysU/Q/qQfj6ATR6l4c3YGH9DMPFezhFuLJgng7dBFlsypKuw0oIxLtNZna6c9BNJ7exp62blF3ztkgmIwC5xm8swrhvNKyaqjYOujCexsKIoxB6EJVgFHQ05kaxfxcV1WEzFoiEx3JCkt8YmmEsiRXIZRYrcswCxEX8AyyeMqFJgLMEEmESa2RnGkDJEW8tSjMJUZdrXYX+SEK4gTS+5tuU8u2WEi6n5DWMG3P0JrIciGfbkhHKR9cDg2L9YpAjIGZe4figi3YWVaGTm2+6KgZeEJcy4UIuxbi3yZ1UYnBKmykLtMsyhZdPeUP53/LwjxU6ZPsgONuNlg8nQHMkRWwXwF7BfNKNx9qT8Sf7kSPtJsojGlc5oKnrJCZmM7sL6x8XLdDKesYkwY2yc5BCWyW5gqtx2xqvrsB72OYNxcleQq4x6w1iCwFC5C4qGYjrlSH4dZsta/aNwTBaAkTg5A+IezBlwfV2B2WzFqw9gD+/wGHM4pdLCjC0ZUpQnmGc4nTSsqT19AtMoYoqa4iVyE8AcyVuRUU5UU4DTkiG17OuwniRPq08VQBRLpnSk3zAWsnDr9P1bMKVAk6/bsIlktHuWL0oTYMh6q2iJmmip7qZ/NZ/BXlNq0HWYtcqxq8xXfuXGus5S8lOMLBEvw5r/gj73AWxUuSn6p9BKSpox9ekkCU7GlZIoIapyRvXbMLEj7igZ5UQ71YYtAWyLd0p+xfeBxGB2+C+pIpZFyk3YKy08yUD66sqRL1k7U5uVtpJ6uaRs70nE92FTHTii5RQNrCtUZjHtSh1IpWPSTzqNqkvx/74N0zgMs0TTjm0rn/qUwj6YcomgsuJoFpKbElreh3FPXbDmL5bUI4moUO0aGAs2+nyYUdHhYSdfwBQsKh66ZOUkIx4YHKsU7pavsqZQIbbYtujbsLLBL21kTJ9hTU3IK6RSy+qT4jblO0mHNuZPYPV0PBg8tuz/qWoIYx8g2GCS1qNGAKNMqj11G9aPLy6Nr6ZnpKK6FRwJY32m4gvp1jCwry9hXZPoKx+YksJ4fUsmZEpm2w5+RVO2lFcfwCZolF0hLUM8a6fsLNmYkpPVVs3T3cIvYNIcVjiErJ+m6gzmvCC9mPPqEqtnxGQciOXQcx3mHsLDd5lJp8fgNEvbZBqm5ERxCVuggkQyGmd6FTatmJ2vlpHHmVxRw1IwNZkolSw1sCUfm4JehoWDDcPyKIeT5df2nuJGUWiK/L3UMFZHW3T6ExjFXktOqi7WlPSm81z/nH41dUXB2P3McJv2MqyWtrmnQq05VEDY2Bs1PMOUipdhrC1y2hBXYcOG3z2FyWMWAtS505fJR0rREobLL5a48gFMxj/RLZ887wY/DXQrIiZrIp3S6KeixA5tCx1XYeniTyIiGZH6gDyWsUXMwQZ3uqdPQ2lTLUkbe+TNqzD1T1U5aySOIRTvpJ8PrFgYsjwkTyBsSxNgi+w+LJ7iyhJN/HqUTKqaaUoiU6nIJg5FbjUtsA7XYa2+5NQspmwhmNPCVOJIMOoSL9pyqamYOn4iVnMXVvXEjpi6MSbdr6kX1KFgyb0ocnf5KAwTjkjFZVhbkwmHs3y1/+Kd60XQN0XZTnVWVsecTwipK5dhES+WlCrAquKXVKX8qAprV5SmqUWFQCFdBz9uwnpNJRO/Qf60Szkxu2OifvkuwcTn5VQfwapyxFQL0tPR8r76XA2F4rEMJz4x6xhl+yqsR63O+BUKOee6cmqIFidBQ2D0lVdyoSWQEnwAk94aZiKqYDi2B7YomaW8n7R0idpQ4ttWcC/DeG6weDZjeO9LuXH6MowByNx4bqgHlv0BrKbN/O8jDiM++JicCmuKKxSlLHDH+PZnsGkv2FPHbaZfr8Nw7I0xZahlHN4UksKZ6W3YnL14uqmP8qtfW4i6dKpc2aHYOo4Y4g63YT6uVOtJqJZdp40qe/OJXB2Z2LYVtcukH6+/Bvsb56L/ASqnjAk0Lb89AAAAAElFTkSuQmCC",
    "urlcheckout": "https://rgpay.com.br/pix/initiate/payment/checkout?payment_id=eyJpdiI6InJoVUFLUS9rWmFONmtRcVZFT0tEVUE9PSIsInZhbHVlIjoiaEdJa0lxMXIrOVFjWnV2QzkwejR0UTVNYm5CTlhqS0JYQ3plRFlyMmxJTUhhazB6bmRYanlISlpWZUxQKzFudSIsIm1hYyI6ImI4MzI3ZWFhNjMzY2M1OTg5MzU1MzEzMDdI3NDQxMjRhYjQwNDkyYmUwYmVkNTNlOGFmMWMyNWQ2ZGYyMDE5OWQiLCJ0YWciOiIifQ%3D%3D"
  },
  "MSG": {
    "success": "ok",
    "message": "Pagamento RGPAY Iniciado. Cod: SUCCESS/PHAAFFJ01"
  }
}

Consultar transação CASH-IN

Esta seção descreve o processo para obter sua notificação de pagamento instantâneo.

Para iniciar o pagamento, siga o código de exemplo e tenha cuidado com os parâmetros. Você precisará fazer a solicitação com os seguintes ENDPOINTS da API.

EndPoint: Solicitar URL com suporte

Método de solicitação: POST

Você receberá os seguintes parâmetros abaixo.

Atenção: A consulta deve conter "trxid ou endToEndId".
Parâmetro Nome Tipo de parâmetro Descrição
trxid string (50) Opcional Identificador "trxid" gerado no webhook Iniciar pagamento CASH-IN.
endToEndId string (50) Opcional Identificador "endToEndId" gerado no webhook quanto cliente efetua pagamento.
public_key string (50) Obrigatório Sua Chave pública API key
Requisição JSON

//application/json  
{
    "trxid": "VhUWu8ubgHWUUH0yI692uNZiEFokfd",
    "endToEndId": "E0549161620240917023126899a26da7",
    "public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Resposta JSON

//application/json  
//Resultado Aprovado
{
    "status": "LIQUIDATED",
    "trxid": "Qnx2kHw1eYebf7DsZERyTfawEnsaQq",
    "EndToEndId": "E18236120202409170515s090b3ebb2e",
    "identifier": "Indentificador Opcional",
    "data": {
        "payment_id": 133,
        "amount": 0.10000000,
        "charge": 0.03000000,
        "final_amount": 0.07000000,
        "account_holder": "RGPAY",
        "payment_create_timestamp": "2021-05-17T05:15:57.000000Z",
        "payment_update_timestamp": "2021-05-17T05:15:57.000000Z",
        "currency": {
            "code": "BRL",
            "symbol": "R$"
        }
    }
}
//Resultado Pendente
{
    "status": "PENDING",
    "trxid": "Qnx2kHw1eYebf7DsZERyTfawEnsaQq",
    "identifier": "uIndentificador Opcional",
    "data": {
        "amount": 0.01000000,
        "account_holder": "RGPAY",
        "payment_create_timestamp": "2021-05-17T05:15:57.000000Z",
        "payment_update_timestamp": "2021-05-17T05:15:57.000000Z",
        "currency": {
            "code": "BRL",
            "symbol": "R$"
        }
    }
}

WebHooks CASH-IN

Esta seção descreve o processo para obter sua notificação de pagamento instantâneo.

Para iniciar o pagamento, siga o código de exemplo e tenha cuidado com os parâmetros. Você precisará fazer a solicitação com os seguintes ENDPOINTS da API.

EndPoint: URL do seu site de aplicação

Método de solicitação: POST

Resposta JSON

//application/json  
{
  "status": "LIQUIDATED",
  "apelido": "Cash-In",
  "signature": "7C6A936853C8DA831D771104D5AD3698A305A871217791A67D25CA05976268DE",
  "identifier": "DFU80XZIK4",
  "data": {
    "payment_type": "PIXWEB",
    "trxid": "pg8FiJMqeBV0SIpaSmZ8ZS3WZHY9z0",
    "EndToEndId": "E05491616202411060117424108253a3",
    "amount": 0.01,
    "charge": 0.01,
    "account_holder": "RGPAY.",
    "payment_timestamp": "2024-11-06T01:17:12.000000Z",
    "currency": {
      "code": "BRL",
      "symbol": "R$"
    }
  }
}

Para aprimorar sua experiência de navegação, usamos cookies e tecnologias de rastreamento quando você visita nosso site. We use cookies or any other tracking technologies when you visit our website, to help customize the Site and improve your experience. leia mais

Permitir