Oracle Commerce Cloud

The goal of this document is to describe the step-by-step process for using PicPay as a payment acquirer within your e-commerce site on Oracle Commerce Cloud.

Step-by-Step:

1. Obtaining Your Integration Keys

Before starting your integration, you must have valid credentials. Your integration keys will be available in the Business Panel, under the integrations menu. These keys must be copied and entered into your Oracle configuration panel.

2. Enabling PicPay Gateway as a Payment Method

Before starting your integration, you must have valid credentials. Your integration keys will be available in the Business Panel, under the integrations menu. These keys must be copied and entered into your Oracle configuration panel.

1. The client should access the Oracle platform panel

2. In the left side menu, click "Settings"

3. Then click "Extensions"

4. Under "Developer" click "Generate ID", add the name "PaymentGatewayPicPay", then click save and copy the ID

5. Extract the "PicPayPaymentGateway" file if received in .zip format, access the "ext.json" file and paste the ID generated in the previous step

6. Recreate the zip file with the "gateway" folder and the "ext.json" file named "PicPayPaymentGateway"

7. In Extensions, select the "Installed" tab, click "Upload extension" and select the zip file

8. Check the list

9. Click "Payment Processing", then "Payment Gateways", and find the "PicPay Payment Gateway" option in the drop-down

10. Enable the gateway by checking the "Payment Gateway Enabled" checkbox, the options "Pay by Card" for credit card and "Wallet" for cash. Fill in the "Client id" and "Client Secret" fields with the integration keys obtained from the PicPay panel and finally click "Save" at the bottom right

3. Configuring Webhook OCC

1. Access the Oracle panel, in the upper left corner click "Settings", "Web APIs" and then click "Webhook"

2. Locate the following webhooks and fill in with the user and password generated by you:
   • Credit Card Payment (Production and View)
     
     
   • Generic Payment (Production and View)
     
     
   • Click "Save" in the bottom right corner to confirm the changes

4. Installing Payment Plugin – SSE

1. Extract the picpay.sse.payments file if received in .zip format
2. Configure the variables with your environment data in the path picpay.sse.payments\src\config

Fields:

• OCC_ADMIN_URL: URL of your Oracle Commerce Cloud environment

• OCC_API_KEY: Oracle generated Application Key in settings/webAPI, click "Register application", it will be generated in the format

xxJ0xxAxOxJX0QxLCJxbXxxOxJxUxI0NxJ0.xxJxdxWxOxI0YxNxOx-0xNx-L0xMx-0XxXx0X0X0Z0XxXxxUx0.xxJpx0xxOxJxxHxxWNxxVxxOnxxFxxGxx0xx.xx.x0VA/xxLS+xx+N0GLT/xxF0 0YxQQUBL0xxM+xxSFxU=

• BASIC_AUTH_USER and BASIC_AUTH_PASS: User and password generated by you, will be used between the webhook and the plugin.

• URL_PICPAY: PicPay order submission URL, default environments dev and tst for sandbox and prd for production.

• KEY_WEBHOOK: API KEY in the format x00x0000-xxx0-0xxx-xx00-00000000xxxx, to obtain this information just access the PicPay business panel, "Settings" and "My checkout".

3. Verify that the DOCUMENT_FIELD_NAME field responsible for sending the buyer's CPF is correctly configured. Access src\app\constants\index.js and find the DOCUMENT_FIELD_NAME constant

4. Plugin Upload: Deploy the SSE using an API platform such as Postman, Insomnia, or Forest.

     Link to Oracle's official documentation: https://docs.oracle.com/en/cloud/saas/cxcommerce/21b/ccdev/develop-server-side-extensions.html

5. Optional: To verify that the deployment was successful, observe the request return as HTTP 200 and the success field. It can be validated by your Oracle URL + /ccstorex/custom/v1/verify or by the list of SSEs.

After validating the upload, just finalize the orders in Oracle Cloud Commerce.

5. Obtaining Plugin Logs

1. Make an HTTP GET request

    Supporting Material: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/opccadminx-custom-v1-logs-get.htm