Getting People

This method returns the list of payers for a collect page

Method Info
Url https://www.payit2.com/api/v1/collect-page/{CollectPageId}/payers
Verb GET
Headers X-PayItSquare-AppKey, X-PayItSquare-Token
{CollectPageId} The id of the collect page to get payers for.
Output
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.
Sample Get Output
[
  {
    "Id": "1272581a-d9a3-485e-a7f0-52169b137a00",
    "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
  },
  {
    "Id": "bd8178ec-6d67-4027-ab1a-3517e0ac62d9",
    "PaidDateTime": "2024-04-24T04:18:36.4511471+00:00",
    "LastViewedDate": null,
    "IsOnlinePayment": true,
    "IsSelfPayment": false,
    "PaymentStatus": null,
    "IsPendingPayNow": false,
    "IsPrivate": false,
    "CanDelete": false,
    "AmountDueOffline": 0.0,
    "IsRegistered": false,
    "FirstName": null,
    "LastName": null,
    "EmailAddress": "you@yourdomain.com",
    "IsAmountNeededOverriden": false,
    "OverriddenAmountNeeded": 0.0,
    "AmountCollected": 100.0,
    "IsManualPayment": false
  }
]