Getting Payers
This method returns the list of payers for a collect page
Method Info
| Url | https://www.payitsquare.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 payer. This will be needed for updating the payer. |
| PaidDateTime | DateTime Array | If the payer has paid, this is the date they paid. If this is null, the payer has not paid yet. |
| LastViewedDate | DateTime Array | |
| IsOnlinePayment | Boolean | If true, the payer paid online through PayPal. |
| IsSelfPayment | Boolean | If true, the payer 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 payer can be deleted. Online payments cannot be deleted. |
| AmountDueOffline | Single | |
| IsRegistered | Boolean | |
| MemberName | String | The payer's 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 payer 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 payer has paid, this will contain the amount the payer paid. |
| IsManualPayment | Boolean | When true, this indicates that they payer marked themselves as paid. |
Sample Get Output
[
{
"Id": "c1974e8c-c020-48d8-bb02-a2be9fedbfd1",
"PaidDateTime": null,
"LastViewedDate": null,
"IsOnlinePayment": false,
"IsSelfPayment": false,
"PaymentStatus": null,
"IsPendingPayNow": false,
"IsPrivate": false,
"CanDelete": false,
"AmountDueOffline": 0.0,
"IsRegistered": false,
"MemberName": "John Doe",
"EmailAddress": "me@mydomain.com",
"IsAmountNeededOverriden": false,
"OverriddenAmountNeeded": 0.0,
"AmountCollected": 0.0,
"IsManualPayment": false
},
{
"Id": "85ea60ce-c981-447a-a85e-ecd8e5f8fae4",
"PaidDateTime": "\/Date(1337298344213-0400)\/",
"LastViewedDate": null,
"IsOnlinePayment": true,
"IsSelfPayment": false,
"PaymentStatus": null,
"IsPendingPayNow": false,
"IsPrivate": false,
"CanDelete": false,
"AmountDueOffline": 0.0,
"IsRegistered": false,
"MemberName": "Jane Doe",
"EmailAddress": "you@yourdomain.com",
"IsAmountNeededOverriden": false,
"OverriddenAmountNeeded": 0.0,
"AmountCollected": 100.0,
"IsManualPayment": false
}
]
