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 for Adfin's own integrations and system events. These tokens authenticate Adfin as the platform itself (not as a specific biller) and are required for endpoints like /api/webhook.

Download OpenAPI description
direct-integration-api-reference.json
direct-integration-api-reference.yaml
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

Customers

Operations

Direct debit mandates

Operations

Invoices

Operations

Recurring invoices

Operations

Payment requests

Operations

Recurring payment requests

Operations

Payments

Operations

Import a payment

Request

Import a payment against an invoice with a custom reference.

Security
Biller Access Token (Production) or Biller Access Token (Staging)
Bodyapplication/jsonrequired
invoiceIdstringrequired

ID of the invoice to apply payment to

Example: "123e4567-e89b-12d3-a456-426614174000"
amountnumberrequired

Payment amount

Example: 100.5
referencestringrequired

Unique payment reference identifier for tracking

Example: "REF-20250104"
curl -i -X POST \
  https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/payments:import \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 100.5,
    "reference": "REF-20250104"
  }'

Responses

Payment successfully imported. Returns the created payment records.

Bodyapplication/json
paymentsArray of objects(PaymentResponse)

The list of payments created as a result of the import

Response
application/json
{
  "payments": [
    { … }
  ]
}

Tax rates

Operations

Items

Operations

Workflows

Operations

Webhooks

Operations