FinrepService⁠

Manage Current Transaction Report (CTR) records.

Operations⁠

getCtrBranchPagedListSelectFields⁠

POST

Retrieves a paged list of CTR branches with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/finrep/getCtrBranchPagedListSelectFields

POST /nexum/627/persistent/finrep/getCtrBranchPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllCtrBranchFields": true,
    "CtrBranchFields": {
      "Address": true,
      "CashinLocation": true,
      "CashoutLocation": true,
      "City": true,
      "CountryCode": true,
      "Ein": true,
      "Id": true,
      "LastFmDate": true,
      "Locator": true,
      "Name": true,
      "RecordChangeDate": true,
      "State": true,
      "Type": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchCtrBranchPagedSelectFields⁠

POST

Searches CTR branches with pagination and selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/finrep/searchCtrBranchPagedSelectFields

POST /nexum/627/persistent/finrep/searchCtrBranchPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllCtrBranchFields": true,
    "CtrBranchFields": {
      "Address": true,
      "CashinLocation": true,
      "CashoutLocation": true,
      "City": true,
      "CountryCode": true,
      "Ein": true,
      "Id": true,
      "LastFmDate": true,
      "Locator": true,
      "Name": true,
      "RecordChangeDate": true,
      "State": true,
      "Type": true,
      "ZipCode": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrFmHistoryPagedListSelectFields⁠

POST

Retrieves a paged list of CTRs from history with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/finrep/getCtrFmHistoryPagedListSelectFields

POST /nexum/627/persistent/finrep/getCtrFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllCtrFmHistoryFields": true,
    "CtrFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchCtrFmHistoryPagedSelectFields⁠

POST

Searches CTRs from history with pagination and selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/finrep/searchCtrFmHistoryPagedSelectFields

POST /nexum/627/persistent/finrep/searchCtrFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllCtrFmHistoryFields": true,
    "CtrFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true
    }
  },
  "SearchFilter": {
    "StartPostDate": "string",
    "EndPostDate": "string",
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrForeignSelectFields⁠

POST

Retrieves foreign CTRs with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

CtrForeignLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/finrep/getCtrForeignSelectFields

POST /nexum/627/persistent/finrep/getCtrForeignSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "CtrForeignLocator": 0,
  "SelectableFields": {
    "IncludeAllCtrForeignFields": true,
    "CtrForeignFields": {
      "Cashin": true,
      "Cashout": true,
      "CountryCode": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrForeignPagedListSelectFields⁠

POST

Retrieves a paged list of foreign CTRs with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/finrep/getCtrForeignPagedListSelectFields

POST /nexum/627/persistent/finrep/getCtrForeignPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllCtrForeignFields": true,
    "CtrForeignFields": {
      "Cashin": true,
      "Cashout": true,
      "CountryCode": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}