/{id} - GET

get https://cubi-sandbox-api.customersbank.com/transfers/v1/{id}

This endpoint allows users to view details for a specific book transfer.

Responses

Response body

object

uuid

required

The ID of the book transfer

accountId

uuid

required

If you are requesting transfers for a specific account Id, this is the account id of the account requested.
If you are requesting a book transfer by the book transfer Id then:
a. If you originated the transfer, this will be your accountId the funds were transferred from.
b. If a third party originated the transfer, this will be your account Id the funds were transferred to.
c. If a transfer is between your own accounts, this be your accountId the funds were transferred from.

accountName

string

required

If you are requesting transfers for a specific account Id, this is the name of the account requested.
If you are requesting a book transfer by the book transfer Id then:
a. If you originated the transfer, this will be the name of your account the funds were transferred from.
b. If a third party originated the transfer, this will be the name of your account the funds were transferred to.
c. If a transfer is between your own accounts, this is the name of the account the funds were transferred from.

counterParty

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

counterPartyAccountId

uuid

required

The counter party account Id participating in the transfer.

If you are requesting transfers for a specific account Id then this will be the Id 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
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 Id.
b. If the tranfer is between your own accounts this will the account Id the funds were transferred to.

counterPartyAccountName

string

required

The counter party account name participating in the transfer.

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
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.

sendingPartner

string | null

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

sendingAccount

string | null

Optional. Will be populated only when you're the originator of the transfer.
The name of the account the funds were transfered from

sendingAccountNumberLast4Digits

string | null

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

receivingPartner

string | null

Optional. Will be populated only when you're the originator of the transfer.
The name of the partner the funds were transfered to

receivingAccount

string | null

Optional. Will be populated only when you're the originator of the transfer.
The name of the account the funds were transfered to

receivingAccountNumberLast4Digits

string | null

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

amount

double

required

The amount of the book transfer

transactionType

string

required

Send Receive

internalMemo

string | null

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

publicMemo

string | null

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

purposeCode

string | null

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

purposeDescription

string | null

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

status

string

required

ApprovalRequired Pending Posted Rejected Declined

declineReason

string | null

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

initiatingUserId

uuid | null

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

initiatingUserName

string | null

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

initiatingUserEmail

string | null

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

approvalUserId

uuid | null

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

approvalUserName

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.

approvalUserEmail

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.

approvedAt

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.

completedAt

date-time | null

Optional. Date time in UTC the transfer was processed successfully.

If you are NOT the originator of the transfer, then this will always be populated
If you originated the transfer this will only be populated when and if the transfer is processsed successfully

sourceType

string

Api Ui

createdAt

date-time | null

Optional. Will be populated only when you're the originator of the transfer.
Date and time in UTC when the transfer was submitted

lastModifiedAt

date-time | null

Optional. Will be populated only when you're the originator of the transfer.
Date and time in UTC of the current status of the transfer.

confirmationNumber

string | null

Confirmation Number for the book transfer entry. This can be used for reconciliation during the BAI2 process.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://cubi-sandbox-api.customersbank.com/transfers/v1/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
34
}
1
{
2
  "id": "00000000-0000-0000-0000-000000000000",
3
  "accountId": "00000000-0000-0000-0000-000000000000",
4
  "accountName": "string",
5
  "counterParty": "string",
6
  "counterPartyAccountId": "00000000-0000-0000-0000-000000000000",
7
  "counterPartyAccountName": "string",
8
  "sendingPartner": "string",
9
  "sendingAccount": "string",
10
  "sendingAccountNumberLast4Digits": "string",
11
  "receivingPartner": "string",
12
  "receivingAccount": "string",
13
  "receivingAccountNumberLast4Digits": "string",
14
  "amount": 0,
15
  "transactionType": "Send",
16
  "internalMemo": "string",
17
  "publicMemo": "string",
18
  "purposeCode": "string",
19
  "purposeDescription": "string",
20
  "status": "ApprovalRequired",
21
  "declineReason": "string",
22
  "initiatingUserId": "string",
23
  "initiatingUserName": "string",
24
  "initiatingUserEmail": "string",
25
  "approvalUserId": "string",

200OK

400BadRequest

401Unauthorized

403Forbidden

404NotFound

422UnprocessableEntity

500InternalServerError