Python SDK

pip install dime-python-sdk

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"

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,
))

# 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,
})

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)

# 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)

# Disputes on the merchant, and the documents that answer one
chargebacks = dime.chargebacks.list('YOUR_SID', {'representment_status': 'New'})
dime.documents.upload('YOUR_SID', 'RetrievalRequest', ['/path/to/receipt.pdf'],
                      chargeback_transaction_info_id=chargebacks.data[0].transaction_info_id)

# Held funds (affiliate keys only). The idempotency key makes a retry safe.
balance = dime.funds.balance('YOUR_SID')
result = dime.funds.release('YOUR_SID', 'payout-2026-10-06', amount=balance.releasable)
if result.release.status != 'released':
    pass  # 'failed' (declined, nothing moved) or 'unknown' (check again before retrying)

txn = dime.transactions.charge_card_token('YOUR_SID', {
    'amount': '49.99',
    'token': 'abc123def456',
    # ...
}, idempotency_key='order-1234-charge')

# Place a hold
auth = dime.transactions.authorize('YOUR_SID', {
    'amount': '100.50',
    'token': 'tok_abc123',
    'phone': '+17701234567',
})

# Capture all of it, or pass a smaller amount
dime.transactions.capture('YOUR_SID', auth.transaction_number, amount='87.25')

# Or release the hold without charging
dime.transactions.void('YOUR_SID', 'CC', auth.transaction_number)

status = dime.merchants.application_status('YOUR_SID')

if status.boarded:
    pass  # The merchant can take payments

# Enroll a customer in a published plan. Charges the first period.
result = dime.subscription_plans.subscribe(
    'YOUR_SID',
    plan_id,
    customer.uuid,
    payment_method_id,
)

dime.subscriptions.pause('YOUR_SID', subscription_id)
dime.subscriptions.resume('YOUR_SID', subscription_id)
dime.subscriptions.cancel('YOUR_SID', subscription_id)

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())