Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.34 KB

charge-request-additional-recipient.md

File metadata and controls

31 lines (22 loc) · 1.34 KB

Charge Request Additional Recipient

Represents an additional recipient (other than the merchant) entitled to a portion of the tender. Support is currently limited to USD, CAD and GBP currencies

Structure

Charge Request Additional Recipient

Fields

Name Type Tags Description
location_id String Required The location ID for a recipient (other than the merchant) receiving a portion of the tender.
Constraints: Minimum Length: 1, Maximum Length: 50
description String Required The description of the additional recipient.
Constraints: Minimum Length: 1, Maximum Length: 100
amount_money Money Hash 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.

Example (as JSON)

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