Creating a Pay Option for a Person
Creates a pay option for a Person.
Method Info
Url | https://www.payit2.com/api/v1/collect-page/{CollectPageId}/Person/{PayerId}/pay-option |
---|---|
Verb | POST |
Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
{CollectPageId} | The id of the collect page. |
{PayerId} | The id of the Person. |
Input
Property | Data Type | Validation Info |
---|---|---|
AmountPer | Single | The amount paid per pay option. |
Quantity | Int32 | The number purchased by the Person. |
PayOptionId | Nullable`1 | This is the ID of the pay option the Person is purchasing. |
Output
Property | Data Type | Other Info |
---|---|---|
Id | Int32 | 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
{ "AmountPer": 0.0, "Quantity": 1, "PayOptionId": null }
Sample Success Response
{ "Id": 1234, "IsSuccess": true, "Messages": [] }
Sample Error Response
{ "Id": "00000000-0000-0000-0000-000000000000", "IsSuccess": false, "Messages": [ "Error Message 1", "Error Message 2" ] }