Getting and Updating People

A Person can be retrieved or updated via this method.

Url	https://www.payit2.com/api/v1/collect-page/{CollectPageId}/Person/{Id}
Verb	GET, PUT/POST
Headers	X-PayItSquare-AppKey, X-PayItSquare-Token
{CollectPageId}	The id of the collect page to get payers for.
{Id}	The id of the Person.

Property	Data Type	Validation Info
FirstName	String	The Person's first name. This is used for display on the collect page and in messages sent for reminders. Required
LastName	String	The Person's last name. This is used for display on the collect page and in messages sent for reminders. Required
EmailAddress	String	This is the email address that reminder emails will be sent to. Required
IsAmountNeededOverriden	Boolean	If the amount needed from this Person is different than the default amount for the collect page, this will be true.
OverriddenAmountNeeded	Single	If IsAmountNeededOverriden is true, this will contain the amount needed.
AmountCollected	Single	If a Person has paid, this will contain the amount the Person paid.
IsManualPayment	Boolean	When true, this indicates that they Person marked themselves as paid.

Property	Data Type	Other Info
Id	Guid	This is the id of the Person. This will be needed for updating the Person.
PaidDateTime	DateTime Array	If the Person has paid, this is the date they paid. If this is null, the Person has not paid yet.
LastViewedDate	DateTime Array
IsOnlinePayment	Boolean	If true, the Person paid online through PayPal.
IsSelfPayment	Boolean	If true, the Person marked themselves as paid on the collect page.
PaymentStatus	String
IsPendingPayNow	Boolean
IsPrivate	Boolean	If true, the user has marked their payment as private.
CanDelete	Boolean	Determines if this Person can be deleted. Online payments cannot be deleted.
AmountDueOffline	Single
IsRegistered	Boolean
FirstName	String	The Person's first name. This is used for display on the collect page and in messages sent for reminders.
LastName	String	The Person's last name. This is used for display on the collect page and in messages sent for reminders.
EmailAddress	String	This is the email address that reminder emails will be sent to.
IsAmountNeededOverriden	Boolean	If the amount needed from this Person is different than the default amount for the collect page, this will be true.
OverriddenAmountNeeded	Single	If IsAmountNeededOverriden is true, this will contain the amount needed.
AmountCollected	Single	If a Person has paid, this will contain the amount the Person paid.
IsManualPayment	Boolean	When true, this indicates that they Person marked themselves as paid.

{
  "Id": "4d99bf76-97b9-4e4f-b992-8518b3812eb2",
  "PaidDateTime": null,
  "LastViewedDate": null,
  "IsOnlinePayment": false,
  "IsSelfPayment": false,
  "PaymentStatus": null,
  "IsPendingPayNow": false,
  "IsPrivate": false,
  "CanDelete": false,
  "AmountDueOffline": 0.0,
  "IsRegistered": false,
  "FirstName": "Jane",
  "LastName": "Doe",
  "EmailAddress": "me@mydomain.com",
  "IsAmountNeededOverriden": false,
  "OverriddenAmountNeeded": 0.0,
  "AmountCollected": 0.0,
  "IsManualPayment": false
}    

{
  "FirstName": "Jane",
  "LastName": "Doe",
  "EmailAddress": "myaddress@mydomain.com",
  "IsAmountNeededOverriden": false,
  "OverriddenAmountNeeded": 0.0,
  "AmountCollected": 0.0,
  "IsManualPayment": false
}

{
  "IsSuccess": true,
  "Messages": []
}    

{
  "IsSuccess": false,
  "Messages": [
    "Error Message 1",
    "Error Message 2"
  ]
}