1. Webhooks
Fintainium APIs
  • Overview
  • Quick Start
  • Use Cases
  • Recipies
    • Connect with Vendor
    • Pay a Vendor
  • API Reference
    • AP Payouts (Accounts Payable)
      • Vendor (Recipient)
        • Create new vendor
        • Update Vendor
        • View Vendor Details
      • Payments (Payouts)
        • Initiate Payment
        • Add Payment Method
      • Bills
        • Create new Bill
      • Country State City
        • GET City List by State Name/ID/Code
    • AR Collection (Accounts Receivable)
      • Invoices
        • Create new Invoice
      • Customers
        • Create new customer
      • Payment (Collection)
        • Initiate Payment
        • Add Payment Method
    • Simplified Payouts
      • Send Payouts
    • Transactions
      • Retrieve Transaction Status
    • Webhooks
      • Register for an Event
        POST
      • Get Webhook Registration Status
        POST
    • Sub-Ledger
      • Retrieve Balance
  1. Webhooks

Register for an Event

POST
https://webhook-staging.fintainium.com/api/webhooks/register
The Register Webhook API allows Fintainium-integrated businesses to register a webhook and receive real-time notifications about key payment events.
Businesses provide a callback URL, select the events they want to subscribe to, and identify themselves using their businessId.

Supported Events#

Funding.Debit.Completed#

This event is triggered when a funding debit (ACH PULL) is successfully completed.

AP (Accounts Payable) Context#

A Funding Debit means Fintainium pulls funds from the client’s operating bank account to cover an upcoming vendor payment.
This ensures sufficient funds are available before sending payments via ACH, Virtual Card, Check, or Rapid Pay.

AR (Accounts Receivable) Context#

A Funding Debit means collecting funds from the Payor/AR Customer to pay an invoice.
This is the PULL of money from the customer’s account.

Funding.Credit.Completed#

This event is triggered when a funding credit (PUSH) is successfully completed.

AP (Accounts Payable) Context#

A Funding Credit means funds are pushed out to the vendor using their preferred payment method:
ACH
Virtual Card
Check
Rapid Pay
This represents the actual disbursement of funds to the vendor.

AR (Accounts Receivable) Context#

A Funding Credit means collected funds are pushed into the client’s operating account as a deposit for the paid invoice.
Once the AR Customer’s payment clears, the business receives the credited amount.

Summary for End Users#

TermMeaningAP (Payables)AR (Receivables)
Funding DebitMoney being pulled (ACH PULL)Pull from client’s bank account to fund vendor paymentsPull from AR customer’s bank account to pay an invoice
Funding CreditMoney being pushedPush funds to the vendor (ACH, VC, Check, Rapid Pay)Push funds to the client’s operating account as a deposit

These webhook events provide unified visibility across both AP and AR workflows, ensuring businesses stay informed of all movement of funds.

Key Features#

Register a webhook endpoint for event-based notifications.
Subscribe to one or multiple webhook events (e.g. Funding.Credit.Completed, Funding.Debit.Completed).
Enables secure and automated tracking of real-time payment and funding updates without requiring API polling.
Returns a unique webhookId and the webhook’s current status upon successful registration.
Use this API to automate status updates and eliminate manual transaction polling.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Registration Success
application/json
Bodyapplication/json

🟢200Successful Webhook Event Notification
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://webhook-staging.fintainium.com/api/webhooks/register' \
--header 'sessionKey;' \
--header 'Content-Type: application/json' \
--data '{
  "businessId": 893746,
  "callbackUrl": "https://client.company.com/fintainium/webhook",
  "eventNames": ["Funding.Credit.Completed"]
}'
Response Response Example
200 - Registration Success - Success
{
  "message": "Webhook registered successfully.",
  "webhookId": "b81d2e10-7e56-4fcb-b1d1-fint-id",
  "status": "Active"
}
Modified at 2025-12-11 21:31:49
Previous
Retrieve Transaction Status
Next
Get Webhook Registration Status
Built with