Skip to content

Overview

The /ibis API endpoints are used to manage debit cards, credit cards, and vAccounts associated with existing connectFi customers.

Pre-Requisite Required

Prior to issuing cards and/or vAccounts, a customer entity must be registered with connectFi. The customer may be either an individual or a business (organization). For more information on registering customers, view the Customer endpoint documentation. KYC/KYB identification is not a pre-requisite to card or account issuing. It is your (the client's) responsibility to ensure that KYC/KYB is successfully performed, if necessary. For more information on the Know Your Customer/Business process, view the KYC/KYB endpoint documentation.

vAccounts

A vAccount (also referred to as a virtual account or account only account) is an account that is not associated with a physical card. These accounts may be issued to both individual and business customers. A vAccount can be used both as a bank account (using the account number and routing number) and similar to a debit card (using the cFiAccountId that is issued in place of the cFiCardId request body property where applicable). The cFiAccountId can be used to make requests to the following debit card related endpoints: /ibis/card/activate, /ibis/card/cardholder-profile, /ibis/card/status, /ibis/card/list (will include all cards and vAccounts for the specified customer), /ibis/financial/funds-credit, /ibis/financial/funds-debit, /ibis/financial/card-to-card, and /ibis/inquiry/transaction-history.

Debit Cards

This service allows physical and/or virtual debit cards to be issued to end users, including both individual and business customers. For a business customer, the card holder may be either a business representative or a business employee. See the Customer endpoint documentation for more information on adding employees to business customers.

Prior to issuing a debit card to a customer, it is recommended that the KYC/KYB process be completed with an "approved" outcome. It is the client's responsibility to ensure that KYC/KYB is verified, if necessary.

Pre-Paid Cards

At times, business customers may need access to pre-paid cards for a number of use-cases, including gift cards, prepaid payroll cards, prepaid cards used for budgeting purposes, or limited spending cards used to teach kids healthy financial habits. Prior to issuing prepaid cards to a business customer, it is recommended that the KYC/KYB process be completed with an "approved" outcome. It is the client's responsibility to ensure that KYC/KYB is verified, if necessary.

Cards can be issued to the business customer using the /ibis/debit-card/add endpoint and preloaded with limited amounts using the /ibis/financial/funds-credit endpoint. When the prepaid card is purchased by an end-user, it can be activated by making a request to /ibis/card/activate. After available funds are depleted from the card, you (the client) may allow the business customer to choose whether to deactivate/close the card (/ibis/card/set-status) or allow the end user to purchase additional funds to reload the card (/ibis/financial/funds-credit).

Credit Cards

This services allows credit cards to be issued to end users.

Prior to issuing a credit card to a customer, it is recommended that the KYC/KYB process be completed with an "approved" outcome. It is the client's responsibility to ensure that KYC/KYB is verified, if necessary.

In addition, a credit application must be completed and approved, and a credit limit must be set for the customer. If you intend to issue credit cards to a test customer in the sandbox, there are specific trigger values that must be included in the customer initialization request in order to create a customer capable of obtaining an approved credit application. For an /ibis/customer/init request configured specifically for creating a sandbox customer who may be issued credit cards in the sandbox, use the following values for customer.firstname, customer.lastName, and customer.identificationDocuments[#] in the /ibis/customer/init request body. Only one such customer may be created, since customer SSN must be unique.

"customer.firstName": "JOLEEN", 
"customer.lastName": "KAPSCH",
"customer.identificationDocuments": [
    {
        "type": "SSN",
        "value": "666989698",
        "issuanceCountryCodeA3": "USA"
    }
 ]

Note: Currently, issuing credit cards is supported for individual customers only.