RemittanceService

Manage remittance records.

Symitar eDocs References: Coming soon.

Operations

getRemittanceSelectFields

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

RemittanceGlobalSequenceDatestring · dateOptional

The remittance global sequence date.

RemittanceGlobalSequenceintegerOptional

The remittance global sequence number.

Responses

200

Successful operation.

application/json

post/getRemittanceSelectFields

POST /nexum/627/persistent/remittance/getRemittanceSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 786

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "RemittanceGlobalSequenceDate": "2026-01-01",
  "RemittanceGlobalSequence": 1,
  "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,
      "TranCode": true,
      "TranType": true,
      "User": true,
      "VoidDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "Remittance": {
    "Amount": 1,
    "ConfirmationNumber": "text",
    "ConfirmationSeq": 1,
    "ConsoleNumber": 1,
    "Description": "text",
    "FundType": 1,
    "GlCode": 1,
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2026-01-01",
    "MemberAccount": "text",
    "Payer": 1,
    "PostDate": "2026-01-01",
    "PrevDueDate": "2026-01-01",
    "ProcessorAcct": "text",
    "ProcessorCode": 1,
    "ReconDate": "2026-01-01",
    "RecordChangeDate": "2026-01-01",
    "RemitDate": "2026-01-01",
    "Sequence": 1,
    "Status": 1,
    "TranCode": "text",
    "TranType": 1,
    "User": 1,
    "VoidDate": "2026-01-01"
  }
}

updateRemittanceByID

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

RemittanceGlobalSequenceDatestring · dateOptional

The remittance global sequence date.

RemittanceGlobalSequenceintegerOptional

The remittance global sequence number.

Responses

200

Successful operation.

application/json

post/updateRemittanceByID

POST /nexum/627/persistent/remittance/updateRemittanceByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 761

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "RemittanceGlobalSequenceDate": "2026-01-01",
  "RemittanceGlobalSequence": 1,
  "RemittanceFields": {
    "Amount": 1,
    "ConfirmationNumber": "text",
    "ConfirmationSeq": 1,
    "ConsoleNumber": 1,
    "Description": "text",
    "FundType": 1,
    "GlCode": 1,
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2026-01-01",
    "MemberAccount": "text",
    "Payer": 1,
    "PostDate": "2026-01-01",
    "PrevDueDate": "2026-01-01",
    "ProcessorAcct": "text",
    "ProcessorCode": 1,
    "ReconDate": "2026-01-01",
    "RecordChangeDate": "2026-01-01",
    "RemitDate": "2026-01-01",
    "Sequence": 1,
    "Status": 1,
    "TranCode": "text",
    "TranType": 1,
    "User": 1,
    "VoidDate": "2026-01-01"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}

createRemittance

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/createRemittance

POST /nexum/627/persistent/remittance/createRemittance HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceFields": {
    "Amount": "0.01",
    "Description": "NXW3TEST",
    "MemberAccount": "0000013824",
    "ProcessorAcct": "99999999990000",
    "Status": 0,
    "TranType": 0,
    "FundType": 0
  }
}

200

Successful operation.

{
  "RemittanceCompositeKey": {
    "RemittanceGlobalSequenceDate": "2026-01-01",
    "RemittanceGlobalSequence": 1
  }
}

deleteRemittance

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

RemittanceGlobalSequenceDatestring · dateOptional

The remittance global sequence date.

RemittanceGlobalSequenceintegerOptional

The remittance global sequence number.

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteRemittance

POST /nexum/627/persistent/remittance/deleteRemittance HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "RemittanceGlobalSequenceDate": "2026-01-01",
  "RemittanceGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}