Introduction to Adfin Core
Resources
Resource | What it represents | Typical operations |
---|---|---|
Customer | A customer record with contact details, mandate status. | Create/update / list / delete customers (/customers endpoints). |
Invoice | A bill was issued to a customer. Includes line-items, taxes, due dates, and a unique invoice number. Invoices are distributed via Adfin. | Draft, activate, void, mark-as-paid, or bulk list via /invoices and /invoices/[id]. |
Payment Request | A demand for funds—one-off, partial, or multi-invoice. | Draft → Activate / Cancel; filter, paginate |
Direct debit | Consent to pull funds from the customer’s bank. | Create or cancel mandates per customer (/customers/[id]/directdebitmandates |
Webhook | Outbound events that keep your system in sync (e.g., invoice paid). | Configure per application |
Typical integration
Typical integration flow
- Create or sync the customer in Adfin as soon as you capture them in your platform (POST /customers).
- Push your invoice (or credit note) exactly as it exists in your accounting system; totals are accepted “as-is” so rounding stays consistent (POST /invoices).
- OR Raise a payment request. Choose the workflow:
- AUTO_COLLECT schedules Direct Debit automatically if the mandate is ACTIVE.
- ON_DEMAND generates a hosted checkout for card/open-banking.
- Activate the invoice or payment request when you’re ready to bill; Adfin emails the payer and, if relevant, queues the bank file.
- Listen for webhooks such as payment. Success, invoice paid or DD mandate. Updated to drive your UI and reconciliation.
Use cases and design
Bring-your-own-ledger
Adfin never alters invoice amounts; you can send pre-calculated totals, tax, and references. You can master your sales ledger and use payment requests or invoicing to drive payments via Adfin.
Users can also connect accounting software, such as Xero and QuickBooks, where any invoice created in Adfin can flow to the connected accounting software. This means you do not have to maintain the integration yourself.
One-time payment requests for clients
Payment requests can be used to generate payment links to display as part of a flow. For example, using Adfin to collect a payment on a client signing up, as well as setting up a direct debit processing. All invoices and payment requests are linked to a single customer.
Lightweight commerce for merchants
Payment requests (with no chasing or reminders) can be used to use Adfin payment links as a hosted payment page. Simply create the customer, create a payment request, and redirect the user to the payment request URL that is returned in the body.
Updated 16 days ago