1. Transactions
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
        GET
    • Webhooks
      • Register for an Event
      • Get Webhook Registration Status
    • Sub-Ledger
      • Retrieve Balance
  1. Transactions

Retrieve Transaction Status

GET
https://staginggateway.fintainium.com/gateway/api/payouts/batch/transactionStatus

Description#

The Retrieve Transaction Status API enables Fintainium businesses to fetch the status of both Accounts Payable (AP) and Accounts Receivable (AR) transactions.
It allows users to track the progress of single or multiple transactions in real time for reconciliation, audit, and reporting.
This API returns the current status of transactions based on the provided identifiers and filters.
Each request must include a businessId and a transactionType (Payable or Receivable).
Users can refine the results using a variety of optional filters such as vendor/customer details, transaction references, date ranges, due dates, and payment method.

Request Parameters#

Note: All parameters must be included in the API request; if a parameter is not being used, it should be passed as an empty or blank value.

Mandatory Parameters#

FieldTypeDescription
businessIdStringUnique ID of the business.
transactionTypeStringIndicates whether the transaction is Payable (AP) or Receivable (AR).

Optional Parameters#

FieldTypeDescription
internalIdStringRecipient’s internal ID (Vendor for AP / Customer for AR).
nameStringVendor or Customer name (case-insensitive).
transactionIdStringBill or Invoice number.
fintainiumTransactionIdsArray[String]Fintainium-generated transaction reference(s).
fromDateString (MM/DD/YYYY)Bill/Invoice date — start range.
toDateString (MM/DD/YYYY)Bill/Invoice date — end range.
fromDueDateString (MM/DD/YYYY)Bill/Invoice due date — start range.
toDueDateString (MM/DD/YYYY)Bill/Invoice due date — end range.
paymentMethodStringAP (Payable): ACH, Check, VC, Rapid_Pay
AR (Receivable): ACH, Card
(Values are not case-sensitive.)

Logical Rules Summary#

Mandatory: businessId and transactionType must always be provided.
Recipient filters:
Use either internalId or name.
If both are provided, internalId takes precedence and name is ignored.
Transaction filters:
Use either fintainiumTransactionIds or transactionIds.
If both are provided, fintainiumTransactionIds takes precedence and transactionIds is ignored.
Date filters:
(fromDate, toDate) must be provided together if used — filters by bill/invoice creation date.
(fromDueDate, toDueDate) must be provided together if used — filters by bill/invoice due date.
Payment method filter:
Applicable for both AP and AR.
AP (Payable): ACH, Check, VC, Rapid_Pay
AR (Receivable): ACH, Card
Not case sensitive (ACH, ach, Ach are treated equally).

Key Features#

Retrieve transaction statuses for both AP (vendor payouts) and AR (customer collections).
Flexible filtering using recipient, transaction reference, and date range criteria.
Returns up to 100 transaction records per request.
If more than 100 transactions exist, the API returns at least the most recent 100.
Supports single or bulk status retrieval for efficient tracking.
Designed for reconciliation, reporting, and monitoring across AP and AR workflows.
Ideal for businesses to monitor payouts, collections, and due-date-driven workflows with greater flexibility and precision.

Request

Query Params

Header Params

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://staginggateway.fintainium.com/gateway/api/payouts/batch/transactionStatus?businessId=123&transactionType=Payable&fintainiumTransactionIds=tx1%2Ctx2%2Ctx3%2Ctx4&transactionId=INV-00123&internalId=XXXXXYYZZ&name=John%20Supplies%20Ltd&fromDate=01%2F01%2F2025&toDate=01%2F31%2F2025&fromDueDate=02%2F01%2F2025&toDueDate=02%2F28%2F2025&paymentMethod=ACH' \
--header 'sessionKey: YOUR_API_KEY_HERE'
Response Response Example
{
  "type": "Payable",
  "internalId": "VendorOne1",
  "partyName": "Vexdor One",
  "totalAmount": "$196.00",
  "recipientCharge": 4.0,
  "transactionAmount": "$200.00",
  "depositBy": "Akil Staging Test Business",
  "transactionId": "10249398193",
  "fintTransactionId": "6934880",
  "transactionDate": "2025-08-28T03:23:53Z",
  "paymentDate": "08/28/2025",
  "paymentMethod": "Virtual Credit Card",
  "paymentMethodId": "1004",
  "paymentReferenceNumber": "A24043J3D2KT",
  "status": "Paid Card Available",
  "statusId": "2003",
  "errorCode": ""
}
Modified at 2025-11-13 15:04:46
Previous
Send Payouts
Next
Register for an Event
Built with