Skip to content
NexumAPI Docs

FinrepService⁠

Manage Current Transaction Report (CTR) records.

Operations⁠

getCtrForeignPagedList⁠

POST

Retrieves a paged list of foreign CTRs.

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}/2022.01/finrep/getCtrForeignPagedList
POST /nexum/627/2022.01/finrep/getCtrForeignPagedList 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"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrForeignListSelectFields⁠

POST

Retrieves a 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
POST/nexum/{sym}/2022.01/finrep/getCtrForeignListSelectFields
POST /nexum/627/2022.01/finrep/getCtrForeignListSelectFields 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",
  "SelectableFields": {
    "IncludeAllCtrForeignFields": true,
    "CtrForeignFields": {
      "Cashin": true,
      "Cashout": true,
      "CountryCode": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchCtrForeignSelectFields⁠

POST

Searches 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
POST/nexum/{sym}/2022.01/finrep/searchCtrForeignSelectFields
POST /nexum/627/2022.01/finrep/searchCtrForeignSelectFields 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",
  "SelectableFields": {
    "IncludeAllCtrForeignFields": true,
    "CtrForeignFields": {
      "Cashin": true,
      "Cashout": true,
      "CountryCode": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "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}/2022.01/finrep/getCtrForeignPagedListSelectFields
POST /nexum/627/2022.01/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": {}
  }
}

searchCtrForeignPagedSelectFields⁠

POST

Searches foreign CTRs with pagination and selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CtrNumberstringoptional
Querystringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/finrep/searchCtrForeignPagedSelectFields
POST /nexum/627/2022.01/finrep/searchCtrForeignPagedSelectFields 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
    }
  },
  "Query": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrNote⁠

POST

Retrieves CTR notes.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CtrNumberstringoptional
CtrNoteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/finrep/getCtrNote
POST /nexum/627/2022.01/finrep/getCtrNote 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",
  "CtrNoteLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}