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.

Download OpenAPI description
partner-integration-api-reference.json
partner-integration-api-reference.yaml
Languages
Servers
Mock server
https://developer.adfin.com/_mock/products/partner-integration/partner-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

Recurring invoices

Operations

Payment requests

Operations

Recurring payment requests

Operations

Payments

Operations

Payouts

Operations

Tax rates

Operations

Items

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

List the referred billers

Request

This endpoint should be used for tracking referrals from the moment a user registered under a referral link or code that belongs to the caller. The caller is identified from the authentication token provided.

Security
Biller Access Token (Staging) or Platform Bearer Token or Biller Access Token (Production)
Query
referralCodestring

Return only referrals for this referral link or code.

lastUpdatedTimestring(date-time)

Return only referrals updated at or after this time.

curl -i -X GET \
  'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/referrals/billers?referralCode=string&lastUpdatedTime=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
referredBillersArray of objects(ReferredBillerResponse)

The referred billers matching the request, oldest referral first.

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