What has happened to a customer, invoice, payment request or schedule.
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
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/
Request
The plan is a forecast rather than a record. It is recalculated as other activity changes what is needed, so a row is only true as at the moment it is read. While a recalculation is outstanding the plan is a single REASSESS row and nothing else.
Security
Biller Access Token (Staging) or Biller Access Token (Production)
Query
The kind of record to read the plan for. Required, together with entityId. Only CUSTOMER and PAYMENT_REQUEST have a plan.
Enum"INVOICE""PAYMENT_REQUEST""CUSTOMER""SCHEDULE"
Example: entityType=CUSTOMER
The record to read the plan for, as a UUID. Required, together with entityType.
Example: entityId=3fa85f64-5717-4562-b3fc-2c963f66afa6
How many rows to return per page. A request for more than the maximum is refused.
Default 50
Example: size=50
- Mock serverhttps://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/scheduled_activities
- Production API Server URLhttps://api.adfin.com/api/scheduled_activities
- Staging API Server URLhttps://api.staging.adfin.com/api/scheduled_activities
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/scheduled_activities?entityType=CUSTOMER&entityId=3fa85f64-5717-4562-b3fc-2c963f66afa6&page=1&size=50&sort=scheduledAt%2Casc' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'A page of the plan, soonest first unless another order was asked for. An empty list means nothing is planned.
What is planned, soonest first unless another order was asked for.
This row, for reading the message it would send. Opaque, and only good for as long as the plan is unchanged.
The kind of record it is planned against.
Enum"INVOICE""PAYMENT_REQUEST""CUSTOMER""SCHEDULE"
What is planned.
Enum"SEND_NOTIFICATION""SEND_CUSTOMER_STATEMENT""SEND_DIRECT_DEBIT_COLLECTION_NOTICE""SEND_CARD_COLLECTION_NOTICE""SEND_MANDATE_REQUEST""SEND_MANDATE_REMINDER""SEND_CARD_REQUEST""SEND_CARD_REMINDER""MAKE_PAYMENT""COLLECT_DIRECT_DEBIT_PAYMENT"
What can be done about it. Empty where there is nothing to offer.
Response
application/json
{ "activities": [ { … } ], "pagination": { "page": 0, "size": 0, "totalPages": 0, "totalElements": 0, "numberOfElements": 0, "sort": "string" } }