We make it easy to pay or get paid from a bank account.

Account Tokens

An account token is an identifier for a bank account. You should store this token, then use it any time you need to interact with this account

Account tokens do not expire

Account tokens can be used to

Create Payments

Pull money from or send money to this account using ACH

To create a payment, call the POST /v3/Payments API endpoint

Get Routing and Account Number

Routing and Account Number information is only available for 24 hours after enrollment

To get account and routing number, call the POST /v3/Accounts/{accountToken}/Export API endpoint

Check Account Balance

The latest balance can be obtained by calling POST /v3/Accounts/{accountToken}?updateBalance=true API endpoint

Use the LastUpdated date to see the accuracy of the balance

How an account token is created

BankONBOARD Widget

The widget will generate an account token upon successful completion

Handle the onEnrollmentSuccess event, then save the account token

API

You can create an account token by providing the customer's routing and account number to POST /v3/Accounts

How to capture an account token from the BankONBOARD Widget

Client-Side Javascript Event

Handle the onEnrollmentSuccess event, then save the account token to your system

Cashflow.onEnrollmentSuccess = function(accountToken, accountData) {
                // The accountToken is available to you in the accountToken variable or accountData.accountId
}

Webhook

Set your server's callback URL in the widget settings, or specify the URL on widget launch with the callbackURL parameter

The onEnrollmentSuccess event must be enabled in the widget settings for server-side delivery

We will call your URL with the following data

{
  "WebhookId": "GUID",
  "WebhookMessage":"The CFS widget has triggered an event.",
  "AssociatedItems": [{
    "ItemType":"EventLogItemResult",
    "Content":{
      "EventLogId": "GUID",
      "WidgetSessionId": "GUID",
	  "CustomerId": "string",
      "MerchantId": integer,
      "EventType": "onEnrollmentSuccess",
      "EventMessage": "accountToken",
      "EventDate": "datetime",
	  "enrollmentData": {
	    "accountToken": "string",
		"accountType": "string",
		"accountNickname": "string",
		"last4Digits": "string",
		"institution": "string"
	  },
      "verificationData" : {
        "inquiryId": "GUID",
        "inquiryType": "BankVERIFY+, BankLOGIN+, or BankVerify"
      }
    }
  }]
}

Virtual Wallet

When the enrollment is successful, the account is saved in our database and associated with your user.

If you are asking your user to select an account each time they pay or cash out, you may be able to call GET /v3/Customers/{customerId}/Accounts each time without saving the token to your system

Launch the BankONBOARD widget and provide your customer's ID
Your customer completes the widget, and the account is saved in our system
When the customer is ready to make a payment or cash out, call GET /v3/Customers/{customerId}/Accounts to get all available accounts
Call POST /v3/Payments with the selected account token to create a transaction

Need help?

Get a hold of us!

Send us a ticket with your questions to support@RIBBIT.ai

We can answer your questions over e-mail or schedule a meeting with your team

Developer Docs

Account Tokens

Account tokens can be used to

How an account token is created

How to capture an account token from the BankONBOARD Widget

Need help?