Card issuance

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

Guide

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

1

Prerequisite

• Get the Prepaid Card payment method enabled. 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 inout, 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

Card Issuance

Once the user has completed the onboarding flow and passed the identity check, 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.

• Zūm API: Call the Approve Card endpoint in the User API. If the response is successful, it verifies that the KYC is complete and a card will be issued to the user

5

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/{{userId}}.

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}}.

6

Funding the Card

Cards must be funded through the Zūm Wallet ecosystem before they can be used and there are three ways.

• Customer Funding via Zūm API: Use the Transaction API to move funds from the Wallet to the specific card using the transaction endpoints. You can create a transaction like the example below for loading a prepaid card:

Endpoint: /api/transaction
Method: POST

{
    "Amount": 10.0,
    "ZumRailsType": "LoadPrepaidCard",
    "TransactionMethod": "PrepaidCard",
    "Memo": "",
    "Comment": "",
    "WalletId": "1d431e8b-...85452adb4eee",
    "UserId": "8ebd932b-...b92633e14297"
}

• Customer Funding via Zūm Portal: Navigate to the Transactions page --> Add new --> select the Load Prepaid Card under the Transaction Type

• Cardholder Funding via Zūm Connect: This allows the cardholder to use any of the other enabled Zūm Rails Payment Rails to fund their card.

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

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

For Customer Funding, 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, as well as the amount that will be enough to fund the prepaid cards.

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