Deleting People
Use this method to delete a Person. People can only be deleted if the Person has not paid online.
Method Info
Url | https://www.payit2.com/api/v1/collect-page/{CollectPageId}/Person/{Id} |
---|---|
Verb | DELETE |
Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
{CollectPageId} | The id of the collect page to get payers for. |
{Id} | The id of the Person. |
Method Info
Url | https://www.payit2.com/api/v1/collect-page/{CollectPageId}/Person/{Id}/delete |
---|---|
Verb | 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. |
Output
Property | Data Type | Other Info |
---|---|---|
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 Success Response
{ "IsSuccess": true, "Messages": [] }
Sample Error Response
{ "IsSuccess": false, "Messages": [ "Error Message 1", "Error Message 2" ] }