DistributionPlan

Specifies how open loop cash will be distributed before and after redemption of brand cash. Distribution plans are always connected with a particular cash design.

Attributes

id
String: the distribution plan ID.
title
String. The name of the distribution plan.
created
String. The ISO 8601 date and time when the distribution plan was created.
modified
String. The ISO 8601 date and time when the distribution plan was last modified.
recipients

A list of JSON objects. Specifies who will receive open loop cash and when. Each item in the list is an object with these attributes:

loop_id
String. If this percentage is to be distributed before redemption, loop_id is the string 0. If the percentage is to distributed after redemption, loop_id is the id of the connected cash design.
recipient_type
String. May be discount (don’t distribute the percentage), static (distribute to a specific wallet), or redeemer (distribute to the merchant who redeemed the brand cash.) Other future possible values include processor and surcharge.
recipient_id
String. The ID of the recipient if recipient_type is static, otherwise 0.
redeem_currency
String. The cash design currency if the percentage is to be distributed after redemption; otherwise redeem_currency is an empty string.
distribute_currency
String. The cash design currency.
percentage
String containing a decimal value up to 100. The percentage specifies the amount to distribute as a percentage of the amount of brand cash sent.

Used In