@idonatedev/idonate-sdk NPM

What's this?

Javascript libraries for integrating with iDonate services.

Example: Low Level Transaction API, with reCAPTCHA

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>createTransaction demo, with reCaptcha</title>
    <script src="https://www.google.com/recaptcha/api.js" async defer></script>
    <script src="https://unpkg.com/@idonatedev/idonate-sdk@0.0.4-alpha.1"></script>
  </head>
  <body>
    <button type="button" onclick="grecaptcha.execute()">Submit</button>
    <!--
      This reCAPTCHA site key will never report a bot user:
        https://developers.google.com/recaptcha/docs/faq#id-like-to-run-automated-tests-with-recaptcha.-what-should-i-do

      Replace this with your own site key. The corresponding private key must also be configured on your Organization in
      the environment you are targeting.
    -->
    <div
      class="g-recaptcha"
      data-sitekey="6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI"
      data-callback="recaptchaCallback"
      data-size="invisible"
    ></div>
  </body>
  <script>
    // config will usually be supplied statically, at the page level.
    config = {
      organizationId: '2aa2e362-51aa-483d-bedd-645ae18cc1f3',
      paymentGatewayId: '12344321-e605-429e-b9a9-4516738635db',
    };

    // the rest of this information will typically be entered into forms by donors,
    // but is abstracted here for demo purposes.
    const billingContact = {
      firstName: 'Billing',
      lastName: 'Contact',
      email: 'billing.contact@example.com',
    };

    const billingAddress = {
      address1: '123 Place St.',
      city: 'Hometown',
      state: 'TX',
      zip: '76543',
      country: 'US',
    };

    const paymentDetails = {
      bankRoutingNumber: '123456',
      bankAccountNumber: '123456789',
    };

    idonateClient = new idonate.Client(config.organizationId, {
      enableSandboxMode: true,
    });

    function recaptchaCallback(recaptchaToken) {
      /**
       * Everything happens after the reCaptcha callback:
       * - tokenize payment details with the payment service
       * - associate that token with a PaymentMethod within iDonate
       * - use the new PaymentMethod to charge a payment and create a new Transaction
       *
       * createPaymentMethod and createTransaction are both secured using reCaptcha.
       *
       * A reCaptcha result is valid for two minutes, the same result can be used in both calls as long as the result
       * remains valid.
       */
      idonateClient
        .tokenizeCardConnectBankAccount(
          paymentDetails.bankRoutingNumber,
          paymentDetails.bankAccountNumber
        )
        .then((tokenResult) => {
          console.log('received tokenResult', tokenResult);

          return idonateClient.createPaymentMethod({
            paymentGatewayId: config.paymentGatewayId,
            paymentMethodType: 'bank_account',
            paymentMethodToken: tokenResult.token,
            recaptchaToken: recaptchaToken,

            contact: billingContact,
            address: billingAddress
          });
        })
        .then((paymentMethodResult) => {
          console.log('received paymentMethodResult: ', paymentMethodResult);

          return idonateClient.createTransaction({
            paymentGatewayId: config.paymentGatewayId,
            paymentMethodId: paymentMethodResult.paymentMethodId,
            recurringFrequency: 'once',

            paymentAmount: 5.0,
            currency: 'USD',

            billingContact: billingContact,
            billingAddress: billingAddress,

            customerMeta: {
              'up to 80 chars': 'up to 800 chars',
              is_demo: true,
            },

            recaptchaToken: recaptchaToken,
            corporateMatchingId: -1
          });
        })
        .then((createTransactionResult) => {
          console.log(
            'received createTransactionResult: ',
            createTransactionResult
          );
        });
    }
  </script>
</html>

Changes

0.0.4-alpha.3

adjustments to support internal applications

0.0.4-alpha.1

rename idonate.client to idonate.Client to fit style guidelines
- idonate.client compatibility will be maintained until 0.0.6 (or equivalent) is released.
Implement support for (and default to) using the Production environment for API calls.
Add an options parameter to the Client constructor, initially with only one option: enableSandboxMode
- if enableSandboxMode is true, API calls will be made against the Staging environment.
Add corporateMatchingId to the createTransaction payload.
Enable support for 'bring-your-own reCAPTCHA', adding the recaptchaToken parameter to createPaymentMethod and createTransaction methods.
- reCAPTCHA results are valid for two minutes and the same token can be re-used within this timeframe.
Update example in README to include reCAPTCHA support, trigger with a button instead of on load (example results continue to only show in the console)