FinrepService⁠

Manage Current Transaction Report (CTR) records.

Operations⁠

searchCtrPersonCtrTranInfoSelectFields⁠

POST

Searches CTR transaction information for individuals with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

CtrPersonLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/searchCtrPersonCtrTranInfoSelectFields

POST /nexum/627/2022.01/finrep/searchCtrPersonCtrTranInfoSelectFields 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",
  "CtrPersonLocator": 0,
  "SelectableFields": {
    "IncludeAllCtrPersonCtrTranInfoFields": true,
    "CtrPersonCtrTranInfoFields": {
      "AccountNumber": true,
      "Amount": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SlId": true,
      "SlIdType": true,
      "Source": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrPersonCtrTranInfoPagedListSelectFields⁠

POST

Retrieves a paged list of CTR transaction information for individuals with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

CtrPersonLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/finrep/getCtrPersonCtrTranInfoPagedListSelectFields

POST /nexum/627/2022.01/finrep/getCtrPersonCtrTranInfoPagedListSelectFields 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",
  "CtrPersonLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllCtrPersonCtrTranInfoFields": true,
    "CtrPersonCtrTranInfoFields": {
      "AccountNumber": true,
      "Amount": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SlId": true,
      "SlIdType": true,
      "Source": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchCtrPersonCtrTranInfoPagedSelectFields⁠

POST

Searches CTR transaction information for individuals with pagination and selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

CtrPersonLocatorintegeroptional

Querystringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/finrep/searchCtrPersonCtrTranInfoPagedSelectFields

POST /nexum/627/2022.01/finrep/searchCtrPersonCtrTranInfoPagedSelectFields 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",
  "CtrPersonLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllCtrPersonCtrTranInfoFields": true,
    "CtrPersonCtrTranInfoFields": {
      "AccountNumber": true,
      "Amount": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SlId": true,
      "SlIdType": true,
      "Source": true
    }
  },
  "Query": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

updateCtrByID⁠

POST

Updates a CTR by its ID.

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/updateCtrByID

POST /nexum/627/2022.01/finrep/updateCtrByID 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",
  "CtrUpdatableFields": {
    "AckByUser": "string",
    "AckDate": "string",
    "AckErrorByUser": "string",
    "AckErrorDate": "string",
    "ApproveAmendByUser": "string",
    "ApproveAmendDate": "string",
    "ApproveByUser": "string",
    "ApproveDate": "string",
    "Approver": "string",
    "ApproverTitle": "string",
    "BackFileFlag": 0,
    "BranchRouting": "string",
    "CashinBillsInsert": 0,
    "CashinCurrWager": 0,
    "CashinCurrXchng": 0,
    "CashinDeposit": 0,
    "CashinFundsXfer": 0,
    "CashinGamingIns": 0,
    "CashinNegIns": 0,
    "CashinOther": 0
  },
  "CtrAccountUpdateRequest": [
    {
      "CtrAccountLocator": 0,
      "CtrAccountUpdatableFields": {
        "AccountNumber": "string",
        "SlId": "string",
        "SlIdType": 0,
        "Source": 0
      }
    }
  ],
  "CtrBranchUpdateRequest": [
    {
      "CtrBranchLocator": 0,
      "CtrBranchUpdatableFields": {
        "Address": "string",
        "CashinLocation": 0,
        "CashoutLocation": 0,
        "City": "string",
        "CountryCode": "string",
        "Ein": "string",
        "Id": 0,
        "Name": "string",
        "State": "string",
        "Type": 0,
        "ZipCode": "string"
      }
    }
  ],
  "CtrForeignUpdateRequest": [
    {
      "CtrForeignLocator": 0,
      "CtrForeignUpdatableFields": {
        "Cashin": 0,
        "Cashout": 0,
        "CountryCode": "string"
      }
    }
  ],
  "CtrNoteUpdateRequest": [
    {
      "CtrNoteLocator": 0,
      "CtrNoteUpdatableFields": {
        "Code": 0,
        "EnterDate": "string",
        "EnterTime": 0,
        "ExpirationDate": "string",
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ],
        "UserId": 0,
        "VoidFlag": 0,
        "VoidedBy": 0
      }
    }
  ],
  "CtrPersonUpdateRequest": [
    {
      "CtrPersonLocator": 0,
      "CtrPersonUpdatableFields": {
        "Address": "string",
        "BirthDate": "string",
        "Cashin": 0,
        "Cashout": 0,
        "City": "string",
        "CountryCode": "string",
        "DbaFirst": "string",
        "DbaLast": "string",
        "DbaMiddle": "string",
        "DbaSuffix": "string",
        "Email": "string",
        "EntityFlag": 0,
        "First": "string",
        "Gender": "string",
        "Headquarters": 0,
        "IdIssueByCountry": "string",
        "IdIssueByState": "string",
        "IdNumber": "string",
        "IdTypeOtherDesc": "string",
        "IdVerifyMethod": 0
      },
      "CtrPersonCtrTranInfoUpdateRequest": [
        {
          "CtrPersonCtrTranInfoLocator": 0,
          "CtrPersonCtrTranInfoUpdatableFields": {
            "AccountNumber": "string",
            "Amount": 0,
            "SlId": "string",
            "SlIdType": 0,
            "Source": 0
          }
        }
      ]
    }
  ],
  "nxAttributes": {
    "customFields": {}
  }
}

updateCtrAccountByID⁠

POST

Updates a CTR account by its ID.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrAccountLocatorintegeroptional

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/updateCtrAccountByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrAccountLocator": 0,
  "CtrAccountUpdatableFields": {
    "AccountNumber": "string",
    "SlId": "string",
    "SlIdType": 0,
    "Source": 0
  },
  "CtrNumber": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

updateCtrBranchByID⁠

POST

Updates a CTR branch by its ID.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrBranchLocatorintegeroptional

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/updateCtrBranchByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrBranchLocator": 0,
  "CtrBranchUpdatableFields": {
    "Address": "string",
    "CashinLocation": 0,
    "CashoutLocation": 0,
    "City": "string",
    "CountryCode": "string",
    "Ein": "string",
    "Id": 0,
    "Name": "string",
    "State": "string",
    "Type": 0,
    "ZipCode": "string"
  },
  "CtrNumber": "string",
  "nxAttributes": {
    "customFields": {}
  }
}