{"id":502,"date":"2026-04-06T02:14:42","date_gmt":"2026-04-06T00:14:42","guid":{"rendered":"https:\/\/riskpaygo.com\/?page_id=502"},"modified":"2026-04-06T11:38:03","modified_gmt":"2026-04-06T09:38:03","slug":"api","status":"publish","type":"page","link":"https:\/\/riskpaygo.com\/pt\/api\/","title":{"rendered":"Integra\u00e7\u00e3o da API RiskPayGo"},"content":{"rendered":"<p>Esta documenta\u00e7\u00e3o explica como integrar o RiskPayGo ao seu site ou aplicativo para criar pagamentos, redirecionar o comprador para a p\u00e1gina de finaliza\u00e7\u00e3o da compra e receber a confirma\u00e7\u00e3o final do status via webhook.<\/p>\n<p>A integra\u00e7\u00e3o deve ser feita a partir do seu backend. N\u00e3o \u00e9 recomend\u00e1vel expor credenciais ou l\u00f3gica sens\u00edvel no frontend.<\/p>\n<h2>Antes de come\u00e7armos<\/h2>\n<p>Antes de come\u00e7ar, voc\u00ea precisa de uma conta comercial aprovada e ativa com a RiskPayGo. Voc\u00ea tamb\u00e9m precisa das suas credenciais de integra\u00e7\u00e3o e garantir que o dom\u00ednio do qual voc\u00ea coletar\u00e1 pagamentos esteja aprovado em sua conta.<\/p>\n<p>Os dados de que voc\u00ea precisar\u00e1 s\u00e3o seus <code>ID do comerciante<\/code>, voc\u00ea <code>Token da API<\/code>, voc\u00ea <code>Segredo do Webhook<\/code> e a URL base da API.<\/p>\n<p>A URL base \u00e9 a seguinte:<\/p>\n<pre><code>https:\/\/riskpaygo.com\/portal\/api\/plugin<\/code><\/pre>\n<h2>Autentica\u00e7\u00e3o<\/h2>\n<p>Todas as requisi\u00e7\u00f5es \u00e0 API devem ser autenticadas. Para isso, voc\u00ea precisa incluir o token privado no cabe\u00e7alho. <code>Autoriza\u00e7\u00e3o<\/code> e o identificador do comerciante no cabe\u00e7alho <code>X-RPG-Merchant<\/code>.<\/p>\n<p>Os cabe\u00e7alhos necess\u00e1rios s\u00e3o os seguintes:<\/p>\n<pre><code>Accept: application\/json\nContent-Type: application\/json\nAuthorization: Bearer TU_API_TOKEN\nX-RPG-Merchant: TU_MERCHANT_ID<\/code><\/pre>\n<p>Essas credenciais devem ser usadas apenas no servidor. Elas n\u00e3o devem ser vis\u00edveis no JavaScript do navegador ou em c\u00f3digo p\u00fablico.<\/p>\n<h2>Dom\u00ednio aprovado<\/h2>\n<p>O RiskPayGo valida o dom\u00ednio que voc\u00ea envia no campo. <code>site.url<\/code>Isso significa que ter credenciais v\u00e1lidas n\u00e3o \u00e9 suficiente: o dom\u00ednio a partir do qual voc\u00ea est\u00e1 criando o pagamento tamb\u00e9m deve estar registrado e aprovado em sua conta.<\/p>\n<p>Se o dom\u00ednio n\u00e3o corresponder a nenhum dos seus projetos aprovados, a API rejeitar\u00e1 a solicita\u00e7\u00e3o, mesmo que o token esteja correto.<\/p>\n<p>Portanto, antes de iniciar a produ\u00e7\u00e3o, \u00e9 aconselh\u00e1vel verificar se o URL exato da sua loja ou aplicativo est\u00e1 registrado no painel.<\/p>\n<h2>Criar um pagamento<\/h2>\n<p>Para iniciar um pagamento, voc\u00ea precisa enviar uma solicita\u00e7\u00e3o. <code>PUBLICAR<\/code> para o ponto de extremidade de cria\u00e7\u00e3o de pagamento.<\/p>\n<pre><code>POST https:\/\/riskpaygo.com\/portal\/api\/plugin\/payments\/create<\/code><\/pre>\n<p>Nesse pedido, voc\u00ea deve enviar as principais informa\u00e7\u00f5es do pedido: o valor, a moeda, suas refer\u00eancias internas, os dados do comprador e os URLs de devolu\u00e7\u00e3o e notifica\u00e7\u00e3o.<\/p>\n<p>Uma solicita\u00e7\u00e3o t\u00edpica incluir\u00e1 campos como: <code>id_do_pedido_do_comerciante<\/code>, <code>id_do_pedido<\/code>, <code>chave_de_ordem<\/code>, <code>quantia<\/code>, <code>moeda<\/code>, <code>cliente<\/code>, <code>site<\/code>, <code>notify_url<\/code>, <code>URL de retorno<\/code> e <code>url_de_cancelamento<\/code>.<\/p>\n<p>Abaixo segue um exemplo completo do corpo da mensagem que voc\u00ea pode enviar:<\/p>\n<pre><code>{\n  \"merchant_order_id\": \"PED-1001\",\n  \"order_id\": 1001,\n  \"order_key\": \"pedido_1001_key\",\n  \"amount\": \"149.99\",\n  \"currency\": \"USD\",\n  \"customer\": {\n    \"email\": \"cliente@ejemplo.com\",\n    \"first_name\": \"Nombre\",\n    \"last_name\": \"Apellido\",\n    \"phone\": \"+34123456789\",\n    \"country\": \"ES\",\n    \"date_of_birth\": \"1990-05-20\"\n  },\n  \"site\": {\n    \"url\": \"https:\/\/tu-dominio.com\/\",\n    \"name\": \"Mi tienda\",\n    \"platform\": \"custom\",\n    \"plugin\": \"integracion-propia\"\n  },\n  \"notify_url\": \"https:\/\/tu-dominio.com\/api\/riskpaygo\/webhook\",\n  \"return_url\": \"https:\/\/tu-dominio.com\/pago\/completado\",\n  \"cancel_url\": \"https:\/\/tu-dominio.com\/pago\/cancelado\"\n}<\/code><\/pre>\n<p>O campo <code>quantia<\/code> Deve ser maior que zero. A moeda \u00e9 enviada em <code>moeda<\/code>. Em <code>cliente<\/code> \u00c9 recomend\u00e1vel enviar, pelo menos, o endere\u00e7o de e-mail do comprador. <code>site.url<\/code> Voc\u00ea deve enviar o dom\u00ednio aprovado. <code>notify_url<\/code> Voc\u00ea indica onde deseja receber a notifica\u00e7\u00e3o sobre o status do pagamento.<\/p>\n<h2>Resposta da API<\/h2>\n<p>Se a solicita\u00e7\u00e3o for bem-sucedida, o RiskPayGo retorna uma resposta com a refer\u00eancia de pagamento interna e o URL de finaliza\u00e7\u00e3o da compra. Essa refer\u00eancia permite que voc\u00ea vincule o pagamento ao seu pedido e o acompanhe posteriormente.<\/p>\n<p>A resposta esperada tem a seguinte forma:<\/p>\n<pre><code>{\n  \"success\": true,\n  \"data\": {\n    \"payment_ref\": \"RPG-20260313-ABC12345\",\n    \"checkout_url\": \"https:\/\/riskpaygo.com\/portal\/checkout.php?ref=RPG-20260313-ABC12345\",\n    \"fee_percent\": 20,\n    \"plan_slug\": \"free\"\n  }\n}<\/code><\/pre>\n<p>Assim que voc\u00ea receber <code>URL de finaliza\u00e7\u00e3o de compra<\/code>Voc\u00ea deve redirecionar o comprador para esse endere\u00e7o para que ele possa concluir o pagamento.<\/p>\n<h2>O que fazer em rela\u00e7\u00e3o ao caixa<\/h2>\n<p>O pagamento \u00e9 processado atrav\u00e9s de um sistema de finaliza\u00e7\u00e3o de compra hospedado pela RiskPayGo. Seu sistema n\u00e3o deve considerar o pedido como pago simplesmente porque voc\u00ea obteve o URL da finaliza\u00e7\u00e3o da compra ou porque o usu\u00e1rio retornou ao site.<\/p>\n<p>Recomenda-se salvar a refer\u00eancia. <code>refer\u00eancia_de_pagamento<\/code>Redirecione o comprador e aguarde a confirma\u00e7\u00e3o final via webhook.<\/p>\n<p>O <code>URL de retorno<\/code> Serve para redirecionar o usu\u00e1rio ao seu site ap\u00f3s o pagamento, mas o status final deve ser baseado na notifica\u00e7\u00e3o que voc\u00ea recebe em <code>notify_url<\/code>.<\/p>\n<h2>Webhook de confirma\u00e7\u00e3o<\/h2>\n<p>Quando o status do pagamento mudar, o RiskPayGo enviar\u00e1 uma solicita\u00e7\u00e3o. <code>PUBLICAR<\/code> para o URL indicado em <code>notify_url<\/code>Essa notifica\u00e7\u00e3o inclui uma assinatura no topo. <code>Assinatura X-RPG<\/code>.<\/p>\n<p>Voc\u00ea deve validar essa assinatura usando o seu <code>Segredo do Webhook<\/code>A valida\u00e7\u00e3o deve ser feita no corpo original exato da solicita\u00e7\u00e3o, n\u00e3o em um JSON reserializado.<\/p>\n<p>O cabe\u00e7alho que voc\u00ea precisa verificar \u00e9 este:<\/p>\n<pre><code>X-RPG-Signature:<\/code><\/pre>\n<p>A notifica\u00e7\u00e3o do RiskPayGo pode incluir informa\u00e7\u00f5es como o nome do comerciante, a refer\u00eancia do pedido, a refer\u00eancia do pagamento, o status e o ID da transa\u00e7\u00e3o. Um exemplo seria este:<\/p>\n<pre><code>{\n  \"merchant_id\": \"TU_MERCHANT_ID\",\n  \"order_id\": 1001,\n  \"order_key\": \"pedido_1001_key\",\n  \"payment_ref\": \"RPG-20260313-ABC12345\",\n  \"transaction_id\": \"RPG-20260313-ABC12345\",\n  \"status\": \"paid\",\n  \"provider_status\": \"success\",\n  \"provider_event\": \"payment_succeeded\",\n  \"source\": \"payera_webhook\"\n}<\/code><\/pre>\n<p>O importante aqui \u00e9 validar a assinatura e depois usar o valor de <code>status<\/code> Para atualizar o pedido em seu sistema.<\/p>\n<h2>Status de pagamento<\/h2>\n<p>Durante a integra\u00e7\u00e3o, voc\u00ea deve considerar quatro estados principais.<\/p>\n<p><code>pendente<\/code> Isso indica que o pagamento foi iniciado, mas ainda n\u00e3o foi confirmado.<\/p>\n<p><code>pago<\/code> Isso indica que o pagamento foi confirmado com sucesso. Normalmente, esse \u00e9 o status que voc\u00ea deve usar para marcar o pedido como pago.<\/p>\n<p><code>fracassado<\/code> Indica que o pagamento falhou ou foi rejeitado.<\/p>\n<p><code>cancelado<\/code> Indica que o pagamento foi cancelado ou expirou.<\/p>\n<p>A recomenda\u00e7\u00e3o geral \u00e9 usar o webhook como fonte prim\u00e1ria de informa\u00e7\u00f5es e considerar o pedido pago somente ap\u00f3s o recebimento. <code>status = pago<\/code>.<\/p>\n<h2>Erros comuns<\/h2>\n<h3>Comerciante n\u00e3o autorizado<\/h3>\n<p>Se a API responder com um erro de autoriza\u00e7\u00e3o, a primeira coisa que voc\u00ea deve verificar \u00e9 se o valor enviado em <code>Autoriza\u00e7\u00e3o<\/code> estar correto e que o comerciante enviou em <code>X-RPG-Merchant<\/code> O token deve corresponder. Voc\u00ea tamb\u00e9m precisa confirmar se a conta foi aprovada e est\u00e1 ativa.<\/p>\n<h3>Dom\u00ednio n\u00e3o aprovado<\/h3>\n<p>Se o problema estiver no dom\u00ednio, verifique o valor enviado. <code>site.url<\/code> e verifique se o dom\u00ednio existe como um projeto aprovado no painel RiskPayGo.<\/p>\n<h3>Valor inv\u00e1lido<\/h3>\n<p>Se a API rejeitar o valor, certifique-se de que <code>quantia<\/code> Foi enviado corretamente e possui um valor maior que zero.<\/p>\n<h3>Assinatura de webhook inv\u00e1lida<\/h3>\n<p>Se o seu sistema n\u00e3o conseguir validar a notifica\u00e7\u00e3o, verifique se voc\u00ea est\u00e1 usando o <code>Segredo do Webhook<\/code> Correto e que o c\u00e1lculo da assinatura seja feito exatamente no corpo original da solicita\u00e7\u00e3o.<\/p>\n<h2>Compat\u00edvel com WooCommerce<\/h2>\n<p>Se voc\u00ea estiver usando o plugin oficial do WooCommerce, os mesmos detalhes de integra\u00e7\u00e3o ainda ser\u00e3o necess\u00e1rios. Voc\u00ea precisar\u00e1 configurar a URL base, o comerciante, o token e o segredo do webhook.<\/p>\n<p>Os principais valores a serem inseridos s\u00e3o estes:<\/p>\n<pre><code>API Base URL: https:\/\/riskpaygo.com\/portal\/api\/plugin\nMerchant ID: TU_MERCHANT_ID\nAPI Token: TU_API_TOKEN\nWebhook Secret: TU_WEBHOOK_SECRET<\/code><\/pre>\n<p>A URL do webhook no WordPress geralmente tem este formato:<\/p>\n<pre><code>https:\/\/tu-dominio.com\/wp-json\/riskpaygo\/v1\/webhook<\/code><\/pre>\n<h2>Recomenda\u00e7\u00f5es finais<\/h2>\n<p>Antes de iniciar a produ\u00e7\u00e3o, \u00e9 aconselh\u00e1vel verificar se o dom\u00ednio est\u00e1 aprovado e se o seu <code>notify_url<\/code> Ele responde corretamente via HTTPS, o que voc\u00ea salva. <code>refer\u00eancia_de_pagamento<\/code> em seu sistema e que voc\u00ea s\u00f3 marque os pedidos como pagos quando a confirma\u00e7\u00e3o final chegar via webhook.<\/p>\n<p>Com essa estrutura, voc\u00ea j\u00e1 possui uma base s\u00f3lida para integrar o RiskPayGo ao seu pr\u00f3prio site, a um aplicativo personalizado ou a uma loja WooCommerce.<\/p>","protected":false},"excerpt":{"rendered":"<p>Esta documentaci\u00f3n explica c\u00f3mo integrar RiskPayGo en tu web o aplicaci\u00f3n para crear pagos, redirigir al comprador al checkout y [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"default","adv-header-id-meta":"","stick-header-meta":"default","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"class_list":["post-502","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/riskpaygo.com\/pt\/wp-json\/wp\/v2\/pages\/502","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/riskpaygo.com\/pt\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/riskpaygo.com\/pt\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/riskpaygo.com\/pt\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/riskpaygo.com\/pt\/wp-json\/wp\/v2\/comments?post=502"}],"version-history":[{"count":0,"href":"https:\/\/riskpaygo.com\/pt\/wp-json\/wp\/v2\/pages\/502\/revisions"}],"wp:attachment":[{"href":"https:\/\/riskpaygo.com\/pt\/wp-json\/wp\/v2\/media?parent=502"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}