Hosted Checkout

The Credit Key checkout process begins when the customer selects Credit Key as the payment method. The following steps describe how to initiate, complete, update, cancel, capture, and refund orders using the V2 Hosted Checkout and Order endpoints.

Begin Hosted Checkout

Endpoint: POST /v2/hosted/checkout

Use this endpoint to start a hosted checkout session. Include:

Cart items and totals
Customer details
Billing and shipping addresses
Merchant reference (cart/order ID)
return_url
cancel_url
Optional metadata

Return URL

Example format: https://www.merchantsite.com/return/after/checkout?id=%CKKEY%

Credit Key replaces %CKKEY% with the actual Credit Key order key when redirecting the customer back to your site.

This value must be captured and stored for all follow-up calls to /v2/order/{key}.

📘
Payment is not authorized until the order is updated using /v2/order/{key}
See Post Checkout Operations

Pay by Link(Hosted)

Initiate a hosted payment flow process outside of a conventional e-commerce checkout experience.

The Credit Key standalone checkout feature allows merchants to initiate a payment process outside of a conventional e-commerce checkout experience. When the hosted Credit Key checkout flow is invoked using this method, an email or SMS notification will be sent to the customer. The email will contain a link that will redirect the customer to a checkout experience hosted on creditkey.com to complete the payment process. Alternatively, the checkout link can be used to provide a pay-by-link in any context.

Implementation

/hosted/link

Specifies how the borrower is notified to complete the payment flow. When set to NONE, no notification is sent and the payment URL is returned in the response.

Response:

"key": "CK-GSB1288",
  "checkout_url": "https://checkout.creditkey.com/ihiKAWU3gan9G1I01rbCM8oY6l9vlLK"

📘
completed_order_status
The default status for an order completed using this method is Authorized. Created and Captured are optional statuses for this checkout method.

Post order management operations are the same as a hosted checkout flow. See related documentation.