PayeeService

Display, create, revise, and delete payee information.

Symitar eDocs References: Coming soon.

Operations

getPayeeSelectFields

post

Retrieves selected fields of information for a payee.

Authorizations
Body
PayeeNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/payee/getPayeeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 673

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeNumber": "text",
  "SelectableFields": {
    "IncludeAllPayeeFields": true,
    "PayeeFields": {
      "BillPaymentTypeCode": true,
      "CheckCode": true,
      "City": true,
      "CompanyDisc": true,
      "CompanyEntryDesc": true,
      "CompanyName": true,
      "ContactEmail": true,
      "ContactName": true,
      "ContactPhone": true,
      "CreationDate": true,
      "DfiAccount": true,
      "ExtraAddress": true,
      "LastFmDate": true,
      "LastPaymentDate": true,
      "Name": true,
      "Number": true,
      "PaymentsLastYear": true,
      "PaymentsYtd": true,
      "RdfiName": true,
      "RdfiRt": true,
      "ReceivingComp": true,
      "RecordChangeDate": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Payee": {
    "BillPaymentTypeCode": 1,
    "CheckCode": 1,
    "City": "text",
    "CompanyDisc": "text",
    "CompanyEntryDesc": "text",
    "CompanyName": "text",
    "ContactEmail": "text",
    "ContactName": "text",
    "ContactPhone": "text",
    "CreationDate": "2025-06-23",
    "DfiAccount": "text",
    "ExtraAddress": "text",
    "LastFmDate": "2025-06-23",
    "LastPaymentDate": "2025-06-23",
    "Name": "text",
    "Number": "text",
    "PaymentsLastYear": 1,
    "PaymentsYtd": 1,
    "RdfiName": "text",
    "RdfiRt": "text",
    "ReceivingComp": "text",
    "RecordChangeDate": "2025-06-23",
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  }
}

updatePayeeByID

post

Updates information about a payee based on its ID.

Authorizations
Body
PayeeNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/payee/updatePayeeByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 677

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeNumber": "text",
  "PayeeFields": {
    "BillPaymentTypeCode": 1,
    "CheckCode": 1,
    "City": "text",
    "CompanyDisc": "text",
    "CompanyEntryDesc": "text",
    "CompanyName": "text",
    "ContactEmail": "text",
    "ContactName": "text",
    "ContactPhone": "text",
    "CreationDate": "2025-06-23",
    "DfiAccount": "text",
    "ExtraAddress": "text",
    "LastFmDate": "2025-06-23",
    "LastPaymentDate": "2025-06-23",
    "Name": "text",
    "Number": "text",
    "PaymentsLastYear": 1,
    "PaymentsYtd": 1,
    "RdfiName": "text",
    "RdfiRt": "text",
    "ReceivingComp": "text",
    "RecordChangeDate": "2025-06-23",
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

createPayee

post

Adds a new payee.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/payee/createPayee HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 656

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeFields": {
    "BillPaymentTypeCode": 1,
    "CheckCode": 1,
    "City": "text",
    "CompanyDisc": "text",
    "CompanyEntryDesc": "text",
    "CompanyName": "text",
    "ContactEmail": "text",
    "ContactName": "text",
    "ContactPhone": "text",
    "CreationDate": "2025-06-23",
    "DfiAccount": "text",
    "ExtraAddress": "text",
    "LastFmDate": "2025-06-23",
    "LastPaymentDate": "2025-06-23",
    "Name": "text",
    "Number": "text",
    "PaymentsLastYear": 1,
    "PaymentsYtd": 1,
    "RdfiName": "text",
    "RdfiRt": "text",
    "ReceivingComp": "text",
    "RecordChangeDate": "2025-06-23",
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayeeNumber": "text"
}

deletePayee

post

Removes an existing payee.

Authorizations
Body
PayeeNumberstringRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/payee/deletePayee HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayeeNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "nxAttributes": {}
}
PreviousParticipantServiceNextPowerOnService

Last updated

Was this helpful?