Build with AI

Use your AI coding assistant to build a Ledyer integration with the right documentation and product-specific guidance.

How to use these prompts

Open your project in a coding assistant that can read your repository and fetch documentation URLs.
Copy the prompt for your integration and paste it into the assistant. Add any project-specific requirements, such as your fulfillment flow or accounting system.
Let the assistant inspect your project, read the documentation, and clarify missing requirements before implementing.
Review the implementation and validate it in sandbox using the relevant guides and checklists.

For Payments, Checkout, and Settlement integrations, generate your API credentials in the Ledyer merchant portal. See Payment API authentication for how to use them.

Documentation sources

llms.txt is the starting point: product relationships, shared best practices, and links to the relevant guides.
openapi.json describes the public payment, Order Management, and Settlement HTTP APIs in Swagger/OpenAPI 2.0 format. It defaults to sandbox and does not cover Access. See the OpenAPI usage guide for scope, environments, and authentication.
Integration guides explain browser SDKs, notifications, and lifecycle behavior. Use them alongside the specification.

Integration prompts

Choose the prompt that matches your product. Payments adds a payment option to your existing checkout; Checkout embeds Ledyer’s checkout experience. Both prompts include shared Order Management so the integration covers the order lifecycle beyond purchase authorization.

Ledyer Checkout

Embed Ledyer’s checkout and connect the complete order lifecycle.

Build an embedded Ledyer Checkout integration in this project.

Inspect this repository and implement the integration using its existing stack, architecture, and conventions. Identify existing integration code before making changes.

Start by fetching https://developers.ledyer.com/llms.txt, then read the relevant linked guides and the sources below. Fetch the actual documentation rather than relying on prior knowledge. If you cannot access a source, ask me to supply it before implementing behavior that depends on it.

Identify missing requirements, credentials, callback URLs, and configuration. Ask focused questions for unresolved decisions; use environment variables for credentials and keep secrets on the backend. Start with sandbox configuration.

Implement backend order session creation, iframe rendering, cart/session updates, and browser events. Follow the documented suspend/resume behavior during updates. Implement the applicable order validation, session and order notifications, order acknowledgement, and backend synchronization. Distinguish browser completion events from authoritative backend payment state.

API credentials (clientId and clientSecret) are generated in the Ledyer merchant portal. Tell me to generate them there if they are not already configured, and configure them through backend environment variables.

Use https://developers.ledyer.com/openapi.json for HTTP operations and schemas. It is Swagger/OpenAPI 2.0 and defaults to sandbox. Use the guides for browser SDKs, notifications, and lifecycle behavior.

Include shared Order Management: retrieve and synchronize orders and payment status, capture full or partial orders, cancel orders, and issue full or partial refunds as needed by this application's fulfillment flow. Treat webhooks as triggers to fetch authoritative API state, handle duplicate and out-of-order events, and use the session ID when an order ID is unavailable. Never capture before paymentConfirmed. Use Idempotency-Key on order-modifying Order Management requests, with a unique key per operation reused for retries. Follow the documented discount, gift card, and VAT rules when those features apply.

Documentation sources:
- https://developers.ledyer.com/docs/payment-products/checkout/introduction
- https://developers.ledyer.com/docs/payment-products/checkout/create-order-session
- https://developers.ledyer.com/docs/payment-products/checkout/render-the-iframe
- https://developers.ledyer.com/docs/payment-products/checkout/update-order-session
- https://developers.ledyer.com/docs/payment-products/checkout/client-api-events
- https://developers.ledyer.com/docs/payment-products/checkout/notifications/introduction
- https://developers.ledyer.com/docs/payment-products/checkout/notifications/acknowledge
- https://developers.ledyer.com/docs/payment-products/checkout/checklist
- https://developers.ledyer.com/docs/payment-products/authentication
- https://developers.ledyer.com/docs/payment-products/environments
- https://developers.ledyer.com/docs/best-practices/order-syncing
- https://developers.ledyer.com/docs/best-practices/idempotency
- https://developers.ledyer.com/docs/best-practices/discounts
- https://developers.ledyer.com/docs/best-practices/giftcards
- https://developers.ledyer.com/docs/order-management/get-payment-status
- https://developers.ledyer.com/docs/order-management/get-order
- https://developers.ledyer.com/docs/order-management/checklist
- https://developers.ledyer.com/docs/testing

Implement the complete relevant flow, including error handling and retries where appropriate. Use the documented request fields, amounts, VAT rules, SDK methods, and lifecycle behavior; do not invent APIs or assume another provider's behavior applies.

Add meaningful tests for the integration, run the project's relevant checks, and explain what was verified and what still needs sandbox validation. Document required configuration and how to run the integration. Review the applicable integration checklists and clearly identify any remaining steps.

Ledyer Payments

Add Ledyer as a payment option in your existing checkout, including Order Management.

Build a Ledyer Payments integration in this project's existing checkout.

Inspect this repository and implement the integration using its existing stack, architecture, and conventions. Identify existing integration code before making changes.

Start by fetching https://developers.ledyer.com/llms.txt, then read the relevant linked guides and the sources below. Fetch the actual documentation rather than relying on prior knowledge. If you cannot access a source, ask me to supply it before implementing behavior that depends on it.

Identify missing requirements, credentials, callback URLs, and configuration. Ask focused questions for unresolved decisions; use environment variables for credentials and keep secrets on the backend. Start with sandbox configuration.

Implement payment session creation, browser SDK integration, purchase authorization, and backend order creation using the authorization token. Collect customer data before authorization and keep order and customer data consistent with the payment session. Handle pending signatory flows, reauthorization after changes, unused authorizations, and backend notifications according to the Payments guides.

API credentials (clientId and clientSecret) are generated in the Ledyer merchant portal. Tell me to generate them there if they are not already configured, and configure them through backend environment variables.

Use https://developers.ledyer.com/openapi.json for HTTP operations and schemas. It is Swagger/OpenAPI 2.0 and defaults to sandbox. Use the guides for browser SDKs, notifications, and lifecycle behavior.

Include shared Order Management: retrieve and synchronize orders and payment status, capture full or partial orders, cancel orders, and issue full or partial refunds as needed by this application's fulfillment flow. Treat webhooks as triggers to fetch authoritative API state, handle duplicate and out-of-order events, and use the session ID when an order ID is unavailable. Never capture before paymentConfirmed. Use Idempotency-Key on order-modifying Order Management requests, with a unique key per operation reused for retries. Follow the documented discount, gift card, and VAT rules when those features apply.

Documentation sources:
- https://developers.ledyer.com/docs/payment-products/payments/introduction
- https://developers.ledyer.com/docs/payment-products/payments/create-session
- https://developers.ledyer.com/docs/payment-products/payments/client-integration
- https://developers.ledyer.com/docs/payment-products/payments/create-order
- https://developers.ledyer.com/docs/payment-products/payments/best-practices
- https://developers.ledyer.com/docs/payment-products/payments/notifications/introduction
- https://developers.ledyer.com/docs/payment-products/payments/checklist
- https://developers.ledyer.com/docs/payment-products/authentication
- https://developers.ledyer.com/docs/payment-products/environments
- https://developers.ledyer.com/docs/best-practices/order-syncing
- https://developers.ledyer.com/docs/best-practices/idempotency
- https://developers.ledyer.com/docs/best-practices/discounts
- https://developers.ledyer.com/docs/best-practices/giftcards
- https://developers.ledyer.com/docs/order-management/get-payment-status
- https://developers.ledyer.com/docs/order-management/get-order
- https://developers.ledyer.com/docs/order-management/checklist
- https://developers.ledyer.com/docs/testing

Implement the complete relevant flow, including error handling and retries where appropriate. Use the documented request fields, amounts, VAT rules, SDK methods, and lifecycle behavior; do not invent APIs or assume another provider's behavior applies.

Add meaningful tests for the integration, run the project's relevant checks, and explain what was verified and what still needs sandbox validation. Document required configuration and how to run the integration. Review the applicable integration checklists and clearly identify any remaining steps.

Settlement

Retrieve payouts and transactions for reconciliation with your records.

Build a Ledyer Settlement API integration for payout reconciliation in this project.

Inspect this repository and implement the integration using its existing stack, architecture, and conventions. Identify existing integration code before making changes.

Start by fetching https://developers.ledyer.com/llms.txt, then read the relevant linked guides and the sources below. Fetch the actual documentation rather than relying on prior knowledge. If you cannot access a source, ask me to supply it before implementing behavior that depends on it.

Identify missing requirements, credentials, callback URLs, and configuration. Ask focused questions for unresolved decisions; use environment variables for credentials and keep secrets on the backend. Start with sandbox configuration.

API credentials (clientId and clientSecret) are generated in the Ledyer merchant portal. Tell me to generate them there if they are not already configured, and configure them through backend environment variables.

Use https://developers.ledyer.com/openapi.json for HTTP operations and schemas. It is Swagger/OpenAPI 2.0 and defaults to sandbox.

Implement authenticated backend retrieval of settlement lists, individual settlements, and settlement transactions. Follow the documented filters and pagination. Make synchronization restartable and avoid duplicate imported records when rerunning it.

Inspect this application's accounting or order records and identify how to match settlement transactions to them using documented identifiers. Preserve the documented amount, sign, and currency semantics and avoid floating-point rounding errors. Reconcile payout totals with their transactions and surface unmatched records or discrepancies for review. Ask me about the intended output or accounting destination if the repository does not establish it. Do not assume undocumented transaction types or reconciliation rules.

Documentation sources:
- https://developers.ledyer.com/docs/payment-products/authentication
- https://developers.ledyer.com/docs/payment-products/environments
- https://developers.ledyer.com/docs/settlement/get-settlements
- https://developers.ledyer.com/docs/settlement/get-settlement
- https://developers.ledyer.com/docs/settlement/get-settlement-tx

Implement the complete relevant flow, including error handling and retries where appropriate. Use the documented request fields, amounts, VAT rules, SDK methods, and lifecycle behavior; do not invent APIs or assume another provider's behavior applies.

Add meaningful tests for the integration, run the project's relevant checks, and explain what was verified and what still needs sandbox validation. Document required configuration and how to run the integration. Review the applicable integration checklists and clearly identify any remaining steps.

Ledyer Access

Identify customers and retrieve user and company information.

Build a Ledyer Access integration in this project.

Inspect this repository and implement the integration using its existing stack, architecture, and conventions. Identify existing integration code before making changes.

Start by fetching https://developers.ledyer.com/llms.txt, then read the relevant linked guides and the sources below. Fetch the actual documentation rather than relying on prior knowledge. If you cannot access a source, ask me to supply it before implementing behavior that depends on it.

Identify missing requirements, credentials, callback URLs, and configuration. Ask focused questions for unresolved decisions; use environment variables for credentials and keep secrets on the backend. Start with sandbox configuration.

Access is an identity integration for customer identification, login, and onboarding using OAuth 2.0 and OpenID Connect. It is separate from payment API authentication and is not described by the payment OpenAPI specification.

The callback URL (redirect URI) must be sent to Ledyer for whitelisting before the integration can be used. Ask me to confirm the callback URL and arrange whitelisting with Ledyer. The redirect URI used in authorization requests must exactly match the whitelisted URL.

Use established OAuth/OIDC libraries. Implement the documented authorization URI, browser integration, callback handling, authorization code exchange, and retrieval of user and company information. Map the returned information into this application's customer accounts according to its existing account model. Follow the documented protocol requirements and the chosen library's security guidance.

Documentation sources:
- https://developers.ledyer.com/docs/access/introduction
- https://developers.ledyer.com/docs/access/construct-uri
- https://developers.ledyer.com/docs/access/client-integration
- https://developers.ledyer.com/docs/access/get-user-data

Implement the complete relevant flow, including error handling and retries where appropriate. Use the documented request fields, amounts, VAT rules, SDK methods, and lifecycle behavior; do not invent APIs or assume another provider's behavior applies.

Add meaningful tests for the integration, run the project's relevant checks, and explain what was verified and what still needs sandbox validation. Document required configuration and how to run the integration. Review the applicable integration checklists and clearly identify any remaining steps.