API Reference
API Reference
Start typing to search…

/search?id={id} - GET

get https://cubi-sandbox-api.customersbank.com/transfers/v1/search
Query Params
uuid
required

Format - uuid. The account id to search transactions for

date-time

Format - date-time (as date-time in RFC3339). Optional start date from which to search

date-time

Format - date-time (as date-time in RFC3339). Optional end date for which to search

inStatus
array of strings

Optional list of transfer statuses to filter on

inStatus
boolean
int32

Format - int32.

int32

Format - int32.

string
boolean
filters
array of objects
filters
Responses

Response body
object
int32
int32
int32
int32
items
array of objects
items
object
uuid

The ID of the book transfer

string
required

The name of the counter party participating in the transfer
If it a transfer between your own accounts, this will be your own client name

string
required

The counter party account name participating in the transfer.

  1. If you are requesting transfers for a specific account Id then this will be the name of the account opposite the requested account. i.e. If the request is for the sending account, this value will be of the receiving account
  2. If you are requesting a book transfer by the book transfer Id then:
    a. If the transfer involves a third party, this will be the third parties account name.
    b. If the tranfer is between your own accounts this will the account name the funds were transferred to.
string
required

The name of the partner the funds were transfered from

string
required

The name of the account the funds were transfered from

string
required

The last 4 digits of the counter party account number

string
required

The name of the partner the funds were transfered to

string
required

The name of the account the funds were transfered to

string
required

The last 4 digits of the account the funds were sent from

string
required

The last 4 digits of the account the funds were sent to

double

The amount of the book transfer

string

Send Receive

string | null

Optional. Will be populated only when you're the originator of the transfer.

string | null

Optional, will be populated if the sender provided a public memo

string
required

The PurposeCode of the book transfer

string | null

Optional, will be populated if the sender provided a purpose description

string
required

ApprovalRequired Pending Posted Rejected Declined

string | null

Optional. Will be populated only when you're the originator of the transfer.

string | null

Optional. Will be populated only when your partner is the originator of the transfer.

string | null

Optional. Will be populated only when your partner is the originator of the transfer.

uuid | null

Optional. Will be populated only when your partner is the originator of the transfer.

string | null

Optional. Will be populated only when you're the originator of the transfer. Will not be populated for transfers from single control accounts.

date-time | null

Optional. Will be populated only when you're the originator of the transfer. Will not be populated for transfers from single control accounts.
Uses UTC date time.

date-time
string

Api Ui

date-time | null

Date and time in UTC of the current status of the transfer.

Updated 10 days ago

Did this page help you?
Language

Updated 10 days ago

Did this page help you?