whatsapp-docs-mcp 1.0.0

package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_billdesk.md

@@ -0,0 +1,343 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent/pg-guide-billdesk -->
+<!-- Scraped: 2025-12-20T17:45:07.879Z -->
+
+# Guia de integração do portal de pagamento do Billdesk
+
+Updated: 14 de nov de 2025
+
+Este documento apresenta a integração de pagamento com o Billdesk, necessária para comerciantes ou provedores de soluções empresariais, que configuraram um chatbot usando as APIs do WhatsApp Business e precisam receber pagamentos de usuários do WhatsApp.
+
+Além disso, abrange as APIs que precisam ser integradas e como a integração funciona em conjunto com a integração da API do WhatsApp Business. Embora não seja um guia abrangente, ele serve como uma visão geral para auxiliar na compreensão do processo de integração do portal de pagamento. Todos os detalhes específicos ou únicos relacionados ao gateway de pagamento devem ser determinados pelo comerciante ou parceiro de solução.
+
+Em termos de integração com o produto WA P2M, este documento cobre as solicitações e respostas destacadas em vermelho no diagrama de fluxo.
+
+![](https://scontent-gru1-2.xx.fbcdn.net/v/t39.2365-6/583839518_1550939386241240_3556025567907244162_n.png?_nc_cat=110&ccb=1-7&_nc_sid=e280be&_nc_ohc=7bbQmhKCO0UQ7kNvwHgd7CX&_nc_oc=AdlWTDNHaI2icEU4e0h6ZKco0yHsd5nQbwbD0bH7_unGbEosqTKLc6h9bTOFVKgusB8&_nc_zt=14&_nc_ht=scontent-gru1-2.xx&_nc_gid=Zogmjbs7Cm2JtYRqhqum9g&oh=00_Afmj8ISawHkMLcj0xH-QQB2VCSL1qinn3JeTrN9JKQKKOA&oe=696120AF)
+
+## Integração de pagamento do Billdesk
+
+### Configuração
+
+Para fazer a autenticação com a API do Billdesk, é preciso criar um cliente e selecionar um método de autenticação entre HMAC e Javascript Object Signing and Encryption (JOSE), sendo esta a opção preferencial. Esses métodos são usados para criptografar/descriptografar a solicitação/resposta das APIs do Billdesk.
+
+Para simplificar a explicação, os exemplos a seguir abordarão apenas o corpo da carga final que será incluído no objeto final necessário para uma autenticação bem-sucedida com a API. É importante consultar a documentação do Billdesk’s para ver orientações sobre como esse objeto final deve ser estruturado.
+
+Para prosseguir, você precisa dos seguintes detalhes:
+
+-   Identificação do cliente e chave secreta do Billdesk.-   Detalhes da configuração de pagamento que você já definiu na conta do WhatsApp Business
+    -   Código de categoria do comerciante-   VPA do comerciante-   Nome do comerciante
+
+### API de Iniciação de Pagamento
+
+#### Exemplo de solicitação para `POST` a https://pguat.billdesk.io/payments/ve1\_2/transactions/create
+
+```
+{  "mercid": "BDMERCHANTID",  "orderid": "UPIODR00000004",  "amount": "2.00",  "currency": "356",  "bankid": "ICW",  "txn_process_type": "intent",  "itemcode": "DIRECT",  "payment_method_type": "upi",  "wa_mc": "0743",  "wa_vpa": "billdesk@hdfcbank",  "wa_txnid": "H477676443",  "wa_mercname": "SIDDHIVINK",  "additional_info": {    "additional_info1": "Details1",    "additional_info2": "Details2"  },  "device": {    "init_channel": "app",    "ip": "124.124.1.1",    "user_agent": "App/22.6.74 Platform/19.5.0"  }}
+```
+
+Parâmetros
+
+Descrição
+
+Identificação do pedido (obrigatório)
+
+string
+
+Identificação do pedido única gerada pelo comerciante para identificar a transação
+
+mercid (obrigatório)
+
+string
+
+Identificador único definido pelo BillDesk para cada comerciante
+
+quantidade (obrigatório)
+
+string
+
+Valor da transação com dois dígitos decimais
+
+moeda (obrigatório)
+
+string
+
+Moeda ISO do valor da transação
+
+txn\_process\_type (opcional)
+
+string
+
+O valor deve ser definido como `intent`.
+
+bankid (opcional)
+
+string
+
+Identificador exclusivo do BillDesk definido para o banco ou adquirente.
+
+ru (opcional)
+
+string
+
+URL de devolução do comerciante
+
+itemcode (obrigatório)
+
+string
+
+O valor itemcode fornecido pelo BillDesk, com um valor padrão `DIRECT`.
+
+devic (obrigatório)
+
+objeto
+
+Objeto do dispositivo. Para saber mais, consulte a documentação do BillDesk.
+
+payment\_method\_type (obrigatório)
+
+string
+
+Defina como `upi`.
+
+wa\_mc (obrigatório)
+
+string
+
+Categoria do comerciante
+
+wa\_vpa (obrigatório)
+
+string
+
+VPA do beneficiário
+
+wa\_txnid (obrigatório)
+
+string
+
+O txnid único gerado pelo banco para a transação.
+
+wa\_mercname (obrigatório)
+
+string
+
+Nome do comerciante
+
+#### Exemplo de resposta
+
+```
+{  "objectid": "transaction",  "transactionid": "X7890477676443",  "orderid": "UPIODR00000004",  "mercid": "BDMERCID",  "transaction_date": "2022-03-18T11:50:27+05:30",  "amount": "2.00",  "surcharge": "0.00",  "discount": "0.00",  "charge_amount": "2.00",  "currency": "356",  "additional_info": {    "additional_info1": "Details1",    "additional_info2": "Details2"  },  "txn_process_type": "intent",  "bankid": "ICW",  "itemcode": "DIRECT",  "auth_status": "0002",  "transaction_error_code": "TRP0000",  "transaction_error_desc": "Transaction Pending ",  "transaction_error_type": "pending",  "payment_method_type": "upi",  "wa_mc": "7399",  "wa_vpa": "billdesk@hdfcbank",  "wa_txnid": "H477676443",  "wa_mercname": "SIDDHIVINK",  "intent": "dXBpOi8vcGF5P3BhPWJpbGxkZXNrQGhkZmNiYW5rJnBuPVNJRERISVZJTksmbWM9NjMwMCZ0cj1YSEQ1MDQ3NzY3NjQ0MyZ0bj1QYXkmYW09Mi4wMCZtYWwMCZjdT1JTlI="}
+```
+
+### Analisar a resposta
+
+Use o valor de `wa_txnid` na resposta e passe-o como o `reference_id` ao configurar o objeto `parameters` para enviar na [mensagem de detalhes do pedido](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent#paramobject) usando a API.
+
+Verifique os valores na intenção recebida:
+
+-   A chave `intent` tem o valor codificado em base64 da intenção-   A decodificação de `intent` deve gerar um valor semelhante a: `upi://pay?pa=billdesk@hdfcbank&pn=SIDDHIVINKamp;mc=6300&tr=XHD50477676443&tn=Pay&am=2.00&malORS`-   O valor de `pa` é o `VPA` do comerciante. Esse valor deve corresponder à identificação de VPA no `payment_configuration` enviado no objeto `parameters`.
+
+### Webhook de status
+
+O Billdesk publicará um objeto de transação no URL de devolução (`ru`) especificado na API de iniciação de pagamento.
+
+Chave
+
+Tipo de dados
+
+Descrição
+
+objectid (obrigatório)
+
+string
+
+A string que representa o tipo do objeto. Esse valor será fixado como transação.
+
+transactionid
+
+string
+
+A identificação de transação única gerada pelo BillDesk para a transação
+
+orderid
+
+string
+
+Identificação do pedido único gerado pelo comerciante para a transação.
+
+mercid
+
+string
+
+Identificador único definido pelo BillDesk para cada comerciante
+
+transaction\_date
+
+timestamp
+
+Data e hora da transação do BillDesk no formato AAAA-MM-DDThh:mm:ssTZD
+
+amount
+
+string
+
+Valor da transação com dois dígitos decimais
+
+surcharge
+
+string
+
+Sobretaxa do cliente em dois decimais aplicada ao valor da transação, se houver.
+
+desconto
+
+string
+
+Sobretaxa do cliente em dois decimais aplicada ao valor da transação, se houver.
+
+charge\_amount
+
+string
+
+Cobrança total na moeda
+
+currency
+
+integer
+
+Moeda ISO do valor da transação
+
+txn\_process\_type
+
+string
+
+Indica o tipo de processamento da transação.
+
+A intenção para payment\_method\_type é upi, e a forma de pagamento é intenção de UPI
+
+bankid
+
+string
+
+Identificador exclusivo do BillDesk definido para o banco ou adquirente.
+
+txn\_process\_type
+
+string
+
+Indica o tipo de processamento da transação.
+
+A intenção para payment\_method\_type é upi, e a forma de pagamento é UPI intent.
+
+ru
+
+string
+
+URL de devolução do comerciante
+
+additional\_info
+
+objeto
+
+Matriz de 10 valores `additional_info` que podem ser anexados à transação. Observação: recomenda-se que o comerciante não transmita informações de PII do cliente em campos de informações adicionais.
+
+itemcode
+
+string
+
+O valor itemcode fornecido pelo BillDesk, com um valor padrão `DIRECT`.
+
+bank\_ref\_no
+
+string
+
+Número de referência da transação gerado pelo banco ou pela entidade adquirente
+
+auth\_status
+
+string
+
+Representa o status de autorização da transação com os seguintes valores possíveis:
+
+-   `0300` – Transação bem-sucedida-   `0002` – A transação está aguardando autorização-   `0399` – Falha na transação
+
+settlement\_lob
+
+string
+
+Linha de negócios de liquidação pré-configurada pelo BillDesk para liquidação de fundos no cliente
+
+cliente
+
+objeto
+
+Objeto do cliente
+
+dispositivo
+
+objeto
+
+Objeto do dispositivo
+
+transaction\_error\_code
+
+string
+
+Representa o código de erro para uma transação com status `0399`.
+
+transaction\_error\_type
+
+string
+
+Representa a categoria de erro padrão para uma transação com status `0399`.
+
+transaction\_error\_desc
+
+string
+
+Representa a descrição do código de erro para uma transação com status `0399`.
+
+authcode
+
+string
+
+O código de autorização recebido do adquirente para uma transação com cartão autorizada com sucesso
+
+eci
+
+string
+
+O valor de eci da autenticação realizada para a transação do cartão.
+
+payment\_method\_type
+
+string
+
+Representa a forma de pagamento, por exemplo, upi.
+
+cartão
+
+Objeto
+
+Objeto da forma de pagamento (aplicável quando a forma de pagamento for cartão)
+
+customer\_refid
+
+string
+
+Identificador único do cliente referente ao comerciante.
+
+links
+
+objeto
+
+Links associados ao objeto
+
+### Como analisar a resposta
+
+Use o `auth_status` recuperado da resposta acima e transmita a [mensagem de status](/docs/whatsapp/cloud-api/payments-api/upi#step-7--update-order-status) correspondente via API do WhatsApp.
+
+Você achou esta página útil?
+
+![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
+
+![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)

package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_cashfree.md

@@ -0,0 +1,145 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent/pg-guide-cashfree -->
+<!-- Scraped: 2025-12-20T17:44:59.590Z -->
+
+# Guia de integração do gateway de pagamento da Cashfree
+
+Updated: 31 de out de 2025
+
+## Propósito
+
+Este documento apresenta a integração de pagamento com a Cashfree, necessária para comerciantes ou parceiros de soluções que configuraram um chatbot usando as APIs do WhatsApp Business e precisam receber pagamentos de usuários do WhatsApp.
+
+Além disso, abrange o conjunto de APIs que precisam ser integradas e como a integração funciona em conjunto com a integração da API do WhatsApp Business. Para saber mais sobre a integração de pagamento da Cashfree, consulte a documentação da Cashfree.
+
+Onde isso se encaixa em todo o fluxo em termos de integração com o produto WA P2M: o documento a seguir cobre as solicitações e respostas em vermelho no diagrama do fluxo abaixo. ![Image](https://scontent-gru2-1.xx.fbcdn.net/v/t39.2365-6/569169662_1344528437405807_2132705829768077708_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=e280be&_nc_ohc=LxZvaBSjAD4Q7kNvwGYJcUn&_nc_oc=AdlQqX2V72OWxfbwyK-3pxbMuybZoEqy2VmHPO7vOutPyX9wYqc-EShgEhKWB94aTgk&_nc_zt=14&_nc_ht=scontent-gru2-1.xx&_nc_gid=lAelSM4jWWnMuXk_nuKG3w&oh=00_AflD2G7BM0FEZu2bLsuD8XO5zRX5M6xAD3BAK248mI6K1A&oe=69612DE2)
+
+## Integração de pagamento da Cashfree
+
+### Configuração
+
+-   Obtenha as credenciais (segredo e identificação do cliente) no painel da Cashfree depois de configurar a conta.-   Obtenha o VPA, o MCC e o código de finalidade do comerciante junto à Cashfree. Isso será usado para definir a [configuração de pagamento](/docs/whatsapp/on-premises/payments-api/upi#before-you-start) no WhatsApp. É compatível com diversos VPAs, portanto, é possível configurar várias opções de pagamento. Cada configuração de pagamento deve ter um VPA.
+    
+    ### Criar pedido
+    
+    Isso cria o pedido na Cashfree.
+    
+
+[Consulte a documentação](https://l.facebook.com/l.php?u=https%3A%2F%2Fdocs.cashfree.com%2Freference%2Fcreateorder&h=AT01qL6yMJkDMu7tRseghgBE6BXYveTAAQzeZqcoFHvs5-kg6IDqCcvr6zGQUAGb3IBTdYwaEg_cAOfWb4HR_uLQGhhwhqYyoi1Omqa-tXKjC-eCk2_oDLUX45wbabZchBKrNveXqCu0NDTv0NL-ozckmjM)
+
+#### Solicitação
+
+```
+curl --request POST \     --url https://sandbox.cashfree.com/pg/orders \ // Production URL : https://api.cashfree.com/pg/orders     --header 'accept: application/json' \     --header 'content-type: application/json' \     --header 'x-api-version: 2022-09-01' \     --header 'x-client-id: 26268833355ef02b8ff299390c886262' \     --header 'x-client-secret: 1708cc38a3c1c3c2512d79b3530dc5cc65ad2fde' \     --data '    {     "customer_details": {          "customer_id": "7112AAA812234",          "customer_email": "john@cashfree.com",          "customer_phone": "9908734801",          "customer_bank_account_number": "1518121112",          "customer_bank_ifsc": "CITI0000001",          "customer_bank_code": 3333     },     "order_meta": {          "notify_url": "https://b8af79f41056.eu.ngrok.io/webhook.php", // Notification URL where status notifications sent - can be different for different merchants          "payment_methods": "upi"     },      "order_tags": {          "channel": "WhatsApp" // Custom tag     },     "order_id": "order02",     "order_amount": 200.5,     "order_currency": "INR",     "order_expiry_time": "2022-12-29T00:00:00Z",     "order_note": "Test order"    }
+```
+
+#### Resposta
+
+```
+{  "cf_order_id": 3401407,  "created_at": "2022-12-26T14:11:07+05:30",  "customer_details": {    "customer_id": "7112AAA812234",    "customer_name": null,    "customer_email": "john@cashfree.com",    "customer_phone": "9908734801"  },  "entity": "order",  "order_amount": 200.5,  "order_currency": "INR",  "order_expiry_time": "2022-12-29T05:30:00+05:30",  "order_id": "order02",  "order_meta": {    "return_url": null,    "notify_url": "https://b8af79f41056.eu.ngrok.io/webhook.php",    "payment_methods": "upi"  },  "order_note": "Test order",  "order_splits": [],  "order_status": "ACTIVE",  "order_tags": {    "channel": "WhatsApp" // Custom tag  },  "payment_session_id": "session_364o8HjN0-gc6n_n4EBEPOXriJUJvCeVIdy9u8ihOhwvpNg9F1wMorWmkVxUR90kTe473bpbotNxyZ6Fze8M0w42_BpTxoEWsbBR21y7i0nh",  "payments": {    "url": "https://sandbox.cashfree.com/pg/orders/order02/payments" // production URL’s are different  },  "refunds": {    "url": "https://sandbox.cashfree.com/pg/orders/order02/refunds"  },  "settlements": {    "url": "https://sandbox.cashfree.com/pg/orders/order02/settlements"  },  "terminal_data": null}
+```
+
+### Pagamento do pedido
+
+Essa API retorna a URL de intenção da UPI que contém os parâmetros necessários para as APIs do WhatsApp. [Consulte a documentação](https://l.facebook.com/l.php?u=https%3A%2F%2Fdocs.cashfree.com%2Freference%2Forderpay&h=AT01qL6yMJkDMu7tRseghgBE6BXYveTAAQzeZqcoFHvs5-kg6IDqCcvr6zGQUAGb3IBTdYwaEg_cAOfWb4HR_uLQGhhwhqYyoi1Omqa-tXKjC-eCk2_oDLUX45wbabZchBKrNveXqCu0NDTv0NL-ozckmjM)
+
+#### Solicitação
+
+```
+curl --request POST \     --url https://sandbox.cashfree.com/pg/orders/sessions \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --header 'x-api-version: 2022-09-01' \     --data '    {     "payment_method": {          "upi": {               "channel": "link",               "upi_id": "rajnandan1@okhdfcbak",               "upi_expiry_minutes": 10          }     },     "payment_session_id": "session_364o8HjN0-gc6n_n4EBEPOXriJUJvCeVIdy9u8ihOhwvpNg9F1wMorWmkVxUR90kTe473bpbotNxyZ6Fze8M0w42_BpTxoEWsbBR21y7i0nh" // this is from the create order API response    }
+```
+
+#### Resposta
+
+```
+{  "action": "custom",  "cf_payment_id": 885899755, // is the transaction ID, is also present in UPI url  "channel": "link",  "data": {    "url": null,    "payload": {      "bhim": "https://payments-test.cashfree.com/pgbillpayuiapi/simulator/885899755?txnId=885899755&amount=200.50&pa=cashfree@testbank&pn=Cashfree&tr=885899755&am=200.50&cu=INR&mode=00&purpose=00&mc=5732&tn=Cashfree%20Simulator%20Payment",      "default": "https://payments-test.cashfree.com/pgbillpayuiapi/simulator/885899755?txnId=885899755&amount=200.50&pa=cashfree@testbank&pn=Cashfree&tr=885899755&am=200.50&cu=INR&mode=00&purpose=00&mc=5732&tn=Cashfree%20Simulator%20Payment",      "gpay": "https://payments-test.cashfree.com/pgbillpayuiapi/simulator/885899755?txnId=885899755&amount=200.50&pa=cashfree@testbank&pn=Cashfree&tr=885899755&am=200.50&cu=INR&mode=00&purpose=00&mc=5732&tn=Cashfree%20Simulator%20Payment",      "paytm": "https://payments-test.cashfree.com/pgbillpayuiapi/simulator/885899755?txnId=885899755&amount=200.50&pa=cashfree@testbank&pn=Cashfree&tr=885899755&am=200.50&cu=INR&mode=00&purpose=00&mc=5732&tn=Cashfree%20Simulator%20Payment",      "phonepe": "https://payments-test.cashfree.com/pgbillpayuiapi/simulator/885899755?txnId=885899755&amount=200.50&pa=cashfree@testbank&pn=Cashfree&tr=885899755&am=200.50&cu=INR&mode=00&purpose=00&mc=5732&tn=Cashfree%20Simulator%20Payment",      "web": "https://sandbox.cashfree.com/pg/view/upi/qcrgfb.session_364o8HjN0-gc6n_n4EBEPOXriJUJvCeVIdy9u8ihOhwvpNg9F1wMorWmkVxUR90kTe473bpbotNxyZ6Fze8M0w42_BpTxoEWsbBR21y7i0nh.c252cd27-c877-4a51-8352-837d04a2f4c2"    },    "content_type": null,    "method": null  },  "payment_amount": 200.5,  "payment_method": "upi"}
+```
+
+### Como analisar a resposta
+
+Armazene o cf\_payment\_id como um identificador único do pagamento na Cashfree. Como a Cashfree é compatível com vários pagamentos para determinado order\_id (ou cf\_order\_id), armazenar o cf\_payment\_id é importante para desduplicar vários/duplicar pagamentos (se ocorrerem devido a um bug ou outra razão).
+
+Extrair os pares de chave-valor em data.payload.default
+
+-   Verifique se "am" é igual ao valor que foi definido.-   Use o valor em "tr" como reference\_id ao configurar o [objeto Parameters](/docs/whatsapp/on-premises/payments-api/upi#paramobject) para enviar a mensagem de pagamento por meio da API do WhatsApp.-   O valor de "pa" é o VPA do comerciante que será usado para a transação. O nome da configuração de pagamento que corresponde ao vpa devolvido deve ser usado como payment\_configuration ao configurar o [objeto Parameters](/docs/whatsapp/on-premises/payments-api/upi#paramobject) para enviar a mensagem de pagamento usando a API do WhatsApp.-   Caso o VPA do comerciante obtido acima não corresponda a nenhum dos VPAs definidos na configuração de pagamento do WhatsApp, o pagamento deve ser descontinuado. Entre em contato com a Cashfree para confirmar o VPA atualizado e atualize a [configuração de pagamento do WhatsApp](/docs/whatsapp/on-premises/payments-api/upi#before-you-start) conforme apropriado.-   Verifique também se os valores "mode" e "purpose" são os mesmos que os definidos na configuração de pagamento. Em caso de erro de correspondência, registre isso para entrar em contato com a Cashfree e ter acesso aos valores corretos/atualizados. Não bloqueie o pagamento devido a esse erro de correspondência.
+
+```
+"default": "upi://pay?pa=cfsukoonaa@yesbank&pn=Sukoon&tr=877376394&am=10.00&cu=INR&mode=00&purpose=00&mc=5399&tn=877376394"
+```
+
+## Webhook
+
+Depois que o usuário concluir o pagamento no WhatsApp, a Cashfree enviará um webhook com informações sobre a conclusão. Observe que, embora o WhatsApp também compartilhe um sinal de conclusão de pagamento, use o sinal da Cashfree para o status de pagamento final a fim de evitar problemas de reconciliação.
+
+Com base no payment\_status do webhook, [atualize o status do pedido para o usuário usando a API do WhatsApp](/docs/whatsapp/on-premises/payments-api/upi#step-8--update-order-status).
+
+[Guia de referência](https://l.facebook.com/l.php?u=https%3A%2F%2Fdocs.cashfree.com%2Fdocs%2Fpayment-webhooks&h=AT01qL6yMJkDMu7tRseghgBE6BXYveTAAQzeZqcoFHvs5-kg6IDqCcvr6zGQUAGb3IBTdYwaEg_cAOfWb4HR_uLQGhhwhqYyoi1Omqa-tXKjC-eCk2_oDLUX45wbabZchBKrNveXqCu0NDTv0NL-ozckmjM)
+
+### Webhook de transação bem-sucedida
+
+```
+{  "data": {    "order": {      "order_id": "1633615918",      "order_amount": 1.00,      "order_currency": "INR",      "order_tags": null    },    "payment": {      "cf_payment_id": 1107253,      "payment_status": "SUCCESS",      "payment_amount": 1.00,      "payment_currency": "INR",      "payment_message": "Transaction pending",      "payment_time": "2021-10-07T19:42:40+05:30",      "bank_reference": "1903772466",      "auth_id": null,      "payment_method": {        "upi": {          "channel":null,          "upi_id":"miglaniyogesh7@okhdfcbank" }                },       "payment_group":"upi"    "customer_details": {      "customer_name": "Yogesh",      "customer_id": "12121212",      "customer_email": "yogesh.miglani@gmail.com",      "customer_phone": "9666699999"    }  },  "event_time": "2021-10-07T19:42:44+05:30",  "type": "PAYMENT_SUCCESS_WEBHOOK"}
+```
+
+### Webhook de falha na transação
+
+```
+{  "data": {    "order": {      "order_id": "order_01",      "order_amount": 2,      "order_currency": "INR",      "order_tags": null    },    "payment": {      "cf_payment_id": 975677709,      "payment_status": "FAILED",      "payment_amount": 2,      "payment_currency": "INR",      "payment_message": "ZA::U19::Transaction fail",      "payment_time": "2022-05-25T14:28:22+05:30",      "bank_reference": "214568722700",      "auth_id": null,      "payment_method": {        "upi": {          "channel": null,          "upi_id": "9611199227@paytm"        }      },      "payment_group": "upi"    },    "customer_details": {      "customer_name": null,      "customer_id": "7112AAA812234",      "customer_email": "miglaniyogesh7@gmail.com",      "customer_phone": "9611199227"    },    "error_details": {      "error_code": "TRANSACTION_DECLINED",      "error_description": "issuer bank or payment service provider declined the transaction",      "error_reason": "auth_declined",      "error_source": "customer"    }  },  "event_time": "2022-05-25T14:28:38+05:30",  "type": "PAYMENT_FAILED_WEBHOOK"}
+```
+
+## Verificação de status
+
+A API de status pode ser usada como alternativa caso o webhook não seja recebido em determinado intervalo de tempo. Com base no payment\_status da resposta, [atualize o status do pedido para o usuário usando a API do WhatsApp](/docs/whatsapp/on-premises/payments-api/upi#step-8--update-order-status).
+
+[Documento de referência](https://l.facebook.com/l.php?u=https%3A%2F%2Fdocs.cashfree.com%2Freference%2Fgetpaymentbyid&h=AT01qL6yMJkDMu7tRseghgBE6BXYveTAAQzeZqcoFHvs5-kg6IDqCcvr6zGQUAGb3IBTdYwaEg_cAOfWb4HR_uLQGhhwhqYyoi1Omqa-tXKjC-eCk2_oDLUX45wbabZchBKrNveXqCu0NDTv0NL-ozckmjM)
+
+#### Solicitação
+
+```
+curl --request GET \     --url https://sandbox.cashfree.com/pg/orders/order02/payments/885899755 \     --header 'accept: application/json' \     --header 'x-api-version: 2022-09-01' \     --header 'x-client-id: 26268833355ef02b8ff299390c886262' \     --header 'x-client-secret: 1708cc38a3c1c3c2512d79b3530dc5cc65ad2fde'
+```
+
+#### Resposta
+
+```
+{  "auth_id": null,  "authorization": null,  "bank_reference": null,  "cf_payment_id": 885704957,  "entity": "payment",  "error_details": null,  "is_captured": true,  "order_amount": 10.15,  "order_id": "12345",  "payment_amount": 10.15,  "payment_completion_time": "2022-10-27T08:43:05+05:30",  "payment_currency": "INR",  "payment_group": "upi",  "payment_message": "Transaction Successful",  "payment_method": {    "upi": {      "channel": "link"    }  },  "payment_status": "SUCCESS",  "payment_time": "2022-10-27T08:42:07+05:30"}OR{  "auth_id": null,  "authorization": null,  "bank_reference": null,  "cf_payment_id": 885899755,  "entity": "payment",  "error_details": null,  "is_captured": false,  "order_amount": 200.5,  "order_id": "order02",  "payment_amount": 200.5,  "payment_completion_time": "2022-12-26T14:24:56+05:30",  "payment_currency": "INR",  "payment_gateway_details": null,  "payment_group": "upi",  "payment_message": "User dropped and did not complete the two factor authentication",  "payment_method": {    "upi": {      "channel": "link",      "upi_id": "987836150"    }  },  "payment_status": "USER_DROPPED",  "payment_time": "2022-12-26T14:14:56+05:30"}
+```
+
+## Reembolso
+
+A API de Reembolso pode ser usada para acionar reembolsos para o usuário.
+
+[Documento de referência](https://l.facebook.com/l.php?u=https%3A%2F%2Fdocs.cashfree.com%2Freference%2Fcreaterefund&h=AT01qL6yMJkDMu7tRseghgBE6BXYveTAAQzeZqcoFHvs5-kg6IDqCcvr6zGQUAGb3IBTdYwaEg_cAOfWb4HR_uLQGhhwhqYyoi1Omqa-tXKjC-eCk2_oDLUX45wbabZchBKrNveXqCu0NDTv0NL-ozckmjM)
+
+#### Solicitação
+
+```
+curl --request POST \     --url https://sandbox.cashfree.com/pg/orders/12345/refunds \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --header 'x-api-version: 2022-01-01' \     --header 'x-client-id: xxxxxx' \     --header 'x-client-secret: xxxxxx' \     --data '    {     "refund_amount": 5,     "refund_id": "refund12345"    }
+```
+
+#### Resposta
+
+```
+{  "cf_payment_id": 885704957,  "cf_refund_id": "refund_49234",  "created_at": "2022-10-27T14:35:22+05:30",  "entity": "refund",  "metadata": null,  "order_id": "12345",  "processed_at": null,  "refund_amount": 5,  "refund_arn": null,  "refund_charge": 0,  "refund_currency": "INR",  "refund_id": "refund12345",  "refund_mode": "STANDARD",  "refund_note": null,  "refund_splits": [],  "refund_status": "PENDING",  "refund_type": "MERCHANT_INITIATED",  "status_description": "In Progress"}
+```
+
+## Como lidar com casos especiais
+
+### Expiração do pedido
+
+-   A Cashfree permite definir o tempo de validade de um pedido na API de Criação de Pedido. Use isso para definir o tempo de expiração preferido.-   Após a expiração do pedido, se nenhum webhook for recebido, faça uma verificação de status para confirmar que o pedido expirou e depois [cancele o pedido no WhatsApp para atualizar o usuário](/docs/whatsapp/on-premises/payments-api/upi#step-8--update-order-status).
+
+### Como lidar com falhas no pagamento
+
+-   A mensagem de pagamento enviada ao usuário via WhatsApp permite várias tentativas em caso de falha (ou seja, o botão Pagar fica disponível até que o pagamento seja bem-sucedido). No entanto, a Cashfree exige que a identificação de referência (campo "tr" no URL recebido na resposta de pagamento do pedido) seja único para cada pagamento.-   Então, quando uma resposta de falha de pagamento for recebida da Cashfree, [atualize o status do pedido no WhatsApp para cancelado](/docs/whatsapp/on-premises/payments-api/upi#step-8--update-order-status). Poste um aviso para informar que é possível enviar outra mensagem de pagamento para que o usuário tente fazer o pagamento novamente.-   Caso haja um atraso no cancelamento e o usuário consiga fazer o pagamento com sucesso, a Cashfree não enviará um webhook para o comerciante, mas fará um reembolso automático, sem nenhuma ação adicional necessária por parte do comerciante. Caso o cliente pergunte sobre esse tipo de situação (em que a transação foi bem-sucedida, mas o pagamento não foi registrado na Cashfree), informe que o reembolso será processado em alguns dias.
+
+### Como cancelar um pedido de transação bem-sucedida
+
+Pode surgir um cenário em que a Cashfree compartilhou um sinal de pagamento bem-sucedido, mas o pedido não pôde ser atendido pelo comerciante. Nesse caso, processe o reembolso do pagamento por meio de um dos seguintes mecanismos:
+
+-   Use a API de Reembolso.-   Use o painel da Cashfree para comerciantes.
+
+Você achou esta página útil?
+
+![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
+
+![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)

package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_ccavenue.md

@@ -0,0 +1,146 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent/pg-guide-ccavenue -->
+<!-- Scraped: 2025-12-20T17:45:16.191Z -->
+
+# Guia de integração do gateway de pagamento da CCAvenue
+
+Updated: 14 de nov de 2025
+
+Este documento apresenta a integração de pagamento com a CCAvenue, necessária para comerciantes ou provedores de soluções empresariais (BSP) que configuraram um chatbot usando as APIs do WhatsApp Business e precisam receber pagamentos de usuários do WhatsApp.
+
+Além disso, abrange as APIs que precisam ser integradas e como a integração funciona em conjunto com a integração da API do WhatsApp Business. Embora não seja um guia abrangente, ele serve como uma visão geral para auxiliar na compreensão do processo de integração do gateway de pagamento. Todos os detalhes específicos ou únicos relacionados ao gateway de pagamento devem ser determinados pelo comerciante (ou BSP).
+
+Em termos de integração com o produto WA P2M, este documento cobre as solicitações e respostas destacadas em vermelho no diagrama de fluxo.
+
+![](https://scontent-gru2-2.xx.fbcdn.net/v/t39.2365-6/582933363_2600727520301874_3735890498928031759_n.png?_nc_cat=105&ccb=1-7&_nc_sid=e280be&_nc_ohc=8RznaaSstK4Q7kNvwGjBzTy&_nc_oc=AdlbnGoE-96VfFWfCg9YPDPncSsZGM4GIowGALIVWeQ8To20uA1d3aPu8Rp_5q0akTE&_nc_zt=14&_nc_ht=scontent-gru2-2.xx&_nc_gid=gkRMCKLbJI3P3yaDEzohIQ&oh=00_AflSnFifEyee4-JUn96LJOmFN4nohOaoO2OpTa2QLvsnlA&oe=696106F5)
+
+## Integração da CCAvenue com os Pagamentos do WhatsApp
+
+### Configuração
+
+Para saber como fazer a autenticação com o servidor, consulte a documentação da CCAvenue.
+
+Para simplificar a explicação, os exemplos a seguir abordarão apenas o corpo da carga final que será incluído no objeto final necessário para uma autenticação bem-sucedida com a API. É importante consultar a documentação da CCAvenue para ver orientações sobre como esse objeto final deve ser estruturado.
+
+Para prosseguir, você precisa dos seguintes detalhes:
+
+-   Autenticação bem-sucedida-   Detalhes da configuração de pagamento que você já definiu na conta do WhatsApp Business.
+    -   Código de categoria do comerciante-   VPA do comerciante
+
+### API de Iniciação de Pagamento
+
+Exemplo de carga para `POST` a `https://secure.ccavenue.com/transaction.do`
+
+#### Solicitação
+
+```
+curl -X POST -d 'card_name=UPI&order_id=67314339998877&currency=INR&payment_option=OPTUPI&card_type=UPI&merchant_id=2&amount=100.00&re direct_url=https://merchantredirecturl.com'
+```
+
+Nome
+
+Descrição
+
+Tipo
+
+`merchant_id`
+
+A identificação do comerciante é um identificador único gerado pela CCAvenue para cada comerciante ativado.
+
+Numérico
+
+`order_id`
+
+Essa identificação é usada pelos comerciantes para identificar o pedido. Envie uma identificação única em cada solicitação.
+
+Caracteres alfanuméricos (30) permitidos: alfabeto (A – Z e a – z), números, - (hífen), / (barra), \_(sublinhado)
+
+`currency`
+
+A moeda que você quer usar para processar a transação. INR: rupia indiana
+
+“INR”
+
+`amount`
+
+Valor do pedido
+
+Numérico (12, 2)
+
+`redirect_url`
+
+A CCAvenue postará o status do pedido juntamente com os parâmetros nesse URL. Se o valor não for enviado, o status do pedido será enviado de volta para o URL configurado no módulo de notificações de eventos dinâmicos na sua conta MARS. Se não houver um URL configurado na conta MARS, o PG exibirá o status do pedido na página de confirmação da CCAvenue.
+
+Caracteres alfanuméricos (100) permitidos: alfabeto (A – Z e a – z), números, / (barra) e \_ (sublinhado).
+
+`card_type`
+
+O tipo de cartão usado pelo cliente.
+
+UPI
+
+"UPI"
+
+`card_name`
+
+Nome do cartão usado pelo cliente. Essa lista será fornecida pela CCAvenue.
+
+UPI
+
+"UPI"
+
+#### Exemplo de resposta da CCAvenue
+
+```
+{
+     "status":"0",
+     "enc_response":"68b4c0ff090e439119f91d0ace1930973e5a2fc244b122e255170de2b412d486269678930fc2c175a64357a882854f62e5adb6d4476f629df3bb532cc5c82828258ed40b09181949c48e6b9365eabf9dc9e1acb5308f5d6776e2400e0c4ac4282afd81e3a66519b3734192062a49b51d956f93d9cebf4d49b9480ed6cbcdb5f87e50c7a3bd052dca39718738a49a5e22408a8656052fa506458ca1f904970fdf"
+}
+```
+
+#### Exemplo de resposta descriptografada
+
+```
+{
+     "errorCode":"",
+     "errorMessage":"",
+     "intentUrl":"upi://pay?pa=vpa@samplebank&pn=Infibeam Avenues Limited&tr=123123123123&am=100.0&cu=INR&mc=8299"
+ }
+```
+
+#### Analisar a resposta
+
+-   Use o valor de `tr` no valor de resposta marcado pela chave `intentUrl` e passe-o como o `reference_id` ao configurar o objeto `parameters` para enviar na mensagem de detalhes do pedido usando a API do WhatsApp.-   Verifique se os valores na chave `intentUrl` recebida na resposta correspondem à configuração de pagamento criada no Gerenciador do WhatsApp:
+    -   O valor de `pa` é o VPA do comerciante. Esse valor deve corresponder à identificação da UPI no `payment_configuration` enviado no objeto "parâmetros".-   O valor de `mc` deve corresponder ao código MCC inserido na configuração de pagamento.
+
+### Webhook de status
+
+Quando um evento ocorre, como o processamento bem-sucedido de um pagamento na sua conta da CCAvenue, a CCAvenue gera um objeto de evento. Esse objeto contém detalhes essenciais, incluindo o tipo de evento e os dados associados. A CCAvenue envia esse objeto de evento para um URL designado nas configurações de webhook da sua conta por meio de uma solicitação HTTP POST.
+
+### Status do pagamento
+
+Use a notificação de webhook acima para encontrar o status do pagamento com a **API de Status do Pagamento**.
+
+#### Solicitação
+
+Exemplo de carga para `POST` a `https://api.ccavenue.com/apis/servlet/DoWebTrans`
+
+```
+{
+  "orderNo": "11111111",
+  "referenceNo": "111111111111"
+}
+```
+
+#### Analisar a resposta
+
+Use o `order_status` recuperado da resposta acima e transmita a [mensagem de status](/docs/whatsapp/cloud-api/payments-api/upi#step-7--update-order-status) correspondente via API do WhatsApp.
+
+## Processo de integração do WhatsApp com a Billdesk
+
+-   Quando o parceiro inicia uma solicitação para a Billdesk, um formulário de solicitação é enviado para coletar valores como: IPs de parceiros para a lista de permissão, URLs de retorno de ligação de parceiros e conta do comerciante para acionar a configuração de um ambiente UAT.-   Depois que o formulário de solicitação for compartilhado, a Billdesk compartilhará as credenciais de UAT e os documentos da API para que os parceiros possam criar a solução no UAT. Esse processo leva de quatro a cinco dias.-   Os parceiros podem testar as integrações usando uma [ferramenta da web](https://l.facebook.com/l.php?u=https%3A%2F%2Fpguatweb.billdesk.io%2Fpgtxnsimulator%2Fbanksimulator%2Fupi%2F[tr-value%3E]&h=AT3cGl1PlGOqj5UfcGG0DMfKid64KR2Xg7ujscxtbR0vAinIX0kZaMZAzEWGqMOYe4m3fBOHgXyN5-LvWqad4hVedq7K5JNMrjr9d7sGJxXsiLDT-6x5sJkPpgJ6NBPh-Dd1psCjaNehO3lqwE1HCdFgJ9E). Para isso, substitua `[tr-value]` no URL pelo valor `tr` da resposta "createTransactions", e você poderá simular uma resposta bem-sucedida.-   Os parceiros devem solicitar um post de aprovação de UAT, o que normalmente demora de um a dois dias, durante o qual a Billdesk E2E testa a solução ou solicita capturas de tela se o teste E2E não for possível. Para o WhatsApp, a Billdesk verifica se a bandeja de apps abre e redireciona para os apps corretos.-   Após o recebimento da aprovação, um ambiente de produção é criado em cerca de uma semana. Em seguida, as credenciais para produção são compartilhadas.
+
+Você achou esta página útil?
+
+![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
+
+![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)