Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.51 KB

additional-recipient.md

File metadata and controls

32 lines (23 loc) · 1.51 KB

Additional Recipient

Represents an additional recipient (other than the merchant) receiving a portion of this tender.

Structure

AdditionalRecipient

Fields

Name Type Tags Description
locationId string Required The location ID for a recipient (other than the merchant) receiving a portion of this tender.
Constraints: Minimum Length: 1, Maximum Length: 50
description string | undefined Optional The description of the additional recipient.
Constraints: Maximum Length: 100
amountMoney Money Required Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
receivableId string | undefined Optional The unique ID for the RETIRED AdditionalRecipientReceivable object. This field should be empty for any AdditionalRecipient objects created after the retirement.
Constraints: Maximum Length: 192

Example (as JSON)

{
  "location_id": "location_id4",
  "description": null,
  "amount_money": {
    "amount": null,
    "currency": null
  },
  "receivable_id": null
}