The Hosted endpoints allow merchants to launch Credit Key-hosted customer experiences for financing applications and payments.

Use these endpoints when you want Credit Key to manage the customer-facing financing experience while your application controls when and where that experience is launched.

Hosted experiences can be used to:

• Allow customers to apply for a Credit Key line of credit.
• Add Credit Key to an online checkout.
• Send customers a payment link by email or SMS.
• Retrieve the status of a hosted session.

Hosted Application

Launch the Credit Key financing application independently of checkout.

GET /v2/hosted/apply

Use Hosted Application when you want customers to apply for financing before making a purchase. The endpoint generates a Credit Key-hosted application experience that can be launched from your website, financing page, ERP, CRM, or other customer touchpoints.

The financing application may also be presented as part of Hosted Checkout when Credit Key does not recognize the customer.

Common use cases

• Apply for Financing buttons
• Financing pages
• Pre-checkout financing
• ERP or CRM workflows
• Sales representative workflows
• Marketing campaigns

Hosted Checkout

Launch the Credit Key financing and payment experience for a specific order.

POST /v2/hosted/checkout

Use Hosted Checkout when a customer selects Credit Key as a payment method during checkout.

The request includes the order amount, cart information, customer details, billing and shipping addresses, merchant reference, and callback URLs. Credit Key returns a hosted checkout experience where the customer can authenticate, apply if necessary, select available financing terms, and complete the payment flow.

After a successful checkout, Credit Key redirects the customer to the merchant's return_url and provides the Credit Key order key (CKKEY) used to manage the order through the Orders API.

Common use cases

• Custom eCommerce checkout
• Custom storefronts
• ERP checkout flows
• CRM or internal ordering applications
• Sales-assisted transactions

Hosted Payment Link

Create a Credit Key-hosted payment experience that can be sent to a customer without requiring a traditional online checkout.

POST /v2/hosted/link

Use Hosted Payment Link when an order originates through an offline or assisted sales channel.

Depending on the request configuration, Credit Key can notify the customer by email or SMS with a link to complete payment. You can also configure the request so no notification is sent and use the returned checkout_url to deliver the payment link yourself.

Common use cases

• Phone orders
• Email orders
• Sales representative orders
• ERP or CRM workflows
• Invoices
• Pay-by-link experiences

Hosted Status

Retrieve the current status of a hosted Credit Key experience.

GET /v2/hosted/status

Use this endpoint when your application needs to determine the current state of a hosted session.

Refer to the endpoint documentation for the supported request parameters, response fields, and status values.

What's Next

After a customer completes a Hosted Checkout or Hosted Payment Link flow, use the Orders API to manage the resulting Credit Key order.

Order operations include:

• Retrieving an order
• Authorizing an order
• Updating an order
• Capturing an order
• Canceling an order
• Processing refunds

See Orders for the complete order lifecycle and related endpoints.