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

Retrieves a biller

Request

Fetches the details of the authenticated user's associated biller. Returns a 404 if no biller is found.

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

Responses

The biller details retrieved successfully

Bodyapplication/json
idstringrequired

The unique identifier of the biller.

namestring[ 0 .. 255 ] charactersrequired

The legal registration name of the company.

statementNamestring[ 0 .. 22 ] charactersrequired

The biller statement name shown on bank and credit card statements.

aliasstring[ 0 .. 50 ] charactersrequired

The short name of the biller.

registrationNostringrequired

The registration number of the company.

currencyCodestringrequired

The default currency of the biller.. Possible values (non-exclusive): AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SPL, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMW, ZWD

countryCodestringrequired

The default country code of the biller.

timezonestringrequired

The default timezone of the biller.

websitestring

The website of the biller.

categoryCodestring

The merchant category code (MCC) representing the business type.

industryCodestring

The industry code that represents the industry of the biller.

legalEntityTypestringrequired

The legal entity type of the biller.. Possible values (non-exclusive): organization, soleProprietorship

vatRegistrationNostring

The VAT registration number of the biller.

billingEmailstring

The email address for billing purposes.

emailDomainstring

The email domain of the biller.

paymentDetailsArray of objects(PaymentDetails)

The list of payment details associated with the biller.

bankAccountsArray of objects(BankAccountResponse)

The list of bank accounts associated with the biller.

locationsArray of objects(Location)

The registered business locations of the biller.

statusstringrequired

The status of the biller. Possible values (non-exclusive): PENDING, VERIFIED, ACTIVE, INACTIVE, LAPSED, BLACKLISTED

channelBillerIdstring

The identifier of the biller associated with the payment provider.

paymentSettingsobject(PaymentSettingsResponse)

Payment settings response details

accountingSettingsobject(AccountingSettingsResponse)

The accounting settings of the biller.

externalDataArray of objects(BillerExternalData)

References about this biller from external platforms Adfin integrates with, such as ID, etc.

Response
application/json
{
  "id": "string",
  "name": "string",
  "statementName": "string",
  "alias": "string",
  "registrationNo": "string",
  "currencyCode": "string",
  "countryCode": "string",
  "timezone": "string",
  "website": "string",
  "categoryCode": "string",
  "industryCode": "string",
  "legalEntityType": "string",
  "vatRegistrationNo": "string",
  "billingEmail": "string",
  "emailDomain": "string",
  "paymentDetails": [
    { … }
  ],
  "bankAccounts": [
    { … }
  ],
  "locations": [
    { … }
  ],
  "status": "string",
  "channelBillerId": "string",
  "paymentSettings": {
    "status": "string",
    "paymentMethods": [ … ],
    "entityId": "string",
    "entityType": "string"
  },
  "accountingSettings": {
    "connectors": [ … ]
  },
  "externalData": [
    { … }
  ]
}

Patch a Biller

Request

Applies JSON Patch operations to update specific biller fields.

Security
Biller Access Token (Staging) or Biller Access Token (Production)
Bodyapplication/json-patch+jsonrequired
operationsArray of AddOperation (object) or CopyOperation (object) or MoveOperation (object) or RemoveOperation (object) or ReplaceOperation (object) or TestOperation (object)

Patch operations to be applied to biller

curl -i -X PATCH \
  https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/biller \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "operations": [
      {
        "op": "string",
        "path": {
          "empty": true
        },
        "value": {}
      }
    ]
  }'

Responses

The biller was successfully patched.

Customers

Operations

Direct debit mandates

Operations

Invoices

Operations

Recurring invoices

Operations

Payment requests

Operations

Recurring payment requests

Operations

Payments

Operations

Tax rates

Operations

Items

Operations

Workflows

Operations

Webhooks

Operations