Bypassing Payments through Violet

With Payment Bypassing, you are able to leverage Violet’s Checkout capabilities while bypassing all order payment requirements. The channel assumes all responsibility for facilitating payments between the shopper and the merchant, and Violet only handles order placement and management.

1. Sharing your payment flow with Violet beforehand. We will need to review your existing relationship with Merchants and current payment mechanisms and then enable your application for payment bypassing on our end. You can reach out to us on support@violet.io to start this process.
2. Subscribe to the ORDER_CANCELED, ORDER_REFUNDED, and ORDER_RETURNED webhooks, or the catchall ORDER_UPDATED webhook. This is to ensure that channels can facilitate a refund back to the shopper when necessary, as Violet will send a webhook when a merchant triggers a refund.

​

Changes to Checkout

When bypassing payments, the two major changes to Checkout are the following:

1. You do not need a payment intent created by Violet, so you can leave out the wallet_based_checkout flag from the Create Cart API or mark it as false.

   //Create cart using Violet Payments
   
   {
     "base_currency": "USD",
     "wallet_based_checkout": true,
     "skus": [
         {
         "sku_id": {{default_sku_id}},
         "quantity": 5
       }
     ]
   }
   
   //Create cart while bypassing payments
   
   {
     "base_currency": "USD",
     "skus": [
         {
         "sku_id": {{default_sku_id}},
         "quantity": 5
       }
     ]
   }
   

2. If you currently apply a payment method manually to the cart during Checkout, you can skip this call. This is the /checkout/cart/:cart_id/payment API.

The remainder of the calls made to Violet during the checkout flow all remain the same.

​

Merchant Level Payment Bypassing

If you are looking to migrate from using the Violet payments stack to your own, you may want to bypass payments on a per merchant basis. You can do this through the following:

PUT apps/{app_id}/configuration/payments-bypass/{merchant_id}

<No response body>

Status code: 200 (Success)
Status code: non-200 (Failure)

Exceptions in the following scenarios: 
- App does not exist
- Merchant does not exist
- App does not have permissions for this Merchant or App
- The Merchant has already been added to the list

GET apps/{app_id}/configuration/payments-bypass

[
    {
        private Long id;
        private Integer merchantId;
        private Integer appId;
        private Date dateCreated;
        private Date dateLastModified;
    }
]

To delete a merchant from the payment bypass list, you can call DELETE apps/{app_id}/configuration/payments-bypass/{merchant_id} or simply include payment methods to the order during checkout. If a payment method is included, Violet will honor that payment method.

DELETE apps/{app_id}/configuration/payments-bypass/{merchant_id}

This API will remove the given merchant_id from the payments bypass list for this app_id. If the merchant doesn’t exist or isn’t present in this list, an exception will be thrown.

DELETE apps/{app_id}/configuration/payments-bypass/{merchant_id}

<No response body>

Status code: 200 (Success)
Status code: non-200 (Failure)

Exceptions in the following scenarios: 
- App does not exist
- Merchant does not exist
- Merchant bypass record does not exist
- App does not have permissions for this Merchant

When Violet receives a Refund for an Order that bypassed our payments flow, we emit a notification and expect the Shopper and Merchant to be refunded by you. In order to receive notifications, please subscribe to the ORDER_REFUNDED webhook. You are able to view refunds that come for Orders, even if the payment was handled externally, through GET orders/{order_id}/refunds. A sample response for an external refund is as follows:

[
    {
        "id": 119,
        "order_id": 142,
        "bag_id": 145,
        "merchant_id": 6,
        "app_id": 10000,
        "transaction_id": 87,
        "amount": 385900,
        "reason": "",
        "refund_currency": "JPY",
        "status": "EXTERNAL",
        "skus": [
            {
                "id": 126,
                "refund_id": 119,
                "bag_id": 145,
                "quantity_refunded": 1,
                "external_id": "43598413463851",
                "order_sku_id": 133
            }
        ],
        "date_created": "2023-01-26T15:44:08+0000",
        "date_last_modified": "2023-01-26T15:44:09+0000",
        "external_id": "942270382379",
        "errors": []
    }
]