The transactions history resource returns a collection of transactions that have been processed along with their current status and other relevant information. Transactions that are currently scheduled but have not yet been processed can be found in the Pending Transactions resource.
End-point | Method | Description |
---|---|---|
/api/transactions-history | GET | Returns a collection of transactions that have been processed |
/api/transactions-history/{id} | GET | Return a specific transaction based on the transaction ID |
All API endpoints require an authentication header to be included with the request. See API Authentication |
Parameter | Type | Description | ||
---|---|---|---|---|
id | int or Array Filter | OmniFund assigned Transaction ID |
| |
customer | int or Array Filter | OmniFund assigned Customer ID |
| |
amount | float or Array Filter | Amount of the transaction |
| |
referenceId | string or Array Filter | Merchant provided transaction reference ID |
| |
tranDate | Effective date the transaction is schedule to be processed on. Dates are displayed in and accept Unix format. |
|
{ "@context": "/api/contexts/transactions-history", "@id": "/api/transactions-history", "@type": "hydra:Collection", "hydra:member": [ { "@id": "/api/transactions-history/29678731", "@type": "transactions-history", "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 } |
Transaction History collection items also support pagination. For more information on pagination see Paginating Collection Results.