Creating a Pay Option
Creates a pay option for a collect page.
Method Info
| Url | https://www.payitsquare.com/api/v1/collect-page/{CollectPageId}/pay-option |
|---|---|
| Verb | POST |
| Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
| {CollectPageId} | The id of the collect page. |
Input
| Property | Data Type | Validation Info |
|---|---|---|
| Title | String | The title to show payers for the pay option. Required |
| Description | String | The description of this pay option. |
| AmountNeeded | Single | The amount a payer will pay for this option. Required |
| DefaultQuantityPer | Int32 | The default number a payer will purchase for this pay option. |
| HasQuantityAvailable | Boolean | |
| QuantityAvailable | Int32 | The number available for this pay option. |
| LatePayAmount | Single | If paid after the late paid date, the amount that will be used. |
| AtTheDoorAmount | Single | The amount a payer will pay at the door. |
| QuantityRemaining | Int32 | The number still remaining for this pay option. |
| IsHiddenCoupon | Boolean | When true, payers will need to enter a coupon code to retrieve this pay option. |
| CouponCode | String | When is hidden coupon is true, this will be the code payers will need to enter to retrieve this pay option. |
| AllowAmountOverride | Boolean | When true, payers will be able to change the amount they pay. |
| ShowQuantitySelector | Boolean | When true, payers will have a quantity selector, and they will be able to change it. |
| HasLatePayOption | Boolean | When true, payers will pay a different amount after the late pay date. |
| HasAtTheDoorAmount | Boolean | When true, payers will be shown the at the door amount. |
| IsActive | Boolean | When true, payers will be able to use this pay option. |
| HasExpireDate | Boolean | When true, the pay option will expire when the expire date passes. |
| ExpireDateLocal | String | When has expire date is true, this will be the date when this pay option expires. |
| SortOrder | Int32 | Will determine the order pay options will appear. |
| CountsAsPaidOther | Boolean | |
| ItemId | String | |
| LatePayStartDateLocal | String | The date that late payments start. |
| TimeZoneId | String |
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
{
"Title": "My Title",
"Description": "My pay option description.",
"AmountNeeded": 25.0,
"DefaultQuantityPer": 1,
"HasQuantityAvailable": false,
"QuantityAvailable": 50,
"LatePayAmount": 35.0,
"AtTheDoorAmount": 40.0,
"QuantityRemaining": 22,
"IsHiddenCoupon": false,
"CouponCode": "",
"AllowAmountOverride": false,
"ShowQuantitySelector": true,
"HasLatePayOption": true,
"HasAtTheDoorAmount": true,
"IsActive": true,
"HasExpireDate": false,
"ExpireDateLocal": null,
"SortOrder": 3,
"CountsAsPaidOther": false,
"ItemId": null,
"LatePayStartDateLocal": null,
"TimeZoneId": "Eastern Standard Time"
}
Sample Success Response
{
"Id": "8ff942b8-8ad4-4de6-85eb-fdd0ba81e329",
"IsSuccess": true,
"Messages": []
}
Sample Error Response
{
"Id": "00000000-0000-0000-0000-000000000000",
"IsSuccess": false,
"Messages": [
"Error Message 1",
"Error Message 2"
]
}
