LogoLogo
NymCardAPI catalogContact usnFront catalog
  • NYMCARD DOCUMENTATION
  • Get Started
    • nCore API Quick Tutorial
    • API Core Principles
    • Program management
      • Manage documents by APIs
      • User KYB process
      • Necessary parameters per user type
      • User ID verification by SDK
      • User KYC process
    • Issuance
      • Users
      • Cards
    • Issuing Physical Cards
      • Individual card issuance
      • Bulk card issuance
      • Card fulfillment
      • Card PIN management
      • Card replacement
      • Proxy number usage
    • Issuing Virtual Cards
      • Migration of virtual to physical card
    • Funding and transfers
      • Funding
      • Internal funding source
      • External funding source
        • From card
        • From bank account
        • Lean API flow
        • DAPI direct API flow
      • Transfers
      • Western Union APIs
    • Product Management
      • Card product
      • Balance limits
      • Velocity limits
      • Fees
      • Charges
      • Multi-currency
      • Authorization controls
        • Enhancements for MCC list management
    • Transactions
      • Payment ecosystem
      • Transaction lifecycle
      • Transaction types
      • Transaction endpoints scenarios
      • Multi-clearing process
    • Webhooks
      • Introduction to webhooks
      • nCore webhook events
      • Steps to configure a webhook
      • Webhooks samples
      • Webhook changes for simulation
      • Webhooks management
    • Security
      • PCI widget
      • 3D Secure
      • OTP SMS templates
    • Release announcements
      • Embedded Lending Release Notes
      • Changes in the release on 13/07/2023
      • Changes in the release on 23/05/2023
      • Changes in the release on 04/04/2023
  • For developers
    • nCore API catalog
    • nFront API catalog
Powered by GitBook
On this page
  • Replace a card with a personalized card
  • Replace a card with a non-personalized bulk card
  • Card renewal

Was this helpful?

  1. Get Started
  2. Issuing Physical Cards

Card replacement

PreviousCard PIN managementNextProxy number usage

Last updated 9 months ago

Was this helpful?

The platform provides card replacement feature to replace the terminated card. A terminated card (personalized or non personalized) can be replaced with a non-personalized bulk card or with a personalized card when requested by the API user.

The API user can raise a card replacement request for a terminated card due to any reason, e.g. stolen, lost, damaged, expired, etc. The replaced card will take the place of the original terminated card and will be linked to the existing account of the original card instead of creating a new account.

On this page:

Replace a card with a personalized card

A terminated (non-personalized or personalized) card can be replaced with a personalized card when requested by the API user. After the successful card replacement the replaced card takes the place of the original terminated card and is linked to the existing account of the card being replaced.

Please note:

1. A new PAN (Primary Account Number), PIN (Primary Identification Number), CVV2 (Card Verification Value 2) & expiry date is generated and instead of creating a new account this new card is linked to the original card’s account.

2. For a successful card replacement, following details required.

  • original card product ID in "card_product_id"

  • original user ID in "user_id"

  • original card ID in "reference_card_id"

You can replace a card with a personalized card by sending a POST request to /cards endpoint as shown below.

{ "id": "d089a80f-e641-4045-8a80-54841e4a7458", "user_id": "d089a80f-e641-4045-8a80-54841e4a7458", "card_type": "PHYSICAL", "card_product_id": "", "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458", "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458", "name_on_card": "John Smith", "shipping_details": { "method": "COURIER", "return_address": { "first_name": "John", "middle_name": "Anthony", "last_name": "Smith", "mobile": "+551185249635", "address_line1": "Flat 1904", "address_line2": "Glass Tower", "city": "New York City", "state": "New York", "country": "USA", "postal_code": "12345" }, "shipping_address": { "first_name": "John", "middle_name": "Anthony", "last_name": "Smith", "mobile": "+551185249635", "address_line1": "Flat 1904", "address_line2": "Glass Tower", "city": "New York City", "state": "New York", "country": "USA", "postal_code": "12345" } }, "dry_run": "false", "card_validity_term": 36 }

Replace a card with a non-personalized bulk card

nCore supports feature to replace the terminated card (from a personalized or non-personalized card to a non-personalized bulk card) when requested by the API user. The API user can raise a card replacement request for a terminated card due to any reason e.g. stolen, lost, damaged, expired etc.. The replaced card takes the place of the original terminated card and is linked to the existing account of the original card instead of creating a new account.

Please note:

To replace a terminated card (personalized or non-personalized) with a non-personalized card you require:

  • Please make sure that the original card's card product ID = bulk issuance's card product ID.

  • Get a card created in bulk issuance you want to link/replace by sending a GET request to /cards endpoint.

  • provide terminated card id in “reference_card_id” field when replacing a card.

The platform treats it as a card replacement request and links the non-personalized card provided in the request with the account of the original card present in field "reference_card_id".

You can send a POST request to /cards/{id}:replace endpoint; where id is the non-personalized card id you want to replace the terminated card with.

Card renewal

Impacted APIs:

  • Create card product

  • Update card product

  • Get card product

  • Get list of card product

This enhancement has impact on both existing and new card products.

Example:

 "card_settings": {
  ...
  "allow_card_renewal": true, // default = false
  "renew_before_days": 60, // default = 60
  "new_pan_on_renewal": false,  // default = false
  "auto_renewal_process": true // default = false
}

{ "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7459", "activate_card": true }

Introduced the following parameters in the response of APIs under 'card_settings' parameter: "allow_card_renewal", "renew_before_days", "new_pan_on_renewal", "auto_renewal_process". They are used to renew an existing card so that if a card is about to be expired, a new card can be generated and provided to the cardholder for uninterrupted card services.

POST /cards/{id}:replace
Card products
POST /cards
Replace a card with a personalized card
Replace a card with a non-personalized bulk card
Card renewal