Card create update service

Use cases

The card create update APIs enable customers to activate and manage card status, control online usage, and adjust transaction limits for better security and flexibility. They also support PIN setup, statement preferences, auto repayment settings, transaction logging and reversal, account linking, issuing virtual or physical cards, and cardless ATM withdrawals for convenience and seamless banking experience.

1. Activate a newly delivered card

API: POST /update-card-delivery

Purpose:
To activate a newly issued debit or credit card after the customer has received it.

Use case description:

• Scenario:
  A customer receives a new card via postal delivery or at a branch and wants to activate it through mobile banking.
• System action:
  The system calls /update-card-delivery using card ID, CIF, customer phone number, and expiration date.
• Outcome:
  The card status is updated to "active," enabling transactions.
• Benefit:
  Empowers customer self-service, reduces call center dependency, and ensures secure activation.

2. Update card status (lock/unlock/activate)

API: POST /update-card-status

Purpose:
To manually update the status of a card (e.g., lock, unlock, activate) based on user action or risk controls.

Use case description:

• Scenario:
  A customer temporarily misplaces their card and locks it via mobile app. Later, they find it and unlocks it again.
• System action:
  The app calls /update-card-status to change the status accordingly.
• Outcome:
  Card status is updated in real-time for usage or security purposes.
• Benefit:
  Enhances security and user control over card access.

3. Enable or disable online usage for debit cards

API: POST /update-ecom-status-debit

Purpose:
To enable or disable online (e-commerce) transactions for debit cards.

Use case description:

• Scenario:
  A customer enables online usage to complete an e-commerce purchase.
• System action:
  The system calls /update-ecom-status-debit with the card ID and enable flag.
• Outcome:
  The card’s online usage setting is updated accordingly.
• Benefit:
  Enhances security and gives customers control over online transactions.

4. Enable or disable online usage for credit cards

API: POST /update-ecom-status-visa

Purpose:
To manage e-commerce enablement for credit cards (Visa/MasterCard/etc.).

Use case description:

• Scenario:
  A customer disables online usage after receiving phishing alerts.
• System action:
  System calls /update-ecom-status-visa with card details and updated flag.
• Outcome:
  E-commerce capability is toggled off based on customer decision.
• Benefit:
  Reduces card-not-present fraud exposure.

5. Adjust transaction limits (withdrawal, POS, contactless)

API: POST /update-tran-limit

Purpose:
To modify transaction limits on the customer’s debit or credit card.

Use case description:

• Scenario:
  A customer lowers their daily withdrawal limit for safety or raises it temporarily during travel.
• System action:
  The system calls /update-tran-limit with the new threshold settings.
• Outcome:
  Limits are updated in real-time.
• Benefit:
  Empowers personalized financial control and risk management.

6. Set or reset card PIN

API: POST /update-pin

Purpose:
To create or reset the PIN associated with a debit or credit card.

Use case description:

• Scenario:
  A customer receives a new card and sets their own secure PIN via mobile app.
• System action:
  System triggers /update-pin with customer authentication and new PIN.
• Outcome:
  PIN is updated securely and instantly.
• Benefit:
  Eliminates the need for physical PIN mailers and enables digital-first onboarding.

7. Set statement delivery preferences (email/paper/both)

API: POST /update-stmt-receiving-method

Purpose:
To allow customers to choose how they receive credit card statements.

Use case description:

• Scenario:
  A customer switches from paper to email delivery to go paperless.
• System action:
  System calls /update-stmt-receiving-method with updated preference.
• Outcome:
  Customer will receive statements via the selected channel(s).
• Benefit:
  Supports sustainability and customer convenience.

8. Modify automatic credit card repayment method

API: POST /change-repayment

Purpose:
To configure or update how monthly credit card payments are deducted (e.g., full, minimum, custom amount).

Use case description:

• Scenario:
  A customer sets up auto-debit for 100% monthly repayment from their linked account.
• System action:
  System sends /change-repayment request with the method and linked account.
• Outcome:
  Card system updates repayment rule.
• Benefit:
  Reduces missed payments and improves customer credit health.

9. Record a credit card transaction (bill payment)

API: POST /create-purchase

Purpose:
To log a bill payment made using a credit card into the card system.

Use case description:

• Scenario:
  Customer pays a utility bill using their credit card via the banking app.
• System action:
  System calls /create-purchase to record the transaction.
• Outcome:
  Transaction is logged and appears in the customer’s credit card statement.
• Benefit:
  Ensures real-time sync between transaction and card systems.

10. Reverse a credit card transaction

API: POST /purchaseReversal

Purpose:
To reverse a previously processed card transaction in cases like failures or customer cancellations.

Use case description:

• Scenario:
  A transaction fails due to timeout, and the app initiates a reversal to roll back the debit.
• System action:
  Calls /purchaseReversal with original transaction reference.
• Outcome:
  Funds are released back to available balance.
• Benefit:
  Supports clean transaction handling and improves customer satisfaction.

11. Link/update account for debit card

API: POST /update-debit-account-link

Purpose:
To change or associate the account linked to a customer’s debit card.

Use case description:

• Scenario:
  Customer opens a new current account and wants it linked to their existing debit card.
• System action:
  System calls /update-debit-account-link with card and new account info.
• Outcome:
  Debit card is linked to the updated account.
• Benefit:
  Improves flexibility and enables account reconfiguration.

12. Issue a virtual credit card

API: POST /create-virtual-card

Purpose:
To issue a virtual credit card for customers who already have an active physical credit card.

Use Case Description:

Scenario:
A customer already owns a physical credit card that has been activated. They want to use a virtual credit card for secure online shopping.

System Action:
The system calls /create-virtual-card with the customer's information, specifying the card type (virtual/physical), and associated credit issuing contract ID.

Outcome:

• A virtual credit card is generated and displayed in the mobile app. The customer needs to activate the virtual credit card for immediate use.

Benefit:
Improves convenience and security for customers by enabling card usage without waiting for physical delivery. Also supports modern digital-first banking experiences.

13. Issue a virtual or physical debit card

API: POST /create-virtual-card

Purpose:
To issue a virtual or physical debit card, allowing customers to instantly access banking services via digital platforms or receive a physical card for in-person transactions.

Use Case Description:

Scenario:
A customer has just opened a new current account and wants to start using their debit card immediately. They can choose to generate a virtual card for online transactions or request a physical card for everyday offline usage.

System Action:
The system calls the /create-virtual-card API with customer details, selected card type (virtual or physical), card product, linked account information, and other necessary parameters.

Outcome:

• For virtual cards: A debit card is instantly created and becomes available for activation. Once activated, it is displayed in the digital banking app for immediate use.
• For physical cards: The system registers a production request. The card is printed, embossed, and sent to either the customer’s provided address or a designated bank branch for pickup.

Benefit:

• Reduces waiting time by enabling instant card access for virtual use.
• Offers flexibility for customers to choose between virtual and physical formats.
• Enhances onboarding with a paperless, digital-first experience.

14. Create ATM cardless withdrawal code

API: POST /create-cash-by-code

Purpose:
To allow customers to withdraw cash from ATMs without using a physical card.

Use case description:

• Scenario:
  Customer forgets their wallet but needs cash. They request a withdrawal code in the app.
• System action:
  System calls /create-cash-by-code and returns a secure one-time code.
• Outcome:
  Customer uses code at ATM to withdraw cash.
• Benefit:
  Improves convenience and access to cash during emergencies or travel.