Skip to content
/
Retrieve a payout

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
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

Verifications

Operations

Customers

Operations

Direct debit mandates

Operations

Invoices

Operations

Recurring invoices

Operations

Payment requests

Operations

Recurring payment requests

Operations

Payments

Operations

Payouts

Operations

List payouts

Request

Returns the payouts Adfin has made to the bank account.

Security
Biller Access Token (Production) or Biller Access Token (Staging)
Query
statusArray of strings

Only return payouts in these states. Repeat the parameter to name more than one, combined with OR. Omit it to return every state.

Items Enum"PROCESSING""SENT""FAILED""RETURNED"
Example: status=SENT
minPayoutDatestring(date)

Only return payouts paid out on or after this date. Inclusive.

Example: minPayoutDate=2026-08-01
maxPayoutDatestring(date)

Only return payouts paid out on or before this date. Inclusive.

Example: maxPayoutDate=2026-08-31
pageinteger(int32)>= 1

Which page to return, counting from one.

Default 1
Example: page=1
sizeinteger(int32)[ 1 .. 200 ]

How many payouts to return per page. A request for more than the maximum is refused.

Default 50
Example: size=50
sortstring

How to order the page.

Default "payoutDate,desc"
Enum"payoutDate,desc""payoutDate,asc"
curl -i -X GET \
  'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/payouts?status=SENT&minPayoutDate=2026-08-01&maxPayoutDate=2026-08-31&page=1&size=50&sort=payoutDate%2Cdesc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested page of payouts.

Bodyapplication/json
payoutsArray of objects(PayoutResponse)required

The payouts

payouts[].​idstring(uuid)required

The id of the payout

payouts[].​statusstringrequired

The status of the payout

Enum"PROCESSING""SENT""FAILED""RETURNED"
payouts[].​totalAmountnumberrequired

The total amount of the payout

payouts[].​currencyCodestringrequired

The currency of the payout

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
payouts[].​payoutDatestring(date)required

The working day the money is paid out to the bank account. This is not the day the customer paid.

Example: "2026-08-24"
payouts[].​creationTimestring(date-time)required

The time the payout was created

payouts[].​lastUpdatedTimestring(date-time)required

The time the payout was last updated

payouts[].​referencestring

The reference that appears on the bank statement

payouts[].​payoutItemsCountinteger(int32)required

The number of items that make up the payout

paginationobject(Pagination)required
pagination.​pageinteger(int32)

The current page number One-based page index (1..N).

pagination.​sizeinteger(int32)

The size of the page, i.e., the number of elements per page.

pagination.​totalPagesinteger(int32)

The total number of pages available.

pagination.​totalElementsinteger(int64)

The total number of elements across all pages.

pagination.​numberOfElementsinteger(int64)

The number of elements in the current page.

pagination.​sortstring

Sorting criteria in the format: property,(asc|desc).

Response
application/json
{
  "payouts": [
    { … }
  ],
  "pagination": {
    "page": 0,
    "size": 0,
    "totalPages": 0,
    "totalElements": 0,
    "numberOfElements": 0,
    "sort": "string"
  }
}

Retrieve a payout

Request

Returns one payout.

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

The id of the payout

curl -i -X GET \
  'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/payouts/{payoutId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The payout.

Bodyapplication/json
idstring(uuid)required

The id of the payout

statusstringrequired

The status of the payout

Enum"PROCESSING""SENT""FAILED""RETURNED"
totalAmountnumberrequired

The total amount of the payout

currencyCodestringrequired

The currency of the payout

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
payoutDatestring(date)required

The working day the money is paid out to the bank account. This is not the day the customer paid.

Example: "2026-08-24"
creationTimestring(date-time)required

The time the payout was created

lastUpdatedTimestring(date-time)required

The time the payout was last updated

referencestring

The reference that appears on the bank statement

payoutItemsCountinteger(int32)required

The number of items that make up the payout

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "PROCESSING",
  "totalAmount": 0,
  "currencyCode": "AED",
  "payoutDate": "2026-08-24",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastUpdatedTime": "2019-08-24T14:15:22Z",
  "reference": "string",
  "payoutItemsCount": 0
}

Retrieve the breakdown of a payout

Request

Returns the items that make up the payout. The item amounts sum to the payout total amount.

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

The id of the payout

Query
pageinteger(int32)>= 1

Which page to return, counting from one.

Default 1
Example: page=1
sizeinteger(int32)[ 1 .. 200 ]

How many items to return per page. A request for more than the maximum is refused.

Default 50
Example: size=50
sortstring

How to order the page.

Default "creationTime,desc"
Enum"creationTime,desc""creationTime,asc"
curl -i -X GET \
  'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/payouts/{payoutId}/items?page=1&size=50&sort=creationTime%2Cdesc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested page of the breakdown.

Bodyapplication/json
itemsArray of objects(PayoutItemResponse)required

The items that make up the payout

items[].​idstring(uuid)required

The id of the item

items[].​typestringrequired

The type of the item

Enum"PAYMENT""PAYOUT"
items[].​statusstringrequired

The status of the item

Enum"SUCCESS""FAILURE"
items[].​amountnumberrequired

The amount of the item

items[].​currencyCodestringrequired

The currency of the item

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
items[].​paymentMethodstring

The method the payment was collected with. Set for PAYMENT items.

Enum"CARD""APPLE_PAY""GOOGLE_PAY""AMEX""OPEN_BANKING""DIRECT_DEBIT""BANK_TRANSFER""EXTERNAL_BANK_ACCOUNT""IMPORTED"
items[].​customerobject(CustomerDetails)
items[].​paymentRequestsArray of objects(PaymentRequestDetails)

The payment requests the payment was applied to. Set for PAYMENT items.

items[].​receiptNostring

The receipt number

items[].​creationTimestring(date-time)required

The time the item was created

paginationobject(Pagination)required
pagination.​pageinteger(int32)

The current page number One-based page index (1..N).

pagination.​sizeinteger(int32)

The size of the page, i.e., the number of elements per page.

pagination.​totalPagesinteger(int32)

The total number of pages available.

pagination.​totalElementsinteger(int64)

The total number of elements across all pages.

pagination.​numberOfElementsinteger(int64)

The number of elements in the current page.

pagination.​sortstring

Sorting criteria in the format: property,(asc|desc).

Response
application/json
{
  "items": [
    { … }
  ],
  "pagination": {
    "page": 0,
    "size": 0,
    "totalPages": 0,
    "totalElements": 0,
    "numberOfElements": 0,
    "sort": "string"
  }
}

Tax rates

Operations

Items

Operations

Workflows

Operations

Activities

What has happened to a customer, invoice, payment request or schedule.

Operations

Scheduled Activities

Operations

Webhooks

Operations