Collecting Payment Information

Choose your implementation style

Great job! We've got a record for your new vendor. In order to send them a payment, we're going to need some information from them about their bank (if we're sending ACH transfers) or their mailing address (if we're mailing physical checks). You can use Routable's interface for this interaction, or create your own.

Routable provides three distinct pathways to obtaining account information from your vendors and customers. See the sections below for details on each methodology. You can even mix and match to suit your needs!

:incoming-envelope: 1. Email an Invitation

Use the Invite a Company API endpoint to send an email invitation to the Contact(s) attached to your the Company. The email will contain a link that directs the user to a branded, Routable-hosted form that gathers payment details for every country Routable supports, so you don't have to worry about user interface or validation for any of this data.

Learn More

:link: 2. Use a Redirect Link

Using the same Invite a Company API endpoint with different parameters, request a link that you can present your users or redirect them to, in order to embed the Routable onboarding process into your own application's vendor or customer intake workflow. Uses the same branded, pre-built form as emailed invitations, but without sending your contact to their email for a link. Provide a confirmation URL, and we'll also redirect the user back to your site to continue your onboarding process when we've collected everything we need to get them set up in Routable for you.

Learn More

:hammer: 3. Build Your Own User Interface

If you'd prefer to fully construct your own user interface for collecting payment data rather than using Routable's pre-built solution, no problem! Collect a few fields and pass them to our Payment Methods API, and you can get your partners up and running in no time.

Learn More

:incoming-envelope: 1. Email an Invitation

Routable provides a simple workflow to "invite" a company to be a part of your organization. The Contacts you added as part of the previous step will receive an email with a link inviting them to add their Payment Method details on a form built and managed by Routable.

All we need to do is send a request Invite a Company endpoint to get them onboard!

We'll need the id from the Company we created in the previous step to make this call, as it's supplied in the URL. We'll also need the Acting [Team Member](doc:team-members) ID.

{
    "acting_team_member": teamMemberId,
    "message": "{{your custom email message here}}",
    "send_invite_email": true,
    "get_links": false
}

The default Contact(s) on the Company you created in the previous step will receive an email inviting them to enter their payment information on a Routable-hosted web form. It will look something like the example below. Use the message field in the Invite a Company request to add any custom information or messaging to the body of the email.

14961496

Your vendor will receive an email (see the first image) that, when opened, will direct them to complete the onboarding process on the branded Routable external flow.

The green Register to be paid button will take your Contact to the form described in the Routable Company Onboarding Form section below.

:link: 2. Use a Redirect Link

Do you want to use the Routable onboarding form, but you'd prefer to integrate the experience into your own onboarding flow rather than waiting for your partners to receive an email? No problem! We'll send a slightly modified version of the Invite a Company call discussed above, but this time, we'll request links rather than an email:

{
    "acting_team_member": teamMemberId,
    "send_invite_email": false,
    "get_links": true,
    "confirmation_redirect_url": "https://www.example.com/after-joining"
}
12001200

In this example, Routable's user interface for vendor onboarding is seamlessly inserted into the website's user onboarding workflow.

🚧

Want to pre-send Payables?

The onboarding link that is returned as part of the Use a redirect or link to direct the user to Routable's onboarding form will not allow the vendor to accept any pending Payables in the same session, however, the link that is sent via email will allow it. This is done for security reasons. If you need to use Use a redirect or link to direct the user to Routable's onboarding form, it is recommended to not send Payables to the invited Company until their onboarding has been completed.

Now, the response will include, for each Contact in the returned Company resource, a personalized invitation_url for onboarding. You'll need to identify which Contact in the Company is doing the actual onboarding, and direct them to the external_flow_url when you're ready for them to do their Routable onboarding via the form described below. When they finish the Routable onboarding form, we will redirect them to the URL you specified in your confirmation_redirect_url in the request, where the user can continue the onboarding workflow in your application.

πŸ“˜

Want the best of both worlds?

If you'd like to send an email and use a redirect link to the onboarding process, you may specify both send_invite_email = true and get_links = true in your Invite a Company request. You'll also want to specify both message and confirmation_redirect_url in this case.

(Options 1 & 2) Routable's Company Onboarding Form

The following form, hosted and maintained by Routable, allows your vendors and customers to enter their payment details and tax information. The form will take care of collecting and validating all of the relevant data, including the various distinctions between payment requirements for the various countries we support.

10241024

The form your vendors and customers will complete to onboard themselves.

πŸ“˜

Branding your onboarding forms and emails

Routable provides an easy way to add your company's logo and colors to the emails and forms we show your vendors and customers. You can configure your branding settings from your Routable Dashboard.

:hammer: 3. Build Your Own User Interface

If you've chosen to build your own user interface for collecting Payment Methods from your vendors and customers, this section is for you.

Routable supports payment methods of types address and bank. The address payment method is used when you send a Payable via a physically-mailed check, and the bank payment method is used for ACH transfers. A third payment method, international, provides the same types of details as bank, but accepts more complex data to allow the flexibility to support the requirements of the various countries you can send Cross-Border Payments to with Routable.

Collecting a bank Payment Method

You'll need to provide your users a form to populate banking information such as routing number, account number, and account type (checking or savings). We've provided a sample form for you below.

12801280

A sample bank account collection interface.

14961496

Here's another example of a custom interface that uses Routable's API to onboard vendors under the hood.

Once you've collected this information from the user, send a Create a Payment Method call to save it.

{
    "type": "bank",
    "type_details": {
        "country": "US",
        "account_number": "12345861398613",
        "account_type": "checking",
        "routing_number": "063100222"
    },
    "is_primary": true,
}

Collecting an address Payment Method

We use address Payment Methods to mail physical checks. You can provide a form for the user to enter their address, or, if you've already collected it as part of the user onboarding process, you can just submit the address you've already collected via the API.

401401

A sample address collection form.

Once you've collected this information from the user, send a Create a Payment Method call to save it.

{
    "type": "address",
    "type_details": {
        "country": "US",
        "address_line_1": "2018 N Main Ave",
        "address_line_2": "Suite 150",
        "city": "Scranton",
        "postal_code": "18508",
        "state": "PA",
        "country": "US",
        "print_name": "Bob Vance",
        "print_business_name": "Vance Refrigeration"
    },
    "is_primary": true
}

🚧

Heads up!

This onboarding method is currently supported for domestic (US) vendors and customers only. An expansion to this functionality to support our new Cross-Border Payments is coming soon!

Outstanding work!

Well done! Now the Company data is stored, the payment method(s) are collected, and the Company is in the accepted status. We're ready to send a payment! Let's get to it in the Your First Payable section!

πŸ“˜

Company Status

You can track the Company's process through the onboarding journey using the status field of the Company. As you saw in the Onboarding Your Vendors section, a Company that has been added but not yet invited is in the added status. if we send an invitation using the Invite a Company workflow, the Company will transition to the invited status. Once they complete the onboarding form and enter payment information (if Invited) or a Payment Method is added (via your API calls), a final transition to the accepted status will occur. Vendors in this status are ready to be paid! :rocket:


Did this page help you?