Checkout Flow
The Credit Key Checkout Flow allows approved business customers to select their terms and securely complete their purchase through a seamless, fully-hosted financing experience.
Once a customer has been approved for Credit Key, they can complete their purchase using our Hosted Checkout experience. The checkout flow provides a streamlined, secure, and fully-hosted interface where customers choose their financing terms, confirm their order, and authorize payment. Merchants can integrate the checkout using our Hosted Checkout API, JavaScript SDK, or platform-specific apps.
Credit Key handles all underwriting, term selection, payment authorization, and compliance requirements—keeping the merchant's implementation lightweight and reducing PCI and KYC exposure.
How the Credit Key Checkout Works
1. Begin Hosted Checkout
Your server initiates the checkout by calling:
POST /v2/hosted/checkoutThis request includes details such as: Cart items, Billing and shipping addresses, Order total and charges, Merchant order reference, Callback URLs (return, cancel, order complete), Optional metadata to support ERP or invoicing workflows
The API returns a checkout_url, which directs the customer into the hosted Credit Key experience.
You can send customers into hosted checkout using:
- Modal via JavaScript SDK (
ck.checkout(checkout_url, 'modal')) - Full redirect in a new tab
2. Customer Selects Financing Terms
Inside the hosted checkout, Credit Key displays the financing options available to the customer based on their approval decision. Options may include:
- Net 30 (fee-free)
- Extended terms such as Net 60 or Net 90
- Installment plans (e.g., 3, 6, or 12 months)
3. Payment Authorization
After the customer selects their term and confirms the purchase:
- The merchant receives the customer redirect or webhook notification with order details
- The order is now ready to be Authorized
At this stage, the order is in a pre-authorized state. The order will be Authorized once the order is awaiting fulfillment in your system.
4. Order Completion
Once payment flow is completed, the customer is redirected back to the merchant using:
return_url(successful flow)cancel_url(if the customer exits)
Merchants use these redirects—or with webhooks—to finalize authorization and complete the checkout flow and present a standard order confirmation page.
5. Capture, Shipment, and Post-Checkout Operations
After authorization, merchants manage fulfillment using the standard order APIs:
- Update Order
- Cancel
- Capture payments (full or partial)
- Process refunds/partial refunds
- Pass metadata to ERPs or invoice providers
- Reconcile transactions through the merchant portal or via SFTP
All financial and invoicing workflows are handled on Credit Key's side.
Checkout Integration Options
Hosted Checkout (Recommended)
The fastest way to integrate Credit Key. All borrower interactions, underwriting, and term selection occur in a hosted environment.
Updated 23 days ago
