Skip to content
/
Retrieve autopilot guidan...

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
prod.json
prod.yaml
Languages
Servers
Mock server
https://developer.adfin.com/_mock/api-docs/prod/
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

Tax rates

Operations

Items

Operations

Workflows

Operations

Webhooks

Operations

Customer Autopilot Settings

Operations for managing customer-level autopilot settings

Operations

Retrieve autopilot guidance for a customer.

Request

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

The unique identifier of the customer.

curl -i -X GET \
  'https://developer.adfin.com/_mock/api-docs/prod/customers/{customerId}/autopilot_settings' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The guidance was retrieved successfully.

Bodyapplication/json
customerIdstring

The unique identifier of the customer.

settingsobject(Settings)
Response
application/json
{
  "customerId": "string",
  "settings": {
    "id": "string",
    "guidance": "string",
    "creationTime": "2019-08-24T14:15:22Z",
    "lastUpdatedTime": "2019-08-24T14:15:22Z"
  }
}

Create or update autopilot guidance for a customer.

Request

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

The unique identifier of the customer.

Bodyapplication/jsonrequired
guidancestring[ 0 .. 2000 ] charactersrequired

Free-text guidance for autopilot workflow generation. Maximum 2000 characters.

curl -i -X PUT \
  'https://developer.adfin.com/_mock/api-docs/prod/customers/{customerId}/autopilot_settings' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "guidance": "string"
  }'

Responses

The request was successful.

Bodyapplication/json
customerIdstring

The unique identifier of the customer.

settingsobject(Settings)
Response
application/json
{
  "customerId": "string",
  "settings": {
    "id": "string",
    "guidance": "string",
    "creationTime": "2019-08-24T14:15:22Z",
    "lastUpdatedTime": "2019-08-24T14:15:22Z"
  }
}

Delete autopilot guidance for a customer.

Request

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

The unique identifier of the customer.

curl -i -X DELETE \
  'https://developer.adfin.com/_mock/api-docs/prod/customers/{customerId}/autopilot_settings' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The guidance was deleted.