# Adfin API 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`. Version: 1.0.0 ## Servers Production API Server URL ``` https://api.adfin.com/api ``` Staging API Server URL ``` https://api.staging.adfin.com/api ``` ## Security ### Biller Access Token (Production) Type: oauth2 ### Platform Bearer Token Type: http Scheme: Bearer ### Biller Access Token (Staging) Type: oauth2 ## Download OpenAPI description [Adfin API](https://developer.adfin.com/_bundle/products/direct-integration/direct-integration-api-reference.yaml) ## oAuth2 ### Issue an OAuth 2.0 access token - [POST /oauth2/token](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/oauth2/issueoauth2token.md) ### Revoke an OAuth2 Refresh token - [POST /oauth2/revoke](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/oauth2/revokeoauth2refreshtoken.md) ### Authorize an app to access Adfin data on behalf of an Adfin user - [POST /oauth2/authorize](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/oauth2/authorize.md) ### Get the authorization details for an app - [GET /oauth2/authorization](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/oauth2/getappauthorizationdetails.md) ## Biller ### Retrieves the payment capabilities of a biller - [GET /billers/{billerId}/payment_capabilities](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/biller/getpaymentcapabilities.md): Returns the payment capabilities that apply to the biller, each with its status. A capability that does not apply is left out of the list rather than sent with a status. A missing capability means only that Adfin does not offer it to this biller right now. It is not a rejection, and the list length is not a fixed denominator. ### Retrieves a biller - [GET /biller](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/biller/getbiller.md): Fetches the details of the authenticated user's associated biller. Returns a 404 if no biller is found. ## Verifications ### Get a biller's verifications - [GET /billers/{billerId}/verifications](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/verifications/getverifications.md): Returns the biller's verification history, latest first. checks[] is ordered and open. Checks may be added, removed or reordered, so an integration must not switch exhaustively on key or fail on an unrecognised one. A check that does not apply to a biller is left out of the list rather than sent with a status. A missing key means only that Adfin is not asking this biller for it right now. ## Customers ### Retrieve a list of customers by filter - [GET /customers](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/getcustomers.md) ### Update a customer - [PUT /customers](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/putcustomer.md) ### Create a customer - [POST /customers](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/createcustomer.md) ### Retrieve a customer - [GET /customers/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/getcustomerbyid.md) ### Update a customer by id - [PUT /customers/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/updatecustomerbyid.md) ### Resume collection for a customer - [PUT /customers/{customerId}:resume_collection](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/resumecustomercollection.md): Starts collection from the customer by the named methods again. Methods that are not named keep their current state, and a method that is not paused stays as it is. ### Pause collection for a customer - [PUT /customers/{customerId}:pause_collection](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/pausecustomercollection.md): Stops collection from the customer by the named methods. Payment requests already raised for the customer are not collected by those methods until collection is resumed. Methods that are not named keep collecting, and a method that is already paused stays as it is. ### Assign an owner to a customer - [PUT /customers/{customerId}:assign_owner](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/assigncustomerowner.md) ### Assign an action to a customer - [PUT /customers/{customerId}:assign_action](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/assigncustomeraction.md) ### Get the collection preferences for a customer - [GET /customers/{customerId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/getcustomercollectionpreferences.md): The values in force, after the agent's settings and every override are resolved. ### Reset the collection preferences for a customer - [DELETE /customers/{customerId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/deletecustomercollectionpreferences.md): Clears every override, not only these settings, including any set by Adfin or in the Adfin app. To turn a single setting off, PATCH it with an enabled of false instead. A pause set with :pause_collection survives. ### Change the collection preferences for a customer - [PATCH /customers/{customerId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/patchcustomercollectionpreferences.md): A field left out of the body is unchanged. partialPayments takes at most one of minimumAmount or minimumPercentage. ### Remove the owner from a customer - [DELETE /customers/{customerId}:remove_owner](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/removecustomerowner.md) ### Remove the action from a customer - [DELETE /customers/{customerId}:remove_action](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/customers/removecustomeraction.md) ## Direct debit mandates ### Create a direct debit mandate - [PUT /customers/{id}/directdebitmandates](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/direct-debit-mandates/create.md): The request body is optional. It may carry a redirectUrl and, through mandateRemindersPreferences, ask the agent to remind the customer to set the mandate up. Reminders are off unless mandateRemindersPreferences.mandateReminders.enabled is true. Set mandateRemindersPreferences.useAgentDefaults to true to leave the customer's reminder configuration untouched. Bank details cannot be submitted through the API: the customer authorises the mandate themselves via the url returned in the response. In staging, you can open that link yourself and complete it with test bank details. ### Reinstate a cancelled direct debit mandate - [PUT /customers/directdebitmandates/{id}:reinstate](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/direct-debit-mandates/reinstatedirectdebitmandate.md) ### Cancel a direct debit mandate - [PUT /customers/directdebitmandates/{id}:cancel](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/direct-debit-mandates/canceldirectdebitmandate.md) ### Search direct debit mandates by filters - [GET /customers/directdebitmandates](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/direct-debit-mandates/searchdirectdebitmandates.md) ### Retrieve a direct debit mandate - [GET /customers/directdebitmandates/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/direct-debit-mandates/getdirectdebitmandate.md) ## Invoices ### Resume collection for an invoice - [PUT /invoices/{invoiceId}:resume_collection](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/resumeinvoicecollection.md): Starts collection of every payment request raised for this invoice by the named methods again. Those payment requests keep being collected even while the customer as a whole is paused. Methods that are not named keep their current state. ### Pause collection for an invoice - [PUT /invoices/{invoiceId}:pause_collection](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/pauseinvoicecollection.md): Stops collection of every payment request raised for this invoice by the named methods, leaving the customer's other invoices alone. Methods that are not named keep collecting, and a method that is already paused stays as it is. ### Get an invoice by its id - [GET /invoices/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/getinvoice.md) ### Update an invoice - [PUT /invoices/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/putinvoice.md) ### Void an invoice - [PUT /invoices/{id}:void](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/voidinvoice.md) ### Manually mark an invoice as paid - [PUT /invoices/{id}:mark-as-paid](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/markinvoiceaspaid.md) ### Activate (send) an invoice - [PUT /invoices/{id}:activate](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/activateinvoice.md) ### Retrieve a list of invoices by filter - [GET /invoices](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/getinvoices.md) ### Create an invoice - [POST /invoices](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/createinvoice.md) ### Preview instalment plan for an invoice - [POST /invoices/{invoiceId}/instalments/preview](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/previewinstalmentforinvoice.md) ### Import a credit note - [POST /invoices/{invoiceId}/credit_notes](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/importcreditnote.md): Apply a credit note from another system to an invoice. The credit note lowers the amount due. The invoice must still take payments. ### Get the collection preferences for an invoice - [GET /invoices/{invoiceId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/getinvoicecollectionpreferences.md): The values in force, after the agent's settings and every override are resolved. ### Reset the collection preferences for an invoice - [DELETE /invoices/{invoiceId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/deleteinvoicecollectionpreferences.md): Clears every override, not only these settings, including any set by Adfin or in the Adfin app. To turn a single setting off, PATCH it with an enabled of false instead. A pause set with :pause_collection survives. ### Change the collection preferences for an invoice - [PATCH /invoices/{invoiceId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/patchinvoicecollectionpreferences.md): A field left out of the body is unchanged. partialPayments takes at most one of minimumAmount or minimumPercentage. statements, mandateReminders, cardReminders and directDebitEncouragement can only be set on the customer. ### Get the file for a specific invoice - [GET /invoices/{id}/file](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/getfile.md) ### Cancel an imported credit note - [DELETE /invoices/{invoiceId}/credit_notes/{creditNoteId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/invoices/cancelimportedcreditnote.md): Cancel a credit note imported through the API. The amount returns to the amount due of the invoice. ## Recurring invoices ### Retrieve a recurring invoice - [GET /schedules/invoices/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/getrecurringinvoicebyid.md) ### Update a recurring invoice - [PUT /schedules/invoices/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/updaterecurringinvoice.md) ### Delete a recurring invoice - [DELETE /schedules/invoices/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/deleterecurringinvoice.md) ### Cancel a recurring invoice - [PUT /schedules/invoices/{id}:cancel](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/cancelrecurringinvoice.md) ### Activate a recurring invoice - [PUT /schedules/invoices/{id}:activate](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/activaterecurringinvoice.md) ### Create a recurring invoice - [POST /schedules/invoices](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/postrecurringinvoice.md): The recurring invoice is created as a draft. Nothing is generated or sent to the customer until it is activated, either via PUT /schedules/invoices/{id}:activate or from the console. ### Get the collection preferences for a recurring invoice - [GET /schedules/invoices/{recurringInvoiceId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/getrecurringinvoicecollectionpreferences.md): Returns how collection is set up for the invoices this recurring invoice raises. The values in force, after the agent's settings and every override are resolved. ### Reset the collection preferences for a recurring invoice - [DELETE /schedules/invoices/{recurringInvoiceId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/deleterecurringinvoicecollectionpreferences.md): Resets how collection is set up for the invoices this recurring invoice raises. Clears every override, not only these settings, including any set by Adfin or in the Adfin app. To turn a single setting off, PATCH it with an enabled of false instead. ### Change the collection preferences for a recurring invoice - [PATCH /schedules/invoices/{recurringInvoiceId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-invoices/patchrecurringinvoicecollectionpreferences.md): Changes how collection is set up for the invoices this recurring invoice raises. A field left out of the body is unchanged. partialPayments takes at most one of minimumAmount or minimumPercentage. statements, mandateReminders, cardReminders and directDebitEncouragement can only be set on the customer. ## Payment requests ### Resume collection for a payment request - [PUT /payment_requests/{paymentRequestId}:resume_collection](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/resumepaymentrequestcollection.md): Starts collection of this payment request by the named methods again. A payment request resumed this way keeps being collected even while the customer as a whole is paused. Methods that are not named keep their current state. ### Pause collection for a payment request - [PUT /payment_requests/{paymentRequestId}:pause_collection](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/pausepaymentrequestcollection.md): Stops collection of this payment request by the named methods, leaving the customer's other payment requests alone. The pause overrides whatever the customer-level state is, so a payment request can be held back while the rest of the customer keeps being collected. Methods that are not named keep collecting, and a method that is already paused stays as it is. ### Get a payment request - [GET /payment_requests/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/getpr.md) ### Update a payment request - [PUT /payment_requests/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/putpaymentrequest.md) ### Void a payment request - [PUT /payment_requests/{id}:void](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/voidpr.md) ### Manually mark a standalone payment request as paid - [PUT /payment_requests/{id}:mark-as-paid](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/markpraspaid.md) ### Cancel auto-collection on the next failure - [PUT /payment_requests/{id}:cancel-collection-on-failure](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/cancelcollectiononfailure.md): Marks this payment request so that, if its next auto-collection attempt fails, further collection retries are cancelled and the workflow transitions off auto-collect. ### Activate (send) a payment request - [PUT /payment_requests/{id}:activate](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/activatepr.md) ### Update the distribution details of payment requests - [PUT /payment_requests/distribution](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/updatedistributiondetails.md) ### Retrieve a list of payment requests by filter - [GET /payment_requests](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/getpaymentrequests.md) ### Create a payment request - [POST /payment_requests](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/postpaymentrequest.md) ### Bulk import payment requests - [POST /payment_requests/bulk_import](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/bulkimport.md) ### Get the collection preferences for a payment request - [GET /payment_requests/{paymentRequestId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/getpaymentrequestcollectionpreferences.md): The values in force, after the agent's settings and every override are resolved. ### Reset the collection preferences for a payment request - [DELETE /payment_requests/{paymentRequestId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/deletepaymentrequestcollectionpreferences.md): Clears every override, not only these settings, including any set by Adfin or in the Adfin app. To turn a single setting off, PATCH it with an enabled of false instead. A pause set with :pause_collection survives. ### Change the collection preferences for a payment request - [PATCH /payment_requests/{paymentRequestId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/patchpaymentrequestcollectionpreferences.md): A field left out of the body is unchanged. partialPayments takes at most one of minimumAmount or minimumPercentage. statements, mandateReminders, cardReminders and directDebitEncouragement can only be set on the customer. ### Retrieve bulk payment request import job details - [GET /payment_requests/bulk_import/{jobId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/getbulkpaymentrequestimportjobdetails.md) ### Retrieve bulk payment request import job items - [GET /payment_requests/bulk_import/{jobId}/items](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/getbulkpaymentrequestimportjobitems.md) ### Cancel a payment request (deprecated) - [PUT /payment_requests/{id}:cancel](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payment-requests/cancelpr.md): This endpoint is deprecated and will be removed in a future release. Use /{id}:void instead ## Recurring payment requests ### Retrieve a recurring payment request by its ID - [GET /schedules/payment_requests/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/getrecurringpaymentrequestbyid.md) ### Update a recurring payment request - [PUT /schedules/payment_requests/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/updaterecurringpaymentrequest.md) ### Delete a recurring payment request - [DELETE /schedules/payment_requests/{id}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/deleterecurringpaymentrequest.md) ### Cancel a recurring payment request - [PUT /schedules/payment_requests/{id}:cancel](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/cancelrecurringpaymentrequest.md) ### Create a recurring payment request - [POST /schedules/payment_requests](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/postrecurringpaymentrequest.md) ### Get the collection preferences for a recurring payment request - [GET /schedules/payment_requests/{recurringPaymentRequestId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/getrecurringpaymentrequestcollectionpreferences.md): Returns how collection is set up for the payment requests this recurring payment request raises. The values in force, after the agent's settings and every override are resolved. ### Reset the collection preferences for a recurring payment request - [DELETE /schedules/payment_requests/{recurringPaymentRequestId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/deleterecurringpaymentrequestcollectionpreferences.md): Resets how collection is set up for the payment requests this recurring payment request raises. Clears every override, not only these settings, including any set by Adfin or in the Adfin app. To turn a single setting off, PATCH it with an enabled of false instead. ### Change the collection preferences for a recurring payment request - [PATCH /schedules/payment_requests/{recurringPaymentRequestId}/collection_preferences](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/recurring-payment-requests/patchrecurringpaymentrequestcollectionpreferences.md): Changes how collection is set up for the payment requests this recurring payment request raises. A field left out of the body is unchanged. partialPayments takes at most one of minimumAmount or minimumPercentage. statements, mandateReminders, cardReminders and directDebitEncouragement can only be set on the customer. ## Payments ### Import a payment - [POST /payments:import](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payments/importpayment.md): 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. ### Cancel an imported payment - [DELETE /payments/{paymentId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payments/cancelimportedpayment.md): Cancel an imported payment for a payment request. ## Payouts ### List payouts - [GET /payouts](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payouts/getpayouts.md): Returns the payouts Adfin has made to the bank account. ### Retrieve a payout - [GET /payouts/{payoutId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payouts/getpayout.md): Returns one payout. ### Retrieve the breakdown of a payout - [GET /payouts/{payoutId}/items](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/payouts/getpayoutitems.md): Returns the items that make up the payout. The item amounts sum to the payout total amount. ## Tax rates ### Retrieve tax rate options - [GET /catalogs/tax_rates](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/tax-rates/gettaxratecataloguesforbiller.md) ## Items ### Get line item catalogue items for a given filter - [GET /catalogs/items](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/items/getlineitemcatalogue.md) ## Account codes ### Retrieve the account codes for invoice line items - [GET /catalogs/invoice/account_codes](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/account-codes/getaccountcodecataloguesforbiller.md): Lists the sales account codes of the biller's connected accounting platform. Send an item's id as accountCodeId on an invoice line item. ## Activities What has happened to a customer, invoice, payment request or schedule. ### Read the activity feed for one record - [GET /activities](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/activities/getactivities.md): Returns what happened to a single record, newest first. A feed carries only that record's own activities. pagination reports the totals for the whole filtered result rather than for the page. ### Read one activity - [GET /activities/{activityId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/activities/getactivity.md): Returns a single activity by its own id. ## Scheduled Activities What is planned next for a customer or a payment request. ### Read what is planned for a customer or a payment request - [GET /scheduled_activities](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/scheduled-activities/getscheduledactivities.md): 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. ## Webhooks ### Retrieve a webhook - [GET /apps/{clientId}/webhooks/{webhookId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/webhooks/getwebhookbyid.md) ### Update a webhook - [PUT /apps/{clientId}/webhooks/{webhookId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/webhooks/updatewebhook.md) ### Delete a webhook - [DELETE /apps/{clientId}/webhooks/{webhookId}](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/webhooks/deletewebhook.md) ### Generate or replace the webhook signing secret key - [PUT /apps/{clientId}/webhooks/digest](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/webhooks/generatewebhooksecretkey.md) ### Create or update the authentication method and credentials for webhook target URLs - [PUT /apps/{clientId}/webhooks/auth](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/webhooks/storewebhookauthentication.md) ### Retrieve webhooks for a clientId - [GET /apps/{clientId}/webhooks](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/webhooks/getwebhooks.md) ### Create a webhook - [POST /apps/{clientId}/webhooks](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/webhooks/createwebhook.md) ## Referrals ### List the referred billers - [GET /referrals/billers](https://developer.adfin.com/products/direct-integration/direct-integration-api-reference/referrals/getreferredbillers.md): This endpoint should be used for tracking referrals from the moment a user registered under a referral link or code that belongs to the caller. The caller is identified from the authentication token provided.