Most Synctera APIs act on resources whose IDs are specified in requests. These resources must exist. This means there is a sequence to calling the APIs to get from a clean slate to a successful transaction.
This document is aimed at capturing that sequence, which is a reflection of a typical customer journey. We have provided the exact API details here but we strongly encourage you to read the Guides mentioned below to understand the dependencies, alternatives, configuration needs and additional information about these products.
You can also explore and try out the Postman collection once you have an API key.
Before You Begin
Get an API Key
If you don't already have an API key, you will need one in order to call the APIs. If you have signed up for the t-minus10 program (click here for more details on t-minus10) you can self-serve an API key by following the "Sandbox" or "Live testing" links in the top navigation. If you are already working with the Synctera team, you an also reach out to your contact at Synctera to get an API key.
- Live Testing or Production: https://app.synctera.com/admin/developer-tools/api-keys
- Sandbox: https://app-sandbox.synctera.com/admin/developer-tools/api-keys
Once an API key is issued in Sandbox, you can immediately start calling the APIs below. In Live Testing or Production, your FinTech must first pass KYB.
KYB Your FinTech
In Sandbox - you're done! KYB was automatically passed for your Sandbox workspace.
In Live Testing or Production, you need to have run a successful KYB on your Fintech if you want to issue cards or move money via ACH / Internal transfers.
If you are on t-minus 10, you need to do this by filling in Business information and Owner details and then Run KYB using the t-minus 10 platform.
If you are not on t-minus10, your contact at Synctera will collect the required information to run KYB for you.
Guides and APIs
Customers & Businesses
These are customers of the Financial Service that use Synctera APIs. Customers can either be Individuals or Businesses. If your customers are businesses, create a business.
Customers or Businesses who are onboarded to your platform will need to accept disclosures for legal needs. You will work with Synctera Implementation & Onboarding team to identify the disclosures needed for your company.
API: Create Disclosure
KYB & KYC
The next step is to ensure that you know your customer and they are who they claim to be. Run KYC if your customer is an individual. Run KYB if your customer is a business.
As part of this, you can also enroll the user for Watchlists.
Account templates define basic characteristics of an account. This is a mandatory step to create an account.
You can also use Account Products which can be included in the account template to capture the Interest / Fee aspects of the account.
Once a Customer is created, Verified, and an account template is created, you can now create an account for the customer / business.
You can use Account relationships to create further relationships on the accounts - e.g Joint Account Holder.
Once an account is created, the next step is to move funds from an external bank account to move funds into the customer’s account at the Fintech.
Guide: External Accounts)
To move funds into a customer account, you would typically link a customer's external account and move funds from there. Alternatively, as a convenience in the sandbox environment, you can also create an internal account to do this. Internal accounts in production would typically be used for specific needs such as issuing promotional credits to your customers. To create an internal account, use this API.
Move Funds with ACH
Once an external account is linked (or you created an internal account as above), you can move funds from an external account into the customer’s account at the Fintech.
Once the account is funded, the customer access the money on the account using cards or ACH. Users can be issued multiple virtual cards and a physical card per account.
You will have to use Marqeta widgets for accessing card details. You also can issue custom Cards with images uploaded by the user.
API: Issue a Card
You can also move money between accounts held in the Fintech.
Updated 6 months ago