Migrate cards

Start migration of non-PCI cards.

This endpoint generates the following events:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Start migration of non-PCI data for cards.

boolean
required
Defaults to false

Include card on Mastercard's Automatic Billing Updater (ABU)?

string
required

New BIN of card (use with template_id)

boolean
required
Defaults to true

Is contactless enabled?

string
required

Issuing date and hour of a card. Format = YYYY-MM-ddTHH:mm:SSZ.

migration
object
required

Additional migration details

string
enum
required

Card mode

Allowed:
string
required
length between 3 and 50

Nickname of card. An account can have multiple cards. For example, an account could have one plastic card and three virtual cards. You give them nicknames to identify them: "Plastic card", "Netflix card", and so on. You cannot repeat the same nickname for multiple plastic cards.

string
enum
required

Card network name

Allowed:
string
required

Migration status of card. The platform does not consider embossing on migrated cards since they are already issued. Typically set to either TO_MIGRATE or MIGRATING. For more information on allowed values, refer to Card status.

boolean
deprecated

Is this an additional card? Use when a card is linked to an additional customer on the account, and you must send the previous migration customer's migration ID.

atc
array of integers

Card ATC list (Application Transaction Counter). For example, [21,20,19,18,16,15,14]. Only send if you have the correct information from the current processor. Sends null by default.

atc
number
0 to 4320
Defaults to 24

REQUIRED for a virtual card. Rotation interval in hours for a virtual card's CVV. You can pass "0" if the virtual card does not have CVV rotation. To force a card's CVV rotation, you can call the Rotate virtual card CVV endpoint.

string

Expiration date of card. Format = YYYY/MM.

metadata
object

Metadata (free-form fields) formatted as a JSON object using any key-value pairs.

string

Migration phase ID. Account migration can be split into phases (batches), where each phase must have a unique phase ID. When assigning a phase ID, use a name that is meaningful, such as Rollout_Jan2025. REQUIRED for noname cards; optional for nominal cards.

string
length between 2 and 25

Applicant name to be printed on a card (2 characters minimum, 25 characters max). Use only letters (a-z|A-Z) and space, as specified in the ISO EMV tag 5F20 for cardholder name. No letters with accents, numbers, or special characters.

string

ID of a program created specifically for noname cards. Used to link noname cards to this type of account.

Note: This field is REQUIRED for noname cards but otherwise optional.

string
enum

Card stage. REQUIRED for named cards. Set to UNBLOCKED initially.

Allowed:
string

Used in order to override the definitions of the program when creating a card. Only send if the card's brand is different from the account's program brand.

number
≥ 0

Card transaction limit. (Only for virtual cards.) Sends "0" by default.

string
enum

Card type. It is not possible to change the type after migration, so if you need to change it you must recreate the card to get a new type.

Allowed:
string

Card unlock date and time. Format = YYYY-MM-ddTHH:mm:ss.SSSSSZ.

Headers
string
required

JSON Web Token (JWT). Tokens expire quickly, which can result in an Unauthorized message.

Responses
202

Accepted

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json