Banking API

Sivo exposes a RESTful API that implements the capabilities needed to take advantage of its debt-as-a-service functionality. The APIs are designed to follow modern standards and best practices to make it as easy as possible to adopt and integrate with your application. You can use standard HTTP verbs (POST to create, GET to retrieve, etc.) in your requests and expect standard HTTP response codes in the responses (2xx for success, 4xx for request errors, and 5xx for other errors).

Sivo offers a sandbox mode for development and test purposes (see the Testing section for details and best practices).

The best way to get started is to log into the Sivo application to retrieve your client id and refresh token from the Integrations > API page. Next, you can write code to obtain an access token from Sivo👇

A simple way to get started with the banking APIs is to send some funds from your Sivo cash account. If you want to test these recipes, you can use your Sandbox environment which has test funds. Hint: the Sivo app has an option to add funds for testing, just switch to the Sandbox and go to the Banking > Cash page.

Just follow these steps to send some test funds:

  1. Retrieve your cash account: Before you can send funds, you need to know the ID of your Sivo cash account, and possibly the current balance to confirm if you have sufficient funds to send. You can get it from the Sivo Application, by going to Banking > Cash and copying the "Cash account ID" to your clipboard. You can also get it programmatically by using the following API to retrieve your Sivo accounts. The account with a label of cash is the one you are looking for.
  1. Create a contact: This is the destination bank account used to send the funds. You only need to do this only once for each destination account. Then you can reuse the contact to send multiple payments to that account. Use the "Create a Contact" recipe to accomplish this:
  1. Send funds to a contact: To send funds to an existing contact you should use the send ACH or send wire endpoints. You need to provide the account ID and contact ID from the prior steps.

See the Testing section for tips on how to test different transfer scenarios.