Account Sweep APIs

Name Description Introduced In
getAccountSweepById This API retrieves account sweep details by ID. 2023.01
createAccountSweep This API creates account sweep details by ID. 2023.01
getAccountSweeps This API retrieves account sweep details. 2023.01
editAccountSweep This API edits an account sweep. 2023.01
deleteAccountSweep This API deletes an account sweep. 2023.01
initiateDownloadAccountSweeps This API downloads account sweep details. 2023.01
Object Data Model This Object Data Model describes the parameter name and other attribute details for Trade Finance.  
ClosedgetAccountSweepById
 
Description: This API retrieves account sweep details by ID.
Method: POST
URL: {base_url} /services/data/v1/AccountSweepsObjects/operations/AccountSweeps/getAccountSweepById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "accountId": "123161"
}
Response: 
{

    "AccountSweep": [
        {
            "primaryAccountName": "Current Account",
            "primaryAccountNumber": "124192",
            "secondaryAccountName": "Savings Account",
            "secondaryAccountNumber": "124192",
            "belowSweepAmount": "12.0",
            "aboveSweepAmount": "34.0",
            "frequency": "Daily",
            "startDate": "12/12/2022",
            "endDate": "12/12/2023",
            "serviceRequestId": "SUS22361I3CLP"
        }
    ],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Service Request Microservice
Enterprise API: {base_url}/api/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API field MS API field Transact API field
NA AccountSweep NA AccountSweep
Primary Account primaryAccountName NA primaryAccountName
Primary Account primaryAccountNumber NA primaryAccountNumber
Secondary Account secondaryAccountName NA secondaryAccountName
Secondary Account secondaryAccountNumber NA secondaryAccountNumber
Below Amount belowSweepAmount NA belowSweepAmount
Above Amount aboveSweepAmount NA aboveSweepAmount
Frequency frequency NA frequency
Starting From startDate NA startDate
Reference Number serviceRequestId NA serviceRequestId
End Date endDate NA endDate
ClosedcreateAccountSweep
 
Description: This API creates account sweep details by ID.
Method: POST
URL: {base_url}/services/data/v1/AccountSweepsObjects/operations/AccountSweeps/createAccountSweep
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "primaryAccountNumber": "123161",
    "secondaryAccountNumber": "123153",
    "belowSweepAmount": "5",
    "aboveSweepAmount": "",
    "frequency": "Daily",
    "startDate": "2025-12-12",
    "endDate": "2026-12-12",
    "currencyCode": "USD",
    "primaryAccountName": "MyCheckingAccount",
    "secondaryAccountName": "SavingAccount"
}
Response: 
{
    "serviceRequestId": "ACSW22347SVOVB",
    "opstatus": 0,
    "message": "Service Request created successfully",
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Service Request Microservice
Enterprise API:

Field Mapping

UI Field Experience API field MS API field Transact API field
Reference Number serviceRequestId NA serviceRequestId
ClosedgetAccountSweeps
 
Description: This API retrieves account sweep details.
Method: POST
URL: {base_url}/services/data/v1/AccountSweepsObjects/operations/AccountSweeps/getAccountSweeps
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "sortByParam": "PrimaryAccount",
    "sortOrder": "ASC",
    "pageSize": 11,
    "pageOffset": 0,
    "filterByParam": "sweepcondition",
    "filterByValue": "Both",
    "timeParam": "",
    "timeValue": ""
}
Response: 
{
    "AccountSweeps": [
        {
            "primaryAccountName": "Current Account",
            "primaryAccountNumber": "124192",
            "secondaryAccountName": "Savings Account",
            "secondaryAccountNumber": "124206",
            "belowSweepAmount": "",
            "aboveSweepAmount": "4",
            "frequency": "Daily",
            "startDate": "12/27/2022",
            "endDate": "12/23/2025",
            "serviceRequestId": "SUS22361X19P2"
        },
        {
            "primaryAccountName": "Current Account",
            "primaryAccountNumber": "124206",
            "secondaryAccountName": "Savings Account",
            "secondaryAccountNumber": "124192",
            "belowSweepAmount": "4",
            "aboveSweepAmount": "",
            "frequency": "Daily",
            "startDate": "12/27/2022",
            "endDate": "12/23/2025",
            "serviceRequestId": "SUS22361I3CLP"
        }
    ],

      "opstatus": 0,
      "httpStatusCode": 0

}
Error Code(s):

 
Enterprise Provider: Service Request Microservice
Enterprise API: {base_url}/api/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API field MS API field Transact API field
NA AccountSweep NA AccountSweep
Primary Account primaryAccountName NA primaryAccountName
Primary Account primaryAccountNumber NA primaryAccountNumber
Secondary Account secondaryAccountName NA secondaryAccountName
Secondary Account secondaryAccountNumber NA secondaryAccountNumber
Below Amount belowSweepAmount NA belowSweepAmount
Above Amount aboveSweepAmount NA aboveSweepAmount
Frequency frequency NA frequency
Starting From startDate NA startDate
Reference Number serviceRequestId NA serviceRequestId
End Date endDate NA endDate
ClosededitAccountSweep
 
Description: This API edits an account sweep.
Method: POST
URL: {base_url}/services/data/v1/AccountSweepsObjects/operations/AccountSweeps/editAccountSweep
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "aboveSweepAmount": "",
    "belowSweepAmount": "6",
    "currencyCode": "USD",
    "endDate": "12/23/2025",
    "frequency": "Daily",
    "primaryAccountName": "Current Account",
    "primaryAccountNumber": "124206",
    "secondaryAccountName": "Savings Account",
    "secondaryAccountNumber": "124192",
    "startDate": "12/30/2022"
}
Response: 
{
    "serviceRequestId": "MAS22362JEG8H",
    "message": "Service Request created successfully",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Service Request Microservice
Enterprise API: {base_url}/api/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API field MS API field Transact API field
Reference Number serviceRequestId NA serviceRequestId
CloseddeleteAccountSweep
 
Description: This API deletes an account sweep.
Method: POST
URL: {base_url}/services/data/v1/AccountSweepsObjects/operations/AccountSweeps/deleteAccountSweep
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "aboveSweepAmount": "4",
    "belowSweepAmount": "2",
    "currencyCode": "USD",
    "endDate": "12/23/2025",
    "frequency": "Daily",
    "primaryAccountName": "Current Account",
    "primaryAccountNumber": "124192",
    "secondaryAccountName": "Savings Account",
    "secondaryAccountNumber": "124206",
    "startDate": "12/27/2022"
}
Response: 
{
    "serviceRequestId": "SAS223614V5X2",
    "message": "Service Request created successfully",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Service Request Microservice
Enterprise API: {base_url}/api/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API field MS API field Transact API field
Reference Number serviceRequestId NA serviceRequestId
ClosedinitiateDownloadAccountSweeps
 
Description: This API downloads account sweep details.
Method: POST
URL: {base_url} /services/data/v1/AccountSweepsObjects/operations/AccountSweeps/initiateDownloadAccountSweeps
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "aboveSweepAmount": "4",
    "belowSweepAmount": "2",
    "currencyCode": "USD",
    "endDate": "12/23/2025",
    "frequency": "Daily",
    "primaryAccountName": "Current Account",
    "primaryAccountNumber": "124192",
    "secondaryAccountName": "Savings Account",
    "secondaryAccountNumber": "124206",
    "startDate": "12/27/2022"
}
Response: 
{
    "fileId": "1760612305",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Service Request Microservice
Enterprise API: {base_url}/api/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API field MS API field Transact API field
NA fileId NA NA
ClosedObject Data Model
ClosedData Model: Get Account By Sweep ID
 
Parameter Name DataType Mandatory/Optional Description
AccountSweep Array Mandatory List of account sweeps
primaryAccountName string Mandatory Primary account name
primaryAccountNumber string Mandatory Primary account number
secondaryAccountName string Mandatory Secondary account name
secondaryAccountNumber string Mandatory Secondary account number
belowSweepAmount string Mandatory below sweep amount
aboveSweepAmount string Mandatory above sweep amount
frequency string Mandatory frequency of account sweep
startDate string Mandatory start date
endDate string Mandatory end date
serviceRequestId string Mandatory service request ID
ClosedData Model: Create Account Sweep
 
Parameter Name DataType Mandatory/Optional Description
serviceRequestId Array Mandatory List of account sweeps
ClosedData Model: Get Account Sweeps
 
Parameter Name DataType Mandatory/Optional Description
AccountSweep Array Mandatory List of account sweeps
primaryAccountName string Mandatory Primary account name
primaryAccountNumber string Mandatory Primary account number
secondaryAccountName string Mandatory Secondary account name
secondaryAccountNumber string Mandatory Secondary account number
belowSweepAmount string Mandatory below sweep amount
aboveSweepAmount string Mandatory above sweep amount
frequency string Mandatory frequency of account sweep
startDate string Mandatory start date
endDate string Mandatory end date
serviceRequestId string Mandatory service request ID
ClosedData Model: Edit Account Sweep
 
Parameter Name DataType Mandatory/Optional Description
serviceRequestId Array Mandatory List of account sweeps
ClosedData Model: Delete Account Sweep
 
Parameter Name DataType Mandatory/Optional Description
serviceRequestId Array Mandatory List of account sweeps
ClosedData Model: Download Sweep
 
Parameter Name DataType Mandatory/Optional Description
fileId Array Mandatory List of account sweeps
Field Name
|
Application/Table name
Expand/ Collapse
Share
Print

In this topic

Temenos Headquarters SA
2 Rue de l'Ecole-de-Chimie
CH - 1205 Geneva
Switzerland

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Tuesday, May 23, 2023 8:37:36 PM IST