Getting and Updating Payers
A payer can be retrieved or updated via this method.
Method Info
| Url | https://www.payitsquare.com/api/v1/collect-page/{CollectPageId}/payer/{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 payer. |
Input
| Property | Data Type | Validation Info |
|---|---|---|
| MemberName | String | The payer's 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 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. |
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": "77300d9d-67fa-4238-b994-04b275ac2f39",
"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
}
Sample Input
{
"MemberName": "John Doe",
"EmailAddress": "myaddress@mydomain.com",
"IsAmountNeededOverriden": false,
"OverriddenAmountNeeded": 0.0,
"AmountCollected": 0.0,
"IsManualPayment": false
}
Sample Success Response
{
"IsSuccess": true,
"Messages": []
}
Sample Error Response
{
"IsSuccess": false,
"Messages": [
"Error Message 1",
"Error Message 2"
]
}
