# Imprint Docs

## Docs

- [Welcome](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/welcome.md): Imprint makes integration effortless, empowering you to offer perfectly co-branded financial products wherever your customers shop and however they choose to pay. Explore our guides, examples, and resources to find the perfect solution for your business and make your first API call within minutes.
- [Base URLs](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/base-urls.md): Introduction to Imprint environments and API URLs
- [Authentication](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/authentication.md): Finding and using your API keys
- [Data types](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/data-types.md): Learn how we format amounts, currencies, and dates across the Imprint API
- [Error handling](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/error-handling.md): How Imprint communicates errors
- [API versioning](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/versioning.md): Choose which version of the API your integration uses, and upgrade when you're ready
- [API changelog](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/changelog.md): Partner API version releases
- [Apply for a loan or credit card](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/creating-an-application.md): The end-to-end process of applying for an Imprint payment method involves three steps
- [Application event notifications](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/application-event-notifications.md): Receive the authoritative result of an Imprint application server-side, and reconcile it with the client-side SDK result
- [Card issuance](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/guide-unified-card-experience.md): Understand how unified and distinct card issuance modes work, and what to expect from webhooks and card behavior
- [Add to Wallet](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/add-to-wallet.md): Let your customers add their Imprint card to Apple Pay or Google Pay from inside your own app
- [Create a transaction intent](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/create-transaction-intent.md): Unlock personalized experiences that stand out in the marketplace
- [Offer deferred interest](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/guide-deferred-interest.md): Let customers finance eligible orders with a deferred-interest benefit
- [Rewards Program](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/rewards-event-notifications.md): Guide on reward types, statuses, earning configurations, and processing reward webhooks
- [Account Linking](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/account-linking.md): Connect your customers' loyalty or identity accounts with their Imprint card account
- [Subscribe to event notifications](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/guide-event-notifications.md): Receive and react to real-time event notifications from Imprint
- [Verify event signature](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/verify-event-notification.md): Secure transmission using the event signature header
- [Delivery and retries](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/webhook-delivery-and-retries.md): How Imprint delivers event notifications, when we retry, and how your endpoint should respond
- [Event notifications](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/event-notifications.md)
- [API Key Rotation](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-key-rotation.md): Rotating API Keys
- [Enriching with Read-Only Servicing](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/guide-embedded-servicing.md): Bring a customer's balance, credit line, statements, and card art into your own account page
- [Tips for sandbox testing](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/tips-for-sandbox.md)
- [Simulate transaction events](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/simulate-transaction-events-in-sandbox.md): How to create transaction events in sandbox environment
- [Web](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/web.md): Embed the Imprint application experience on your website
- [iOS](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/ios.md): Embed the Imprint application experience in your iOS app
- [Android](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/android.md): Embed the Imprint application experience in your Android app
- [Search for customers](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/search-for-customers.md)
- [Search for customers](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/search-for-customers-1.md)
- [Retrieve a customer](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/retrieve-a-customer.md): Retrieves the details of an existing customer by ID
- [List a customer's accounts](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/list-a-customers-accounts.md): Lists the accounts a customer holds with your program, each with the `account_id` needed to read it in detail and the type of product it is.
- [Get customer's account](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/get-customers-account.md): Returns the servicing snapshot for one of a customer's card accounts: account status, credit limit and available credit, the amounts they owe, the statement due date, and the APR.
- [List an account's reward categories](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/list-an-accounts-reward-categories.md): Returns the account program's standard earning categories and active signup categories. The response is assembled from the same live product, accrual, and offer configuration used by Imprint's application and servicing experiences; it is not read from static rewards assets.
- [List an account's statements](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/list-an-accounts-statements.md): Returns the account's closed billing statements, newest first. A statement appears here once its cycle has closed; the cycle in progress is not a statement yet — read the account itself for where the customer stands today.
- [Get customer's current rewards balance](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/get-customers-current-rewards-balance.md)
- [List customer's payment methods](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/list-customers-payment-methods.md): **Optional scope:** `PCI_DETAILS_READ`. Without it the request still succeeds, but `card.pci_details` (PAN, CVV, expiry) is omitted from the response.
- [List customer's transaction intents](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/list-customers-transaction-intents.md): **Required scope:** `TRANSACTION_INTENT_READ`
- [List customer's transactions](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/list-customers-transactions.md)
- [List customer's rewards](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customers/list-customers-rewards.md): List customer's rewards in descending order by the reward's updated at timestamp
- [Link an Imprint customer and partner customer accounts](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customer-links/link-an-imprint-customer-and-partner-customer-accounts.md): Creates a link between an existing Imprint customer and a partner's customer account. The API key provided with the request will be used to link the partner with the imprint customer.
- [Update the partner customer ID of a customer link](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customer-links/update-the-partner-customer-id-of-a-customer-link.md): Changes the `partner_customer_id` of the customer's existing active link to a new value. Use this when the partner customer account an Imprint customer is linked to has changed, for example after a partner account merge. The link must already exist and be active; to create a link, use `POST /v2/cust…
- [Create a new customer session](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customer-sessions/create-a-new-customer-session.md): Creates a new session for a customer with a client_secret that can be passed to the SDK, providing client access to modify their own profile, card, or card/loan application. If required, a new customer will be created to attach this session to. Customer history can be attached to this session and wi…
- [Retrieve a session](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/customer-sessions/retrieve-a-session.md)
- [List payment methods](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/payment-methods/list-payment-methods.md): **Optional scope:** `PCI_DETAILS_READ`. Without it the request still succeeds, but `card.pci_details` (PAN, CVV, expiry) is omitted from the response.
- [List payment methods](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/payment-methods/list-payment-methods-1.md): **Optional scope:** `PCI_DETAILS_READ`. Without it the request still succeeds, but `card.pci_details` (PAN, CVV, expiry) is omitted from the response.
- [Retrieve a payment method](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/payment-methods/retrieve-a-payment-method.md): Retrieves the details of the payment method associated with the supplied `payment_method_id`.
- [Add a payment method to a device wallet](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/payment-methods/add-a-payment-method-to-a-device-wallet.md): Provisions the payment method into the device wallet named by the `wallet` path parameter, returning the encrypted payload the platform wallet SDK needs to finish adding the card. `apple_pay` expects the PassKit handshake; `google_pay` expects the Google wallet and device identifiers.
- [Retrieve a payment method's card design](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/payment-methods/retrieve-a-payment-methods-card-design.md): Returns the card design printed on this payment method.
- [List transaction intents](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/transaction-intents/list-transaction-intents.md): Retrieves a list of transaction intents.
- [Create a transaction intent](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/transaction-intents/create-a-transaction-intent.md): Creates a transaction intent object that represents a pending financial transaction. Transaction intents are used to initiate, validate, and track the lifecycle of a transaction before it is finalized.
- [Retrieve a transaction intent](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/transaction-intents/retrieve-a-transaction-intent.md): Retrieves the details of an existing transaction intent by `id`.
- [Update a transaction intent](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/transaction-intents/update-a-transaction-intent.md): Updates the details of the transaction intent associated with the supplied intent_id.
- [Retrieve a transaction](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/transactions/retrieve-a-transaction.md): Retrieves the details of an existing transaction by `id`
- [Search for rewards](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/rewards/search-for-rewards.md)
- [List the product's reward categories](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/rewards/list-the-products-reward-categories.md): Returns the authenticated API key's product-level standard earning categories and active signup categories. The product is inferred from the API key; this endpoint does not accept product, customer, or account identifiers.
- [Retrieve a reward](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/rewards/retrieve-a-reward.md): Retrieves the details of an existing reward by ID
- [Updates a reward](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/rewards/updates-a-reward.md): Updates the status or amount of pending rewards
- [List card designs](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/card-designs/list-card-designs.md): Returns the card designs available for your program.
- [Retrieve order events](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/order-events/retrieve-order-events.md): Get a list of order events.
- [Create order events](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/order-events/create-order-events.md): Create new order events.
- [Delete order event](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/order-events/delete-order-event.md): Delete an existing order event.
- [Retrieve orders](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/orders/retrieve-orders.md): Get a list of orders.
- [Create orders](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/orders/create-orders.md): Create new orders.
- [Modify order](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/orders/modify-order.md): Modify an existing order.
- [Delete order](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/orders/delete-order.md): Delete an existing order.
- [Simulate transaction event in sandbox environment](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/simulate-transaction-event/simulate-transaction-event-in-sandbox-environment.md)
- [Simulate Statement Reward](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/simulate-statement-reward/simulate-statement-reward.md): Initiate a statement reward webhook to be sent in sandbox environment
- [Simulate Reward](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/simulate-reward/simulate-reward.md): Initiate a reward webhook in sandbox. Specify the reward type to simulate processing of pending rewards.
- [Create an API Key](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/keys/create-an-api-key.md): Creates a new API key. The new key is granted the same permissions as the API key that authenticates this request.
- [Delete an API Key](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/keys/delete-an-api-key.md): Deletes an existing API Key
- [Application event notification](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/webhooks/application-event-notification.md): Receive an event notification when an application for a payment method is created or transitions statuses.
- [Transaction event notification](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/webhooks/transaction-event-notification.md): Receive a notification when a transaction is created or when events for the transaction happen Please see the [event notifications guide](https://docs.imprint.co/guide-event-notifications) for more information regarding the lifecycle of a transaction.
- [Payment method event notification](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/webhooks/payment-method-event-notification.md): Receive a notification when a payment method (e.g. credit card or loan) is created or transitions statuses.
- [Customer link event notification](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/webhooks/customer-link-event-notification.md): Receive a notification when a customer’s Imprint account is successfully linked to a partner account via the Account Linker.
- [Reward event notification](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/webhooks/reward-event-notification.md): Receive an event notification when a reward is created, updated, or available
- [Streak event notification](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/webhooks/streak-event-notification.md): Receive an event notification when a customer's streak starts, progresses, completes, or fails.
- [Account status event notification](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/webhooks/account-status-event-notification.md): Receive an event notification when a customer's account reaches a terminal state (e.g. closure).

## OpenAPI Specs

- [openapi](https://imprint-b3c5d5af-partner-docs-latest.mintlify.site/api-reference/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.