Payee

Schema

Name / Description Type / Format Example
title
The name of this Payee
 string "string"
bankDetails BankDetails {BankDetails}
paymentDateRule string "OnPayDate" "OnDayOfWeekAfterPayDate" "OnDayOfMonth"
paymentDateDayOfWeek string "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
paymentDateDayOfMonth integer int32 0
hasMinimumBankDetails
Denotes whether the payee has the minimum bank details to receive a payment
 boolean true
id
The unique id of the object
 string uuid "string"

JSON Example 

{
  "title": "string",
  "bankDetails": {
    "bankName": "string",
    "bankBranch": "string",
    "bankReference": "string",
    "accountName": "string",
    "accountNumber": "string",
    "sortCode": "string",
    "note": "string",
    "buildingSocietyRollNumber": "string"
  },
  "paymentDateRule": "OnPayDate",
  "paymentDateDayOfWeek": "Sunday",
  "paymentDateDayOfMonth": 0,
  "hasMinimumBankDetails": true,
  "id": "string"
}

References

Contained in Models

- none -

Consumed by Operations
Create Payee
Update Payee
Returned by Operations
Create Payee
Get Payee
Update Payee