Introduction

When Skipify submits a payment, we use the credentials provided in the Merchant Portal for your current payment gateway.

To ensure you can process and manage orders that have been submitted, Skipify shares the gateway's response with you. This response may be used to interact with the gateway directly as you do today, or you can opt to use our APIs instead.

The response is provided to you in different ways depending on which product you've decided to integrate.

PayLink

This response is provided to you via a Webhook that you can subscribe to in the merchant portal.

🚧

Webhooks Recommended

Skipify highly recommends implementing Webhooks so that you can instantly receive automated updates when customers successfully pay for the order, run into a problem with payment, or when your payment request has expired.

❗️

Limits on Payment Links

PayLink is different than Connected Checkout or The Skipify Button in that it accepts payments from both registered Skipify users as well as guests. For guest payments, Skipify does not store customer data, so it is not always possible for Skipify to process order captures, voids, or refunds for those orders via the Skipify API.

However, the payment gateway responses are shared with you after order completion so that you can contact the gateway directly to process your any voids, captures, or refunds. The payment processor gateway response is provided through Skipify's webhooks. Simply subscribe to the ORDER_PAYMENT_SUCCEEDED or the ORDER_PAYMENT_FAILED webhooks. Data received via these webhooks include a gatewayTransactionId that you can reference to communicate with your payment processor.

Alternatively, you can retrieve order details using the Skipify orderId (using the GET endpoint), available in the request bodies from the ORDER_PAYMENT_SUCCEEDED and the ORDER_PAYMENT_FAILED webhooks.

Note that Order details only include lists of gateway transactions processed for the order through Skipify. Currently, Skipify guest payments processed via Express can be captured or voided using Skipify's API, but Express refunds & RAFT captures, voids, and refunds for unrecognized users cannot currently be processed using Skipify's API.

Because of these limitations on guest/unregistered customers, we recommend that you do not use Skipify's endpoints for capture, refund and void for your PayLink integration, and instead utilize the webhook structure described above.

Connected Checkout & The Skipify Button

The response is provided to you via a callback within the SDK.

Please review the following endpoints:

GET Order

Use the Get Order API to find a previously created Order with an updated status.

You can query this API either by the Skipify API ID which is returned to you when an Order is created, or by the Order ID which you specify (merchant_order_id field in Skipify).

This request has no body, and instead requires the Order ID in the URI. The manner in which you obtain the OrderID may vary by use case.

Capture Order

Use this endpoint to tell us that you are ready to capture funds for an order. It's also possible for you to utilize the gateway response to directly capture funds directly with your gateway instead of using this API.

Void Order

Use this endpoint to tell us that you want to fully or partially void an order. It's also possible for you to utilize the gateway response to directly void orders directly with your gateway instead of using this API.

Refund Order

Use this endpoint to tell us that want to issue a full or partial refund for an order. It's also possible for you to utilize the gateway response to directly issue refunds with your gateway instead of using this API.