Last updated 10 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
Retrieve positive pay
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/parameter/getPositivePay HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 151 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PositivePayVendorIndex": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "PositivePay": { "Description": "text", "Type": 1, "VendorId": "text", "VendorIndex": 1, "VendorToken": "text", "VendorUrl": "text" } }
Returns the positive pay with select fields
POST /nexum/627/2022.01/parameter/getPositivePaySelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 331 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PositivePayVendorIndex": 1, "SelectableFields": { "IncludeAllPositivePayFields": true, "PositivePayFields": { "Description": true, "Type": true, "VendorId": true, "VendorIndex": true, "VendorToken": true, "VendorUrl": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of positive pay
POST /nexum/627/2022.01/parameter/getPositivePayPagedList 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" } } }
{ "PositivePay": [ { "Description": "text", "Type": 1, "VendorId": "text", "VendorIndex": 1, "VendorToken": "text", "VendorUrl": "text" } ], "Token": "text" }
Returns the list of positive pay with select fields
POST /nexum/627/2022.01/parameter/getPositivePayListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 304 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllPositivePayFields": true, "PositivePayFields": { "Description": true, "Type": true, "VendorId": true, "VendorIndex": true, "VendorToken": true, "VendorUrl": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "PositivePayList": { "hasReachedMaximumListSize": true, "PositivePay": [ { "Description": "text", "Type": 1, "VendorId": "text", "VendorIndex": 1, "VendorToken": "text", "VendorUrl": "text" } ] } }
Retrieve a list of select fields for PositivePay settings
POST /nexum/627/2022.01/parameter/searchPositivePaySelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 336 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllPositivePayFields": true, "PositivePayFields": { "Description": true, "Type": true, "VendorId": true, "VendorIndex": true, "VendorToken": true, "VendorUrl": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Returns paged list of positive pay with select fields
POST /nexum/627/2022.01/parameter/getPositivePayPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 398 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllPositivePayFields": true, "PositivePayFields": { "Description": true, "Type": true, "VendorId": true, "VendorIndex": true, "VendorToken": true, "VendorUrl": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a paged list of select fields for PositivePay settings
POST /nexum/627/2022.01/parameter/searchPositivePayPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 413 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllPositivePayFields": true, "PositivePayFields": { "Description": true, "Type": true, "VendorId": true, "VendorIndex": true, "VendorToken": true, "VendorUrl": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update positive pay by ID
POST /nexum/627/2022.01/parameter/updatePositivePayByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 270 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PositivePayVendorIndex": 1, "PositivePayUpdatableFields": { "Description": "text", "Type": 1, "VendorId": "text", "VendorToken": "text", "VendorUrl": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
