Secured Credit Card issuance

This is a step by step tutorial on how you can use Zūm Rails to complete card onboarding and card issuance for Secured Credit Card.

Guide

To start issuing cards, the Credit Card Issuance payment method needs to be enabled. Speak to our sales or support team on how to get Cards enabled.

1

Prerequisite

• Get the Credit Card Issuance payment method enabled on the Zūm Portal. Our Zūm Rails team will get your account ready for testing

• Make sure you have a sandbox account for testing and read the developer quick start as described here

• Get the API username and password in the sandbox portal as described here for API access

• Get your funding source ID. You can find this information in your portal under settings/funding source page or via API, as described here

• Get your wallet ID. You can find this information in your portal under the wallet page or via API, as described here

2

Authenticate with Zūm APIs

Authenticate with the Zūm Rails API as indicated below, or view more details here

Endpoint: /api/authenticate
Method: POST

{
  "Username": "abc...123",
  "Password": "xyz...321"
}

3

Cardholder Onboarding (IDV and KYC)

Zūm Rails requires Identity Verification (IDV) to meet KYC standards before a card can be issued.

• To onboard via public URL: In the Zūm Portal, you can access your Card Onboarding URL to send directly to your prospect cardholders in the Settings --> Integration Codes page

• To onboard via Card Onboarding Hosted Link/SDK (Integrated):

  1. Create a Connect Token: Call POST /api/connect/createtoken and set the ConnectTokenType to "CardOnboarding".

  2. Initialize the SDK: Embed the Zūm Connect iFrame or SDK into your application using this token.

To help streamline the Zūm Connect experience, it is possible to pass pre-filled information that you already have through optional parameters in the url

The prospect cardholder completes the Card Onboarding three-step flow:

• Profile Setup: full name, email, date of birth, and phone number.

• One-Time Passcode: sent to their email

• ID Verification: address input, a selfie, Government ID upload, and occupation details.

Once the prospect cardholder has completed the onboarding flow, a User will be created at Zūm Rails. You have to store the Zūm Rails UserID, received in the response of the API call or event listener. In addition, you can enable email notifications and card webhook to keep you updated on the IDV status.

4

Security Deposit

Before approving the issuance of the Secured Credit Card for the User, the Security Deposit must be in your Zūm Wallet. You can collect the Security Deposit of the User before or after the Cardholder Onboarding step is completed and verified.

Fund Zūm Wallet

To disburse funds, funds must first be deposited into the Zūm Rails platform. Create a transaction to fund the wallet from your funding source. A funding source is your operating bank account from your business with your bank. Make sure you inform the FundingSourceId and the WalletId in the payload. Alternatively, if the User is funding the Security Deposit, enable the Payment Method (EFT, Interac, Credit Card, and/or Debit Card) to secure the funds.

If needed, you can check the Zūm Wallet balance before as described here

Endpoint: /api/transaction
Method: POST

{
  "ZumRailsType": "FundWallet",
  "TransactionMethod": "Eft",
  "Amount": 123.45,
  "Memo": "Fund 01",
  "Comment": "Funding Zum Wallet for weekly loan disbursements",
  "FundingSourceId": "<your-funding-source-id>",
  "WalletId": "<your-wallet-id>"
}

5

Card Issuance

Once the user has completed the onboarding flow, passed the identity check, and the Security Deposit is in your Zūm Wallet, then the card can be issued.

• Zūm Portal: Navigate to the User page and search for the user in the portal. If the card KYC is "Approved", you will see an option under the 3 Dots menu to approve and issue the card manually. You will be asked to provide the Credit Limit Amount which is the Security Deposit that will be pulled from the Zūm Wallet.

• Zūm API: Call the Approve Card endpoint in the User API. If the response is successful, it verifies that the KYC is complete, Security Deposit was successfuly pulled, and a card was issued to the User

6

Card Activation

Newly issued cards start in an IssuedInactive status.

• Zūm Portal: Navigate to the User --> Manage Prepaid Card --> Card Status Change --> set to "Activate"

• Zūm API: Use the Activate Card endpoint: PATCH {{env}}/api/card/activate-card.

You can verify the status at any time on the Zūm Portal by navigate to the User --> Manage Prepaid Card --> see Card Status or by calling GET {{env}}/api/card/get-card-status/{{userId}}.

The card is now ready to be used by the User.

7

Receive card updates

The recommended way to receive card updates is through webhooks.

You can configure your webhook URL and which events you might want to receive in the Zūm Rails portal, under settings/webhook and api settings.

We recommend setting up all available prepaid card events events.

When the card onboard status changes, card status changes and financial transaction activity occurs, we will post to your webhook URL with relevant payload, as described here