GET api/Payments/PartyPaymentOption/ValidateGiftCertificate?giftCertificateDID={giftCertificateDID}&orderId={orderId}&partyId={partyId}
Retrieves the Gift Certificates available for party payment.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| giftCertificateDID | string |
Required |
|
| orderId |
The order identifier (optional). |
integer |
None. |
| partyId |
The party identifier (optional). |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ICheckoutPaymentGiftCertificateViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| GiftCertificateTypeID | integer |
None. |
|
| CertificateDID | string |
None. |
|
| Amount | decimal number |
None. |
|
| TotalOnCard | decimal number |
None. |
|
| OriginalAmount | decimal number |
None. |
|
| Description | string |
None. |
|
| ExpirationDate | date |
None. |
|
| ShouldDisplayGiftCertificateID | boolean |
None. |
|
| ShouldDisplayCurrencySymbol | boolean |
None. |
|
| ShouldDisplayExpirationDate | boolean |
None. |
|
| ShouldDisplayExpiredGiftCertificates | boolean |
None. |
|
| IsAvailableOnEnrollment | boolean |
None. |
|
| IsUnavailable | boolean |
None. |
|
| Applied | boolean |
None. |
|
| Selected | boolean |
None. |
Response Formats
application/xml, text/xml
Sample:
<CheckoutPaymentGiftCertificateViewModel> <ID>0</ID> <GiftCertificateTypeID>0</GiftCertificateTypeID> <CertificateDID /> <Amount>0</Amount> <TotalOnCard>0</TotalOnCard> <OriginalAmount>0</OriginalAmount> <Description /> <ExpirationDate>01/01/0001 00:00:00</ExpirationDate> <ShouldDisplayGiftCertificateID>False</ShouldDisplayGiftCertificateID> <ShouldDisplayCurrencySymbol>False</ShouldDisplayCurrencySymbol> <ShouldDisplayExpirationDate>False</ShouldDisplayExpirationDate> <ShouldDisplayExpiredGiftCertificates>False</ShouldDisplayExpiredGiftCertificates> <IsAvailableOnEnrollment>False</IsAvailableOnEnrollment> <IsUnavailable>False</IsUnavailable> <Applied>False</Applied> <Selected>False</Selected> <SelectedAmount>0</SelectedAmount> </CheckoutPaymentGiftCertificateViewModel>
application/json, text/json
Sample:
{
"ID": 0,
"GiftCertificateTypeID": 0,
"Amount": 0.0,
"TotalOnCard": 0.0,
"OriginalAmount": 0.0,
"ExpirationDate": "0001-01-01T00:00:00",
"ShouldDisplayGiftCertificateID": false,
"ShouldDisplayCurrencySymbol": false,
"ShouldDisplayExpirationDate": false,
"ShouldDisplayExpiredGiftCertificates": false,
"IsAvailableOnEnrollment": false,
"IsUnavailable": false,
"Applied": false,
"Selected": false,
"SelectedAmount": 0.0
}