WireOfacDetails

Perform various operations on wire Office of Foreign Assets Control (OFAC) records.

Symitar eDocs References: Coming soon.

Operations

getWireOfacDetails

post

Retrieve Office of Foreign Assets Control (OFAC) details

Authorizations
Body
WireSequenceNumberintegerOptional
WireOfacDetailsLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getWireOfacDetails
POST /nexum/627/2022.01/wire/getWireOfacDetails HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "WireOfacDetailsLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WireOfacDetails": {
    "Locator": 1,
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ]
  }
}

getWireOfacDetailsSelectFields

post

Retrieve Office of Foreign Assets Control (OFAC) details with selected fields

Authorizations
Body
WireSequenceNumberintegerOptional
WireOfacDetailsLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getWireOfacDetailsSelectFields
POST /nexum/627/2022.01/wire/getWireOfacDetailsSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "WireOfacDetailsLocator": 1,
  "SelectableFields": {
    "IncludeAllWireOfacDetailsFields": true,
    "WireOfacDetailsFields": {
      "Locator": true,
      "Text": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WireOfacDetails": {
    "Locator": 1,
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ]
  }
}

getWireOfacDetailsPagedList

post

Retrieve paged Office of Foreign Assets Control (OFAC) details

Authorizations
Body
WireSequenceNumberintegerOptional
Responses
200

Successful operation.

application/json
post
/getWireOfacDetailsPagedList
POST /nexum/627/2022.01/wire/getWireOfacDetailsPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WireOfacDetails": [
    {
      "Locator": 1,
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

getWireOfacDetailsListSelectFields

post

Retrieve a list of Office of Foreign Assets Control (OFAC) details with selected fields

Authorizations
Body
WireSequenceNumberintegerOptional
Responses
200

Successful operation.

application/json
post
/getWireOfacDetailsListSelectFields
POST /nexum/627/2022.01/wire/getWireOfacDetailsListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "SelectableFields": {
    "IncludeAllWireOfacDetailsFields": true,
    "WireOfacDetailsFields": {
      "Locator": true,
      "Text": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WireOfacDetailsList": {
    "hasReachedMaximumListSize": true,
    "WireOfacDetails": [
      {
        "Locator": 1,
        "Text": [
          {
            "EntryId": 1,
            "Text": "text"
          }
        ]
      }
    ]
  }
}

searchWireOfacDetailsSelectFields

post

Searches for wire OFAC details with selected fields

Authorizations
Body
WireSequenceNumberintegerOptional
Responses
200

Successful operation.

application/json
post
/searchWireOfacDetailsSelectFields
POST /nexum/627/2022.01/wire/searchWireOfacDetailsSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "SelectableFields": {
    "IncludeAllWireOfacDetailsFields": true,
    "WireOfacDetailsFields": {
      "Locator": true,
      "Text": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WireOfacDetailsList": {
    "hasReachedMaximumListSize": true,
    "WireOfacDetails": [
      {
        "Locator": 1,
        "Text": [
          {
            "EntryId": 1,
            "Text": "text"
          }
        ]
      }
    ]
  }
}

getWireOfacDetailsPagedListSelectFields

post

Retrieve paged Office of Foreign Assets Control (OFAC) details with selected fields

Authorizations
Body
WireSequenceNumberintegerOptional
Responses
200

Successful operation.

application/json
post
/getWireOfacDetailsPagedListSelectFields
POST /nexum/627/2022.01/wire/getWireOfacDetailsPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllWireOfacDetailsFields": true,
    "WireOfacDetailsFields": {
      "Locator": true,
      "Text": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WireOfacDetails": [
    {
      "Locator": 1,
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

searchWireOfacDetailsPagedSelectFields

post

Searches for wire OFAC details paged with selected fields

Authorizations
Body
WireSequenceNumberintegerOptional
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchWireOfacDetailsPagedSelectFields
POST /nexum/627/2022.01/wire/searchWireOfacDetailsPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 368

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireSequenceNumber": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllWireOfacDetailsFields": true,
    "WireOfacDetailsFields": {
      "Locator": true,
      "Text": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WireOfacDetails": [
    {
      "Locator": 1,
      "Text": [
        {
          "EntryId": 1,
          "Text": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

updateWireOfacDetailsByID

post

Updates OFAC details for a wire by ID

Authorizations
Body
WireOfacDetailsLocatorintegerOptional
WireSequenceNumberintegerOptional
Responses
200

Successful operation.

application/json
post
/updateWireOfacDetailsByID
POST /nexum/627/2022.01/wire/updateWireOfacDetailsByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WireOfacDetailsLocator": 1,
  "WireOfacDetailsUpdatableFields": {
    "Text": [
      {
        "EntryId": 1,
        "Text": "text"
      }
    ]
  },
  "WireSequenceNumber": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?