Physical Card Creation
A physical card will be printed when created and delivered directly to your Enduser. It can be used in-store, at an ATM, and online. Physical cards support chip-and-PIN and contactless payment methods.
By default, magstripe is inactive.
The card will be attached to a carrier, which can be customized. The design for the carrier will have been set up into the card programme based on the carrier template design you've sent.
Prerequisite
Before being able to create a Physical card, you must have :
- A validated Enduser with a ledger. The Ledger doesn't need to be upgraded. This Ledger will be debited at each transaction.
- A Card Program matching the Enduser type and the Ledger type, and allowing Physical Cards. See Card Programs page for more details Here.
Creating the card
Physical Cards can be created either by a Partner, or directly by the Enduser himself.
To create a Physical Card, use the "Create a Card" endpoint and provide the Ledger Id as well as the Card Program.
You could also provide extra informations :
- Delivery Method : Type of delivery for the physical card : "FIRST_CLASS", "INTERNATIONAL_MAIL", "DHL" or "COURIER"
- Friendly name : A custom name you want to give to this card.
- Name on card : The name that will be embossed/printed on the card, limited to 21 characters. If not provided, the name of the related Enduser will be taken. By default, name on card is
firstName+lastName.
Request Body schema: application/json
| deliveryMethod required | string Enum: "UK_MAIL" "INTERNATIONAL_MAIL" "DHL" |
| ledgerId required | string <uuid> |
| profileId required | string <uuid> The card profile id. Must be an active card profile. |
| nameOnCard | string^[A-Z\s]{1,21}$ Default: "FIRSTNAME LASTNAME" The name that will be printed on the card. Can only contain ISO basic Latin alphabet and can be up to 21 characters long including spaces. |
| friendlyName | string [ 0 .. 255 ] characters |
Array of objects You can add rules when creating a card. You can only send one rule by type in the list. As a partner, this rules take priority over the rules set in the profile |
{- "deliveryMethod": "UK_MAIL",
- "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
- "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
- "nameOnCard": "FIRSTNAME LASTNAME",
- "friendlyName": "string",
- "rules": [
- {
- "type": "DAILY_MAX_COUNT",
- "value": 1,
- "name": "string"
}
]
}This is the expected Payload for a physical Card creation :
- Payload
- curl
{- "operator": "END_USER",
- "reason": "string"
}id : {
"id": "120e9d1f-8444-4b91-85e8-5b208615a3e5"
}When created, a Physical card is NOT activated. It has to be activated when received by the cardholder. See Card Activation page for details.
Card Shipment
Physical card will be created and shipped within days, according to the selected Delivery Method. Card is sent directly to the Enduser Address.
No tracking is available for now. We are looking to add this possibility as soon as possible.
Extra costs may apply depending on the Delivery Method.
| Delivery Method | Estimated time for delivery |
|---|---|
| First Class | 1-2 working days |
| International Mail | 1-2 working days |
| DHL | 1-2 working days |
| Courier | 1-2 working days |
Fetch the card
You can now Fetch the card by theid to get all its information : | id required | string <uuid> |
| endUserId required | string <uuid> |
| ledgerId required | string <uuid> |
required | object (Profile) |
| expiryDate | string |
| nameOnCard | string |
| friendlyName | string |
object (AddressResponseDto) Address used on the bank statements of your users. | |
| deliveryMethod | string Enum: "UK_MAIL" "INTERNATIONAL_MAIL" "DHL" "COURIER" |
| truncatedPan | string Last 4 digits of the card. The truncated pan is only displayed if the card has been activated. |
| type required | string Enum: "PHYSICAL" "VIRTUAL" |
| scheme required | string Enum: "MASTERCARD" "VISA" |
| currency required | string Enum: "EUR" "GBP" "USD" "PLN" "AUD" "CHF" "CAD" "SEK" "NOK" "JPY" "HUF" "HKD" "NZD" "CZK" "SGD" "RON" "HRK" |
required | object (CardStatusDto) |
| creationDate required | string <date-time> |
| updateDate required | string <date-time> |
| pinStatus required | string Enum: "LOCKED" "UNLOCKED" "WAITING_ONLINE_TRANSACTION" |
required | Array of objects (CardRuleResponseDto) |
Card status
Cards can have mutliples status during life cycle :
| Card status | Description |
|---|---|
| CREATED | The card have been created |
| AWAITING_ACTIVATION | The card is waiting first activation |
| ACTIVATING | The card is currently activating (few seconds) |
| REACTIVATING | The card is currently reactivating after being suspended (few seconds) |
| ACTIVE | The card is active and ready to use |
| SUSPENDING | The card us curretly suspending, cannot be used |
| SUSPENDED | The card is suspended and cannot be used |
| CLOSING | The card is currently closing, cannot be used |
| CLOSED | The card is permanantly closed |
| FAILED | The card creation failed, please check your payload or contact customer care |
| INTERNAL_ERROR | Not your fault, please contact your customer care, check our status page |
| EXPIRED | The card is expired, you can renew it. |
You can close / suspend a card for multiple reasons :
| Status reason | Description |
|---|---|
| STOLEN | The card is closed / suspended because has been stolen |
| LOST | The card is closed / suspended because has been lost |
| DAMAGED | The card is closed / suspended because has been damaged |
| OTHER | Any other reason, you need to add a otherStatusReason |
The operator is the one which has decided to close / suspend the card. It can be you as a Partner, an Enduser request or us.