OnlineCard

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineCard

post

Retrieve OnlineCard parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OnlineCardCardTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getOnlineCard

POST /nexum/627/2022.01/parameter/getOnlineCard HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineCardCardType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "OnlineCard": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getOnlineCard"
}

getOnlineCardSelectFields

post

Retrieve OnlineCard parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OnlineCardCardTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getOnlineCardSelectFields

POST /nexum/627/2022.01/parameter/getOnlineCardSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "OnlineCardCardType": 0,
  "SelectableFields": {
    "OnlineCardFields": {
      "CardType": true,
      "Bin": true,
      "SignatureDescription": true
    }
  }
}

200

Successful operation.

{
  "OnlineCard": {
    "Bin": null,
    "CardType": 0,
    "SignatureDescription": null
  },
  "MessageId": "getOnlineCardSelectFields"
}

getOnlineCardPagedList

post

Retrieve OnlineCard parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getOnlineCardPagedList

POST /nexum/627/2022.01/parameter/getOnlineCardPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "OnlineCard": [],
  "Token": null,
  "MessageId": "getOnlineCardPagedList"
}

getOnlineCardListSelectFields

post

Retrieve OnlineCard parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getOnlineCardListSelectFields

POST /nexum/627/2022.01/parameter/getOnlineCardListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineCardFields": true
  }
}

200

Successful operation.

{
  "OnlineCardList": [],
  "MessageId": "getOnlineCardListSelectFields"
}

searchOnlineCardSelectFields

post

Search OnlineCard parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchOnlineCardSelectFields

POST /nexum/627/2022.01/parameter/searchOnlineCardSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineCardFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "OnlineCardList": [],
  "MessageId": "searchOnlineCardSelectFields"
}

getOnlineCardPagedListSelectFields

post

Retrieve OnlineCard parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getOnlineCardPagedListSelectFields

POST /nexum/627/2022.01/parameter/getOnlineCardPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "OnlineCardFields": {
      "CardType": true,
      "Bin": true,
      "SignatureDescription": true
    }
  }
}

200

Successful operation.

{
  "OnlineCard": [
    {
      "Bin": null,
      "CardType": 0,
      "SignatureDescription": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getOnlineCardPagedListSelectFields"
}

searchOnlineCardPagedSelectFields

post

Search OnlineCard parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchOnlineCardPagedSelectFields

POST /nexum/627/2022.01/parameter/searchOnlineCardPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "OnlineCardFields": {
      "CardType": true,
      "Bin": true,
      "SignatureDescription": true
    }
  }
}

200

Successful operation.

{
  "OnlineCard": [
    {
      "Bin": null,
      "CardType": 0,
      "SignatureDescription": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchOnlineCardPagedSelectFields"
}

updateOnlineCardByID

post

Update OnlineCard parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OnlineCardCardTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateOnlineCardByID

POST /nexum/627/2022.01/parameter/updateOnlineCardByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineCardCardType": 1,
  "OnlineCardUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateOnlineCardByID"
}