# Dime Payments - [Introduction](https://docs.dimepayments.com/guides/introduction.md): The Dime Payments API lets you process payments, manage customers, and automate billing for your business. - [Quickstart](https://docs.dimepayments.com/guides/quickstart.md): Make your first API call in under 5 minutes. - [Authentication](https://docs.dimepayments.com/guides/authentication.md): How to authenticate requests to the Dime Payments API. - [PHP SDK](https://docs.dimepayments.com/guides/sdks/php.md): Official PHP client for the Dime Payments API - [JavaScript SDK](https://docs.dimepayments.com/guides/sdks/javascript.md): Official JavaScript client for the Dime Payments API - [Python SDK](https://docs.dimepayments.com/guides/sdks/python.md): Official Python client for the Dime Payments API - [Retrying Safely](https://docs.dimepayments.com/guides/idempotency.md): Send an Idempotency-Key so a charge or refund that timed out can be retried without moving money twice. - [Authorize and Capture](https://docs.dimepayments.com/guides/authorize-capture.md): Place a hold on a card now and collect the money later. - [Held Funds](https://docs.dimepayments.com/guides/held-funds.md): Check a held balance and release funds to the merchant's bank account. - [Webhooks](https://docs.dimepayments.com/guides/webhooks.md): Receive real-time notifications when events occur in your Dime Payments account. - [Disputes and Chargebacks](https://docs.dimepayments.com/guides/disputes.md): How chargebacks work in Dime Payments, how to track them, and how to send evidence. - [Payouts](https://docs.dimepayments.com/guides/payouts.md): How and when funds are deposited into your merchant bank account. - [WooCommerce Setup Guide](https://docs.dimepayments.com/help/shared/woocommerce-setup.md): Install and configure the Dime Payments gateway plugin for WooCommerce to accept card and ACH payments at checkout. - [Response Codes](https://docs.dimepayments.com/guides/response-codes.md): Every HTTP status code and error message returned by the Dime Payments API, with troubleshooting guidance. - [Virtual Terminal](https://docs.dimepayments.com/help/shared/virtual-terminal.md): Take a live card or ACH payment on behalf of a customer in two quick steps. - [Recording manual transactions](https://docs.dimepayments.com/help/shared/manual-transactions.md): Record a check, cash, card or bank payment taken outside Dime, record a refund, and bulk-import past transactions from a file. - [Deposits](https://docs.dimepayments.com/help/shared/deposits.md): See funds settled to your bank account and group manual transactions into a deposit. - [Recurring payments](https://docs.dimepayments.com/help/shared/recurring-payments.md): View and manage scheduled recurring payments that charge a customer automatically on a set frequency. - [Voiding or refunding a payment](https://docs.dimepayments.com/help/shared/void-or-refund.md): The difference between a void and a refund, and when to use each. - [Chargebacks and returns](https://docs.dimepayments.com/help/shared/chargebacks-returns.md): See chargebacks filed against your account and understand how to respond to them. - [Invoices](https://docs.dimepayments.com/help/shared/invoices.md): Create, send, and track invoices, and let customers pay online by card or ACH. - [Recurring invoices](https://docs.dimepayments.com/help/shared/recurring-invoices.md): Set up schedules that automatically generate and send invoices on a cadence. - [Subscriptions](https://docs.dimepayments.com/help/shared/subscriptions.md): Create subscription plans that bill customers automatically on a recurring cadence. - [Subscribers](https://docs.dimepayments.com/help/shared/subscribers.md): View and manage every customer enrolled in your subscription plans. - [Reports Overview](https://docs.dimepayments.com/help/business/reports-overview.md): A guide to every report in the Dime Payments dashboard. - [Items](https://docs.dimepayments.com/help/business/items.md): Set up and manage the payment categories shown on your payment form. - [Custom Receipt](https://docs.dimepayments.com/help/business/custom-receipt.md): Customize the payment receipt email sent to customers after each transaction. - [Design Settings](https://docs.dimepayments.com/help/business/design-settings.md): Customize your public payment page -- URL, logo, form options, and notifications. - [Reports Overview](https://docs.dimepayments.com/help/church/reports-overview.md): A guide to every report in the Dime Payments dashboard. - [Campaigns](https://docs.dimepayments.com/help/church/campaigns.md): Create and manage giving campaigns and fundraising drives. - [Items (Giving Categories)](https://docs.dimepayments.com/help/church/items.md): Set up and manage the giving categories shown on your donation form. - [Custom Receipt](https://docs.dimepayments.com/help/church/custom-receipt.md): Customize the donation receipt email sent to donors after each transaction. - [Design Settings](https://docs.dimepayments.com/help/church/design-settings.md): Customize your public giving page -- URL, logo, colors, form options, and notifications. - [Moving from Dime Giving](https://docs.dimepayments.com/help/church/dime-giving-move.md): What changed when Dime Giving moved to Dime Payments, and where to find things now. - [Signing in and finding your statements](https://docs.dimepayments.com/help/donors/sign-in.md): Sign in to see your giving history, recurring gifts, and statements. - [Managing your recurring gifts](https://docs.dimepayments.com/help/donors/recurring-gifts.md): Change the amount, frequency, or card on a recurring gift, or pause or cancel it. - [Applying for an account](https://docs.dimepayments.com/help/shared/applying.md): How to sign up and apply to start accepting payments with Dime. - [Account](https://docs.dimepayments.com/help/shared/account.md): View your merchant account details, see who has access, and understand how to close your account. - [API keys](https://docs.dimepayments.com/help/shared/api-keys.md): Create and manage API tokens for connecting Dime Payments to WooCommerce, Zapier, and custom integrations. - [Bank Account](https://docs.dimepayments.com/help/shared/bank-account.md): How to connect and update the bank account where your payments are deposited. - [Code Snippets](https://docs.dimepayments.com/help/shared/code-snippets.md): Embed your payment form on your website or share a direct payment link. - [Email Sender](https://docs.dimepayments.com/help/shared/email-sender.md): Configure the from name and email address used for all customer emails. - [Why ACH Refunds Are Held for 7 Days](https://docs.dimepayments.com/help/shared/ach-refund-hold.md): Understanding the ACH refund hold policy and how it protects you as a merchant. - [WooCommerce Setup Guide](https://docs.dimepayments.com/help/shared/woocommerce-setup.md): Install and configure the Dime Payments gateway plugin for WooCommerce to accept card and ACH payments at checkout. - [List Merchants](https://docs.dimepayments.com/api-reference/merchant-management/list-merchants.md): Get a list of all merchants and their fields - [Show a specific Merchant's Details](https://docs.dimepayments.com/api-reference/merchant-management/show-a-specific-merchants-details.md): List all non-protected fields for a merchant. Other fields are available using their specific requests. - [Create Merchant](https://docs.dimepayments.com/api-reference/merchant-management/create-merchant.md): Create a merchant record which can be used for generating an application. - [Update a specific Merchant's Details](https://docs.dimepayments.com/api-reference/merchant-management/update-a-specific-merchants-details.md): Update a Merchant's details. - [Get a unique, secure link to the signup application for a Merchant.](https://docs.dimepayments.com/api-reference/merchant-management/get-a-unique-secure-link-to-the-signup-application-for-a-merchant.md): Passed a merchant's ID, returns a full URL to the application for processor approval. This link expires in 30 days (App\Models\Company::APPLICATION_LINK_DAYS). - [Get a Merchant's onboarding status](https://docs.dimepayments.com/api-reference/merchant-management/get-a-merchants-onboarding-status.md): Where a merchant sits in onboarding, from first contact through to being boarded and able to take money. Use this to follow up an application you sent with `get-form-link` without having to ask us. - [List Transactions](https://docs.dimepayments.com/api-reference/transaction-management/list-transactions.md): Retrieves a list of transactions for a given Merchant, filtered by various parameters. - [Charge a Credit Card](https://docs.dimepayments.com/api-reference/transaction-management/charge-a-credit-card.md): This endpoint allows you to charge a credit card using the PAN Data or a Token. This endpoint will process the charge and return a token representing the card that can be used for transactions as well as the transactionId and the customerUUID if requested. If you pass a customer UUID or a customer p… - [Charge a Bank Account](https://docs.dimepayments.com/api-reference/transaction-management/charge-a-bank-account.md) - [Tokenize a Credit Card](https://docs.dimepayments.com/api-reference/transaction-management/tokenize-a-credit-card.md): This endpoint allows you to tokenize a credit card, which will verify its validity and return a token representing the card that can be used for transactions. This method requires PCI compliance on the part of the affiliate or merchant. - [Show Transaction](https://docs.dimepayments.com/api-reference/transaction-management/show-transaction.md) - [Authorize a Credit Card](https://docs.dimepayments.com/api-reference/transaction-management/authorize-a-credit-card.md): Places a hold on a credit card without moving any money. The authorized amount is reserved against the cardholder's available credit, and no funds reach the merchant until the authorization is captured via the capture endpoint. - [Capture an Authorized Credit Card](https://docs.dimepayments.com/api-reference/transaction-management/capture-an-authorized-credit-card.md): Captures funds from a credit card authorization created by the authorize endpoint. This is the point at which money actually moves: the authorization only reserved the funds. - [Refund Transaction](https://docs.dimepayments.com/api-reference/transaction-management/refund-transaction.md): Processes a refund for a transaction based on the provided data. - [Void Transaction](https://docs.dimepayments.com/api-reference/transaction-management/void-transaction.md): Void a transaction - [List Chargebacks](https://docs.dimepayments.com/api-reference/chargeback-management/list-chargebacks.md): Get the chargebacks raised against a merchant. - [Show Chargeback](https://docs.dimepayments.com/api-reference/chargeback-management/show-chargeback.md): Get a single chargeback by its processor identifier. - [Upload Documents](https://docs.dimepayments.com/api-reference/document-management/upload-documents.md): Send us one or more documents for a merchant, stating what they are for. - [List Documents](https://docs.dimepayments.com/api-reference/document-management/list-documents.md): The documents held for a merchant, so you can confirm what we have received. Covers documents uploaded through this API and those added by our team or through the merchant application. - [List Addresses](https://docs.dimepayments.com/api-reference/addresses/list-addresses.md): List all addresses for a specific customer. - [Show Address](https://docs.dimepayments.com/api-reference/addresses/show-address.md): Show details of a specific address. - [Create Address](https://docs.dimepayments.com/api-reference/addresses/create-address.md): Create a new address for a customer. - [Update Address](https://docs.dimepayments.com/api-reference/addresses/update-address.md): Update an existing address. - [Delete Address](https://docs.dimepayments.com/api-reference/addresses/delete-address.md): Remove an address from a customer. - [List Customers](https://docs.dimepayments.com/api-reference/customer-management/list-customers.md): Retrieves a list of customers for a given company, filtered by various parameters. - [Show Customer](https://docs.dimepayments.com/api-reference/customer-management/show-customer.md): Show a specific customer's details - [Create Customer](https://docs.dimepayments.com/api-reference/customer-management/create-customer.md): Create a customer record linked to your Company/Merchant. - [Update Customer](https://docs.dimepayments.com/api-reference/customer-management/update-customer.md): Update a customer record. Make changes to the customer referenced by UUID, phone number, or email. One of the filters is required to be provided to select a unique customer. Only pass the fields that require updating in the data object. - [Delete Customer](https://docs.dimepayments.com/api-reference/customer-management/delete-customer.md): Delete a customer record from the selected Merchant. One of the filters is required to select a unique customer. This will also cancel any recurring payments associated with the customer for your company. - [List Deposits](https://docs.dimepayments.com/api-reference/deposit-management/list-deposits.md): Get Deposits from Merchant Account with supporting transactions - [List Deposits with Supporting Trans](https://docs.dimepayments.com/api-reference/deposit-management/list-deposits-with-supporting-trans.md): Get Deposits from Merchant Account with supporting transactions. Could result in large datasets if range is too large. - [Show Deposit with Supporting Trans](https://docs.dimepayments.com/api-reference/deposit-management/show-deposit-with-supporting-trans.md): Show a Deposit from Merchant Account with supporting transactions - [Get held balance](https://docs.dimepayments.com/api-reference/held-funds/get-held-balance.md): The merchant's current balance at the processor, and how much of it is releasable today. - [List releasable transactions](https://docs.dimepayments.com/api-reference/held-funds/list-releasable-transactions.md): The payments of a held-funds merchant that can be released right now, and what each comes to — the list to choose from when releasing by `transaction_info_ids`. - [Release held funds](https://docs.dimepayments.com/api-reference/held-funds/release-held-funds.md): Send part of a merchant's held balance to the bank account on file. - [List Invoices](https://docs.dimepayments.com/api-reference/invoice-management/list-invoices.md): Retrieves a paginated (cursor) list of invoices for a Merchant, optionally filtered by status. - [Show Invoice](https://docs.dimepayments.com/api-reference/invoice-management/show-invoice.md): Retrieves a single invoice with its line items, payments, and event history. - [Create Invoice](https://docs.dimepayments.com/api-reference/invoice-management/create-invoice.md): Creates a draft invoice with its line items. Every line must reference an item (fund/designation) that belongs to the Merchant; the line name and unit price are snapshotted onto the invoice. The invoice number may be supplied, otherwise the next number is allocated automatically. - [Update Invoice](https://docs.dimepayments.com/api-reference/invoice-management/update-invoice.md): Updates a draft invoice. Only draft invoices can be edited — once sent, an invoice is locked. Passing `data.lines` replaces the existing line items. - [Delete Invoice](https://docs.dimepayments.com/api-reference/invoice-management/delete-invoice.md): Soft-deletes a draft invoice. Only draft invoices can be deleted. - [Send Invoice](https://docs.dimepayments.com/api-reference/invoice-management/send-invoice.md): Emails the invoice to the customer with a link to the public pay page and advances the invoice to Sent. A paid, void, or refunded invoice cannot be sent. - [Mark Invoice Sent](https://docs.dimepayments.com/api-reference/invoice-management/mark-invoice-sent.md): Activates a draft invoice for payment WITHOUT emailing it — for Merchants who share the public link themselves. Advances Draft to Sent so the pay link becomes live. - [Void Invoice](https://docs.dimepayments.com/api-reference/invoice-management/void-invoice.md): Voids an invoice. Voiding is terminal — the invoice can no longer be paid. An already void or refunded invoice cannot be voided again. - [Duplicate Invoice](https://docs.dimepayments.com/api-reference/invoice-management/duplicate-invoice.md): Clones any invoice into a new draft (copying its line items) with a freshly allocated invoice number. - [Pay Invoice](https://docs.dimepayments.com/api-reference/invoice-management/pay-invoice.md): Records a merchant-initiated (MOTO) payment against an open invoice, charging a credit card (raw card or a stored token) or a bank account (ACH) through the processor. Mirrors the card/ACH charge endpoints but targets the invoice: the amount is the invoice balance (or a partial amount when the invoi… - [Get Invoice Link](https://docs.dimepayments.com/api-reference/invoice-management/get-invoice-link.md): Returns the public pay link (and token) for an invoice. - [Add Line Item](https://docs.dimepayments.com/api-reference/invoice-management/add-line-item.md): Appends a single line item to a draft invoice and recalculates totals. - [Update Line Item](https://docs.dimepayments.com/api-reference/invoice-management/update-line-item.md): Updates a single line item on a draft invoice. Only the fields you pass are changed; the line amount is recomputed and invoice totals refreshed. - [Delete Line Item](https://docs.dimepayments.com/api-reference/invoice-management/delete-line-item.md): Removes a single line item from a draft invoice and recalculates totals. - [List Invoice Items](https://docs.dimepayments.com/api-reference/invoice-management/list-invoice-items.md): Lists the Merchant's items (funds/designations) available to use as invoice line items, ordered alphabetically. - [Create Invoice Item](https://docs.dimepayments.com/api-reference/invoice-management/create-invoice-item.md): Creates an invoicing-only item (fund/designation) for the Merchant. The item is hidden from public giving pages and can be referenced as a line item's `item_id`. - [List Recurring Invoices](https://docs.dimepayments.com/api-reference/invoice-management/list-recurring-invoices.md): Retrieves a paginated (cursor) list of recurring-invoice templates for a Merchant, optionally filtered by status. - [Show Recurring Invoice](https://docs.dimepayments.com/api-reference/invoice-management/show-recurring-invoice.md): Retrieves a single recurring-invoice template with its line items, the invoices it has generated (the 50 most recent), and the upcoming run dates. - [Create Recurring Invoice](https://docs.dimepayments.com/api-reference/invoice-management/create-recurring-invoice.md): Creates a recurring-invoice template. The template carries its own snapshot of the line items and requires a linked customer (used to resolve the email on every run). When the start date is today the first invoice is generated and sent immediately; a future start date just schedules the first run. - [Cancel Recurring Invoice](https://docs.dimepayments.com/api-reference/invoice-management/cancel-recurring-invoice.md): Cancels an active recurring-invoice template. No further invoices are generated. Only active templates can be cancelled. - [List payment methods for a customer](https://docs.dimepayments.com/api-reference/payment-method-management/list-payment-methods-for-a-customer.md): This endpoint shows all payment methods for a customer. Must pass at least one filter to select a specific customer - [Show a Payment Method for a customer](https://docs.dimepayments.com/api-reference/payment-method-management/show-a-payment-method-for-a-customer.md): This endpoint shows a specific payment method for a customer. Must pass at least one filter to select a specific customer - [Create a Payment Method for a customer](https://docs.dimepayments.com/api-reference/payment-method-management/create-a-payment-method-for-a-customer.md): This endpoint creates a new payment method for a customer. Must pass at least one filter to select a specific customer - [Update a Payment Method for a customer](https://docs.dimepayments.com/api-reference/payment-method-management/update-a-payment-method-for-a-customer.md): This endpoint updates a payment method for a customer. Must pass at least one filter to select a specific customer - [Delete a Payment Method for a customer](https://docs.dimepayments.com/api-reference/payment-method-management/delete-a-payment-method-for-a-customer.md): This endpoint deletes a payment method for a customer. Must pass at least one filter to select a specific customer - [List Recurring Payments](https://docs.dimepayments.com/api-reference/recurring-payments-management/list-recurring-payments.md): Retrieves a list of recurring payments for a given Merchant, filtered by various parameters. - [Pause Recurring Payment](https://docs.dimepayments.com/api-reference/recurring-payments-management/pause-recurring-payment.md): Pauses a scheduled recurring payment. If pause_until_date is not passed, it will be set to 2099-12-31 - [Cancel Recurring Payment](https://docs.dimepayments.com/api-reference/recurring-payments-management/cancel-recurring-payment.md): Cancels a scheduled recurring payment. - [Activate Recurring Payment](https://docs.dimepayments.com/api-reference/recurring-payments-management/activate-recurring-payment.md): Activates a scheduled recurring payment. Set to status of Active and calculates next run date. - [Edit Recurring Payment](https://docs.dimepayments.com/api-reference/recurring-payments-management/edit-recurring-payment.md): Edits an existing recurring payment. All fields other than `sid` and `recurring_payment_id` are optional; only the fields you pass will be updated. The customer cannot be changed, and a new payment method must belong to the recurring payment's existing customer. When `recurrence_schedule` or `start_… - [Create Recurring Payment](https://docs.dimepayments.com/api-reference/recurring-payments-management/create-recurring-payment.md): Creates a scheduled recurring payment. The payment will run on the next date based on schedule and start date. So if you create one that starts on 2025-01-01 00:00:00 with Monthly, then the payment method will be charged on 2025-02-01 Recurring Payments run around 0500 EST. - [Show Recurring Payment](https://docs.dimepayments.com/api-reference/recurring-payments-management/show-recurring-payment.md): Show details of a scheduled recurring payment. - [Delete Recurring Payment](https://docs.dimepayments.com/api-reference/recurring-payments-management/delete-recurring-payment.md): Delete a recurring payment. - [List subscription plans](https://docs.dimepayments.com/api-reference/subscription-plans-management/list-subscription-plans.md) - [Show a subscription plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/show-a-subscription-plan.md) - [Create a subscription plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/create-a-subscription-plan.md): The plan is created as a draft. Publish it (or use the merchant UI) before customers can subscribe. - [Update a subscription plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/update-a-subscription-plan.md): Replaces the plan's fields and line items wholesale. Existing subscribers keep their own snapshot and are unaffected. - [Delete a subscription plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/delete-a-subscription-plan.md): Only plans with no subscribers can be deleted; otherwise archive it. - [Publish a subscription plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/publish-a-subscription-plan.md): Moves a draft plan to active so customers can subscribe. The plan must be a draft and carry at least one line item. - [Archive a subscription plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan.md): Stops new subscriptions and hides it from the catalog. Existing subscribers keep their subscription. - [Reactivate a subscription plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/reactivate-a-subscription-plan.md): Moves an archived plan back to draft so it can be reviewed and re-published. `allow_public` stays off until the merchant opts back into the catalog. - [Subscribe a customer to a plan](https://docs.dimepayments.com/api-reference/subscription-plans-management/subscribe-a-customer-to-a-plan.md): Charges the first payment against the customer's saved payment method and enrolls them in the plan. The plan must be active. Fires SUBSCRIPTION_CREATED. - [List subscriptions](https://docs.dimepayments.com/api-reference/subscriptions-management/list-subscriptions.md): A merchant with nothing to show answers **200 with an empty `data` array**, not a 404. A 404 from this endpoint means the merchant itself was not found. - [Show a subscription](https://docs.dimepayments.com/api-reference/subscriptions-management/show-a-subscription.md) - [Pause a subscription](https://docs.dimepayments.com/api-reference/subscriptions-management/pause-a-subscription.md): Pauses an active subscription until the given date. If `data.pause_until_date` is omitted it pauses indefinitely. Fires the `SUBSCRIPTION_PAUSED` webhook. - [Resume a subscription](https://docs.dimepayments.com/api-reference/subscriptions-management/resume-a-subscription.md): Reactivates a paused subscription and recomputes its next charge date. Fires the `SUBSCRIPTION_RESUMED` webhook. - [Cancel a subscription](https://docs.dimepayments.com/api-reference/subscriptions-management/cancel-a-subscription.md): Permanently cancels a subscription — no further charges are made. Fires the `SUBSCRIPTION_CANCELLED` webhook. - [Get New Customers](https://docs.dimepayments.com/api-reference/zapier/get-new-customers.md): Get a list of all new customers since the last time it was checked. - [Get Transactions](https://docs.dimepayments.com/api-reference/zapier/get-transactions.md): Get a list of all transactions for a Merchant - [Get Transactions by Customer](https://docs.dimepayments.com/api-reference/zapier/get-transactions-by-customer.md): Get a list of all transactions for a given customer using their phone number - [Get Most Recent Transaction](https://docs.dimepayments.com/api-reference/zapier/get-most-recent-transaction.md): Get the most recent transactions details ## OpenAPI Specs - [openapi](https://app.dimepayments.com/openapi.yaml) - [openapi](/openapi.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.