| Bookmark Name | Actions |
|---|
Approval Request Manager
| Name | Description |
|---|---|
| approveACHFile | This API allows the user to approve the ACH file. |
| approveACHTransaction | This API allows the user to approve the ACH transaction request. |
| approveBBGeneralTransaction | This API allows the user to approve a general transaction request . |
| getACHTransactionsPendingForApproval | This API allows the user to fetch all the ACH transaction details that are waiting for approval in the approval queue. |
| rejectACHTransaction | This API allows the user to reject the ACH transaction request. |
| rejectBBGeneralTransaction | This API allows the user to reject a general transaction request. |
| getACHTransactionsRequestedByMe | This API allows the user to fetch all the ACH transactions requested by the user. |
| getRequestsHistory | This API allows the user to fetch all the previous requests made by the user for a transaction. |
approveACHFile
| Description: | This API allows the user to approve the ACH file. | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyApprovals/approveACHFile | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters Request_id (Mandatory) Specifies the unique ID of the ACH transaction request that needs an approval. Comments (Mandatory) Specifies the additional comments of the user. Action (Mandatory) Specifies the action performed on the ACH file. {
"Request_id":"71",
"Comments":"Approved",
"Action":"Approved"
}
|
||
| Response: |
Parameters /ActedBy Specifies the unique ID of the approver. /FeatureAction Specifies the feature action of the approved request. /Status Specifies the status of the approval. /Transaction_id Specifies the unique ID of the approved transaction.
{
ActedBy: "1525111101"
FeatureAction_id: "ACH_FILE_CREATE"
Status: "Approved"
Transaction_id: "65"
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
approveACHTransaction
| Description: | This API allows the user to approve the ACH transaction request. | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyApprovals/approveACHTransaction | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters Request_id (Mandatory) Specifies the unique ID of the ACH transaction request that needs an approval. Comments (Mandatory) Specifies the additional comments of the user. Action (Mandatory) Specifies the action performed on the ACH file. {
"Request_id":"71",
"Comments":"Approved",
"Action":"Approved"
}
|
||
| Response: |
Parameters /ActedBy Specifies the unique ID of the approver. /FeatureAction Specifies the feature action of the approved request. /Status Specifies the status of the approval. /Transaction_id Specifies the unique ID of the approved transaction.
{
ActedBy: "1525111101"
FeatureAction_id: "ACH_COLLECTION_CREATE"
Status: "Approved"
Transaction_id: "65"
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
approveBBGeneralTransaction
| Description: | This API allows the user to approve a general transaction request . | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyApprovals/approveBBGeneralTransaction | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters Request_id (Mandatory) Specifies the unique ID of the ACH transaction request that needs an approval. Comments (Mandatory) Specifies the additional comments of the user. Action (Mandatory) Specifies the action performed on the ACH file. {
"Request_id":"71",
"Comments":"Approved",
"Action":"Approved"
}
|
||
| Response: |
Parameters /ActedBy Specifies the unique ID of the approver. /FeatureAction Specifies the feature action of the approved request. /Status Specifies the status of the approval. /Transaction_id Specifies the unique ID of the approved transaction.
{
ActedBy: "1525111101"
FeatureAction_id: "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE"
Status: "Approved"
Transaction_id: "65"
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getACHTransactionsPendingForApproval
| Description: | This API allows the user to fetch all the ACH transaction details that are waiting for approval in the approval queue. | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyApprovals/getACHTransactionsPendingForApproval | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters searchString Specifies the string value such as nickname, firstname, lastname, and name to search the fields file name. sortByParam Specifies the field that must be sorted. By default, the payees will be sorted based on the date of creation. sortOrder Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default the value is set to ascending pageSize Specifies the number of rows that must be returned in the result. pageOffset Specifies the row from where the data must be retreived. The offset value is often used together with the limit. filterByTransactionType Specifies the type of transaction based on which the transactions are filtered. filterByStatus Specifies the status of the transaction based on which the transactions are filtered. filterByParam Specifies the parameter based on which the transactions are filtered. filterByValue Specifies the parameter value based on which the transactions are filtered. {
"searchString":"",
"sortByParam":"createdts",
"sortOrder":"DESC",
"pageSize":11,
"pageOffset":0,
"filterByTransactionType":"",
"filterByStatus":"",
"filterByParam":"",
"filterByValue":""
}
|
||
| Response: |
View the Response Parameters
/ACHTransactions Specifies an array of JSON object of ACH transactions. /ACHTransactions/AccountName Specifies the name of the account. /ACHTransactions/CompanyName Specifies the name of the company /ACHTransactions/CompanyId Specifies the unique ID of the company /ACHTransactions/CreatedOn Specifies the date of creation for the transaction. /ACHTransactions/Createdby Specifies the name of the user who performed the transaction. /ACHTransactions/EffectiveDate Specifies the effective date for the transaction. /ACHTransactions/MaxAmount Specifies the maximum amount for the ACH transaction. /ACHTransactions/RequestType Specifies the type of request. /ACHTransactions/Request_id Specifies the unique ID of the ACH transaction request. /ACHTransactions/Status Specifies the status of the ACH transaction. /ACHTransactions/TemplateName Specifies the name of the template. /ACHTransactions/TemplateRequestType_id Specifies the unique ID of the template request. /ACHTransactions/TemplateTypeValue Specifies the value of the template type. /ACHTransactions/TemplateType_id Specifies the unique ID of the template based on the type of template. /ACHTransactions/TotalAmount Specifies the total amount involved in the ACH transaction. /ACHTransactions/TransactionTypeValue Specifies the value of the transactio type. /ACHTransactions/TransactionType_id Specifies the unique ID transaction based on the type of transaction. /ACHTransactions/Transaction_id Specifies the unique ID of the transaction. /ACHTransactions/amIApprover Specifies whether the user is the approver. The value is Boolean. /ACHTransactions/amICreator Specifies whether the user is the creator. The value is Boolean. /ACHTransactions/createdby Specifies the name of the user who created the transaction. /ACHTransactions/featureActionId Specifies the unique ID of the feature action of the approved request. /ACHTransactions/receivedApprovals Specifies the number of requests that are received for approval. /ACHTransactions/requiredApprovals Specifies the number of requests that require approvals. /ACHTransactions/softDelete Specifies the value of the soft delete flag. /ACHTransactions/userName Specifies the username. View the Sample Response Code
ACHTransactions: [{
AccountName: "AccountName"
CompanyName: "Sugar Dough Bakers Inc._combineduserSB"
Company_id: "200929043902605"
CreatedOn: "2020-09-29T15:39:16Z"
Createdby: "1384203155"
DebitAccount: "200929043904279"
EffectiveDate: "2019-02-26 00:00:00.0"
MaxAmount: "9000"
RequestType: "CCD (Cash Concentration and Disbursement)"
Request_id: "74"
Status: "Pending"
TemplateName: "Cash Concentration"
TemplateRequestType_id: "3"
TemplateTypeValue: "ACH"
TemplateType_id: "1"
TotalAmount: "8218"
TransactionTypeValue: "Collection"
TransactionType_id: "1"
Transaction_id: "68"
amIApprover: "true"
amICreator: "true"
createdby: "combineduserSB"
featureActionId: "ACH_COLLECTION_CREATE"
receivedApprovals: "0"
requiredApprovals: "1"
softDelete: "0"
userName: "combineduserSB"
}]
httpStatusCode: 0
opstatus: 0
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
rejectACHTransaction
| Description: | This API allows the user to reject the ACH transaction request. | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyApprovals/rejectACHTransaction | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters Request_id (Mandatory) Specifies the unique ID of the ACH transaction request that needs an approval. Comments (Mandatory) Specifies the additional comments of the user. Action (Mandatory) Specifies the action performed on the ACH file. {
"Request_id":"72",
"Comments":"Reject",
"Action":"Rejected"
}
|
||
| Response: |
Parameters /ActedBy Specifies the unique ID of the user who rejected the transaction. /FeatureAction Specifies the feature action of the rejected request. /Status Specifies the status of the rejection. /Transaction_id Specifies the unique ID of the rejected transaction. {
ActedBy: "1525111101"
FeatureAction_id: "ACH_PAYMENT_CREATE"
Status: "Rejected"
Transaction_id: "66"
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
rejectBBGeneralTransaction
| Description: | This API allows the user to reject a general transaction request. | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyApprovals/rejectBBGeneralTransaction | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters Request_id (Mandatory) Specifies the unique ID of the ACH transaction request that needs an approval. Comments (Mandatory) Specifies the additional comments of the user. Action (Mandatory) Specifies the action performed on the ACH file. {
"Request_id":"72",
"Comments":"Reject",
"Action":"Rejected"
}
|
||
| Response: |
Parameters /ActedBy Specifies the unique ID of the user who rejected the transaction. /FeatureAction Specifies the feature action of the rejected request. /Status Specifies the status of the rejection. /Transaction_id Specifies the unique ID of the rejected transaction. {
ActedBy: "1525111101"
FeatureAction_id: "DOMESTIC_WIRE_TRANSFER_CREATE"
Status: "Rejected"
Transaction_id: "114"
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getACHTransactionsRequestedByMe
| Description: | This API allows the user to fetch all the ACH transactions requested by the user. | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyRequests/getACHTransactionsRequestedByMe | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters searchString Specifies the string value such as nickname, firstname, lastname, and name to search the fields file name. sortByParam Specifies the field that must be sorted. By default, the payees will be sorted based on the date of creation. sortOrder Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default the value is set to ascending pageSize Specifies the number of rows that must be returned in the result. pageOffset Specifies the row from where the data must be retreived. The offset value is often used together with the limit. filterByTransactionType Specifies the type of transaction based on which the transactions are filtered. filterByStatus Specifies the status of the transaction based on which the transactions are filtered. filterByParam Specifies the parameter based on which the transactions are filtered. filterByValue Specifies the parameter value based on which the transactions are filtered. {
"searchString":"",
"sortByParam":"createdts",
"sortOrder":"DESC",
"pageSize":11,
"pageOffset":0,
"filterByTransactionType":"",
"filterByStatus":"",
"filterByParam":"",
"filterByValue":""
}
|
||
| Response: |
View the Response Parameters
/ACHTransactions Specifies an array of JSON object of ACH transactions. /ACHTransactions/AccountName Specifies the name of the account. /ACHTransactions/CompanyName Specifies the name of the company /ACHTransactions/CompanyId Specifies the unique ID of the company /ACHTransactions/CreatedOn Specifies the date of creation for the transaction. /ACHTransactions/Createdby Specifies the name of the user who performed the transaction. /ACHTransactions/EffectiveDate Specifies the effective date for the transaction. /ACHTransactions/MaxAmount Specifies the maximum amount for the ACH transaction. /ACHTransactions/RequestType Specifies the type of request. /ACHTransactions/Request_id Specifies the unique ID of the ACH transaction request. /ACHTransactions/Status Specifies the status of the ACH transaction. /ACHTransactions/TemplateName Specifies the name of the template. /ACHTransactions/TemplateRequestType_id Specifies the unique ID of the template request. /ACHTransactions/TemplateTypeValue Specifies the value of the template type. /ACHTransactions/TemplateType_id Specifies the unique ID of the template based on the type of template. /ACHTransactions/TotalAmount Specifies the total amount involved in the ACH transaction. /ACHTransactions/TransactionTypeValue Specifies the value of the transactio type. /ACHTransactions/TransactionType_id Specifies the unique ID transaction based on the type of transaction. /ACHTransactions/Transaction_id Specifies the unique ID of the transaction. /ACHTransactions/amIApprover Specifies whether the user is the approver. The value is Boolean. /ACHTransactions/amICreator Specifies whether the user is the creator. The value is Boolean. /ACHTransactions/createdby Specifies the name of the user who created the transaction. /ACHTransactions/featureActionId Specifies the unique ID of the feature action of the approved request. /ACHTransactions/receivedApprovals Specifies the number of requests that are received for approval. /ACHTransactions/requiredApprovals Specifies the number of requests that require approvals. /ACHTransactions/softDelete Specifies the value of the soft delete flag. /ACHTransactions/userName Specifies the username. View the Sample Response Code
ACHTransactions: [{
AccountName: "AccountName"
CompanyName: "Sugar Dough Bakers Inc._combineduserSB"
Company_id: "200929043902605"
CreatedOn: "2020-09-29T15:39:16Z"
Createdby: "1384203155"
DebitAccount: "200929043904310"
EffectiveDate: "2019-02-26 00:00:00.0"
MaxAmount: "7000"
RequestType: "CTX (Corporate Trade Exchange)"
Request_id: "73"
Status: "Pending"
TemplateName: "Corporate Trading"
TemplateRequestType_id: "6"
TemplateTypeValue: "ACH"
TemplateType_id: "1"
TotalAmount: "6076"
TransactionTypeValue: "Payment"
TransactionType_id: "2"
Transaction_id: "67"
amIApprover: "true"
amICreator: "true"
createdby: "combineduserSB"
featureActionId: "ACH_PAYMENT_CREATE"
receivedApprovals: "0"
requiredApprovals: "1"
softDelete: "0"
userName: "combineduserSB"
}]
httpStatusCode: 0
opstatus: 0
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getRequestsHistory
| Description: | This API allows the user to fetch all the previous requests made by the user for a transaction. | ||
| Method: | POST | ||
| URL: | services/data/v1/ApprovalRequestObjects/operations/MyRequests/getRequestsHistory | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters Request_id Specifies the unique ID of the ACH transaction request for which the history must be fetched. {
"Request_id":"71"
}
|
||
| Response: |
Parameters /Action Specifies the action performed on the transaction. /Actionts Specifies the times stamp of the action. /Comments Specifies the additional comments provided the user. /Company_id Specifies the unique ID of the company. /Request_id Specifies the unique ID of the ACH transaction. /Status Specifies the status of the action. /approvalId Specifies the unique ID for the approved transaction. /softDelete Specifies the value of the soft delete flag. /userName Specifies the username of the user. {
Action: "Pending"
Actionts: "2020-09-29T15:39:16Z"
Comments: "Request created"
Company_id: "200929043902605"
Request_id: "71"
Status: "Pending"
approvalId: "136"
softDelete: "false"
userName: "John Doe"
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
Add Bookmark
save your best linksView Bookmarks
Visit your best links
BACK
Are you sure you want to log-off?