Skip to content
/
Retrieve bulk payment req...

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

Retrieve bulk payment request import job details

Request

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

The ID of the bulk payment request import job

curl -i -X GET \
  'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/bulk_import/{jobId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The bulk payment request import job details were successfully retrieved.

Bodyapplication/json
jobIdstringrequired

The internal id of the bulk import job

typestringrequired

The type of the import job

Value"BULK_PAYMENT_REQUEST_IMPORT"
statusstringrequired

The status of the import job

Enum"PENDING""PROCESSING""COMPLETED""FAILED""DELETED"
creationTimestring(date-time)required

The creation time of the import job

countsByItemStatusArray of objects(ReviewSessionItemCountByStatus)required

The count of items for each review session item status

countsByItemStatus[].​statusstringrequired

The status of review session item

Enum"PENDING""PROCESSING""COMPLETED""FAILED"
countsByItemStatus[].​countinteger(int32)required

The count of items for this status

Response
application/json
{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "type": "BULK_PAYMENT_REQUEST_IMPORT",
  "status": "COMPLETED",
  "creationTime": "2024-01-15T10:30:00Z",
  "countsByItemStatus": [
    { … },
    { … }
  ]
}

Retrieve bulk payment request import job items

Request

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

The ID of the bulk payment request import job

Query
statusesArray of strings

The status of the bulk payment request import job item

  • PENDING: The item is still to be processed.
  • PROCESSING: The item is currently processing.
  • COMPLETED: The item has been processed.
  • FAILED: The item has failed to be processed.
Items Enum"PENDING""PROCESSING""COMPLETED""FAILED"
pageinteger>= 0

Zero-based page index (0..N)

Default 0
sizeinteger>= 1

The size of the page to be returned

Default 20
sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Default ["creationTime,ASC"]
curl -i -X GET \
  'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/bulk_import/{jobId}/items?statuses=PENDING&page=0&size=20&sort=creationTime%2CASC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Paginated response for the list of bulk payment request import job items

Bodyapplication/json
itemsArray of objects(BulkPaymentRequestImportItemResponse)

The bulk payment request import job items for the current page

paginationobject(Pagination)
Response
application/json
{
  "items": [
    { … },
    { … }
  ],
  "pagination": {
    "page": 0,
    "size": 20,
    "totalElements": 155,
    "totalPages": 8
  }
}

Cancel a payment requestDeprecated

Request

This endpoint is deprecated and will be removed in a future release. Use /{id}:void instead

Security
Biller Access Token (Staging) or Biller Access Token (Production)
Path
idstringrequired

The ID of the payment request

curl -i -X PUT \
  'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/{id}:cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The payment request has been cancelled

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