This function allows you to list out ACHWorks Billing Schedules you created in the system. There is a 1000 result limit.
Function:
Name: achworks/getTransactions
Type: GET
Query Parameters:
| Field | Required | Description |
| id | Yes | Id of ACHWorks Gateway. Please contact us for help. |
| status | Pending, Returned or Settled | |
| sentDateStart | Filter out transactions created after this date. Format (MM/dd/yyyy) | |
| sentEndDate | Filter out transactions created before this date. Format (MM/dd/yyyy) | |
| hitDateStart | Filter out transactions created after this date. Format (MM/dd/yyyy) | |
| hitEndDate | Filter out transactions created before this date. Format (MM/dd/yyyy) | |
| dealId | Filter out the list by the Deal ID |
Example:
https://xyz.com/achworks/getTransactions?status=Pending
Return Result Example:
{
"success": true,
"transactions": [
{
"frontEndTrace": "test-95",
"dealId": 7805,
"dealName": "ACHWorks Sandbox Deal Test",
"status": "Pending",
"amount": "10.25",
"sentDate": "08/01/2022",
"hitDate": "08/02/2022",
"actionDetail":"XYZ",
},
{
"frontEndTrace": "test-96",
"dealId": 8143,
"dealName": "Deal 2",
"status": "Pending",
"amount": "10.12",
"sentDate": "08/01/2022",
"hitDate": "08/02/2022",
"actionDetail":"XYZ",
},
]
}
The dealId and dealName results are current deal tied to the billing schedule. If deal is changed on the billing schedule, that historical deal is not returned to the result set.