Skip to content

additional-recipient.md

Latest commit

 

History

History
32 lines (23 loc) · 1.46 KB

additional-recipient.md

File metadata and controls

32 lines (23 loc) · 1.46 KB

Additional Recipient

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

Structure

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 this tender.
Constraints: Minimum Length: 1, Maximum Length: 50
description string Optional The description of the additional recipient.
Constraints: Maximum Length: 100
amount_money 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.
receivable_id string Optional The unique ID for this AdditionalRecipientReceivable, assigned by the server.
Constraints: Maximum Length: 192

Example (as JSON)

{
  "location_id": "location_id4",
  "description": "description0",
  "amount_money": {
    "amount": 186,
    "currency": "NGN"
  },
  "receivable_id": "receivable_id0"
}