After the payment
Use this section to understand how to use Skipify's additional endpoints to look up orders, as well as process captures, refunds and voids
Introduction
When Skipify submits a payment, we are doing so using your credentials with your current payment gateway.
This is set up in the Merchant Portal.
In order to ensure you can process and manage orders that have been submitted, Skipify shares with you the gateway's response. You can use this response to interact with the gateway directly as you do today, or you can also use our APIs.
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 (optionally) when your payment request has expired.
Expedited Guest Checkout & The Skipify Button
The response is provided to you via a callback within the SDK.
Please review the following endpoints:
Use the Get Order API to find a previously created Order within Skipify with updated status. This call cannot update the order. To do that, you can call the Capture, Void, or Refund APIs.
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, rather it requires the Order ID in the URI. The manner in which you obtain the OrderID varies by use case.
Use this endpoint to tell us that you are ready to capture funds for an order. It is also possible for you to utilize the gateway response (shared as a webhook) to directly capture funds with your gateway instead of using this API.
Use this endpoint to tell us that you wish to void an order. It is also possible for you to utilize the gateway response (shared as a webhook) to directly void orders with your gateway instead of using this API.
It is possible to specify partial voids.
Use this endpoint to tell us that wish to issue a refund for an order. It is also possible for you to utilize the gateway response (shared as a webhook) to directly issue refunds with your gateway instead of using this API.
It is possible to specify partial refunds.
Limits on PayLink
PayLink is different than Expedited Guest 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 capture, void or refunds via the Skipify API. However, payment gateway responses are shared with you after order completion so that you can contact the gateway directly for any void, capture or refund. The payment gateway response is provided through Skipify's webhooks. The ORDER_PAYMENT_SUCCEEDED webhook includes a
gatewayTransactionId
that you can reference to communicate with your payment processor. Alternatively, the ORDER_PAYMENT_SUCCEEDED and ORDER_PAYMENT_FAILED webhooks will include anorderId
that can be used to retrieve the order details, which includes lists of gateway transactions processed for that order through Skipify.Currently, Skipify guest payments processed via Express can be captured or voided using Skipify's API. Express refunds & RAFT captures, voids, and refunds 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.
Updated 5 months ago