Skip to content

Adfin API (1.0.0)

Adfin uses OAuth 2.0 access tokens to authenticate all API requests.

There are two contexts in which tokens are issued:

  • Biller Access Tokens — Generated via the Authorization Code flow when a biller connects their Adfin account. These tokens grant access to that biller's data (invoices, payment requests, customers, etc.).

  • Platform Access Tokens — Generated via the Client Credentials flow when a platform authenticates as itself rather than as one of its billers. A platform uses one to manage its own webhook subscriptions under /api/apps/{clientId}/webhooks.

Languages
Servers
Mock server
https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/
Production API Server URL
https://api.adfin.com/api/
Staging API Server URL
https://api.staging.adfin.com/api/

oAuth2

Operations

Biller

Operations

Verifications

Operations

Customers

Operations

Direct debit mandates

Operations

Invoices

Operations

Get the file for a specific invoice

Request

Security
Biller Access Token (Staging) or Biller Access Token (Production)
Path
idstringrequired
curl -i -X GET \
  'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{id}/file' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The invoice file is successfully returned

Bodyapplication/octet-stream
any(StreamingResponseBody)

Cancel an imported credit note

Request

Cancel a credit note imported through the API. The amount returns to the amount due of the invoice.

Security
Biller Access Token (Staging) or Biller Access Token (Production)
Path
invoiceIdstring(uuid)required

The id of the invoice

creditNoteIdstring(uuid)required

The id of the credit note

curl -i -X DELETE \
  'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{invoiceId}/credit_notes/{creditNoteId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Credit note successfully cancelled.

Recurring invoices

Operations

Payment requests

Operations

Recurring payment requests

Operations

Payments

Operations

Payouts

Operations

Tax rates

Operations

Items

Operations

Account codes

Operations

Activities

What has happened to a customer, invoice, payment request or schedule.

Operations

Scheduled Activities

What is planned next for a customer or a payment request.

Operations

Webhooks

Operations

Referrals

Operations