> For the complete documentation index, see [llms.txt](https://docs.zumrails.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zumrails.com/tokenization/cardholder-portal.md).

# Cardholder Portal

Overview of the Zūm Rails Cardholder Portal features your cardholders can use to manage their Prepaid and Secured Credit Cards.

The Zūm Rails Cardholder Portal is a white-labelled, ready-made portal where your cardholders can view their card, balance, and transactions, and manage their card. Features are enabled per card program under **Program Management → Cardholder Portal** in the Zūm Portal.

## Multiple cards

When **Add a Card** is enabled for your card program, cardholders can add and manage additional cards that share their balance. See [Issue multiple cards to a user](https://docs.zumrails.com/tokenization/how-it-works.md#issue-multiple-cards-to-a-user).

* **Card menu:** cards are grouped by card type. The Primary card is marked **Primary**, with additional cards listed beneath it. Closed cards are hidden from the menu; their transactions remain in Transaction History.
* **Add a card:** the cardholder chooses a virtual or physical card and can enter a nickname. Physical cards also require a shipping address and shipping type.
* **Nicknames:** Nicknames can be edited from the card details.
* **Delete Card:** available for secondary cards only. The card is closed permanently.
* **Transactions:** Transaction History shows which card was used for each transaction.

{% hint style="info" %}
For Secured Credit Cards, closing the Primary card from the Cardholder Portal closes all cards sharing the credit line and unloads the Security Deposit. Prepaid cardholders cannot close their Primary card.
{% endhint %}

## Send Money (Prepaid Card)

Prepaid cardholders can send money from their card balance to a saved recipient by Interac e-Transfer.

#### Enable Send Money

1. Make sure the **User Transfer** transaction type is enabled on your Interac e-Transfer payment method.
2. In the Zūm Portal, navigate to **Program Management → Cardholder Portal** and enable **Interac e-Transfer Send Money**. It is disabled by default.

When enabled, **Send Money** and **Recipients** appear in the Cardholder Portal menu.

{% hint style="info" %}
Send Money is only available for Prepaid Card programs.
{% endhint %}

#### Recipients

From **Recipients**, the cardholder can add, edit, and remove the people they send money to. Each recipient has a first name, last name, and email address. Adding or removing a recipient requires the cardholder to confirm an email one-time passcode.

You can view a cardholder's recipients in the Zūm Portal under **Users → User → Card → Recipients**, or with the [Get Recipients](https://docs.zumrails.com/api-reference/cards.md#get-recipients) endpoint.

#### Sending money

1. The cardholder selects **Send Money** from the menu or the Wallet page.
2. They choose a recipient, enter an amount, and optionally add a message (up to 140 characters).
3. If the recipient is not registered for Interac e-Transfer Autodeposit, the cardholder must set a security question (5–40 characters) and answer (3–25 characters).
4. A confirmation screen shows the recipient, amount, and a transaction reference.

The amount is debited from the card balance when the transfer is sent. If the transfer is cancelled or fails, the amount is credited back to the card. Recipients see the cardholder's name as the sender. Your account's Interac e-Transfer transaction limits apply.

{% hint style="info" %}
**Sandbox:**

* Include an Interac failure event name in the message (e.g. `InteracFailedRecipientRejected`, `InteracFailedBannedAccount`, `InteracFailedInvalidEmailFormat`, `InteracFailedFundsDepositFailed`, `InteracFailedAmountGreaterThanMax`, `InteracFailedGenericError`) to simulate that failure.
* A recipient whose last name contains `automaticdepositenabled` is treated as registered for Autodeposit.
* A recipient whose last name contains `simulatenetworkfailure` simulates a card debit failure.
  {% endhint %}

## Interac e-Transfer History (Prepaid Card)

Cardholders can review the Interac e-Transfers they have sent, and the requests they made to load their card, under **Interac e-Transfer History**. The page is shown when Interac e-Transfer Send Money or Request Money is enabled for the card program.

* **Sent**, **Requested**, and **All** tabs.
* Search, date filter, and CSV export.
* Completed transfers also appear in Transaction History.

| Status    | Description                                  |
| --------- | -------------------------------------------- |
| Pending   | The transfer is in progress                  |
| Completed | The transfer was completed                   |
| Cancelled | The transfer was cancelled                   |
| Failed    | The transfer failed; the reason is displayed |

**Cancelling a transfer:** a cardholder can cancel a **Pending** sent transfer before it is processed by Interac. The amount is returned to the card's available balance immediately, and the cardholder receives a confirmation email. Requested transfers cannot be cancelled.

## Unload Security Deposit & Close Card (Secured Credit Card)

Secured Credit Card cardholders can manage their Security Deposit from the Wallet page card menu:

* **Top Up Deposit:** add funds to the Security Deposit.
* **Unload Security Deposit:** withdraw part of the Security Deposit. The deposit cannot be unloaded to $0.
* **Close Card:** close the card. The remaining Security Deposit is unloaded automatically. See [Security Deposit](https://docs.zumrails.com/tokenization/how-it-works.md#security-deposit).

## Digital Wallets

Cardholders can see the digital wallets (e.g. Apple Pay, Google Pay, Samsung Pay) their card has been added to, with the wallet type, device name and status. Removed and declined wallets are not shown. The section is only shown when the card has been added to a wallet. See [View a card's digital wallets](https://docs.zumrails.com/tokenization/how-it-works.md#view-a-cards-digital-wallets).

## Manage PIN

See [PIN Management](https://docs.zumrails.com/tokenization/how-it-works.md#manage-the-pin-on-a-users-physical-card).

## Order a Physical Card

See [Physical Card Issuance](https://docs.zumrails.com/tokenization/how-it-works.md#physical-card-issuance).

## Available notifications and webhooks

{% tabs %}
{% tab title="Emails from Zum Rails" %}

<table><thead><tr><th width="179.4000244140625">Email(s) To</th><th>Reason for Email(s)</th></tr></thead><tbody><tr><td>Cardholder</td><td>Interac e-Transfer sent, failed, or cancelled</td></tr><tr><td>Cardholder</td><td>Recipient added, updated, or removed</td></tr><tr><td>Cardholder</td><td>One-time passcode to add or remove a recipient</td></tr></tbody></table>
{% endtab %}

{% tab title="Webhooks" %}

| Type                 | Event            | Description                           |
| -------------------- | ---------------- | ------------------------------------- |
| PrepaidCardSendMoney | Started          | Cardholder sent an Interac e-Transfer |
| PrepaidCardSendMoney | Succeeded        | The Interac e-Transfer was completed  |
| PrepaidCardUser      | RecipientAdded   | Cardholder added a recipient          |
| PrepaidCardUser      | RecipientUpdated | Cardholder updated a recipient        |
| PrepaidCardUser      | RecipientDeleted | Cardholder removed a recipient        |
| {% endtab %}         |                  |                                       |
| {% endtabs %}        |                  |                                       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zumrails.com/tokenization/cardholder-portal.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
