Skip to main content

CardOrderResponse

card objectrequired

Ordered card details

activatedAt object
oneOf
null
availableAmount object
oneOf
null
bin object

Card Bank Identification Number

oneOf
null
cardDesign objectrequired

Card design info

backgroundColorstringrequired

Card background color (HEX)

Possible values: <= 2147483647 characters

backgroundImagestring<URI>required

Card display image background uri

Possible values: <= 2147483647 characters

cardNetworkCardNetwork (string)required

Card network

Possible values: [VISA, MASTERCARD]

codestringrequired

Possible values: <= 2147483647 characters

conditionIdstring<uuid>required

Card design condition identifier

Possible values: <= 2147483647 characters

foregroundPrimaryColorstringrequired

Card foreground primary color (HEX)

Possible values: <= 2147483647 characters

foregroundSecondaryColorstringrequired

Card foreground secondary color (HEX)

Possible values: <= 2147483647 characters

formFactorFormFactor (string)required

Card form factor

Possible values: [VIRTUAL, PLASTIC, METAL]

idstring<uuid>required

Card design identifier

Possible values: <= 2147483647 characters

imagestring<URI>required

Card display image uri

Possible values: <= 2147483647 characters

previewImagestring<URI>required

Card display image preview uri

Possible values: <= 2147483647 characters

statusCardDesignStatus (string)required

Card design status

Possible values: [AVAILABLE, DISABLED]

cardHolderIdstring<uuid>required

Customer id of the card holder (Customer representing business member)

Possible values: <= 2147483647 characters

cardHolderNamestringrequired

Card holder name

Possible values: <= 2147483647 characters

cardOwnerIdstring<uuid>required

Customer id of the card owner (Customer representing business). Always same for cards issued under one business

Possible values: <= 2147483647 characters

createdAtstring<Instant>required

Card creation timestamp

Possible values: <= 2147483647 characters

expirationDate object
oneOf
null
formFactorFormFactor (string)required

Card form factor

Possible values: [VIRTUAL, PLASTIC, METAL]

idstring<uuid>required

Card identifier

Possible values: <= 2147483647 characters

issuedAt object
oneOf
null
lastFour object

Last 4 digits of card number

oneOf
null
limitAmount object
oneOf
null
namestringrequired

Card name

Possible values: <= 2147483647 characters

networkCardNetwork (string)required

Card network

Possible values: [VISA, MASTERCARD]

securityPolicy objectrequired

Card security policy

atmbooleanrequired

Whether ATM withdrawals are enabled

Possible values: <= 2147483647 characters

contactlessbooleanrequired

Whether contactless payments are enabled

Possible values: <= 2147483647 characters

ecommerceboolean

Whether ecommerce payments are enabled

Possible values: <= 2147483647 characters

internetbooleanrequired

Whether internet payments are enabled

Possible values: <= 2147483647 characters

locationbooleanrequired

Whether location-based security is enabled

Possible values: <= 2147483647 characters

spendingLimit objectrequired

Card spending limits

limit object
oneOf
null
name objectrequired

Type of spending limit

firstName object

First name

oneOf
null
lastName object

Last name

oneOf
null
middleName object

Middle name

oneOf
null
setAtstring<Instant>required

Timestamp of limit application

Possible values: <= 2147483647 characters

since object
oneOf
null
spentAmount object
oneOf
null
until object
oneOf
null
spendingStrategy objectrequired

Card spending strategy

accountId object
oneOf
null
currency object
oneOf
null
name objectrequired
firstName object

First name

oneOf
null
lastName object

Last name

oneOf
null
middleName object

Middle name

oneOf
null
statusCardState (string)required

Card status

Possible values: [ISSUED, CREATED, ACTIVE, ACTIVATING, FROZEN, TERMINATED]

statusReason object

Explanation of card status

oneOf
null
typeCardType (string)required

Card type

Possible values: [DEBIT, CREDIT, PREPAID]

CardOrderResponse
{
  "card": {
    "activatedAt": "null",
    "availableAmount": "null",
    "bin": "null",
    "cardDesign": {
      "backgroundColor": "string",
      "backgroundImage": "string",
      "cardNetwork": "VISA",
      "code": "string",
      "conditionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "foregroundPrimaryColor": "string",
      "foregroundSecondaryColor": "string",
      "formFactor": "VIRTUAL",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "image": "string",
      "previewImage": "string",
      "status": "AVAILABLE"
    },
    "cardHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cardHolderName": "string",
    "cardOwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "string",
    "expirationDate": "null",
    "formFactor": "VIRTUAL",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "issuedAt": "null",
    "lastFour": "null",
    "limitAmount": "null",
    "name": "string",
    "network": "VISA",
    "securityPolicy": {
      "atm": true,
      "contactless": true,
      "ecommerce": true,
      "internet": true,
      "location": true
    },
    "spendingLimit": {
      "limit": "null",
      "name": {
        "firstName": "null",
        "lastName": "null",
        "middleName": "null"
      },
      "setAt": "string",
      "since": "null",
      "spentAmount": "null",
      "until": "null"
    },
    "spendingStrategy": {
      "accountId": "null",
      "currency": "null",
      "name": {
        "firstName": "null",
        "lastName": "null",
        "middleName": "null"
      }
    },
    "status": "ISSUED",
    "statusReason": "null",
    "type": "DEBIT"
  }
}