The ID of the payment request
- Manually mark a standalone payment request as paid
Resume collection for a payment request
Pause collection for a payment request
Get a payment request
Update a payment request
Void a payment request
Cancel auto-collection on the next failure
Activate (send) a payment request
Update the distribution details of payment requests
Retrieve a list of payment requests by filter
Create a payment request
Bulk import payment requests
Get the collection preferences for a payment request
Reset the collection preferences for a payment request
Change the collection preferences for a payment request
Retrieve bulk payment request import job details
Retrieve bulk payment request import job items
Cancel a payment request
Manually mark a standalon...
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/
- Mock serverhttps://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/{id}:void
- Production API Server URLhttps://api.adfin.com/api/payment_requests/{id}:void
- Staging API Server URLhttps://api.staging.adfin.com/api/payment_requests/{id}:void
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/{id}:void' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'- Mock serverhttps://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/{id}:mark-as-paid
- Production API Server URLhttps://api.adfin.com/api/payment_requests/{id}:mark-as-paid
- Staging API Server URLhttps://api.staging.adfin.com/api/payment_requests/{id}:mark-as-paid
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/{id}:mark-as-paid' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'- Mock serverhttps://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/{id}:cancel-collection-on-failure
- Production API Server URLhttps://api.adfin.com/api/payment_requests/{id}:cancel-collection-on-failure
- Staging API Server URLhttps://api.staging.adfin.com/api/payment_requests/{id}:cancel-collection-on-failure
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.adfin.com/_mock/products/partner-integration/partner-integration-api-reference/payment_requests/{id}:cancel-collection-on-failure' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'