Getting a Person Answer
Returns a answer for a Person.
Method Info
Url | https://www.payit2.com/api/v1/collect-page/{CollectPageId}/Person/{PayerId}/answer/{Id} |
---|---|
Verb | GET |
Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
{CollectPageId} | The id of the collect page. |
{PayerId} | The id of the Person. |
{Id} | The id of the answer. |
Input
Property | Data Type | Validation Info |
---|---|---|
QuestionId | Guid | The ID of the question being answered. |
AnswerText | String | The answer for the question. |
OptionId | Nullable`1 | If the question has options, this is the id of the option they've selected. |
Output
Property | Data Type | Other Info |
---|---|---|
Id | Int32 | The ID of this pay option. |
AmountPer | Single | The amount paid per pay option. |
Quantity | Int32 | The number purchased by the Person. |
PayOptionId | Guid Array | This is the ID of the pay option the Person is purchasing. |
Sample Get Output
{ "Id": 1234, "QuestionText": "My Question", "QuestionId": "0470255b-5807-4dff-a326-0d82bce7b8b0", "AnswerText": "My Answer", "OptionId": null }
Sample Input
{ "QuestionId": "27d2dec0-3a19-44ea-85a9-15a482e8383c", "AnswerText": "My Answer", "OptionId": null }
Sample Success Response
{ "IsSuccess": true, "Messages": [] }
Sample Error Response
{ "IsSuccess": false, "Messages": [ "Error Message 1", "Error Message 2" ] }