OverviewOur API can now be used to purchase gift cards!You can issue DonorsChoose.org gift cards to your customers which they can then use to support classroom projects at DonorsChoose.org. Since the API will enable you to issue a gift card to one of your customers in the denomination of your choosing and the simple form of an 10-digit redemption code, you can use them for dynamically generate and issue "philanthropic customer rewards" of any size. In all scenarios, our initial approach to transactions is to handle the actual transferring of funds between partners like you and DonorsChoose.org outside of our API. You can't pass in a customer's credit card, PayPal, Amazon Payments, or DonorsChoose.org gift card into our API and have us charge them directly. If you are charging donors for their donations, you must do so directly and you will own the billing relationship with them. You can purchase DonorsChoose.org "account credits" via our front-end against which your API transactions will debit. Alternately, for high-volume partners, we can arrange an off-line billing arrangement with you, eg. whereby you sign a contract around the payment terms and then we invoice you monthly. Then we'll provision your API key to enable transactions! In some scenarios, we can enable you to make project donations via the API. For example, you could show your site visitors classroom classroom project listings and then process the donation to a project behind-the-scenes without having to route your site visitor to DonorsChoose.org's front-end! However, we're unable to make this option available to everyone. So if you're interested in using API project donations, get in touch with us so we can discuss how best to meet your needs. Protecting TransactionsTo ensure the integrity and security of all transactions, we require that...
Secure API Request URLAll requests should be POSTed to the following URL: https://apisecure.donorschoose.org/common/json_api.htmlShared ParametersThese parameters are shared by all transactional API requests:
Request DetailsTestingRequest URL & credentialsYou can submit test transactions...To this request URL: https://apisecureqa.donorschoose.org/common/json_api.html (different sub-domain than the production API request URL above) Using the APIkey: "DONORSCHOOSE" And the apipassword: "helpClassrooms!" We ask that you make your test transactions in very small denominations (eg. <=$5) since at present we need to manually replenish the credits in the test account...which we'd like to do infrequently, if possible. :) Sandbox availability & volumeThese requests go against the same testing environment used by our staff so it's unfortunately not uncommon for it to be temporarily offline during rebuilds or accidental outages. We're sorry if the instability of this environment gets in the way of your testing! If you must have this test environment available during a specific time window, get in touch with us and we'll try our best to accommodate.Also, since this is a shared testing environment that isn't resourced as robustly as our production environment, we ask that for now you avoid sending >1 transactional request every 2 seconds. Verifying test transactionsTo quickly verify that a test gift code purchase made via the API has succeed, we recommend visiting http: (slash)(slash) qa {dot} donorschoose (dot) org (slash) redeem and confirming that you can use the gift code to donate to a classroom project.To quickly verify that a test project donation made via the API has succeeded, we recommend visiting the proposalURL supplied in the response and confirming that the test donation appears in the reverse-chronological list of project updates. |
|
Documentation >
Transactions |