Entitlements

Entitlements are permissions required for accessing wires. Administrators assign these entitlements to users. For wires, the entitlements include:

• None: No access to wires.
• View: Can view wires, but cannot perform transactions.
• Full: Can view and initiate wires.

These permissions ensure secure and appropriate access to wire functions.

---

API Status

To perform wires via API, a client must have API access enabled. Users can verify the status of wire APIs by initiating a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/wires/v1/AccountEntitlement

Developers can use this endpoint to:
• Confirm that API access is enabled before proceeding with additional wire-related API calls.
• Verity the API status to diagnose issues related to API connectivity.

Example Request:

A successful request will generate a response of 200 – Ok.

Example Response:

Response Data Element Details:

Name	Type	Description
accountId	string	unique identifier of an account
entitlement	string	set of permissions granted to users. Can be one of the following: None; View; Full

Error Handling
Common errors will include:
400 – Bad Request
404 - Not Found
422 - Unprocessable Content

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.

---

Get Entitlements

Each user that has access to wire APIs is set up with an appropriate entitlement. To view the entitlements assigned to a specific person, a user can initiate a GET request to the following endpoint:

https://cubi-sandbox-api.customersbank.com/wires/v1/AccountEntitlements/{userId}

This request requires the additional data to be included in the path and the body of the request.

Path Parameter Data Element Details:

Name	Type	Description
userId	string	id related to a specific user

Example Request:

A successful request will generate a response of 200 – Success.

Example Response:

Response Data Element Details:

Name	Type	Description
accountId	string	unique identifier of an account
entitlement	string	set of permissions granted to users. Can be one of the following: None; View; Full

Error Handling
Common errors will include:
400 – Bad Request
404 - Not Found
422 - Unprocessable Content

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.

---

Update Entitlements

Administrators have the ability to modify user entitlements. This functionality is restricted solely to administrators. To update user entitlements, the administrator initiates a PUT request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/wires/v1/AccountEntitlements/{userId}

This request requires the additional data to be included in the path and the body of the request.

Path Parameter Data Element Details:

Name	Type	Description
userId	string	id related to a specific user

Body Parameter Data Element Details:

Name	Type	Description
entitlements	array of objects | null	entitlements model
> accountId	string	unique identifier of an account
> entitlement	string	set of permissions granted to users. Can be one of the following: None; View; Full

Example Request:

A successful request will generate a response of 202 – Accepted.

Example Response:

Error Handling
Common errors will include:
400 – Bad Request
422 - Unprocessable Content

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.