OnlineFile
Last updated
Was this helpful?
Last updated
Was this helpful?
Retrieve online file information
POST /nexum/627/2022.01/parameter/getOnlineFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"OnlineFileFileRecord": 1,
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFile": {
"AvailBalExclList": "text",
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"CardType": 1,
"ExcludedStatusReasonCodes": "text",
"FileRecord": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"FraudControlTrackingType": 1,
"FwdUpdateToPinNetwork": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": 1,
"InstitutionId": "text",
"LimitGroupId": "text",
"MinimumBalanceChange": 1,
"NetworkMessageFormat": 1,
"PurgeDays": 1,
"ReceiveCardFraudNoteCode": 1,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": 1,
"SendNewCardOption": 1,
"SendPinOffsetMessage": true,
"SuffixFormat": 1,
"ThirdPartyPayments": [
{
"EntryId": 1,
"ThirdPartyPayments": true
}
],
"UseMailOverride": true,
"FwdUpdatesfrmOtherNetworks": "text",
"VauAbuOptOutWarningCode": 1,
"DigitalIssueTrackingType": 1,
"BonusAwardsTrackingType": 1,
"CardFraudNoteExpDays": 1
}
}
Retrieve online file select fields
POST /nexum/627/2022.01/parameter/getOnlineFileSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1043
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"OnlineFileFileRecord": 1,
"SelectableFields": {
"IncludeAllOnlineFileFields": true,
"OnlineFileFields": {
"AvailBalExclList": true,
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"BonusAwardsTrackingType": true,
"CardFraudNoteExpDays": true,
"CardType": true,
"DigitalIssueTrackingType": true,
"ExcludedStatusReasonCodes": true,
"FileRecord": true,
"FileType": true,
"FileUpdateMethod": true,
"FraudControlTrackingType": true,
"FwdUpdateToPinNetwork": true,
"FwdUpdatesfrmOtherNetworks": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": true,
"InstitutionId": true,
"LimitGroupId": true,
"MinimumBalanceChange": true,
"NetworkMessageFormat": true,
"PurgeDays": true,
"ReceiveCardFraudNoteCode": true,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": true,
"SendNewCardOption": true,
"SendPinOffsetMessage": true,
"SuffixFormat": true,
"ThirdPartyPayments": [
1
],
"UseMailOverride": true,
"VauAbuOptOutWarningCode": true
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFile": {
"AvailBalExclList": "text",
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"CardType": 1,
"ExcludedStatusReasonCodes": "text",
"FileRecord": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"FraudControlTrackingType": 1,
"FwdUpdateToPinNetwork": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": 1,
"InstitutionId": "text",
"LimitGroupId": "text",
"MinimumBalanceChange": 1,
"NetworkMessageFormat": 1,
"PurgeDays": 1,
"ReceiveCardFraudNoteCode": 1,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": 1,
"SendNewCardOption": 1,
"SendPinOffsetMessage": true,
"SuffixFormat": 1,
"ThirdPartyPayments": [
{
"EntryId": 1,
"ThirdPartyPayments": true
}
],
"UseMailOverride": true,
"FwdUpdatesfrmOtherNetworks": "text",
"VauAbuOptOutWarningCode": 1,
"DigitalIssueTrackingType": 1,
"BonusAwardsTrackingType": 1,
"CardFraudNoteExpDays": 1
}
}
Retrieve paged list of online files
POST /nexum/627/2022.01/parameter/getOnlineFilePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFile": [
{
"AvailBalExclList": "text",
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"CardType": 1,
"ExcludedStatusReasonCodes": "text",
"FileRecord": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"FraudControlTrackingType": 1,
"FwdUpdateToPinNetwork": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": 1,
"InstitutionId": "text",
"LimitGroupId": "text",
"MinimumBalanceChange": 1,
"NetworkMessageFormat": 1,
"PurgeDays": 1,
"ReceiveCardFraudNoteCode": 1,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": 1,
"SendNewCardOption": 1,
"SendPinOffsetMessage": true,
"SuffixFormat": 1,
"ThirdPartyPayments": [
{
"EntryId": 1,
"ThirdPartyPayments": true
}
],
"UseMailOverride": true,
"FwdUpdatesfrmOtherNetworks": "text",
"VauAbuOptOutWarningCode": 1,
"DigitalIssueTrackingType": 1,
"BonusAwardsTrackingType": 1,
"CardFraudNoteExpDays": 1
}
],
"Token": "text"
}
Retrieve online file list select fields
POST /nexum/627/2022.01/parameter/getOnlineFileListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1018
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"SelectableFields": {
"IncludeAllOnlineFileFields": true,
"OnlineFileFields": {
"AvailBalExclList": true,
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"BonusAwardsTrackingType": true,
"CardFraudNoteExpDays": true,
"CardType": true,
"DigitalIssueTrackingType": true,
"ExcludedStatusReasonCodes": true,
"FileRecord": true,
"FileType": true,
"FileUpdateMethod": true,
"FraudControlTrackingType": true,
"FwdUpdateToPinNetwork": true,
"FwdUpdatesfrmOtherNetworks": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": true,
"InstitutionId": true,
"LimitGroupId": true,
"MinimumBalanceChange": true,
"NetworkMessageFormat": true,
"PurgeDays": true,
"ReceiveCardFraudNoteCode": true,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": true,
"SendNewCardOption": true,
"SendPinOffsetMessage": true,
"SuffixFormat": true,
"ThirdPartyPayments": [
1
],
"UseMailOverride": true,
"VauAbuOptOutWarningCode": true
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFileList": {
"hasReachedMaximumListSize": true,
"OnlineFile": [
{
"AvailBalExclList": "text",
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"CardType": 1,
"ExcludedStatusReasonCodes": "text",
"FileRecord": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"FraudControlTrackingType": 1,
"FwdUpdateToPinNetwork": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": 1,
"InstitutionId": "text",
"LimitGroupId": "text",
"MinimumBalanceChange": 1,
"NetworkMessageFormat": 1,
"PurgeDays": 1,
"ReceiveCardFraudNoteCode": 1,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": 1,
"SendNewCardOption": 1,
"SendPinOffsetMessage": true,
"SuffixFormat": 1,
"ThirdPartyPayments": [
{
"EntryId": 1,
"ThirdPartyPayments": true
}
],
"UseMailOverride": true,
"FwdUpdatesfrmOtherNetworks": "text",
"VauAbuOptOutWarningCode": 1,
"DigitalIssueTrackingType": 1,
"BonusAwardsTrackingType": 1,
"CardFraudNoteExpDays": 1
}
]
}
}
Retrieve a list of select fields for online files
POST /nexum/627/2022.01/parameter/searchOnlineFileSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1050
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"SelectableFields": {
"IncludeAllOnlineFileFields": true,
"OnlineFileFields": {
"AvailBalExclList": true,
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"BonusAwardsTrackingType": true,
"CardFraudNoteExpDays": true,
"CardType": true,
"DigitalIssueTrackingType": true,
"ExcludedStatusReasonCodes": true,
"FileRecord": true,
"FileType": true,
"FileUpdateMethod": true,
"FraudControlTrackingType": true,
"FwdUpdateToPinNetwork": true,
"FwdUpdatesfrmOtherNetworks": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": true,
"InstitutionId": true,
"LimitGroupId": true,
"MinimumBalanceChange": true,
"NetworkMessageFormat": true,
"PurgeDays": true,
"ReceiveCardFraudNoteCode": true,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": true,
"SendNewCardOption": true,
"SendPinOffsetMessage": true,
"SuffixFormat": true,
"ThirdPartyPayments": [
1
],
"UseMailOverride": true,
"VauAbuOptOutWarningCode": true
}
},
"SearchFilter": {
"Query": "text"
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFileList": {
"hasReachedMaximumListSize": true,
"OnlineFile": [
{
"AvailBalExclList": "text",
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"CardType": 1,
"ExcludedStatusReasonCodes": "text",
"FileRecord": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"FraudControlTrackingType": 1,
"FwdUpdateToPinNetwork": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": 1,
"InstitutionId": "text",
"LimitGroupId": "text",
"MinimumBalanceChange": 1,
"NetworkMessageFormat": 1,
"PurgeDays": 1,
"ReceiveCardFraudNoteCode": 1,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": 1,
"SendNewCardOption": 1,
"SendPinOffsetMessage": true,
"SuffixFormat": 1,
"ThirdPartyPayments": [
{
"EntryId": 1,
"ThirdPartyPayments": true
}
],
"UseMailOverride": true,
"FwdUpdatesfrmOtherNetworks": "text",
"VauAbuOptOutWarningCode": 1,
"DigitalIssueTrackingType": 1,
"BonusAwardsTrackingType": 1,
"CardFraudNoteExpDays": 1
}
]
}
}
Retrieve paged list select fields of online files
POST /nexum/627/2022.01/parameter/getOnlineFilePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1112
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"SelectableFields": {
"IncludeAllOnlineFileFields": true,
"OnlineFileFields": {
"AvailBalExclList": true,
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"BonusAwardsTrackingType": true,
"CardFraudNoteExpDays": true,
"CardType": true,
"DigitalIssueTrackingType": true,
"ExcludedStatusReasonCodes": true,
"FileRecord": true,
"FileType": true,
"FileUpdateMethod": true,
"FraudControlTrackingType": true,
"FwdUpdateToPinNetwork": true,
"FwdUpdatesfrmOtherNetworks": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": true,
"InstitutionId": true,
"LimitGroupId": true,
"MinimumBalanceChange": true,
"NetworkMessageFormat": true,
"PurgeDays": true,
"ReceiveCardFraudNoteCode": true,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": true,
"SendNewCardOption": true,
"SendPinOffsetMessage": true,
"SuffixFormat": true,
"ThirdPartyPayments": [
1
],
"UseMailOverride": true,
"VauAbuOptOutWarningCode": true
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFile": [
{
"AvailBalExclList": "text",
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"CardType": 1,
"ExcludedStatusReasonCodes": "text",
"FileRecord": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"FraudControlTrackingType": 1,
"FwdUpdateToPinNetwork": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": 1,
"InstitutionId": "text",
"LimitGroupId": "text",
"MinimumBalanceChange": 1,
"NetworkMessageFormat": 1,
"PurgeDays": 1,
"ReceiveCardFraudNoteCode": 1,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": 1,
"SendNewCardOption": 1,
"SendPinOffsetMessage": true,
"SuffixFormat": 1,
"ThirdPartyPayments": [
{
"EntryId": 1,
"ThirdPartyPayments": true
}
],
"UseMailOverride": true,
"FwdUpdatesfrmOtherNetworks": "text",
"VauAbuOptOutWarningCode": 1,
"DigitalIssueTrackingType": 1,
"BonusAwardsTrackingType": 1,
"CardFraudNoteExpDays": 1
}
],
"Token": "text"
}
Retrieve a paged list of select fields for online files
POST /nexum/627/2022.01/parameter/searchOnlineFilePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1127
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"PagingRequestContext": {
"NumberOfRecordsToReturn": 1,
"NumberOfRecordsToSkip": 1,
"Token": "text"
},
"SelectableFields": {
"IncludeAllOnlineFileFields": true,
"OnlineFileFields": {
"AvailBalExclList": true,
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"BonusAwardsTrackingType": true,
"CardFraudNoteExpDays": true,
"CardType": true,
"DigitalIssueTrackingType": true,
"ExcludedStatusReasonCodes": true,
"FileRecord": true,
"FileType": true,
"FileUpdateMethod": true,
"FraudControlTrackingType": true,
"FwdUpdateToPinNetwork": true,
"FwdUpdatesfrmOtherNetworks": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": true,
"InstitutionId": true,
"LimitGroupId": true,
"MinimumBalanceChange": true,
"NetworkMessageFormat": true,
"PurgeDays": true,
"ReceiveCardFraudNoteCode": true,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": true,
"SendNewCardOption": true,
"SendPinOffsetMessage": true,
"SuffixFormat": true,
"ThirdPartyPayments": [
1
],
"UseMailOverride": true,
"VauAbuOptOutWarningCode": true
}
},
"Query": "text",
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFile": [
{
"AvailBalExclList": "text",
"AvailBalInclOdProtection": true,
"AvailBalInclOdTolerance": true,
"CardType": 1,
"ExcludedStatusReasonCodes": "text",
"FileRecord": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"FraudControlTrackingType": 1,
"FwdUpdateToPinNetwork": true,
"FwdUpdatetoVisaMasterCard": true,
"HighPriorityMsgOption": 1,
"InstitutionId": "text",
"LimitGroupId": "text",
"MinimumBalanceChange": 1,
"NetworkMessageFormat": 1,
"PurgeDays": 1,
"ReceiveCardFraudNoteCode": 1,
"SendActivationMessage": true,
"SendBalances": true,
"SendCardFraudNoteCode": 1,
"SendNewCardOption": 1,
"SendPinOffsetMessage": true,
"SuffixFormat": 1,
"ThirdPartyPayments": [
{
"EntryId": 1,
"ThirdPartyPayments": true
}
],
"UseMailOverride": true,
"FwdUpdatesfrmOtherNetworks": "text",
"VauAbuOptOutWarningCode": 1,
"DigitalIssueTrackingType": 1,
"BonusAwardsTrackingType": 1,
"CardFraudNoteExpDays": 1
}
],
"Token": "text"
}
Retrieve online file manager information
POST /nexum/627/2022.01/parameter/getOnlineFileMgr HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFileMgr": {
"CycleActiveFrom": 1,
"CycleActiveUntil": 1,
"JournalFormat": 1,
"PauseBetweenCycles": 1,
"HighPriorityFraudTrackType": 1,
"SaveRejectedMsgsInDialog": true,
"SendDeleteOnDataException": true
}
}
Retrieve online file manager select fields
POST /nexum/627/2022.01/parameter/getOnlineFileMgrSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 399
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"SelectableFields": {
"IncludeAllOnlineFileMgrFields": true,
"OnlineFileMgrFields": {
"CycleActiveFrom": true,
"CycleActiveUntil": true,
"HighPriorityFraudTrackType": true,
"JournalFormat": true,
"PauseBetweenCycles": true,
"SaveRejectedMsgsInDialog": true,
"SendDeleteOnDataException": true
}
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"OnlineFileMgr": {
"CycleActiveFrom": 1,
"CycleActiveUntil": 1,
"JournalFormat": 1,
"PauseBetweenCycles": 1,
"HighPriorityFraudTrackType": 1,
"SaveRejectedMsgsInDialog": true,
"SendDeleteOnDataException": true
}
}
Update online files by ID
POST /nexum/627/2022.01/parameter/updateOnlineFileByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 274
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"OnlineFileFileRecord": 1,
"OnlineFileUpdatableFields": {
"CardType": 1,
"FileType": 1,
"FileUpdateMethod": 1,
"NetworkMessageFormat": 1,
"UseMailOverride": true
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"UpdateStatus": {
"isAllFieldsUpdateSuccess": true,
"FailedUpdateStatus": [
{
"Record": "text",
"ErrorCode": "text",
"ErrorMessage": "text",
"PrimaryKeyField": [
{
"Name": "text",
"Value": "text"
}
]
}
]
}
}
Update online file managers by ID
POST /nexum/627/2022.01/parameter/updateOnlineFileMgrByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 335
{
"Credentials": {
"AdministrativeCredentials": {
"Password": "suwn37834b91&"
}
},
"OnlineFileMgrUpdatableFields": {
"CycleActiveFrom": 1,
"CycleActiveUntil": 1,
"HighPriorityFraudTrackType": 1,
"JournalFormat": 1,
"PauseBetweenCycles": 1,
"SaveRejectedMsgsInDialog": true,
"SendDeleteOnDataException": true
},
"nxAttributes": {
"customFields": {
"appId": "glaci"
}
}
}
Successful operation.
{
"UpdateStatus": {
"isAllFieldsUpdateSuccess": true,
"FailedUpdateStatus": [
{
"Record": "text",
"ErrorCode": "text",
"ErrorMessage": "text",
"PrimaryKeyField": [
{
"Name": "text",
"Value": "text"
}
]
}
]
}
}