CashDesign

A cash design specifies the network boundaries, behavior, and appearance of WingCash pages. Every cash page has a fixed design. There are currently three available types of cash designs:

  • National currency, also known as open loop cash. WingCash only allows registered financial institutions to create open loop cash designs and issue national currency.
  • Brand cash, also known as closed loop cash. Premium WingCash members can issue and send brand cash. Brand cash supports distribution plans, a way to automatically distribute open loop cash (including commission payments) upon redemption of brand cash. Brand cash is the basis of gift, loyalty, rewards, and promotional cash.
  • Overlay designs. Any WingCash user is allowed to create an overlay design and temporarily apply it to national currency for a small fee. Overlay designs change only the appearance of the cash page and do not affect the cash network and behavior.

Cash designs are a core component of the WingCash platform. An easy way to understand them better is to experiment in a private WingCash sandbox where you can be an administrator and grant yourself test cash.

Common Attributes

id
String. The ID of the cash design.
currency
String. an ISO 4217 currency (3 uppercase letters).
type

String. Possible values include:

  • open_design: National currency. Cash pages with a design of this type will have a loop_id of 0.
  • overlay_design: A temporary overlay over national currency.
  • gl_design: Brand cash. GL is short for “gift and loyalty”, the origin of brand cash. Cash pages with a design of this type will have have a loop_id that matches the cash design id.
  • amazongc_design: A deprecated design type once used for distributing Amazon.com gift cards through WingCash.
revision
Integer. This number increments whenever the cash design changes. When the design requires an image change, the revision number bumps up to the next 100, causing the rendition URLs to change. (See the renditions attribute.)
featured_id
String; may be null. The ID of the WingCash profile to feature in wallets holding cash with this design.
transferable
Boolean. True if WingCash should allow holders of cash with this design to send the cash to other members without redeeming cash.
max_per_wallet
String containing a decimal amount; may be null. The maximum amount of cash with this design that WingCash should allow any particular member to hold or redeem at once.
title
String. The name of the cash design. Usually ends with the words “Gift Cash”, “Loyalty Cash”, “Promotional Cash”, or “Rewards Cash”. Example: “Widget Factory Gift Cash”.
created
String. The ISO 8601 date and time when the design was created.
modified
String. The ISO 8601 date and time when the design was last modified.
description_html
String. The human-provided description of the cash design, with minimal HTML formatting. May be empty.
description_text
String. The human-provided description of the cash design, stripped of HTML. May be empty.
issuer_id
String. The designated issuer of cash with this design. The issuer of each cash page does not change.
designer_id
String; may be null. The WingCash profile who designed the cash design. This attribute is for display purposes only; does not affect transfers.
generic_provider
Boolean. If true, cash pages with this design should show WingCash as the provider. If false, cash pages with this design should show the WingCash profile identified by issuer_id as the provider.
renditions

A JSON object containing renditions of this cash design. The attribute names are currency denomination values such as “0.01” and “0.05”; the attribute values are JSON objects containing thumbnail and full URLs. For example, to get the thumbnail rendition of the $1.00 note, use this Javascript code:

url = renditions['1.00'].thumbnail

Currently, thumbnail renditions are 112px wide and 48px tall; full size renditions are 640px wide and 310px tall.

network
A list of CashDesignAgreement objects. Lists the cash design network participants. If you have the view_design_network permission on the relevant cash design and your API access token is allowed to use the view_design_network permission, this list includes the agreements for all members of the network. If you do not have the view_design_network permission, this list includes only your own agreements.
network_full
Boolean. Indicates whether you have the view_design_network permission on the relevant cash design and your API access token is allowed to use the view_design_network permission.

Attributes for Editors

If you have the edit_design permission on the relevant cash design and your API access token is allowed to use the edit_design permission, the CashDesign JSON object also has the following attributes.

published
Boolean. True if the cash design has been published to the public. WingCash automatically publishes cash designs to the public upon creation of the first note page.
killed
Boolean. True if WingCash has removed the cash design from publication.
multiple_images
Boolean. True if the cash design is configured to use a different image for each denomination.
waves
Boolean. True if WingCash should draw the standard wavy lines over the images. The wavy lines usually make images look more official, but that is a matter of taste.
expire

A JSON object containing the expiration rule for this design. The expiration object has these attributes:

  • mode: null, “absolute”, or “relative”. null means the cash never expires. “absolute” means cash of this design will expire on a specific date and time. “relative” means cash of this design will expire in a certain number of days after purchase.
  • absolute: The ISO 8601 date and time when the cash will expire. null unless mode is “absolute”.
  • relative: Integer; the number of days after purchase when the cash will expire. null unless mode is “relative”.
email_freq

String; may be null. Specifies how often WingCash will remind holders of cash of this design that they hold the cash. The possible values are:

  • daily
  • weekly (Every Monday)
  • weekly2 (Every Monday and Thursday)
  • monthly (First day of every month)
  • null (never, except the last 7 days before expiration)
distribution_plans
A list of DistributionPlan objects. Use this list to choose a distribution_plan_id when calling POST /design/(string:design_id)/send or POST /design/(string:design_id)/bill.