Incoming Wires

View All Wires

A user has the ability to view details for all incoming wires within a specified date range. To view incoming wire details, initiate a GET request directed to the following endpoint:

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

This request requires the additional data to be included in the query of the request.

Query Parameter Data Element Details:

Name	Type	Description
fromDate	date-time	starting date
toDate	date-time	ending date
paginateResults	boolean	indicates whether the request should be paginated
page	int32	indicates the page to return
perPage	int32	indicates how many items are on a page
sortOn	string	indicates the attribute by which the data is sorted
sortAscending	boolean	indicates if the data is sorted in ascending or descending order

Example Request:

GET //wires/v1/incoming?fromdate=11-05-2023&todate=11-10-2024 HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Content-Type: application/json
Authorization: Bearer ******

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

Example Response:

Response Data Element Details:

Name	Type	Description
pageSize	int32	number of items displayed on a page
pageOffset	int32	offset index indicating starting point for page items
totalPages	int32	total number of pages
totalItemCount	int32	total count of items across all pages
items	array of objects \| null	items model
> id	string	wire id
> amount	double	amount of transaction
> beneficiaryAccountNumber	string \| null	account number belonging to beneficiary
> isReturn	boolean	indicates if this is a returned transaction
> originalWireId	string \| null	original wire id in case of a return
> originatorAccountNumber	string \| null	account number of the originator
> originatorName	string \| null	name of the originator
> originatorAddress1	string \| null	first line of the originator's address
> originatorAddress2	string \| null	second line of the originator's address
> originatorAddress3	string \| null	third line of the originator's address
> typeSubtype	string \| null	type and subtype of the wire transaction
> receiverRoutingNumber	string \| null	routing number of the receiving bank
> receiverName	string \| null	name of the receiving bank
> notes	string \| null	notes or memo for the transaction
> partnerId	string	client id
> imad	string \| null	sending bank trace number
> omad	string \| null	receiving bank trace number
> completedAt	date-time	date and time transaction was completed
> beneficiaryFIIdCode	string \| null	identifier code of the beneficiary's financial institution
> beneficiaryFIName	string \| null	name of the beneficiary's financial institution
> beneficiaryFIId	string \| null	identifier of the beneficiary's financial institution
> beneficiaryFIAddress1	string \| null	first line of the beneficiary financial institution's address
> beneficiearyFIAddress2	string \| null	second line of the beneficiary financial institution's address
> beneficiaryFIAddress3	string \| null	third line of the beneficiary financial institution's address
> beneficiaryIdCode	string \| null	identifier code of the beneficiary
> beneficiaryName	string \| null	name of the beneficiary
> beneficiaryAddress1	string \| null	first line of the beneficiary's address
> beneficiaryAddress2	string \| null	second line of the beneficiary's address
> beneficiaryAddress3	string \| null	third line of the beneficiary's address
> intermediateIdCode	string \| null	identifier code of the intermediate financial institution
> intermediateId	string \| null	identifier of the intermediate financial institution
> intermediateName	string \| null	name of the intermediate financial institution
> intermediateAddress1	string \| null	first line of the intermediate financial institution's address
> intermediateAddress2	string \| null	second line of the intermediate financial institution's address
> intermediateAddress3	string \| null	third line of the intermediate financial institution's address
> originatorIdCode	string \| null	identifier code of the originator
> senderName	string \| null	name of the sender
> senderReference	string \| null	reference number provided by the sender
> beneficiaryReference	string \| null	reference information for the beneficiary

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.

View a Specific Wire

Similar to the prior request, a user can obtain the same level of information for a specific wire if they know the WireId of that transaction. To get information for a specific wire, initiate a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/wires/v1/incoming/{wireId}

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

Path Parameter Data Element Details:

Name	Type	Description
wireId	string	wire id

Example Request:

GET //wires/v1/incoming/[WIRE ID] HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Content-Type: application/json
Authorization: Bearer ******

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

Example Response:

Response Data Element Details:

Name	Type	Description
id	string	wire id
amount	double	amount of transaction
beneficiaryAccountNumber	string \| null	account number belonging to beneficiary
isReturn	boolean	indicates if this is a returned transaction
originalWireId	string \| null	original wire id in case of a return
originatorAccountNumber	string \| null	account number of the originator
originatorName	string \| null	name of the originator
originatorAddress1	string \| null	first line of the originator's address
originatorAddress2	string \| null	second line of the originator's address
originatorAddress3	string \| null	third line of the originator's address
typeSubtype	string \| null	type and subtype of the wire transaction
receiverRoutingNumber	string \| null	routing number of the receiving bank
receiverName	string \| null	name of the receiving bank
notes	string \| null	notes or memo for the transaction
partnerId	string	client id
imad	string \| null	sending bank trace number
omad	string \| null	receiving bank trace number
completedAt	date-time	date and time transaction was completed
beneficiaryFIIdCode	string \| null	identifier code of the beneficiary's financial institution
beneficiaryFIName	string \| null	name of the beneficiary's financial institution
beneficiaryFIId	string \| null	identifier of the beneficiary's financial institution
beneficiaryFIAddress1	string \| null	first line of the beneficiary financial institution's address
beneficiearyFIAddress2	string \| null	second line of the beneficiary financial institution's address
beneficiaryFIAddress3	string \| null	third line of the beneficiary financial institution's address
beneficiaryIdCode	string \| null	identifier code of the beneficiary
beneficiaryName	string \| null	name of the beneficiary
beneficiaryAddress1	string \| null	first line of the beneficiary's address
beneficiaryAddress2	string \| null	second line of the beneficiary's address
beneficiaryAddress3	string \| null	third line of the beneficiary's address
intermediateIdCode	string \| null	identifier code of the intermediate financial institution
intermediateId	string \| null	identifier of the intermediate financial institution
intermediateName	string \| null	name of the intermediate financial institution
intermediateAddress1	string \| null	first line of the intermediate financial institution's address
intermediateAddress2	string \| null	second line of the intermediate financial institution's address
intermediateAddress3	string \| null	third line of the intermediate financial institution's address
originatorIdCode	string \| null	identifier code of the originator
senderName	string \| null	name of the sender
senderReference	string \| null	reference number provided by the sender
beneficiaryReference	string \| null	reference information for the beneficiary

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.