| Field | Description |
|---|---|
| id | String, Yordex generated UUID that is unique for this card. |
| lastDigits | Number, Yordex generated The last 4 digits of this card. |
| scheme | String, Yordex generated The card scheme that this card is linked to for example VISA or MASTERCARD. |
| provider | String, Yordex generated The provider of this card. |
| cardRef | String, Yordex generated The card id that the provider uses for this card. |
| name | String, Yordex generated The display name for this card. |
| expiryDate | String, Yordex generated The expiry date of this card. |
| nameOnCard | String, Yordex generated The name of the user this card was linked to when this card was created. |
| userId | UUID, Mandatory The id of the user linked to this card. |
| cardHolderName | String, Yordex generated The name of the user linked to this card. This does not have to be the same as the nameOnCard because it is possible to re-assign cards. When a card is re-assigned, the cardHolderName changes to the name of the new owner of this card but the nameOnCard does not change as that cannot be changed. |
| balanceInCents | Number, Yordex generated The balance left on this card. |
| imageURL backImageUrl | String, Yordex generated The card background image that can be used for displaying virtual cards. |
| autoTopUpType | String, Optional The type of auto top up to be set on a card. They can only be "TARGET" (setting the card balance to a predetermined number) or "AMOUNT" (raising the balance by a predetermined number). This is only mandatory for setting an auto top up. |
| targetBalanceInCents | Number, Mandatory The target sum of money that is to be left on the card. This is only mandatory for setting an auto top up. |
| autoTopUpFrequency | String, Mandatory How often a card should be topped up, e.g. "MONTHLY", "WEEKLY", etc. This is only mandatory for setting an auto top up. |
| nextTopUpDate | String, Yordex generated The date of a card's next top up. |
| currency | String, Mandatory The currency of this card. This will have to be the same as the currency of the account this card is linked to. |
| virtual | Boolean, Mandatory Whether this card is a virtual card (true) or a physical card (false). |
| status | String, Yordex generated The status of this card. You can find the list of possible statuses on the right hand side of this table. |
| accountId | UUID, Mandatory The id of the account that this card is linked to. |
| multipleOrders | Boolean, Mandatory Whether this card is linked to multiple orders (true) or one order only (false). Physical card will always be linked to multiple orders. Virtual cards can be either. |
| createExpense | Boolean, mandatory Whether or not an expense will be recorded for each payment on a card. |
| seller | String, Yordex generated If multipleOrders:false, this field gives the name of the seller that this card is linked to. |
| cardLimitId (to be deprecated) | UUID, Optional Card limit that is associated with this card. |
| user | Object, Optional When createUsers: true this contains the user details when creating cards. |
| Status | Description |
|---|---|
| ACTIVATED | Active card, can be used |
| BLOCKED | Blocked card, can be used again if it is first unblocked |
| CANCELLED | Cancelled card, can never be used again |