注意:您必须输入sign the服务条款使用此API特性的协议。请下载,在此签署并以电子邮件形式发送一份服务条款协议副本,然后返回至api@globalgiving.org启用此功能。您必须证明您将处理捐献者的输入和数据符合pci dss处理敏感信息时的标准。这主要意味着确保你的连接是HTTPS,你的服务器是安全的,并且你从不存储用户的信用卡信息。
通过该操作,用户可以发送礼品卡。属性所指示的安全请求“/安全/”元素,因此,需要访问令牌(身份验证)。可以通过提交信用卡信息进行购买。
帖子
xml、json
xml、json
https://api.globalgiving.org/api/secure/givingservice/giftcards
api_key在API密匙部分,需要
&api_token在访问令牌部分,需要
&is_test当设置为真正的信用卡资料(< long creditCardNumber >,< expiryDateYear >,< expiryDateMonth >,< securityCode >)可能被省略,因为测试数据将被使用,交易将不会被处理,可选
/ api /安全/ givingservice /礼品卡?api_key = YOUR_API_KEY&api_token = SOME_API_TOKEN
refcode-响应中返回的这个请求的外部标识符(最多20个字符)
transactionId-此交易的唯一交易标识符存储在我们的记录中,以供将来参考和可能的报告,可选(最多100个字符)
电子邮件-必需(最多50个字符)
量-当使用GlobalGiving UK API密钥捐赠时,需要大于10美元或5英镑的数值
currencyCode-可选;默认为“USD”(表示美元)
插件;- - -可选
量-大于零的数值,如果需要插件元素
signupForGGNewsletter-可选;默认为false
sigupForCharityNewsletter-可选;默认为false
payment_detail;
firstname-必需(最多100个字符)
姓-必需(最多100个字符)
地址-必需(最多50个字符)
address2-可选(最多50个字符)
城市-必需(最多25个字符)
状态-必需(最多25个字符)
iso3166CountryCode- - -ISO 3166国家代码指定国家的标识符
邮政编码-必需(最多10个字符)
电话-可选(最多20个字符)
long creditCardNumber-必需(最多20个字符);可选,如果查询参数&is_test = true提供
securityCode-必需(最多10个字符);可选,如果查询参数&is_test = true提供
expiryDateMonth-必需(最多10个字符);可选,如果查询参数&is_test = true提供
expiryDateYear-必需(最多10个字符);可选,如果查询参数&is_test = true提供
giftCardDesign;
id-必需的(必须是一个id代表一个可用的礼品卡设计)
giftCard_detail;
dateToSend-必选(必须是"yyyy-mm-dd"格式,不能是过去的日期)
firstname-必需(最多100个字符)
姓-必需(最多100个字符)
电子邮件-必需(最多200个字符)
电话—可选(最多20个字符),用于在无法发送邮件时联系收件人
来- - -可选
从- - -可选
消息- - -可选
Content-Type: application/xml" -d " 123456789 123456789 transactionId>abc123 john.doe@hotmail.com 25 John Doe 3380 Pearlman Avenue Suite 200 Washington DC US 20001 4000100011112224 securityCode>09 2014 19 giftCard_detail> 2010-09-10 Debbie Gallagher debbie.gallagher@gmail.com 202-555-1212 Debbie Frank 这是一张礼品卡,你可以把它捐赠给你最喜欢的项目! " -X POST "https://api.globalgiving.org/api/secure/givingservice/giftcards?api_key=YOUR_API_KEY&api_token=SOME_API_TOKEN"
注意:为了可读性,以上请求有回车。
<?XML版本="1.0" encoding="utf-8" standalone="yes"?> 25.00 25.00 USD 2008-08-21:26:22.717-07:00 john.doe@hotmail.com false false signupForCharityNewsletter> abc123 true USD GZTKACJEA0Q46 25.00 John Doe lasttcertificate_detail > 3380 Pearlman Avenue Washington DC US 20001 4000-XXXX-XXXX-2224 securityCode>XXX 2014 USD R39339-GC138918-CBcb01 r39339 - gc138918 - cbcb9 25.00 tax扣除tiblecontributionamount > 25.00 19 2010-09-10T23:59:59-07:00 Debbie Gallagher debbie.gallagher@gmail.com202-555-1212 Debbie Frank Here's a gift card so you can donate to your favorite project!
注意:如果成功,响应包含< giftCertificate_detail >包含新< giftCertificateNumber >现在可以用了,还有< >收据节,< checkedOut >,< datetime >元素。
giftCard |
|
元素 | 强制性的 | 描述 |
---|---|---|
refcode | 要求 | 在响应中返回的提交请求者的外部标识符(最多100个字符)。 |
transactionId | 可选 | 您的唯一交易标识符(最多100个字符)存储在我们的记录中,以供将来参考和可能的报告。 |
电子邮件 | 要求 | 购买礼品卡的用户的电子邮件。 |
量 | 要求 | 礼品卡金额。 |
currencyCode | 可选(默认为美元) | 关于使用美元以外货币的问题,请联系GlobalGiving。 |
插件->数量 | 如果提供了插件元素,则需要 | 加上GlobalGiving的运营费用。 |
signupForGGNewsletter | 可选 | 如果用户应收到GlobalGiving通讯,则为True。默认值为false。 |
signupForCharityNewsletter | 可选 | 如用户应收到慈善通讯,则为True。默认值为false。 |
firstname | 要求 | 购买礼品卡用户的姓名。 |
姓 | 要求 | 购买礼品卡用户的姓氏。 |
地址 | 要求 | 购买礼品卡的用户地址。 |
address2 | 要求 | 购买礼品卡的用户地址第2行。 |
城市 | 要求 | 用户购买礼品卡的城市。 |
状态 | 要求 | 用户购买礼品卡的国家或省份。 |
iso3166CountryCode | 要求 | ISO 3166国家代码用户购买礼品卡。 |
邮政编码 | 要求 | 购买礼品卡用户的邮政编码或邮政编码。 |
电话 | 可选 | 购买礼品卡的用户手机。 |
long creditCardNumber | 要求 | 购买礼品卡时使用的信用卡号码。 |
expiryDateMonth | 要求 | 用于购买礼品卡的信用卡的有效期。 |
expiryDateYear | 要求 | 购买礼品卡所用信用卡的有效期。 |
securityCode | 要求 | 购买礼品卡时使用的信用卡安全码。 |
giftCardDesign -> id | 要求 | 表示可用的惟一标识符礼品卡设计. |
dateToSend | 要求 | 送出礼品卡的日期。必须为“yyyy-mm-dd”格式,不能是过去的日期。 |
giftCard_detail -> firstname | 要求 | 礼品卡收礼人的名字。 |
giftCard_detail ->的姓氏 | 要求 | 礼品卡收礼人的姓氏。 |
giftCard_detail ->邮件 | 要求 | 礼品卡收件人的电子邮件。 |
giftCard_detail ->电话 | 可选 | 收礼卡人的电话号码。用于邮件无法发送时。 |
来 | 可选 | 出现在礼品卡“收件人”部分的名字。 |
从 | 可选 | 出现在礼品卡“从”部分的名字。 |
消息 | 可选 | 出现在礼品卡上的信息。 |
giftCertificate |
|
元素 | 强制性的 | 描述 |
---|---|---|
量 | 要求 | 礼品卡金额。 |
chargedAmount | 要求 | 收取的总金额。金额和附加金额的总和。 |
currencyCode | 要求 | 将是“美元”,除非您已收到GlobalGiving UK API密钥,在这种情况下货币代码将是“GBP” |
插件->数量 | 如果提供了插件元素,则需要 | 加上GlobalGiving的运营费用。 |
datetime | 要求 | 购买礼品卡的交易日期(格式:YYYY-MM-DDThh:mm:ss[.s[s*]][TZD])。 |
电子邮件 | 要求 | 购买礼品卡的用户的电子邮件。 |
refcode | 要求 | 随请求一起提交的外部标识符。 |
signupForCharityNewsletter | 要求 | 如用户应收到慈善通讯,则为True。 |
signupForGGNewsletter | 要求 | 如果用户应收到GlobalGiving通讯,则为True。 |
transactionId | 可选 | 随请求一起提交的外部标识符。 |
checkedOut | 要求 | 如果礼品卡购买交易成功,则为True。 |
currencyCode | 要求 | 将是“美元”,除非您已收到GlobalGiving UK API密钥,在这种情况下货币代码将是“GBP” |
giftCertificateNumber | 要求 | 礼品券编号由GlobalGiving提供。 |
remainingAmount | 要求 | 礼券上的金额。 |
地址 | 要求 | 购买礼品卡的用户地址。 |
address2 | 可选 | 购买礼品卡的用户地址第2行。 |
城市 | 要求 | 用户购买礼品卡的城市。 |
long creditCardNumber | 要求 | 部分(不清楚的,如4000-XXXX-XXXX-2224)用于购买礼品卡的信用卡号码。 |
creditCardType | 要求 | 确定用于购买礼品卡的信用卡类型。 |
expiryDateMonth | 要求 | 用于购买礼品卡的信用卡的有效期。 |
expiryDateYear | 要求 | 购买礼品卡所用信用卡的有效期。 |
firstname | 要求 | 购买礼品卡用户的姓名。 |
iso3166CountryCode | 要求 | ISO 3166国家代码用户购买礼品卡。 |
姓 | 要求 | 购买礼品卡用户的姓氏。 |
电话 | 可选 | 购买礼品卡的用户手机。 |
securityCode | 要求 | 购买礼品卡时使用的信用卡安全码。 |
状态 | 要求 | 用户购买礼品卡的国家或省份。 |
邮政编码 | 要求 | 购买礼品卡用户的邮政编码或邮政编码。 |
currencyCode | 要求 | 将是“美元”,除非您已收到GlobalGiving UK API密钥,在这种情况下货币代码将是“GBP” |
receiptNumber | 要求 | 购买礼品卡的收据号码。 |
taxDeductibleContributionAmount | 要求 | 抵扣额:可作为税收抵扣的数额 |
totalAmountBilled | 要求 | 账单总额。 |
giftCardDesign -> id | 要求 | 表示可用的惟一标识符礼品卡设计. |
dateToSend | 要求 | 送出礼品卡的日期。 |
giftCard_detail -> firstname | 要求 | 礼品卡收礼人的名字。 |
giftCard_detail ->的姓氏 | 要求 | 礼品卡收礼人的姓氏。 |
giftCard_detail ->邮件 | 要求 | 礼品卡收件人的电子邮件。 |
giftCard_detail ->电话 | 可选 | 收礼卡人的电话号码。 |
来 | 可选 | 出现在礼品卡“收件人”部分的名字。 |
从 | 可选 | 出现在礼品卡“从”部分的名字。 |
消息 | 可选 | 出现在礼品卡上的信息。 |