Creating Payers
Use this method to create a new payer for a collect page
Method Info
| Url | https://www.payitsquare.com/api/v1/collect-page/{CollectPageId}/payer |
|---|---|
| Verb | POST |
| Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
| {CollectPageId} | The id of the collect page to get payers for. |
Input
| Property | Data Type | Validation Info |
|---|---|---|
| Id | Guid | This is the id of the payer. This will be needed for updating the payer. |
| PaidDateTime | Nullable`1 | If the payer has paid, this is the date they paid. If this is null, the payer has not paid yet. |
| LastViewedDate | Nullable`1 | |
| 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. 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 | The id of the created object. It will be used as part of the url for subsequent updates. Only available if the creation was successful. |
| IsSuccess | Boolean | Indicates if the call was successful or not. |
| Messages | String Array | Will contain a list of error messages if IsSuccess is false |
Sample Input
{
"Id": "92ef3420-4a7d-4499-9ddb-e3e16671ef58",
"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 Success Response
{
"Id": "12537875-e6dc-4b34-b9fd-16bca034de54",
"IsSuccess": true,
"Messages": []
}
Sample Error Response
{
"Id": "00000000-0000-0000-0000-000000000000",
"IsSuccess": false,
"Messages": [
"Error Message 1",
"Error Message 2"
]
}
