In Store APIs v2

Overview

In the related articles below, study up on how to optimize the in store checkout experience for your customers with our instore APIs.

Instore (SMS plus Email to customer)

SMS plus Email to Customer API is used to send a SMS and a Email to customer with a link to start a PayBright application. This API will be used by your POS to allow your instore customers to get approved by PayBright.

Instore (Order Status using PayBrightReference)

Order Status API is used In Store to get status of Customer Application by your store representatives using a PayBright Reference returned as a response to SMS plus Email to Customer API. If you get a status of "1" as a response to the API, it means that the customer was approved by PayBright

Instore (Capture using Gateway Reference)

Instore (Capture using PayBrightReference) is used In Store to capture an authorized In Store transaction. PayBright will return a Successfull or Failed status as a response to the Capture API call. Capture API call is to be made during the shipment of product.

🚧

Auth then Capture

Instore (Capture using Gateway Reference) API is only needed if you are doing a delayed Capture InStore. If the transaction is authorized and captured at the same time, we do not need to call the Capture API. Please discuss your preference with our Implementation team

Instore (Refund using Gateway Reference)

Instore (Refund using PayBrightReference) is used InStore to refund a captured In Store transaction. Note: Capture may be done through the above method, or may be done automatically once transaction is complete. PayBright will return a Successfull or Failed status as a response to the Refund API call. Refund API can include the full amount of the order or a partial refund if required.