Card Creation

A card can be created using Create Card

A card is linked to an individual customer customerHayId and to an account accountId (individual or joint/business)

Card types

• Card types must be agreed with Shaype at the initiation phase in order to ensure card type is available for the customer. If it is not agreed and an unsupported card type is chosen an error will occur.
• Physical card will be created and sent in AWAITING_ACTIVATION.
• Virtual cards will be created and automatically ACTIVE.

Card Design

• Card designs should be agreed with our CSM team
• Sub designs allow you to provide different designs for your customers, these can be chosen when creating a card using cardSubDesign field in request of this endpoint.

Address

Cardholder Address

The cardholder address is the billing address registered for that card. It is used for Visa AVS (Address Verification System) checks to verify the address entered during online transactions matches the billing address stored in our system.

When creating a new card, we use the address stored against the customer linked to the card. This would have been entered on customer creation Create Customer or updated with Update Customer

Similarly when replacing or renewing your card, the address stored against the customer will be used as cardholder address.

Delivery Address

Users are able to get their card delivered to their preferred address, which can be different to the cardholder address. This delivery address is entered as one of the parameters of Create Card

📘

Card created with Virtual card type still require a delivery address. Even though only physical cards will get delivered, virtual cards are always created with the ability to convert to physical in the future using Convert Card. Therefore delivery address is entered on card creation for virtual cards too.

When cards are replaced or renewed, the delivery address used is the cardholder address stored in our system against the customer.

Delivery Method

Clients can enable their users to choose a deliveryMethod

This field is optional, by default cards will be sent via STANDARD delivery.

Delivery options are:

• STANDARD (default if not provided)
• REGISTERED (registered post, requires signature)
• COURIER (overnight courier service, includes tracking)
• EXPRESS (express post, includes tracking)

Card Name

This is the name printed on the card.

By default, we use a concatenation of first name and last name.

📘

Default card name logic

• If smaller than 23 characters combined => card name = first name + " " + last name
• Otherwise => card name = initial of first name + " " + last name

We also enable users to customise the name printed on the card.

nameOnCard and nameOnCardLine2allows you to enter up to 2 lines to be printed on the card. Each line is optional and limited to 23 characters. If entered, they will override the default card name logic.