Implementation

Step 1: Generate online integration credentials

a. Sign in to your ShopBack for Business - Merchant Portal.

• If you have not created an account, refer to our guide here.
• Skip this step if you have already generated the integration credentials.

Go to User Menu -> Settings, and click 'Generate Credential'

b. Once your credentials generated successfully, you may download the credentials for safe keeping. Please note, the Merchant Secret credentials can only be viewed once.

Username = {Merchant ID}

Live Password ={Production Merchant Secret}

Sandbox Password = {Sandbox Merchant Secret}

Step 2: Add ShopBack Pay as a payment option on your checkout

The following screenshot provides a best-practice example how the ShopBack Pay checkout could be designed. We suggest highlighting to customers that ShopBack Pay can be used with any debit / credit card.

Main payment title: ShopBack: Get Cashback with every payment

Secondary payment title: Scratch and win Cashback when you pay with ShopBack

Payment description:

Step 3: Add ShopBack Pay to your payment process

1. Create an auth token using the /auth/login API endpoint

2. Initiate an order an order using our sample payload to /order/initiate API endpoint

3. Implement the consumer redirect to the ShopBack Pay checkout flow (to complete the payment)

4. Implement the Server to server payment notification (payment notification webhook) to receive notification regarding the status of a payment

5. Check the payment status using /order/{orderUuid} API endpoint when we redirect the consumer back to your landing page after 30 seconds

6. Display the outcome based on the payment status

7. Payment completed: Display your order confirmation

8. Payment not completed: Display a payment failure error message and present your cart / checkout

🚧

Important note

Do not – under any circumstances – integrate API calls directly from your frontend (e.g. via AJAX calls). This will create a serious vulnerability on your website.

Step 4: Implement API resources for day-to-day operations, e.g. refunds

Once the order process works end-to-end, it is a good time to connect to additional API resources that will be needed in day-to-day operations:

• Required: Initiate partial order refund
• Optional: Update your order ID