Transfer

A Transfer object is a record of a financial transaction. Each transfer involves a sender, a recipient, and other participants. Basic Transfer objects provide only enough detail to populate a table that lists transfers, while TransferDetail objects provide the full details about individual transfers.

Extended By

TransferDetail

Attributes

id
String: the ID of the transfer.
url
String: the web URL of the transfer.
currency
String: an ISO 4217 currency (3 uppercase letters).
amount
String containing a decimal amount.
workflow_type

String: the type of transfer. Some common transfer types are:

profile_to_profile
Send cash. This transfer type supports payment codes and invitations to people not yet using WingCash.
combine
Replace small cash pages with larger cash pages of an equal total value
link_dfi_account
Link an account at a bank or credit union.
redeem
Deposit cash into a linked bank or credit union account.
purchase_offer
Purchase brand cash through an offer.
expire
Expire promotional cash.
next_activity
String: the name of the next step the transfer will take. In WingCash, transfer steps are called workflow activities. Common values include completed, canceled, pos.wait, and invite.wait.
start
String: the ISO 8601 timestamp when the transfer was created.
timestamp
String: the ISO 8601 timestamp of the transaction. If the transfer has ended, the timestamp indicates when the transfer ended. (Technically, transfers sometimes resume after ending, in which case the timestamp indicates when the transfer first ended.) If the transfer has not ended, the timestamp indicates when the transfer was last modified.
completed
Boolean: true if the transfer completed successfully.
canceled

Boolean: true if the transfer was canceled.

Note

If both completed and canceled are false, the transfer is in a waiting state. For example, the transfer may be waiting for a payment code or it may be waiting for someone to accept an invitation.

Note

If both completed and canceled are somehow true at the same time, the app UI should show the transfer as canceled.

sender_id
String: The profile ID of the sender. This is null if, for example, the sender has not yet signed up for WingCash.
sender_uid
String: the UID of the sender. One of the confirmed_uids of the sender at the time the transfer started. May be null.
sender_info
A UIDInfo object providing info about the sender. Especially useful when sender_id is null.
recipient_id
String: The profile ID of the recipient. This is null when waiting for a payment code or invitation.
recipient_uid
String: the UID of the recipient. This is set even when waiting for a payment code or invitation.
reply_status
String: indicates whether the authenticated profile has sent a reply. Can be sent, unsent, or empty. An empty string means this profile is not the recipient and does not have the option of sending a reply.
recipient_info
A UIDInfo object providing info about the recipient, who may be registered at a service other than WingCash. Especially useful when recipient_id is null.
movements
A list of Movement objects that describe the amounts sent or received by the authenticated user in this transfer.