Skip to content
NexumAPI Docs

getWireBeneficiary⁠

Perform various get operations on wire beneficiary records.

Operations⁠

getWireBeneficiaryAdv⁠

POST

Retrieve beneficiary details including advanced information

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 0,
  "WireBeneficiaryAdvLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getWireBeneficiaryAdvSelectFields⁠

POST

Retrieve beneficiary details with selected fields and advanced information

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 0,
  "WireBeneficiaryAdvLocator": 0,
  "SelectableFields": {
    "IncludeAllWireBeneficiaryAdvFields": true,
    "WireBeneficiaryAdvFields": {
      "Locator": true,
      "Text": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getWireBeneficiaryAdvPagedList⁠

POST

Retrieve paged beneficiary details with advanced information

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getWireBeneficiaryAdvListSelectFields⁠

POST

Retrieve a list of beneficiary details with selected fields

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 0,
  "SelectableFields": {
    "IncludeAllWireBeneficiaryAdvFields": true,
    "WireBeneficiaryAdvFields": {
      "Locator": true,
      "Text": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getWireBeneficiaryAdvPagedListSelectFields⁠

POST

Retrieve paged beneficiary details with selected fields and advanced information

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllWireBeneficiaryAdvFields": true,
    "WireBeneficiaryAdvFields": {
      "Locator": true,
      "Text": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getWireBeneficiaryFiAdv⁠

POST

Retrieve financial institution beneficiary details with advanced information

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 0,
  "WireBeneficiaryFiAdvLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}