Get ACH Fee Report for Institution
Overview
This route will return ACH Fee Report for Institutions
Resource Access
GET https://<hostname>/report/v1/achFees
Parameters
The requested criteria can be a combination of one or more of the following fields:
| Keys | Values |
|---|---|
| filter | %7B%7D |
| search | <Item user wants to search> |
| size | 10 |
| sort | created%3Adesc |
Example Request
GET https://<hostname>/report/v1/achFees?size=2
Example Response
{
"aggregations": {
"totalAmount": {
"value": 23611.38
}
},
"totalRecords": 11727,
"totalType": "exact",
"recordCount": 2,
"records": [
{
"id": "c5edcb3d-7da1-5a00-a3da-a24785ffcd76",
"acl": [
"network:a705f971-e165-5928-b417-47d4aae24342",
"institution:9535f52d-15f7-507e-8165-b9dea8f038c4",
"pps:cpx-acquiring",
"pif:e18ce33d-53ed-52cc-9fd6-35f800d3f4d7",
"piftransaction:c5edcb3d-7da1-5a00-a3da-a24785ffcd76"
],
"tags": [
"Standard ACH"
],
"buyer": {
"id": "cd1ea526-80cf-5c47-8a65-a7c5b7aaf0af",
"ach": {
"billing": "GOOD_FUNDS",
"delayDays": 0,
"debitMethod": "Debit by Batch",
"bankAccountId": "3185620dc17ea77618a4de16b90f4d7959ce0415feb8d7c6c706b98574946ca3",
"exposureTracking": {
"days": 9,
"limit": 10000,
"enabled": true,
"lastUpdatedDate": "2023-09-22T00:01:35.380Z",
"currentExposureAmount": 4.03
}
},
"bid": "UyqXxFdLjxdpWGr",
"name": "UI_Automation_AB_GF_DBB_ETe",
"status": "Approved",
"address": {
"country": "USA"
},
"vcnHost": "",
"passport": {
"account": {
"da": {
"id": 4007890
}
},
"customerId": 4018394,
"bankAccounts": {
"3185620dc17ea77618a4de16b90f4d7959ce0415feb8d7c6c706b98574946ca3": {
"id": 4007029
}
}
},
"achEnabled": true,
"virtualCard": {
"billing": "",
"bankAccountId": "3185620dc17ea77618a4de16b90f4d7959ce0415feb8d7c6c706b98574946ca3",
"exposureTracking": {
"enabled": false
}
},
"achRequested": true,
"externalStatus": "Active",
"dualPifApproval": {
"enabled": true
},
"failOverPayment": {
"enabled": false
},
"associatedInstitutionId": "9535f52d-15f7-507e-8165-b9dea8f038c4"
},
"amount": 1,
"fileId": "e18ce33d-53ed-52cc-9fd6-35f800d3f4d7",
"created": "2023-09-22T09:55:10.443Z",
"creator": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"network": {
"id": "a705f971-e165-5928-b417-47d4aae24342",
"nid": "jXBQQcgkkImFHuk",
"name": "UiAutomation_CN",
"status": "Approved",
"externalStatus": "Active"
},
"fileDate": "2023-09-22T09:54:57.155Z",
"filePath": "jXBQQcgkkImFHuk.JXVjiNLcflRfRzF.pif.singlepayment_20230922055458.csv",
"modified": "2023-09-29T09:56:31.476Z",
"modifier": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"replayId": "1658793823957",
"supplier": {
"id": "7b4e91f2-e159-5d13-9936-0e8b61aaf0a7",
"mcc": {
"code": "",
"description": ""
},
"sid": "6927231707",
"name": "UI_Automation_AP_FF_NFe",
"status": "Approved",
"address": {
"city": "Alpharetta",
"state": "GA",
"country": "USA",
"street1": "",
"street2": "2001 Westside Pkwy",
"postalCode": "30021"
},
"variance": {
"amount": "0"
},
"payeeType": "Supplier",
"paymentTypes": [
{
"id": "ACH",
"type": "ACH",
"enabled": false,
"accountType": ""
},
{
"id": "ACH+",
"type": "ACH+",
"enabled": true,
"feeType": "Flat Fee",
"flatFee": 1,
"netFees": true,
"accountType": "Checking",
"discountRate": "0"
},
{
"id": "Check Issuing",
"type": "Check Issuing",
"enabled": false,
"payableTo": ""
},
{
"id": "Direct",
"type": "Direct",
"enabled": false
},
{
"id": "Dollar Splits",
"type": "Dollar Splits",
"enabled": false
},
{
"id": "Dynamic Discounting",
"type": "Dynamic Discounting",
"enabled": false,
"netFees": false,
"accountType": "",
"lowTermDays": 0,
"discountRate": "0",
"highTermDays": 0
},
{
"id": "Payment Thresholds",
"type": "Payment Thresholds",
"enabled": false
},
{
"id": "Prepaid Debit",
"type": "Prepaid Debit",
"enabled": false,
"prepaidDebitId": "",
"prepaidDebitBalance": 0
},
{
"id": "V Card",
"fax": "",
"type": "V Card",
"enabled": false,
"deliveryMethod": "Email",
"noNotification": false
},
{
"id": "Virtual Wallet",
"type": "Virtual Wallet",
"enabled": false,
"virtualWalletId": "",
"virtualWalletBalance": 0
}
],
"expirePreAuths": false,
"externalStatus": "Active"
},
"isNetFees": true,
"achDebitId": "8be49881-42ff-5115-95b2-ec72662ae672",
"importDate": "2023-09-22T09:54:58.294Z",
"statusDate": "2023-09-29T09:56:31.372Z",
"accountType": "ACH",
"createdFrom": "Single Payment",
"hasInvoices": false,
"institution": {
"id": "9535f52d-15f7-507e-8165-b9dea8f038c4",
"fid": "JXVjiNLcflRfRzF",
"fees": {
"bankAccountId": "76ef5cf12f615bb89436f988f972d02b13bacbabb74499bb707569a2a54f0611"
},
"name": "UI_Automation_ACHI",
"status": "Approved",
"revenue": {
"bankAccountId": "76ef5cf12f615bb89436f988f972d02b13bacbabb74499bb707569a2a54f0611"
},
"goodFunds": {
"bankAccountId": "76ef5cf12f615bb89436f988f972d02b13bacbabb74499bb707569a2a54f0611"
},
"achDelayDays": 0,
"vcnValidDays": 30,
"externalStatus": "Active",
"paymentFileType": "97a4f086-455e-532d-aa73-011a9b83d2fe",
"bankAccountNumber": {
"hash": "FlXkLudt1sEEMA1n0ribJrASF0Wx/nXDPuGYjf9/zxI=",
"mask": "6630"
},
"bankRoutingNumber": {
"hash": "eg+BvXJDky5Jz2Jr8TnsL5ft/uxcDKJoZiKuPTbklhs=",
"mask": "0020"
},
"associatedNetworkId": "a705f971-e165-5928-b417-47d4aae24342"
},
"invoiceCount": 0,
"paymentMethod": "ACH",
"paymentStatus": "Denied",
"transactionId": "c5edcb3d-7da1-5a00-a3da-a24785ffcd76",
"originalAmount": 1,
"hasPendingDebit": true,
"transactionDate": "2023-09-22T09:54:58.294Z",
"awaitingApproval": "2023-09-22T09:55:10.442Z",
"isNewTransaction": true,
"bankAccountNumber": {
"hash": "FlXkLudt1sEEMA1n0ribJrASF0Wx/nXDPuGYjf9/zxI=",
"mask": "6630"
},
"bankRoutingNumber": {
"hash": "eg+BvXJDky5Jz2Jr8TnsL5ft/uxcDKJoZiKuPTbklhs=",
"mask": "0020"
},
"achTransactionType": "credit",
"paymentProcessDate": "2023-09-22T09:55:06.930Z",
"buyerBillingProduct": "ACH",
"transactionCategory": "AchPlusInstitutionCredit",
"paymentAccountNumber": "6630",
"isAchPlusInstitutionCredit": true,
"associatedSupplierCreditIds": [
"2d36ae89-6fe6-51b0-a5e5-2ea4eab766a1"
],
"paymentAuthMessage": "PIF File has been Denied",
"denied": "2023-09-29T09:56:31.372Z",
"netFees": "Yes",
"transactionType": "AP+"
},
{
"accountType": "ACH",
"achDebitId": "e3b15461-f5ff-5c43-97a9-6adb7b3e802e",
"achTransactionType": "credit",
"acl": [
"network:ee990814-01a1-571d-b0e7-53d39c1a5497",
"institution:208f497b-32e6-59ae-a14f-483a34206ffe",
"pps:cpx-acquiring",
"pif:9a7cdb4c989edbe214adb8aaebcc1f7ffaa535a6",
"piftransaction:9849d256-d804-5530-8c33-b3a905404ac7"
],
"amount": 0.1,
"associatedSupplierCreditIds": [
"e2b79eee-7e4f-5cd1-aa6b-957a4ed3b049"
],
"bankAccountNumber": {
"hash": "QQ0Xz6Zx/8gYR0qAtLdvUHpyRnqF9JKBrfkzUibEO0A=",
"mask": "2766"
},
"bankRoutingNumber": {
"hash": "eg+BvXJDky5Jz2Jr8TnsL5ft/uxcDKJoZiKuPTbklhs=",
"mask": "0020"
},
"buyer": {
"ach": {
"bankAccountId": "f76112f18e794d012126a610f4242ba1f3f57cf54194afb11727cc6be15372c2",
"billing": "GOOD_FUNDS",
"debitMethod": "Debit by Batch",
"delayDays": 0,
"exposureTracking": {
"enabled": false
}
},
"achEnabled": true,
"achRequested": true,
"address": {
"country": "USA"
},
"associatedInstitutionId": "208f497b-32e6-59ae-a14f-483a34206ffe",
"bid": "APIBUBID5",
"dualPifApproval": {
"enabled": false
},
"externalStatus": "Active",
"failOverPayment": {
"VCN": "ACH",
"enabled": false
},
"id": "6b5027a2-f170-5e16-9b87-be7b219cd545",
"managedCheckEnabled": false,
“managedCheckRequested” : false,
"name": "ACH Buyer API BU",
"status": "Approved",
"virtualCard": {
"bankAccountId": "f76112f18e794d012126a610f4242ba1f3f57cf54194afb11727cc6be15372c2",
"exposureTracking": {
"enabled": false
}
}
},
"buyerBillingProduct": "ACH",
"created": "2023-03-20T09:24:51.352Z",
"createdFrom": "api",
"creator": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"fileDate": "2021-12-09T00:00:00.000Z",
"fileId": "9a7cdb4c989edbe214adb8aaebcc1f7ffaa535a6",
"filePath": "APIBUNID1.APIBUFID4.pif.WEB_20230320052158.csv",
"hasInvoices": false,
"hasPendingDebit": false,
"id": "9849d256-d804-5530-8c33-b3a905404ac7",
"importDate": "2023-03-20T09:21:58.404Z",
"institution": {
"achDelayDays": 0,
"associatedNetworkId": "ee990814-01a1-571d-b0e7-53d39c1a5497",
"bankAccountNumber": {
"hash": "QQ0Xz6Zx/8gYR0qAtLdvUHpyRnqF9JKBrfkzUibEO0A=",
"mask": "2766"
},
"bankRoutingNumber": {
"hash": "eg+BvXJDky5Jz2Jr8TnsL5ft/uxcDKJoZiKuPTbklhs=",
"mask": "0020"
},
"externalStatus": "Active",
"fees": {
"bankAccountId": "9feb88bbeb8cd789cd900f86ce76d10664f74dc1e76c93b2c2ebc386497b729e"
},
"fid": "APIBUFID4",
"goodFunds": {
"bankAccountId": "9feb88bbeb8cd789cd900f86ce76d10664f74dc1e76c93b2c2ebc386497b729e"
},
"id": "208f497b-32e6-59ae-a14f-483a34206ffe",
"name": "ACH Institution API BU",
"paymentFileType": "bdc93a26-38c3-5052-90d1-c0a68a3221f5",
"revenue": {
"bankAccountId": "9feb88bbeb8cd789cd900f86ce76d10664f74dc1e76c93b2c2ebc386497b729e"
},
"status": "Approved",
"vcnValidDays": 30
},
"invoiceCount": 0,
"isAchPlusInstitutionCredit": true,
"isNetFees": true,
"isNewTransaction": true,
"modified": "2023-03-20T09:25:32.317Z",
"modifier": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"network": {
"externalStatus": "Active",
"id": "ee990814-01a1-571d-b0e7-53d39c1a5497",
"name": "Network BU",
"nid": "APIBUNID1",
"status": "Approved"
},
"originalAmount": 0.1,
"paymentAccountNumber": "2766",
"paymentMethod": "ACH",
"paymentProcessDate": "2023-03-20T09:24:49.559Z",
"paymentStatus": "Sent",
"ready": "2023-03-20T09:24:51.352Z",
"replayId": "698753562160",
"statusDate": "2023-03-20T09:25:32.241Z",
"supplier": {
"address": {
"city": "Alpharetta",
"country": "USA",
"postalCode": "30021",
"state": "GA",
"street2": "2001 Westside Pkwy"
},
"expirePreAuths": false,
"externalStatus": "Active",
"id": "8fdfea26-4f32-52f3-9fad-59e4dfe3eaf1",
"name": "ACH + Discount Rate Net Fees Enabled Supplier API BU",
"payeeType": "Supplier",
"paymentTypes": [
{
"accountType": "Checking",
"discountRate": "1",
"enabled": true,
"feeType": "Discount Rate",
"flatFee": 0,
"id": "ACH+",
"netFees": true,
"type": "ACH+"
},
{
"enabled": false,
"id": "Prepaid Debit",
"type": "Prepaid Debit"
},
{
"enabled": false,
"id": "Virtual Wallet",
"type": "Virtual Wallet"
},
{
"enabled": false,
"id": "Check Issuing",
"type": "Check Issuing"
},
{
"enabled": false,
"id": "Direct",
"type": "Direct"
},
{
"enabled": false,
"id": "V Card",
"type": "V Card"
},
{
"enabled": false,
"id": "ACH",
"type": "ACH"
},
{
"enabled": false,
"id": "Dynamic Discounting",
"type": "Dynamic Discounting"
},
{
"enabled": false,
"id": "Dollar Splits",
"type": "Dollar Splits"
},
{
"enabled": false,
"id": "Payment Thresholds",
"type": "Payment Thresholds"
}
],
"sid": "APIBUSID9",
"status": "Approved",
"variance": {
"amount": "0"
}
},
"tags": [
"Standard ACH"
],
"transactionCategory": "AchPlusInstitutionCredit",
"transactionDate": "2023-03-20T09:25:32.241Z",
"transactionId": "9849d256-d804-5530-8c33-b3a905404ac7",
"paymentAuthMessage": "",
"paymentReference": "307909002841",
"isProxyPay": false,
"merchantId": "282063504",
"sent": "2023-03-20T09:25:32.241Z",
"netFees": "Yes",
"transactionType": "AP+"
}
]
}
Updated 3 days ago