Skip to content
NexumAPI Docs

Wire⁠

Perform various operations on wire records.

Operations⁠

getWire⁠

POST

Returns information about a specific wire.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
WireSequenceNumberintegerrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/wire/getWire
POST /nexum/627/2022.01/wire/getWire 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,
  "nxAttributes": {
    "customFields": {}
  }
}

getWireSelectFields⁠

POST

Retrieves wire information 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/getWireSelectFields
POST /nexum/627/2022.01/wire/getWireSelectFields 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": {
    "IncludeAllWireFields": true,
    "WireFields": {
      "AcceptanceDate": true,
      "AcceptanceTime": true,
      "AccountNumber": true,
      "AdjustmentDate": true,
      "AdjustmentReason": true,
      "Amount": true,
      "ApplicationId": true,
      "BatchNumber": true,
      "BatchNumberChar": true,
      "BeneficiaryAddress": [
        0
      ],
      "BeneficiaryAdvice": true,
      "BeneficiaryAdviceCode": true,
      "BeneficiaryFiAddress": [
        0
      ],
      "BeneficiaryFiAdvice": true,
      "BeneficiaryFiAdviceCode": true,
      "BeneficiaryFiId": true,
      "BeneficiaryFiIdCode": true,
      "BeneficiaryFiInfo": true,
      "BeneficiaryFiIntrnatlId": true,
      "BeneficiaryFiName": true
    },
    "WireBeneficiaryAdvSelectableFields": {
      "IncludeAllWireBeneficiaryAdvFields": true,
      "WireBeneficiaryAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireBeneficiaryFiAdvSelectableFields": {
      "IncludeAllWireBeneficiaryFiAdvFields": true,
      "WireBeneficiaryFiAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireBeneficiaryFiInfoSelectableFields": {
      "IncludeAllWireBeneficiaryFiInfoFields": true,
      "WireBeneficiaryFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireBeneficiaryInfoSelectableFields": {
      "IncludeAllWireBeneficiaryInfoFields": true,
      "WireBeneficiaryInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireDrawdownDebitAcctAdvSelectableFields": {
      "IncludeAllWireDrawdownDebitAcctAdvFields": true,
      "WireDrawdownDebitAcctAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireFiToFiInfoSelectableFields": {
      "IncludeAllWireFiToFiInfoFields": true,
      "WireFiToFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireFmHistorySelectableFields": {
      "IncludeAllWireFmHistoryFields": true,
      "WireFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true
      }
    },
    "WireIntermedFiAdvSelectableFields": {
      "IncludeAllWireIntermedFiAdvFields": true,
      "WireIntermedFiAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireIntermedFiInfoSelectableFields": {
      "IncludeAllWireIntermedFiInfoFields": true,
      "WireIntermedFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireOfacDetailsSelectableFields": {
      "IncludeAllWireOfacDetailsFields": true,
      "WireOfacDetailsFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireReceiverFiInfoSelectableFields": {
      "IncludeAllWireReceiverFiInfoFields": true,
      "WireReceiverFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireServiceMessageSelectableFields": {
      "IncludeAllWireServiceMessageFields": true,
      "WireServiceMessageFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireUscAuditInfoSelectableFields": {
      "IncludeAllWireUscAuditInfoFields": true,
      "WireUscAuditInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getWireSelectFieldsFilterChildren⁠

POST

Retrieves wire information with selected fields and filters for children

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/getWireSelectFieldsFilterChildren
POST /nexum/627/2022.01/wire/getWireSelectFieldsFilterChildren 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": {
    "IncludeAllWireFields": true,
    "WireFields": {
      "AcceptanceDate": true,
      "AcceptanceTime": true,
      "AccountNumber": true,
      "AdjustmentDate": true,
      "AdjustmentReason": true,
      "Amount": true,
      "ApplicationId": true,
      "BatchNumber": true,
      "BatchNumberChar": true,
      "BeneficiaryAddress": [
        0
      ],
      "BeneficiaryAdvice": true,
      "BeneficiaryAdviceCode": true,
      "BeneficiaryFiAddress": [
        0
      ],
      "BeneficiaryFiAdvice": true,
      "BeneficiaryFiAdviceCode": true,
      "BeneficiaryFiId": true,
      "BeneficiaryFiIdCode": true,
      "BeneficiaryFiInfo": true,
      "BeneficiaryFiIntrnatlId": true,
      "BeneficiaryFiName": true
    },
    "WireBeneficiaryAdvSelectableFields": {
      "IncludeAllWireBeneficiaryAdvFields": true,
      "WireBeneficiaryAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireBeneficiaryFiAdvSelectableFields": {
      "IncludeAllWireBeneficiaryFiAdvFields": true,
      "WireBeneficiaryFiAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireBeneficiaryFiInfoSelectableFields": {
      "IncludeAllWireBeneficiaryFiInfoFields": true,
      "WireBeneficiaryFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireBeneficiaryInfoSelectableFields": {
      "IncludeAllWireBeneficiaryInfoFields": true,
      "WireBeneficiaryInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireDrawdownDebitAcctAdvSelectableFields": {
      "IncludeAllWireDrawdownDebitAcctAdvFields": true,
      "WireDrawdownDebitAcctAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireFiToFiInfoSelectableFields": {
      "IncludeAllWireFiToFiInfoFields": true,
      "WireFiToFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireFmHistorySelectableFields": {
      "IncludeAllWireFmHistoryFields": true,
      "WireFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true
      }
    },
    "WireIntermedFiAdvSelectableFields": {
      "IncludeAllWireIntermedFiAdvFields": true,
      "WireIntermedFiAdvFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireIntermedFiInfoSelectableFields": {
      "IncludeAllWireIntermedFiInfoFields": true,
      "WireIntermedFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireOfacDetailsSelectableFields": {
      "IncludeAllWireOfacDetailsFields": true,
      "WireOfacDetailsFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireReceiverFiInfoSelectableFields": {
      "IncludeAllWireReceiverFiInfoFields": true,
      "WireReceiverFiInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireServiceMessageSelectableFields": {
      "IncludeAllWireServiceMessageFields": true,
      "WireServiceMessageFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    },
    "WireUscAuditInfoSelectableFields": {
      "IncludeAllWireUscAuditInfoFields": true,
      "WireUscAuditInfoFields": {
        "Locator": true,
        "Text": [
          0
        ]
      }
    }
  },
  "ChildrenSearchFilter": {
    "WireBeneficiaryAdvFilter": {
      "Query": "string"
    },
    "WireBeneficiaryFiAdvFilter": {
      "Query": "string"
    },
    "WireBeneficiaryFiInfoFilter": {
      "Query": "string"
    },
    "WireBeneficiaryInfoFilter": {
      "Query": "string"
    },
    "WireDrawdownDebitAcctAdvFilter": {
      "Query": "string"
    },
    "WireFiToFiInfoFilter": {
      "Query": "string"
    },
    "WireFmHistoryFilter": {
      "Query": "string"
    },
    "WireIntermedFiAdvFilter": {
      "Query": "string"
    },
    "WireIntermedFiInfoFilter": {
      "Query": "string"
    },
    "WireOfacDetailsFilter": {
      "Query": "string"
    },
    "WireReceiverFiInfoFilter": {
      "Query": "string"
    },
    "WireServiceMessageFilter": {
      "Query": "string"
    },
    "WireUscAuditInfoFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateWireByID⁠

POST

Updates wire information by ID

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/updateWireByID
POST /nexum/627/2022.01/wire/updateWireByID 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,
  "WireUpdatableFields": {
    "AcceptanceDate": "string",
    "AcceptanceTime": "string",
    "AccountNumber": "string",
    "AdjustmentDate": "string",
    "AdjustmentReason": "string",
    "Amount": 0,
    "ApplicationId": "string",
    "BatchNumber": 0,
    "BeneficiaryAddress": [
      {
        "EntryId": 0,
        "BeneficiaryAddress": "string"
      }
    ],
    "BeneficiaryAdviceCode": "string",
    "BeneficiaryFiAddress": [
      {
        "EntryId": 0,
        "BeneficiaryFiAddress": "string"
      }
    ],
    "BeneficiaryFiAdviceCode": "string",
    "BeneficiaryFiId": "string",
    "BeneficiaryFiIdCode": "string",
    "BeneficiaryFiIntrnatlId": "string",
    "BeneficiaryFiName": "string",
    "BeneficiaryId": "string",
    "BeneficiaryIdCode": "string",
    "BeneficiaryName": "string",
    "BeneficiaryReference": "string"
  },
  "WireBeneficiaryAdvUpdateRequest": [
    {
      "WireBeneficiaryAdvLocator": 0,
      "WireBeneficiaryAdvUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireBeneficiaryFiAdvUpdateRequest": [
    {
      "WireBeneficiaryFiAdvLocator": 0,
      "WireBeneficiaryFiAdvUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireBeneficiaryFiInfoUpdateRequest": [
    {
      "WireBeneficiaryFiInfoLocator": 0,
      "WireBeneficiaryFiInfoUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireBeneficiaryInfoUpdateRequest": [
    {
      "WireBeneficiaryInfoLocator": 0,
      "WireBeneficiaryInfoUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireDrawdownDebitAcctAdvUpdateRequest": [
    {
      "WireDrawdownDebitAcctAdvLocator": 0,
      "WireDrawdownDebitAcctAdvUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireFiToFiInfoUpdateRequest": [
    {
      "WireFiToFiInfoLocator": 0,
      "WireFiToFiInfoUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireIntermedFiAdvUpdateRequest": [
    {
      "WireIntermedFiAdvLocator": 0,
      "WireIntermedFiAdvUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireIntermedFiInfoUpdateRequest": [
    {
      "WireIntermedFiInfoLocator": 0,
      "WireIntermedFiInfoUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireOfacDetailsUpdateRequest": [
    {
      "WireOfacDetailsLocator": 0,
      "WireOfacDetailsUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireReceiverFiInfoUpdateRequest": [
    {
      "WireReceiverFiInfoLocator": 0,
      "WireReceiverFiInfoUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireServiceMessageUpdateRequest": [
    {
      "WireServiceMessageLocator": 0,
      "WireServiceMessageUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "WireUscAuditInfoUpdateRequest": [
    {
      "WireUscAuditInfoLocator": 0,
      "WireUscAuditInfoUpdatableFields": {
        "Text": [
          {
            "EntryId": 0,
            "Text": "string"
          }
        ]
      }
    }
  ],
  "nxAttributes": {
    "customFields": {}
  }
}

createWire⁠

POST

Creates an outgoing wire from your credit union to a recipient.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireCreatableFields": {
    "AcceptanceDate": "string",
    "AcceptanceTime": "string",
    "AccountNumber": "string",
    "AdjustmentDate": "string",
    "AdjustmentReason": "string",
    "Amount": 0,
    "ApplicationId": "string",
    "BatchNumber": 0,
    "BeneficiaryAddress": [
      {
        "EntryId": 0,
        "BeneficiaryAddress": "string"
      }
    ],
    "BeneficiaryAdviceCode": "string",
    "BeneficiaryFiAddress": [
      {
        "EntryId": 0,
        "BeneficiaryFiAddress": "string"
      }
    ],
    "BeneficiaryFiAdviceCode": "string",
    "BeneficiaryFiId": "string",
    "BeneficiaryFiIdCode": "string",
    "BeneficiaryFiIntrnatlId": "string",
    "BeneficiaryFiName": "string",
    "BeneficiaryId": "string",
    "BeneficiaryIdCode": "string",
    "BeneficiaryName": "string",
    "BeneficiaryReference": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}