Pending Transactions

Pending transactions are transactions that are currently scheduled to be processed but have not yet been batched. Once a scheduled pending transaction has been processed, it will then be available via the transaction history report.

End-point	Method	Description

End-point	Method	Description
/api/transactions-pending	GET	Returns a collection of pending transactions

All API endpoints require an authentication header to be included with the request. See API Authentication

Filters

Parameter	Type	Description

Parameter	Type	Description
id	int or Array Filter	OmniFund assigned Transaction ID	`# filter based on a single id GET /api/transactions-pending?id=231432546 # filter based on multiple ids GET /api/transactions-pending?id[]=231432546&id[]=231432546`
customer	int or Array Filter	OmniFund assigned Customer ID	`# filter based on a single customer GET /api/transactions-pending?customer=231432546 # filter based on multiple customers GET /api/transactions-pending?customer[]=3245345&customer[]=21176543`
amount	float or Array Filter	Amount of the transaction	`# filter based on a single amount GET /api/transactions-pending?amount=1.25 # filter based on multiple amounts GET /api/transactions-pending?amount[]=1.25&amount[]=25.33`
referenceId	string or Array Filter	Merchant provided transaction reference ID	`# filter based on a single referenceId GET /api/transactions-pending?amount=1.25 # filter based on multiple referenceIds GET /api/transactions-pending?referenceId[]=A1234&referenceId[]=B2345`
tranDate	Range Filter	Effective date the transaction is schedule to be processed on. Dates are displayed in and accept Unix format.	`# filter based on a single timestamp GET /api/transactions-pending?tranDate=1553538663 # filter events between two timestamps GET /api/transactions-pending?tranDate[between]=1553538663..1553638663 # filter events greater than or equal to a timestamp GET /api/transactions-pending?tranDate[gte]=1553538663`

Response

{
    "@context": "/api/contexts/transactions-pending",
    "@id": "/api/transactions-pending",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/api/transactions-pending/29678731",
            "@type": "transactions-pending",
            "amount": "1.25",
            "customer": {
                "@type": "Customer",
                "@id": "_:13734",
                "id": 2970560,
                "company": "",
                "firstName": "Test",
                "lastName": "Customer",
                "email": ""
            },
            "id": 29678731,
            "lockStatus": 0,
            "loginId": "100100",
            "memo": "",
            "notes": "",
            "occurrence": "monthly",
            "occurrence_remaining": "4",
            "poNumber": "",
            "recordType": "debit",
            "referenceId": "A1234",
            "surcharge": "0.00",
            "tranDate": "1619197200",
            "tranType": "ach"
        }
    ],
    "hydra:totalItems": 1
}

Pagination

Transaction Pending collection items also support pagination. For more information on pagination see Paginating Collection Results.