# Zip Documentation

> Zip’s payment platform gives shoppers the choice to pay for their purchases via 4 simple, interest-free installments. Zip is a platform built for shoppers, that empowers you to buy now, pay over-time and avoid interest repayments.

## Guides
- [Introduction](https://docs.us.zip.co/docs/introduction.md): Get started with Zip's easy integrations designed for growth.
- [Virtual Card Checkout](https://docs.us.zip.co/docs/virtual-checkout.md)
- [Implementing Virtual Card Checkout](https://docs.us.zip.co/docs/implementing-virtual-card-checkout.md)
- [Express Checkout for Virtual Card](https://docs.us.zip.co/docs/express-virtual-checkout.md)
- [Tokenization](https://docs.us.zip.co/docs/tokenization.md)
- [API Integration](https://docs.us.zip.co/docs/api-integration.md)
- [API Implementation](https://docs.us.zip.co/docs/api-implementation.md)
- [API Javascript SDK Implementation](https://docs.us.zip.co/docs/api-javascript-sdk.md): The JavaScript SDK is a client-side initiated version of our [Gateway API](https://docs.us.zip.co/docs/custom-integration-guide#gateway-api) integration. It removes the need for a full-page redirect by managing the in-context rendering of the Zip checkout flow in a modal, the same way our Virtual Checkout solution does currently.  Zip takes care of the initial authorization API call through the openCheckout method, which is used with a custom DOM element, and will launch checkout in a popup window (or iframe depending on provided parameters). Read more below.  Zip communicates the results via a Webhook to a predefined endpoint on the merchant side, additionally to return the result on the client-side.  Each consecutive operation, such as void, capture, refund, or other, must be completed on the server side. Please refer to [our API documentation](https://docs.us.zip.co/docs/custom-integration-guide).
- [Express Checkout for API](https://docs.us.zip.co/docs/express-checkout.md)
- [Postman Guide](https://docs.us.zip.co/docs/postman-guide.md): Use Postman to explore the Zip US APIs without writing any code. You can test endpoints right away by importing Zip’s Postman collection and plugging in your credentials.
- [Mobile SDKs](https://docs.us.zip.co/docs/mobile-sdks.md): Integrate your native mobile app with Zip to create a seamless Zip checkout experience for your customer! Available on iOS, Android, and React Native.
- [iOS](https://docs.us.zip.co/docs/ios-sdk.md)
- [Android](https://docs.us.zip.co/docs/android-sdk.md)
- [React Native](https://docs.us.zip.co/docs/react-native-sdk.md)
- [Ecommerce Platforms](https://docs.us.zip.co/docs/ecommerce-platforms.md): Zip provides easy integrations with a variety of ecommerce platforms
- [BigCommerce](https://docs.us.zip.co/docs/bigcommerce.md): Configure the Zip payment option in your BigCommerce store.
- [Enable Zip as a payment method](https://docs.us.zip.co/docs/bigcommerce-add-payment-option.md)
- [Activate Zip on-site messaging](https://docs.us.zip.co/docs/bigcommerce-enable-the-zip-on-site-messaging.md)
- [Magento 2](https://docs.us.zip.co/docs/magento-2.md)
- [Salesforce Commerce Cloud](https://docs.us.zip.co/docs/salesforce.md)
- [Shopify](https://docs.us.zip.co/docs/shopify.md)
- [Installing the Zip on-site messaging app](https://docs.us.zip.co/docs/installing-the-zip-on-site-messaging-app.md)
- [Adding the Zip payment gateway for Shopify](https://docs.us.zip.co/docs/adding-the-zip-payment-gateway-for-shopify.md)
- [Zip Widget for Shopify](https://docs.us.zip.co/docs/integrate-the-classic-widget-new.md)
- [WooCommerce](https://docs.us.zip.co/docs/woocommerce.md)
- [Testing & QA](https://docs.us.zip.co/docs/testing.md)
- [Bypassing OTP Code in Sandbox](https://docs.us.zip.co/docs/bypassing-otp-code-in-sandbox.md)
- [Pre-Qualification](https://docs.us.zip.co/docs/pre-qualification.md)
- [Payment Platforms](https://docs.us.zip.co/docs/payment-platforms.md)
- [Disputes API](https://docs.us.zip.co/docs/disputes.md)
- [Sandbox Testing](https://docs.us.zip.co/docs/sandbox-testing.md)
- [Style Guide & Assets](https://docs.us.zip.co/docs/style-guide-assets.md)
- [Messaging & Widgets Overview](https://docs.us.zip.co/docs/widget-integration-v3.md): Improve conversion and average order value with easy-to-install widgets
- [Zip Widget](https://docs.us.zip.co/docs/zip-widget.md)
- [Payment Widget](https://docs.us.zip.co/docs/payment-widget.md)
- [Second Chance Widget](https://docs.us.zip.co/docs/second-chance-widget.md)
- [Lightweight JavaScript Widgets](https://docs.us.zip.co/docs/lightweight-javascript-widgets.md): Zip Messaging component. Simplified.
- [Lightweight PDP/Cart Widget](https://docs.us.zip.co/docs/lightweight-pdp-cart-widget.md)
- [Lightweight Second Chance Widget](https://docs.us.zip.co/docs/lightweight-javascript-widget-second-chance.md)
- [Merchant Portal](https://docs.us.zip.co/docs/merchant-portal.md): Use the Zip Merchant Portal to manage your orders, download reports, uncover insights, and more.
- [Customer Support FAQ](https://docs.us.zip.co/docs/faq.md)

## API Reference
- [Orders](https://docs.us.zip.co/reference/orders.md)
- [/orders/{orderId}/status](https://docs.us.zip.co/reference/ordersorderidstatus.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/status  Returns an orderStatus field that can be used to confirm payment via Zip.
- [/orders/authorize](https://docs.us.zip.co/reference/ordersauthorize.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/authorize  Creates a new checkout context and redirects to the checkout website using details from the request body.  Sent from the user's browser via a form POST, will start a checkout session within Zip. It will automatically redirect the user to our Zip checkout. You need to ensure you provide your merchant ID, merchant reference (the unique ID you use for the order in your system), confirm/cancel URLs, and the order amount. The order amount should include all shipping, tax, and discount charges. You do not need to provide the order ID as that will be generated for you. Passing as much customer information as possible will improve the user experience by pre-filling data fields and improving conversion.
- [/orders/authorize (for Advanced Approvals merchants)](https://docs.us.zip.co/reference/orders-authorize-advanced-approvals.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/authorize  Creates a new checkout context and redirects to the checkout website using details from the request body. Sent from the user's browser via a form POST, will start a checkout session within Zip. It will automatically redirect the user to our Zip checkout.  This endpoint contains the additionalData object which is used by Zip-approved merchants that are implementing our Advanced Approvals feature.
- [/orders/{orderId}/capture](https://docs.us.zip.co/reference/ordersorderidcapture.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/capture  Captures funds for the specified order. Only applicable to pay-on-ship/deferred fund capture merchants. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL. Default sync value is false for asynchronous behavior.
- [/orders/{orderId}/refund](https://docs.us.zip.co/reference/ordersorderidrefund.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/refund  Refunds funds for the specified order and allocates them to the payment plan to apply it to the customer. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL.  Default sync value is false for asynchronous behavior.  If you are a pay-on-ship/DFC merchant, you can only apply up to your captured amount.
- [/orders/{orderId}/void](https://docs.us.zip.co/reference/ordersorderidvoid.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/void  Voids uncaptured funds for the specified order and allocates them to the payment plan to apply it to the customer. Only applicable to pay-on-ship/deferred fund capture merchants. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL. Default sync value is false for asynchronous behavior.
- [/orders/{orderId}/confirm](https://docs.us.zip.co/reference/ordersorderidconfirm.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/confirm  Confirms the supplied authorized order and initiates the payment plan for the customer. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL. Default sync value is false for asynchronous behavior.  Merchants using the Standard Checkout with the mobile SDK will allow customers to use the Zip checkout without starting an order until this API call is made by the merchant. This same feature can be leveraged for standard online checkouts as well. The payment plan for the customer will not begin until a successful callback is received by the merchant for this operation. This operation does allow merchants to add shipping/taxes after the Zip checkout for the order. This will be processed with the currency of the original order. This functionality is enabled upon request. Please work with the integration team during onboarding if this is needed in your implementation.
- [/orders/associate](https://docs.us.zip.co/reference/ordersassociate.md): Sandbox (Testing): https://gateway.sand.us.zip.co/orders/associate  Associates a merchant's unique order ID with an order after creation.  This endpoint can be used to tie the Merchant Reference that is passed into Zip when checkout is initiated with a differently formatted ID on the merchant side, once the order is created.
- [Configuration](https://docs.us.zip.co/reference/configuration-1.md)
- [/configuration/{merchantId}](https://docs.us.zip.co/reference/configurationmerchantid.md): Sandbox (Testing): https://gateway.sand.us.zip.co/configuration/{merchantId}  Allows a merchant to see their checkout configuration
- [Merchant Disputes](https://docs.us.zip.co/reference/merchant-disputes.md)
- [/merchant-disputes/search](https://docs.us.zip.co/reference/merchant-disputessearch.md): Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/search<br><br>Search merchant disputes.
- [/merchant-disputes](https://docs.us.zip.co/reference/merchant-disputes-1.md): Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes<br><br>Get Merchant dispute by ID.
- [/merchant-disputes/file](https://docs.us.zip.co/reference/merchant-disputesfile-2.md): Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/file <br><br>  Download dispute evidence file by category or file id.
- [/merchant-disputes/close](https://docs.us.zip.co/reference/merchant-resources.md): Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/close<br><br>Accept losing the dispute and close the dispute.
- [/merchant-disputes/submit-evidence](https://docs.us.zip.co/reference/merchant-disputessubmit-evidence.md): Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/submit-evidence  <br><br>  Merchant submit all evidence for the dispute. Not all parameters need to be submitted — just evidence relevant to the dispute. Submissions are final.
- [/merchant-disputes/file](https://docs.us.zip.co/reference/merchant-disputesfile.md): Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/file<br><br> Upload an evidence file using a blob. Note all blobs provided must not assume containers or implicit security. (e.g. for Azure blobs, these have SAS tokens if required).
- [/merchant-disputes/file](https://docs.us.zip.co/reference/merchant-disputesfile-1.md): Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/file <br><br>  Delete dispute evidence file.
- [Reporting](https://docs.us.zip.co/reference/merchant-reporting.md)
- [/transactions/{merchantId}/v3](https://docs.us.zip.co/reference/transactionsmerchantidv3.md): Sandbox (Testing): https://gateway.sand.us.zip.co/transactions/{merchantId}/v3  An abbreviated list of payments in JSON format.
- [/transactions/{merchantId}/v3/csv](https://docs.us.zip.co/reference/transactionsmerchantidv3csv.md): Sandbox (Testing): https://gateway.sand.us.zip.co/transactions/{merchantId}/v3/csv  An abbreviated list of payments in CSV format.
- [/payments/{merchantId}/json](https://docs.us.zip.co/reference/merchantidjson.md): Sandbox (Testing): https://gateway.sand.us.zip.co/payments/{merchantId}/json  An abbreviated list of payments in JSON format.
- [/payments/{merchantId}/csv](https://docs.us.zip.co/reference/merchantidcsv.md): Sandbox (Testing): https://gateway.sand.us.zip.co/payments/{merchantId}/csv  An abbreviated list of payments in a CSV.
- [Overview](https://docs.us.zip.co/reference/overview.md): The Single Merchant Interface (SMI) is used for merchants that are integrating Zip in multiple regions where different currencies are used.
- [Create a checkout](https://docs.us.zip.co/reference/checkouts.md): The first API call you will make in processing a Zip payment is a call to our /checkouts endpoint. This request is made once a customer chooses to use Zip as their payment method at checkout and will contain all order and customer information. The Zip API will then provide a response that includes a redirect url, allowing you to point the customer to the Zip checkout flow where they will complete their application or log in to their Zip account to confirm the payment.
- [Create a charge](https://docs.us.zip.co/reference/charges.md): Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/charges  Once the Zip checkout flow has redirected the customer to your previously defined "redirect_uri," that page should consume the the state of the checkout to determine if it has been approved or declined. If the checkout has been approved, this page should then proceed to charge the customer.
- [Capture a charge](https://docs.us.zip.co/reference/chargeschargeidcapture.md): Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/charges/{chargeId}/capture  Once a Charge has been Authorized it must then be Captured for disbursement to the merchant. This is done by simply referring to the Authorized "charge_id" in the endpoint url and passing the amount to be captured.
- [Refund](https://docs.us.zip.co/reference/refunds.md): Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/refunds  Once a charge has been captured, if a customer wishes to return an item you will need to create a refund.
- [Void](https://docs.us.zip.co/reference/chargeschargeidcancel.md): Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/charges/{chargeId}/cancel  Once the Charge has been Authorized, if for some reason the goods cannot be provided to the customer, the charge will need to be voided.
- [Retrieve a checkout](https://docs.us.zip.co/reference/checkoutsid.md): Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/checkouts/{Id}  Retrieves the details of a checkout that has previously been created. Supply the unique checkout ID that was returned from your previous request, and Zip will return the corresponding checkout information.
- [Retrieve a charge](https://docs.us.zip.co/reference/chargeschargeid.md): Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/charges/{chargeId}  Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Zip will return the corresponding charge information.
- [Getting Started With Your API](https://docs.us.zip.co/reference/getting-started-with-your-api-1.md): This page will help you get started with Master Gateway.