Guides

Payment Button

Payment Button is a JavaScript library from Datatrans that facilitates the setup, rendering, and usage of payment buttons of different Wallet providers. It also uses the Payment Request API specified by W3C. If the Payment Request API is unavailable, it returns to the corresponding vendor implementation. This library gives you a single integration for rendering payment buttons. It automatically detects which button should be displayed depending on the browser and device combination that is used.

๐Ÿ“˜

Domain whitelisting required for Apple Pay

Your domain needs to be whitelisted to allow the Payment Button to correctly do authorizations with Apple Pay. Please login to your merchant account and proceed with whitelisting your domains. The domain whitelist section for Apple Pay can be found in your merchant configuration within the section Apple Pay Settings.

Process overview

To start a transaction via our Payment Button Integration, you will need to initialize the Payment Button Javascript library and wait for your customer to hit the button provided by the library ยน. We will call your webhook once the transaction has been completed ยฒ and inform your front end again once a transaction has been finalized ยณ.

Payment Button integration

To get started include our Payment Button script on your web page.

<script src="https://pay.sandbox.datatrans.com/upp/payment/js/payment-button-2.0.0.js"></script>

Our Payment Button expects the object payment which conforms with the W3C payment request interface description. The object transaction contains Datatrans specific values, including countryCode and refno. Please refer to the section important parameters for more details on the expected values. In contrast to our other APIs, the amounts in the payment button integration are in the standard base unit of the currency. If you want to include fractional monetary units (pennies, cents, Rappen), you will have to separate the amount using a decimal point (eg. 5.10 instead of 510).

const payment = {
  // W3C
  details: {
    total: {
      label: "My Merchant",
      amount: { value: "1.50", currency: "USD" },
    },
    displayItems: [
      {
        label: "Tax",
        amount: { value: "2.50", currency: "USD" },
      }
    ],
    shippingOptions: [
      {
        id: "ground",
        label: "Ground Shipping",
        amount: { value: "5.00", currency: "USD" },
        selected: true,
      },
      {
        id: "express",
        label: "Express Shipping",
        amount: { value: "10.00", currency: "USD" },
      }
    ]
  },
  options: {
    requestPayerEmail: true,
    requestPayerName: true,
    requestPayerPhone: false,
    requestShipping: true
  },
  // Datatrans
  transaction: {
    countryCode: "CH",
    refno: "3e23dasdasd1123"
  }
};

Next, you'll want to define your payment options. Within PaymentButton.init() you define the merchant configuration, the name visible on the payment sheet, the settlement option, the allowed card brands, and other options related to the wallets.

PaymentButton.init({
  merchantId: '{merchantId}',
  merchantName: 'Test',
  tokenOnly: false,
  autoSettle: false,
  allowedCardNetworks: ['AMEX', 'DISCOVER', 'MASTERCARD', 'VISA'],
  googlePayConfiguration: {
    buttonType: "long",
    buttonStyle: "black",
    merchantId: "{googlePayMerchantId}"
  },
  applePayConfiguration: {
    buttonType: "plain",
    buttonStyle: "black"
  }
});

Placing the Payment Button

Place the button at your desired location.

PaymentButton.on("init", function () {
  PaymentButton.create(document.getElementById('paybutton'), payment)
});

Success

Listen for the authorization event of the PaymentButton.on() call.

PaymentButton.on("authorization", function (response) {
  // handle transaction result
});

Webhook

After any transaction that was processed via our Payment Button integration, we will call your webhook with all relevant transaction information. You can define your webhook URL within your merchant configuration. Any server to server request to modify an existing transaction has to be made with our transactionId. Please refer to our page After The Payment for more information on actions you can make after a payment has been completed.

Within our Payment Button integration, your webhook will always be called asynchronously after a transaction has been completed. We only try to call your webhook once. If it fails, no additional calls will be performed.

Showcase & more

For a detailed sample you can visit our Payment Button showcase. All events and parameters are explained there in detail too.