Skip to content
/
Cancel an imported paymen...

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

Import a payment

Request

Import a payment against a payment request with a custom reference. The payment request must be a standalone payment request or a payment request with a one-to-one invoice association.

Security
Biller Access Token (Production) or Biller Access Token (Staging)
Bodyapplication/jsonrequired
paymentRequestIdstring(uuid)required

ID of the payment request to apply the payment to. The payment request must be a standalone payment request or a payment request with a one-to-one invoice association.

Example: "123e4567-e89b-12d3-a456-426614174000"
amountnumberrequired

Payment amount

Example: 100.5
referencestringnon-emptyrequired

Unique payment reference identifier for tracking. A reference can be used once per payment request. It can be used again after that payment is cancelled.

Example: "REF-20250104"
curl -i -X POST \
  https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payments:import \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentRequestId": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 100.5,
    "reference": "REF-20250104"
  }'

Responses

Payment successfully imported.

Cancel an imported payment

Request

Cancel an imported payment for a payment request.

Security
Biller Access Token (Production) or Biller Access Token (Staging)
Path
paymentIdstring(uuid)required
curl -i -X DELETE \
  'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payments/{paymentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Payment successfully cancelled.

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