Skip to content

Introduction

Treezor allows you to issue both Physical and Virtual Cards. This section focuses on Card creation, management, and transactions.

Prior to start working with Cards, you must have a Card Program set up with Treezor.

Info icon

Information – Card Top-up feature also available

If you're looking to receive card payments to credit a Wallet, see the Card Acquiring section of the documentation.

Card Program

Your Card Program defines the design and configuration of the issued Cards. Your Welcome Pack provided by Treezor contains all the forms to fill in.

Card Programs require the help of Treezor teams. Contact your Treezor:

Once your Card Program set up, Treezor will give you your cardPrint. This value is the unique identifier of you Card Program and is required to create Cards.

Card Design AM

You can design both your cards and their shipping packaging.

Your Welcome Pack contains forms and templates for Physical Cards and Virtual Cards design, along with resources to design your cards while abiding by:

  • The guidelines provided by the schemes (e.g., Mastercard, Visa, etc.).
  • The predefined formats from the card printing third-party.

Card Product & Customization options IM

Your Card Product defines options such as Permissions Group and default limits for the Cards you issue.

You can also add logos, customized text, and specify packaging and card design on a per-Card basis. See the Customization article for more information.

Key attributes

Below are some of the most important Card attributes.

AttributeTypeDescription
isLiveintegerThe activation status of the Card. Cards are issued inactive and activated by an API call.
  • 0 – Not activated yet
  • 1 – Activated
statusCodeintegerThe current Card status such as active, stolen, temporarily or permanently blocked
pinTryExceedsintegerIndicates if the PIN try limit has been exceeded (when set to 1, the PIN is blocked)
cardDesignstringThe Card Print Id, the design that is/will be printed on the Card
optionAtmintegerThe ability to make withdrawals at ATM
optionForeignintegerThe ability to use the Card outside the user's country
optionOnlineintegerThe ability to use the Card for online Payments
optionNfcintegerThe ability to use the Card for contactless payment
embossedNamestringThe cardholder's name, as embossed or etched on the Card
maskedPanstringThe PAN with the middle numbers redacted for safety.
publicTokenstring9-character long string printed on the Card. It can be used to activate a card
code icon

API – Swagger documentation available

For a complete list of Card attributes, check the Cards section of the Swagger.

Structure

json
{
	"cardId": 0,
	"userId": 0,
	"walletId": 0,
	"walletCardtransactionId": 0,
	"mccRestrictionGroupId": 0,
	"merchantRestrictionGroupId": 0,
	"countryRestrictionGroupId": 0,
	"publicToken": "string",
	"cardTag": "string",
	"statusCode": "UNLOCK",
	"isLive": 0,
	"pinTryExceeds": 0,
	"maskedPan": "string",
	"embossedName": "string",
	"expiryDate": "string",
	"CVV": "string",
	"startDate": "string",
	"endDate": "string",
	"countryCode": "string",		// Inherited from the User's country
	"currencyCode": "string",		// Always EUR
	"lang": "string",				// Inherited from the User's language
	"deliveryTitle": "string",
	"deliveryLastname": "string",
	"deliveryFirstname": "string",
	"deliveryAddress1": "string",
	"deliveryAddress2": "string",
	"deliveryAddress3": "string",
	"deliveryCity": "string",
	"deliveryPostcode": "string",
	"deliveryCountry": "string",
	"mobileSent": "string",			// Inherited from the User's phone
	"limitsGroup": "string",
	"permsGroup": "string",
	"cardDesign": "string",
	"virtualConverted": 0,
	"optionAtm": 0,
	"optionForeign": 0,
	"optionOnline": 0,
	"optionNfc": 0,
	"limitAtmYear": 0,
	"limitAtmMonth": 0,
	"limitAtmWeek": 0,
	"limitAtmDay": 0,
	"limitAtmAll": 0,
	"limitPaymentYear": 0,
	"limitPaymentMonth": 0,
	"limitPaymentWeek": 0,
	"limitPaymentDay": 0,
	"limitPaymentAll": 0,
	"paymentDailyLimit": 0,
	"totalAtmYear": 0,
	"totalAtmMonth": 0,
	"totalAtmWeek": 0,
	"totalAtmDay": 0,
	"totalAtmAll": 0,
	"totalPaymentYear": 0,
	"totalPaymentMonth": 0,
	"totalPaymentWeek": 0,
	"totalPaymentDay": 0,
	"totalPaymentAll": 0,
	"createdBy": 0,
	"createdDate": "string",
	"modifiedBy": 0,
	"modifiedDate": "string",
	"renewalType": "string",
    "renewalDate": "string",
    "originalCardId": 0,
	"totalRows": 0,
	"designCode": "string",
	"cardLanguages": "string",
	"eventName": "string",			// Inherited from the Wallet the card is attached to
	"eventAlias": "string",			// Inherited from the Wallet the card is attached to
	"restrictionGroupLimits": [
	{
		"paymentDailyLimit": 0,
		"mccRestrictionGroups": 0,
		"countryRestrictionGroups": 0,
		"merchantIdRestrictionGroups": 0
	}
	],
	"cancellationNumber": "string",
	"metadata": null
}

Endpoints

EndpointScope
/v1/cards
Search Cards
read_only
/v1/cards/{cardId}
Retrieve a Card using its id
read_only
/v1/cards/{cardId}
Update a Card information
read_write
/v1/cards/{cardId}/Activate
Activate a Card initially
read_write
/v1/cards/{cardId}/Assign
Assign or Reassign a Card to a User
read_write
/v1/cards/{cardId}/ChangePIN
Change a PIN (requires to know the previous one)
read_write
/v1/cards/{cardId}/setPIN
Define a PIN code
read_write
/v1/cards/{cardId}/UnblockPIN
Unblock a PIN code
read_write
/v1/cards/{cardId}/ConvertVirtual
Convert a Virtual Card to a Physical one
read_write
/v1/cards/{cardId}/Limits
Change a Card limits
read_write
/v1/cards/{cardId}/Options
Change a Card options
read_write
/v1/cards/{cardId}/LockUnlock
Toggle the locking status of a Card
read_write
/v1/cards/{cardId}/Regenerate
Regenerate a Virtual Card image
read_write
/v1/cards/CreateVirtual
Create a new Virtual Card
read_write
/v1/cards/RequestPhysical
Request a new Physical Card
read_write
/v1/cards/Register3DS
Register a Card for 3D Secure
read_write
/v1/cardimages
Retrieve a Virtual (or Virtual converted) Card image
read_write

Object relations diagram

Card object relations