订购礼券

此操作允许用户提交购买礼品券的订单，而无需提交付款细节。这使得GlobalGiving有能力立即生成礼品券，但对订单的核对将在稍后的日期进行。属性所指示的安全请求“/安全/”元素，因此，需要访问令牌(身份验证)。

注意:您必须与GlobalGiving签订特殊协议才能使用此API功能。请联系我们如果希望启用此功能，请获取更多信息。

HTTP方法:

帖子

内容类型:

xml、json

接受类型:

xml、json

路径:

查询字符串参数:

api_key在API密匙部分,需要

&api_token在访问令牌部分,需要

&is_test当设置为真正的礼品券订单将不会在GlobalGiving系统中登记

查询字符串示例:

/ api /安全/ givingservice / giftcertificates吗?api_key = YOUR_API_KEY&api_token = SOME_API_TOKEN

数据参数:

refcode—外部批处理标识符(最多20个字符)。这是用来开发票的，除非与GlobalGiving团队讨论，否则所有订单都应该是一样的。

thirdPartyIdentifier-可选;外部标识符，以唯一标识单个礼品卡。GlobalGiving不检查/保证唯一值。

量-需要大于1的数值

currencyCode-可选;默认为美元。

expirationDate-可选;格式为YYYY-MM-DD。默认为下单后一年。日期不能是订单的同一天，也不能是订单日期的过去，而且不能超过订单日期的两年。

HTTP POST请求使用cURL:

Content-Type: application/xml" -d "  123456789 25 {D21A1915-E024-4B9C-8345-62BECAE048EF} USD 2019-12-31 " -X POST "https://api.globalgiving.org/api/secure/givingservice/giftcertificates?api_key=YOUR_API_KEY&api_token=SOME_API_TOKEN"

注意:为了可读性，以上请求有回车。

XML响应:

<？XML版本="1.0" encoding="utf-8" standalone="yes"?>  GL9476HDT92N 25.00 {d21a1915 - e024 - 4b9c - 8445 - 62becae048ef} USD //www.tuuhangaido.com/gifts/redeem.html?code=GL9476HDT92N 2019-12-31T23:59:59-04:00 

注意:如果成功，response包含< giftCertificateNumber >,< redeemUrl >元素。

订购礼品券请求结构

giftCertificate

refcode 字符串 thirdPartyIdentifier 字符串 量 小数 currencyCode 字符串 expirationDate 字符串

订购礼券的元素定义

元素	强制性的	描述
refcode	要求	提交请求者的外部标识符(最多20个字符)。
thirdPartyIdentifier	可选	提交请求者的外部标识符(最多64个字符)。
量	要求	礼券金额。
currencyCode	可选的;默认为美元	如需使用美元以外的货币，请联系GlobalGiving
expirationDate	可选的;默认为自下单之日起一年	商品券的有效期。不得在过去或下单当日下单，且必须在两年内。

订购礼券响应结构

giftCertificate_detail

giftCertificateNumber 字符串 remainingAmount 小数 curencyCode 字符串 redeemUrl 字符串 expirationDate dateTime

订单礼券响应的元素定义

元素	强制性的	描述
giftCertificateNumber	要求	生成的giftcertid。
remainingAmount	要求	商品券上剩余的金额。这将与所要求的金额相同。
currencyCode	要求	商品券的计价货币。
exipirationDate	要求	商品券过期的日期是好的通过美国东部时区的截止日期。
redeemUrl	要求	URL来认领礼券。