Skip to content
NexumAPI Docs

RemittanceService⁠

Manage remittance records.

Operations⁠

getRemittanceSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
RemittanceGlobalSequenceDatestring · dateoptionalThe remittance global sequence date.
RemittanceGlobalSequenceintegeroptionalThe remittance global sequence number.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/remittance/getRemittanceSelectFields
POST /nexum/627/persistent/remittance/getRemittanceSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "string",
  "RemittanceGlobalSequence": 0,
  "SelectableFields": {
    "IncludeAllRemittanceFields": true,
    "RemittanceFields": {
      "Amount": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "Description": true,
      "FundType": true,
      "GlCode": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "MemberAccount": true,
      "Payer": true,
      "PostDate": true,
      "PrevDueDate": true,
      "ProcessorAcct": true,
      "ProcessorCode": true,
      "ReconDate": true,
      "RecordChangeDate": true,
      "RemitDate": true,
      "Sequence": true,
      "Status": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateRemittanceByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
RemittanceGlobalSequenceDatestring · dateoptionalThe remittance global sequence date.
RemittanceGlobalSequenceintegeroptionalThe remittance global sequence number.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/remittance/updateRemittanceByID
POST /nexum/627/persistent/remittance/updateRemittanceByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "string",
  "RemittanceGlobalSequence": 0,
  "RemittanceFields": {
    "Amount": 0,
    "ConfirmationNumber": "string",
    "ConfirmationSeq": 0,
    "ConsoleNumber": 0,
    "Description": "string",
    "FundType": 0,
    "GlCode": 0,
    "GlobalSequence": 0,
    "GlobalSequenceDate": "string",
    "MemberAccount": "string",
    "Payer": 0,
    "PostDate": "string",
    "PrevDueDate": "string",
    "ProcessorAcct": "string",
    "ProcessorCode": 0,
    "ReconDate": "string",
    "RecordChangeDate": "string",
    "RemitDate": "string",
    "Sequence": 0,
    "Status": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}

createRemittance⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/remittance/createRemittance
POST /nexum/627/persistent/remittance/createRemittance HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceFields": {
    "Amount": "string",
    "Description": "string",
    "MemberAccount": "0",
    "ProcessorAcct": "0",
    "Status": 0,
    "TranType": 0,
    "FundType": 0
  }
}

deleteRemittance⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
RemittanceGlobalSequenceDatestring · dateoptionalThe remittance global sequence date.
RemittanceGlobalSequenceintegeroptionalThe remittance global sequence number.
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/persistent/remittance/deleteRemittance
POST /nexum/627/persistent/remittance/deleteRemittance HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "string",
  "RemittanceGlobalSequence": 0,
  "nxAttributes": {
    "customFields": {}
  }
}