Zūm Connect

Learn how to use the Connect URL at Zūm Rails

URL V/S SDK

Our URLs allow you to host our UI within your application and it's the easiest to use for our clients. It's a unique URL which you can host as an iframe, send by e-mail or sms. Since, this is a public URL which is not tokenized, it’s not the most recommended option.

The javascript sdk library allows you to build a more robust integration with Zūm Rails. Instead of hosting a public URL, the library offers the possibility for you to first create a temporary token, then initiate and receive real-time updates and listen to events. Hence, it is the best option for our clients.

Connect SDK (Install & Init)

To start using the library you will need to do the following:

1. Authorize using the endpoint {{env}}/api/authorize.

2. Create a token which has to be informed in the SDK. Use the endpoint {{env}}/api/connect/createtoken to generate the token. The token is valid for 15 minutes, and it will be automatically expired after a user uses it.

Payload

{
  "ConnectTokenType": "AddPaymentProfile",
  "Configuration": {
    "allowEft": true,
    "allowInterac": true,
    "allowVisaDirect": true,
    "allowCreditCard": true
  }
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": {
    "Token": "production|AddPaymentProfile|85dedfcd-f8de-45e4-851a-5a8b79b75e15|a4ae068aeeea49859c266605a5c3cddd",
    "ExpirationUTC": "2022-03-21T13:30:56.4052997Z",
    "CustomerId": "85dedfcd-f8de-45e4-851a-5a8b79b75e15",
    "CompanyName": "Company To Test",
    "Environment": "production",
    "ConnectTokenType": " "
  }
}

ConnectTokenType	Description
CheckoutProduct	Define a request to go to the Connect checkout product
CheckoutProductPrice	Define a request to go to the Connect checkout product price
AddPaymentProfile	Define a request to go to the Connect Add payment profile
AddFundingSource	Define a request to go to the Connect Add funding source
UpdateSubscription	Define a request to go to the Connect Update subscription
CancelSubscription	Define a request to go to the Connect Cancel subscription
SubscriptionDetails	Define a request to go to the Connect Subscription details
ManageUserPortal	Define a request to go to the Connect Manage user profile
RequestFunds	Define a request to go to the Connect Request funds
InvoicePayment	Define a request to go to the Connect Invoice Payment
InvoiceDownload	Define a request to go to the Connect Invoice Download
SendFunds	Define a request to go to the Connect Send Funds
ThreeDS	Define a request to go to the Connect ThreeDS
HostedCheckout	Define a request to go to the HostedCheckout

1. Refer the javascript sdk library into your website, build your configuration options and init the sdk. Inform the token (result.Token) in any request you want to execute.

NOTE To get the URL/SDK navigate to the settings menu option > Integration codes

Install & Initialize the SDK

Use the JavaScript library below to integrate the SDK into your website. Make sure to use the appropriate URL—one for the sandbox environment and another for production.

Sandbox

<script
  id="zumrailssdk"
  src="https://cdn.zumrails.com/sandbox/zumsdk.js"
  type="text/javascript"
  async=""
></script>

Production

<script
  id="zumrailssdk"
  src="https://cdn.zumrails.com/production/zumsdk.js"
  type="text/javascript"
  async=""
></script>

The library expects 1 mandatory parameter:

Parameter	Description
token	The token received in the endpoint {{env}}/api/connect/createtoken

Bellow you can find an example of the code needed to init the JS SDK.

<script>
  $(function () {
    $("#btnGoConnect").click(function () {
      const token = "<THE TOKEN RECEIVED IN THE CREATE TOKEN ENDPOINT>"

      ZumRailsSDK.init({
        token: token,
        onLoad: function () {
          console.log("onLoad")
        },
        onError: function (error) {
          console.log("onError", error)
        },
        onSuccess: function (data) {
          console.log("onSuccess", data)
        },
        onButtonClose: function () {
          console.log("onButtonClose")
        },
      })
    })
  })
</script>

SDK Callbacks

When something happens, the sdk library will fire a few callbacks, this allows you to easily get the data and take an immediate action. For example, call the endpoint to get the full card information onSuccess by passing the requestId or cardId

onLoad

This callback is triggered when the UI is loaded and presented on the screen.

Parameters

• There are no parameters in this callback

onButtonClose

This callback is triggered when the end user clicks in the X button to close the Connect

Parameters

• There are no parameters in this callback

onError

This callback is triggered when the connection failed by any error not expected in the happy flow

Parameters

• error: An error message explaining the reason why the failure happened

onSuccess

This callback is triggered when the connection is completed

Parameters

• data: The information returned will depend on the ConnectTokenType defined.

For example, when you use AddPaymentProfile will return something like this below:

{
  "invoiceId": null,
  "userId": "2abc0bda-98bf-40e0-993b-4b76302c0843",
  "transactionId": null,
  "subscriptionId": null,
  "origin": "ZUM_RAILS",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

User tokenization / Add payment profile

The best way to add a user to the Zūm Rails platform is through Zūm Connect. It consists of an iFrame website, hosted by Zūm Rails and referenced in your website.

The Zūm Connect iframe will display a form to capture the user's basic information (Full Name and Email) so that we can create an identity.

Independent of the method, the user will always be asked to agree and consent the information shared (PAD). The message can be customized for your needs as well. Your specific settings will be available under your profile in Zūm Rails portal. Depending on your need, you can capture the new user using our webhook mechanism, or if you need it right at the moment we redirect back to your flow, you can capture the Zūm user id (token) by listening to an event message as described in your portal settings.

After a user creates and links his account, you will be able to view it in the Zūm Rails portal or use the API to filter and get a specific user.

Add payment profile using URL

Pre-filling the form

To help streamline the Zūm Connect experience, it is possible to pass information that you already have through optional parameters in the url:

Canada

Name	Description
accountType	Personal or Business
firstName	User first name, when the account type is Personal
lastName	User last name, when the account type when is Personal
email	User email
companyName	Company name, when the account type is Business
memo	Transaction memo that will be created with the request funds. The limit is 15 characters
comment	Transaction comment that will be created with the request funds. The limit is 400 characters
allowEft	To display only EFT payment method.
allowInterac	To display only INTERAC payment method.
allowVisaDirect	To display only VISA DIRECT payment method.
allowCreditCard	To display only CREDIT CARD payment method.
displayTermsAndCondition	To display the terms and conditions checkbox or not.
displayDetailsColumn	To display the left side column with transaction details, amount and recurrency
displayZumRailsLogo	To display the powered by Zūm Rails logo
displayPhoneNumber	To display the phone number field
displayAccountType	To display account type option
displayFullName	To display a full name field instead of first and last name fields when the user chooses Personal as account type. (It can be pre-filled with firstName query param)
hideBackButton	To hide all back buttons
hideShippingAddress	To hide the shipping address
hideRailsName	To hide the rails name when there is just one
hideFirstName*	To hide the first name field
hideLastName*	To hide the last name field
hideFullName*	To hide the full name field
hideEmail*	To hide the email field
hideCreditCardAddress*	To hide all the credit card address fields
language	Change the connect language. There are two available options: en (english) and fr (french). If not set, the language will be chosen according to the browser language. English is applied if the given language is not available
backgroundColor	Change the background color around the form with a hex code (Only numbers, you don't need to send the hash symbol prefix)
foregroundColor	Change the foreground color in the form with a hex code (Only numbers, you don't need to send the hash symbol prefix)
disablePreFilledFields	Disable all fields that received a value by query parameter (Example: firstName, lastName...)
creditCardAddresLine1	Define the field address line 1 in credit card tab
creditCardAddresLine2	Define the field address line 2 in credit card tab
creditCardCity	Define the field city in credit card tab
creditCardProvince	Define the field province/territory in credit card tab
creditCardPostalCode	Define the field postal code in credit card tab
creditCardCountry	Define the field country in credit card tab. NOTE: Currently we only accept "Canada" as the value for this parameter. Any other values, if specified, will be ignored.
clientUserId	Your internal user id for user added
extraField1	User extra field 1
extraField2	User extra field 2
successURL	The URL to which Zum Rails will redirect end-users, after the payment is initiated by the end-user.
cancelURL	The URL to which Zum Rails will redirect end-users, when they decide to cancel the payment.

US

Name	Description
firstName	User first name, when the account type is Personal
lastName	User last name, when the account type when is Personal
allowCreditCard	To display only CREDIT CARD payment method.
allowAch	To display only ACH (bank) payment method.
displayTermsAndConditions	To display the terms and conditions checkbox or not.
displayZumRailsLogo	To display the powered by Zūm Rails logo
hideRailsName	To hide the rails name when there is just one
hideCreditCardAddress*	To hide all the credit card address fields
backgroundColor	Change the background color around the form with a hex code (Only numbers, you don't need to send the hash symbol prefix)
foregroundColor	Change the foreground color in the form with a hex code (Only numbers, you don't need to send the hash symbol prefix)
disablePreFilledFields	Disable all fields that received a value by query parameter (Example: firstName, lastName...)
creditCardAddressLine1	Define the field address line 1 in credit card tab
creditCardAddressLine2	Define the field address line 2 in credit card tab
creditCardAddressCity	Define the field city in credit card tab
creditCardAddressProvince	Define the field province/territory in credit card tab
creditCardAddressPostalCode	Define the field postal code in credit card tab
creditCardAddressCountry	Define the field country in credit card tab.
accountType	“Personal” or “Business”
companyName	Company name, when the account type is Business
idType	The type of ID: “DL” or “SSN”, when the account type is Personal
idNumber	ID (DL or SSN) number, when the account type is Personal
idState	State where ID was issued, when the account type is Personal and id type is DL
businessTaxId	Business tax ID, when the account type is Business
billingAddressLine1	Define the field address line 1 in bank tab
billingAddressLine2	Define the field address line 2 in bank tab
billingAddressCity	Define the field city in bank tab
billingAddressProvince	Define the field state in bank tab
billingAddressPostalCode	Define the field postal code in bank tab
clientUserId	Your internal user id for user added
extraField1	User extra field 1
extraField2	User extra field 2
successURL	The URL to which Zum Rails will redirect end-users, after the payment is initiated by the end-user.
cancelURL	The URL to which Zum Rails will redirect end-users, when they decide to cancel the payment.
singleAccountSelection	Enable the user to select a specific account Chequing or Savings and disable all others.

NOTE

Hiding a field doesn't mean that it is no longer mandatory, please use the other query params to pre-fill: firstName, lastName, email, etc.

The field creditCardProvince can be defined with this state abbreviations:

Abbreviation	Description
AB	Alberta
BC	British Columbia
MB	Manitoba
NB	New Brunswick
NL	Newfoundland and Labrador
NS	Nova Scotia
NT	Northwest Territories
NU	Nunavut
ON	Ontario
PE	Prince Edward Island
QC	Quebec
SK	Saskatchewan
YT	Yukon

Examples:

{{env}}/connect-adduser/{{customerId}}?accountType=personal&firstname=Name&lastname=Last&email=[e-mail]

{{env}}/connect-adduser/{{customerId}}/{{requestFundsId}}?accountType=personal&memo=memo&comment=here%20is%20an%20example%20comment

{{env}}/connect-adduser/{{customerId}}?allowEft=true&language=fr

{{env}}/connect-adduser/{{customerId}}?allowEft=true&allowInterac=true

Event Listeners

When a new user is added or a request funds is fulfilled, Zūm Connect will trigger an event to provide to your application the UserId, TransactionId or RecurrentTransactionId.

To listen to the event in js, your website must refer to Zūm Connect using an iFrame, and then your website should have the script/example.

<script>
  window.addEventListener("message", function (e) {
    var data = e.data
    if (data && data.origin && data.origin === "ZUM_RAILS") {
      console.log(data)
    }
  })
</script>

Add User Event

{
  "origin": "ZUM_RAILS",
  "userId": "c18dd952-...-9bd6a46eb1c4",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

Add Payment Profile using SDK

Once authorized, the next step is to create a token. You will need to create a token with the payload as below. For this specific type of request the parameters for the allowment of rails are mandatory.

Add a payment profile without name matching

{
  "ConnectTokenType": "AddPaymentProfile",
  "Configuration": {
    "allowEft": true,
    "allowInterac": true,
    "allowVisaDirect": true,
    "allowCreditCard": true
  }
}

Add a payment profile with name matching

{
  "ConnectTokenType": "AddPaymentProfile",
  "User": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "addressCity": "Montréal",
    "addressLine1": "4975 Rue de Sorel",
    "addressProvince": "QC",
    "addressPostalCode": "H4P1G3"
  },
  "Configuration": {
    "allowEft": true,
    "allowInterac": true,
    "allowVisaDirect": true,
    "allowCreditCard": true
  }
}

Callbacks

onSuccess

{
  "invoiceId": "null",
  "userId": "80d53753-a9f7-4b81-93f0-44879ed778af",
  "transactionId": "null",
  "subscriptionId": null,
  "origin": "ZUM_RAILS",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

Invoice Checkout

The best way to let the user choose and pay for an item is using the checkout. It consists of an iFrame website, hosted by Zūm Rails and referenced in your website. The Iframe will display the products/prices to the user and they can choose what they would like to pay for. It will display the form to collect the user’s payment information, then create a transaction and send the invoice to the user over their email once the transaction is successful.

Invoice checkout using URL

Event Listener

When a new invoice is created through checkout, Zūm Connect will trigger an event to provide to your application the UserId, TransactionId or InvoiceId.

To listen to the js event, your website must refer to Zūm Connect using an iFrame, and then your website should have the script/example as described.

Other Rails

{
  "origin": "ZUM_RAILS",
  "invoiceId": "c18dd952-...-9bd6a46eb1c4",
  "userId": "c18dd952-...-9bd6a46eb1c4",
  "transactionId": "c18dd952-...-9bd6a46eb1c4",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

EFT

{
  "origin": "ZUM_RAILS",
  "userId": "c18dd952-...-9bd6a46eb1c4",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

Invoice Checkout using SDK

Once authorized, the next step is to create a token. You will need to create a token with the payload as below based on if it's a checkout for an entire product or a specific product price.

Checkout for a product

{
  "ConnectTokenType": "CheckoutProduct",
  "ProductId": "01cd838e-9f07-47e9-8581-ecc324b0529b"
}

Checkout for a specific product price

{
  "ConnectTokenType": "CheckoutProductPrice",
  "ProductId": "01cd838e-9f07-47e9-8581-ecc324b0529b"
}

Callbacks

onSuccess

{
  "invoiceId": "60ca0702-40ef-4d8a-ab5d-0788382c7934",
  "userId": "80d53753-a9f7-4b81-93f0-44879ed778af",
  "transactionId": "15de3094-84d8-4c6b-b001-02384be50ba1",
  "subscriptionId": null,
  "origin": "ZUM_RAILS",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

Subscription checkout

The best way to let the user choose and subscribe to an item is using the checkout. It consists of an iFrame website, hosted by Zūm Rails and referenced in your website. The Iframe will display the products/prices to the user and they can choose what they would like to subscribe to. It will display the form to collect the user’s payment information, create the subscription and email the subscription details to the user.

In case of subscription, a new invoice will be generated based on the billing cycle. Whenever a new invoice is generated we will automatically charge the payment method that was used when creating the subscription using the checkout link.

Subscription checkout using URL

Event Listener

When a new subscription is created through checkout, Zūm Connect will trigger an event to provide to your application the UserId, TransactionId or subscriptionId.

To listen to the js event, your website must refer to Zūm Connect using an iFrame, and then your website should have the script/example as described.

Other Rails

{
  "origin": "ZUM_RAILS",
  "subscriptionId": "c18dd952-...-9bd6a46eb1c4",
  "userId": "c18dd952-...-9bd6a46eb1c4",
  "transactionId": "c18dd952-...-9bd6a46eb1c4",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

EFT

{
  "origin": "ZUM_RAILS",
  "userId": "c18dd952-...-9bd6a46eb1c4",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

Subscription checkout using SDK

Once authorized, the next step is to create a token. You will need to create a token with the payload as below based on if it's a checkout for an entire product or a specific product price.

Checkout for a product

{
  "ConnectTokenType": "CheckoutProduct",
  "ProductId": "01cd838e-9f07-47e9-8581-ecc324b0529b"
}

Checkout a specific product price

{
  "ConnectTokenType": "CheckoutProductPrice",
  "ProductId": "01cd838e-9f07-47e9-8581-ecc324b0529b"
}

Callbacks

onSuccess

{
  "invoiceId": null,
  "userId": "80d53753-a9f7-4b81-93f0-44879ed778af",
  "transactionId": null,
  "subscriptionId": "578c3ddf-64ec-4479-ad7a-a3154bbe64c4",
  "origin": "ZUM_RAILS",
  "clientUserId": null,
  "extraField1" : null,
  "extraField2" : null
}

Manage Subscriptions

This library will allow the users to manage their subscriptions (view, cancel or update them). It consists of an iFrame website, hosted by Zūm Rails and referenced in your website.

View or Update a subscription using the SDK

Once authorized, the next step is to create a token. You will need to create a token with the payload as below.

Cancel a Subscription

{
  "ConnectTokenType": "CancelSubscription",
  "SubscriptionId": "01cd838e-9f07-47e9-8581-ecc324b0529b"
}

Callbacks

onSuccess

{
    "invoiceId": "null",
    "userId": "null",
    "transactionId": "null",
    "subscriptionId": "80d53753-a9f7-4b81-93f0-44879ed778af",
    "origin": "ZUM_RAILS",
    "clientUserId": null,
    "extraField1" : null,
    "extraField2" : null
}

Manage user account

This library will allow the users to manage their account (view, cancel or update, pay for subscriptions/invoices). It consists of an iFrame website, hosted by Zūm Rails and referenced in your website.

Manage user account using SDK

Once authorized, the next step is to create a token. You will need to create a token with the payload as below.

Manage user portal

{
  "ConnectTokenType": "ManageUserPortal",
  "Email": "[e-mail]"
}

Each user will receive a link along with the emails for invoices/subscription which they can use to manage their account. If they initiate this flow on their own they will be asked to enter their email address > Zūm will check if that email address has any subscriptions/invoices under your customer account > if yes, we will send a one-time passcode to the users’ email which if matches with what the user enters in the UI, we will show them their Invoices/subscriptions/payment details.

Hosted Checkout

The Hosted Checkout feature enables developers to quickly generate a secure, customizable payment page by providing product details like name, price, and description. Customers can complete transactions using their preferred payment method through a seamless, white-labeled interface. This solution simplifies payment integration, offering a PCI-compliant checkout experience that maintains brand consistency across different platforms.

Hosted Checkout using SDK

Once authorized, the next step is to create a token. You will need to create a token with the payload as below. Follow the examples to see how to handle the product information, fees attached to product and specific configurations

Mandatory fields

{
  "ConnectTokenType": "HostedCheckout",
  "Amount": 10.0,
  "Items": [
    {
      "Name": "Product Name",
      "Price": 10.0
    }
  ]
}

Complementary information

{
  "ConnectTokenType": "HostedCheckout",
  "Amount": 10.0,
  "ReturnTokenWithoutUrl": true,
  "ExpirationUTC": "2024-09-15T17:53:17.8033045Z",
  "Items": [
    {
      "Name": "Item to sell",
      "Description": "Description of the item to sell",
      "Price": 10.0,
      "Quantity": 1,
      "ImageUrl": "https://image-url-example"
    }
  ],
  "Configuration": {
    "allowEft": true,
    "allowInterac": true,
    "allowVisaDirect": true,
    "successURL": "https://success-url-example",
    "cancelURL": "https://cancel-url-example"
  }
}

With additional amounts

{
  "ConnectTokenType": "HostedCheckout",
  "Amount": 11.1,
  "ReturnTokenWithoutUrl": true,
  "Items": [
    {
      "Name": "Item to sell",
      "Description": "Description of the item to sell",
      "Price": 10.0
    }
  ],
  "AdditionalAmounts": [
    {
     "Type": "CommonFee",
     "Name": "Fee 1",
     "Description": "Common Fee",
     "Amount": 0.1
    },
    {
      "Type": "TaxRate",
      "Name": "TaxRate 1",
      "Description": "Tax Rate",
      "Amount": 0.1,
      "RateType": "Inclusive"
    }
  ],
  "Configuration": {
    "allowCreditCard": true
  }
}

Some fields, if not informed, will have default values.

• If ExpirationUTC isn't specified, the token will be valid during the next 24 hours;

• If Quantity, property of the object inside of the Items list, isn't informed, it's value will be 1;

• If none transaction method is specified (by the fields allowEft, allowInterac, allowVisaDirect, allowCreditCard and allowAch), then the payment methods on the Hosted Checkout will be the ones enabled for the customer that called the API.

Callbacks

onSuccess

{
  "origin": "ZUM_RAILS",
  "invoiceId": "731eabd7-9b50-469f-ab8b-54f7ec89109f",
  "userId": "80d53753-a9f7-4b81-93f0-44879ed778af",
  "transactionId": "0795b370-b2c8-431d-899c-3b54d589e8b0",
  "sessionId" : "89d53753b2c8431d899c54f7ec89109f"
}