GuidesAPI Reference
Guides

How to integrate with Credit Key using MCP

The Credit Key MCP server gives AI-powered development tools access to the latest Credit Key API documentation. Use the prompts below with your MCP-compatible client (such as Claude Desktop, Cursor, Windsurf, VS Code, or ChatGPT) to generate complete integration guides, implementation examples, and troubleshooting advice.

📘

MCP Server

https://docs.creditkey.com/mcp

1. API Authentication

Authenticate with the Credit Key V2 API.

Prompt

Explain how to authenticate with the Credit Key V2 API, obtain credentials, configure Bearer authentication, and make authenticated requests.

2. Hosted Checkout

Build a complete Hosted Checkout integration.

Prompt

Using the Credit Key MCP server, create a complete Hosted Checkout integration guide including:

• Creating a checkout session
• Required request fields
• Handling checkout_url
• Redirect vs modal checkout
• Processing return_url and cancel_url
• Storing the CKKEY
• Next steps after checkout

3. Custom Ecommerce Checkout

Add Credit Key as a payment method in a custom checkout.

Prompt

Generate a step-by-step guide for integrating Credit Key into a custom ecommerce checkout, including backend checkout creation, frontend payment selection, and order completion.

4. Complete Checkout Flow

Implement the complete customer financing workflow.

Prompt

Create a guide covering the complete Credit Key checkout flow from checkout creation through authorization, capture, refund, and cancellation.

5. Authorize an Order

Authorize an order after checkout.

Prompt

Create a guide explaining how to retrieve the CKKEY from the return URL and authorize the order using the Order API.

6. Update an Order

Modify an order before fulfillment.

Prompt

Show how to update an authorized Credit Key order including order totals, shipping, taxes, discounts, metadata, and line items.

7. Capture a Payment

Capture payment after fulfillment.

Prompt

Generate a guide showing when and how to capture a Credit Key order after shipment.

8. Partial Capture

Capture only shipped items.

Prompt

Create a guide demonstrating partial captures for split shipments, including request examples and best practices.

9. Refund an Order

Issue full or partial refunds.

Prompt

Generate a guide covering full refunds, partial refunds, request examples, and the refund lifecycle.

10. Cancel an Order

Cancel an order before fulfillment.

Prompt

Explain how and when to cancel an authorized Credit Key order, including API requests and expected responses.

11. Webhooks

Receive Credit Key events automatically.

Prompt

Generate a webhook integration guide including event handling, validation, retries, security recommendations, and sample implementations.

12. Sandbox Testing

Validate your integration before production.

Prompt

Create a testing guide covering staging credentials, sample borrowers, approval scenarios, declines, SMS verification, and end-to-end testing.

13. Error Handling

Handle API failures gracefully.

Prompt

Generate a troubleshooting guide covering common Credit Key API errors, validation failures, authorization issues, declined applications, and retry strategies.

14. Order Reconciliation

Keep your order system synchronized.

Prompt

Create a guide explaining how to reconcile captures, refunds, settlements, ACH deposits, and merchant reporting.

15. Migrate from V1

Upgrade an existing Credit Key integration.

Prompt

Generate a migration guide describing the differences between the Credit Key V1 and V2 APIs, including endpoint changes, authentication, checkout flow, and order operations.

Tips

  • Ask the MCP to generate examples in your preferred programming language (for example, JavaScript, PHP, Python, Java, C#, Ruby, or Go).
  • Request production-ready code samples that include error handling, retries, and logging.
  • Ask the MCP to explain required and optional request fields before implementing an endpoint.
  • Request sequence diagrams or workflow explanations for complex integration scenarios.
  • Use follow-up prompts to tailor generated guides for your ecommerce platform, backend framework, or architecture.
  • Ask the MCP to reference relevant Credit Key documentation pages and endpoints in its responses for easier verification.