Python SDK

Installation

Requires Python 3.10+

pip install dime-python-sdk

Quickstart

from dime_payments import Client

dime = Client('your-api-token')

txn = dime.transactions.charge_card('YOUR_SID', {
    'amount': '49.99',
    'token': 'tok_abc123',
})

print(txn.transaction_status)  # "Success"

Configuration

from dime_payments import Client, Config

# Simple setup
dime = Client('your-api-token')

# Full control
dime = Client(Config(
    token='your-api-token',
    base_url='https://app.dimepayments.com',
    timeout=30.0,
    max_retries=2,
))

Available Resources

Property	Endpoints
`dime.transactions`	charge_card, charge_ach, tokenize_card, refund, void, show, list
`dime.customers`	list, show, create, update, delete
`dime.payment_methods`	list, show, create, update, delete
`dime.merchants`	list, show, create, update, get_form_link
`dime.addresses`	list, show, create, update, delete
`dime.deposits`	list, list_with_transactions, show
`dime.recurring_payments`	list, show, create, edit, pause, cancel, activate, delete
`dime.invoices`	list, show, create, update, delete, send, mark_sent, void, duplicate, pay, get_link, add_line_item, update_line_item, delete_line_item, list_items, create_item
`dime.recurring_invoices`	list, show, create, cancel

Invoices

Requires v1.2.0 or later. Earlier published versions had no working invoices resource.

Invoices are built from line items that each reference a merchant item (a fund or designation). Draft invoices can be edited; once sent they are locked. Identify the customer with customer_uuid — the same uuid every other resource uses, and the only identifier the customer endpoints return.

# Look up (or create) the items a line can reference
item = dime.invoices.create_item('YOUR_SID', {
    'name': 'Consulting',
    'price': 125,
    'tax_deductible': False,
})

# Create a draft invoice
invoice = dime.invoices.create('YOUR_SID', {
    'customer_uuid': customer.uuid,
    'customer_name': 'Jane Doe',
    'customer_email': 'jane@example.com',
    'payment_terms': 'net_15',  # due_on_receipt | net_15 | net_30 | net_60
    'lines': [
        {'item_id': item.id, 'name': 'Consulting', 'quantity': 2, 'unit_price': 125},
    ],
})

# Email it, or activate the pay link without emailing
dime.invoices.send('YOUR_SID', invoice.id)
dime.invoices.mark_sent('YOUR_SID', invoice.id)

# Share the public pay link
print(dime.invoices.get_link('YOUR_SID', invoice.id).public_url)

# Take a merchant-initiated payment. payment_type is required; omit amount to
# pay the full balance.
dime.invoices.pay('YOUR_SID', invoice.id, {
    'payment_type': 'cc',  # cc | ach
    'token': 'tok_abc123',
    'amount': 125,
})

Statuses

invoice.status is one of draft, sent, viewed, partially_paid, paid, void or refunded — lowercase. Compare against paid to detect settlement; partially_paid means a payment landed but a balance remains, which invoice.balance reports. There is no overdue status — being overdue is a property of an open invoice past its due date and reads as invoice.is_overdue. overdue and all are accepted as filter values on list().

Recurring invoices

template = dime.recurring_invoices.create('YOUR_SID', {
    'customer_uuid': customer.uuid,
    'payment_terms': 'net_30',
    'recurring_frequency': 'Monthly',  # Weekly | Biweekly | FirstFifteenth | Monthly | Yearly
    'recurring_start_date': '2026-09-01',
    'lines': [
        {'item_id': item.id, 'name': 'Retainer', 'quantity': 1, 'unit_price': 500},
    ],
})

dime.recurring_invoices.cancel('YOUR_SID', template.id)

Pagination

# Stream all transactions across every page
for txn in dime.transactions.list('YOUR_SID', {
    'start_date': '2026-01-01 00:00:00',
    'end_date':   '2026-01-31 23:59:59',
}).auto_paging():
    print(txn.amount)

Error Handling

from dime_payments import DimeException, ValidationException

try:
    dime.transactions.charge_card('YOUR_SID', {'amount': '0'})
except ValidationException as e:
    print(e.get_errors())  # {'data.amount': ['must be greater than 0']}
except DimeException as e:
    print(e.get_status_code())

Getting Started

SDKs

Going Live

Integrations

Reference

Installation

Quickstart

Configuration

Available Resources

Invoices

Statuses

Recurring invoices

Error Handling

Links

​Installation

​Quickstart

​Configuration

​Available Resources

​Invoices

​Statuses

​Recurring invoices

​Pagination

​Error Handling

​Links

Installation

Quickstart

Configuration

Available Resources

Invoices

Statuses

Recurring invoices

Pagination

Error Handling

Links