Bunq · Schema

Card

Banking

Properties

Name	Type	Description
pin_code	string	The plaintext pin code. Requests require encryption to be enabled.
activation_code	string	DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION.
status	string	The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/C
order_status	string	The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced.
card_limit	object	The spending limit for the card.
card_limit_atm	object	The ATM spending limit for the card.
country_permission	array	The countries for which to grant (temporary) permissions to use the card.
pin_code_assignment	array	Array of Types, PINs, account IDs assigned to the card.
primary_account_numbers	array	Array of PANs and their attributes.
monetary_account_id_fallback	integer	ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.
preferred_name_on_card	string	The user's preferred name as it will be on the card.
second_line	string	The second line of text on the card
cancellation_reason	string	The reason for card cancellation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Card",
  "title": "Card",
  "type": "object",
  "properties": {
    "pin_code": {
      "type": "string",
      "description": "The plaintext pin code. Requests require encryption to be enabled.",
      "readOnly": false,
      "writeOnly": true
    },
    "activation_code": {
      "type": "string",
      "description": "DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION.",
      "readOnly": false,
      "writeOnly": true
    },
    "status": {
      "type": "string",
      "description": "The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after.",
      "readOnly": false,
      "writeOnly": false
    },
    "order_status": {
      "type": "string",
      "description": "The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced.",
      "readOnly": false,
      "writeOnly": false
    },
    "card_limit": {
      "type": "object",
      "description": "The spending limit for the card.",
      "readOnly": false,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "card_limit_atm": {
      "type": "object",
      "description": "The ATM spending limit for the card.",
      "readOnly": false,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "country_permission": {
      "type": "array",
      "description": "The countries for which to grant (temporary) permissions to use the card.",
      "readOnly": false,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/CardCountryPermission"
      }
    },
    "pin_code_assignment": {
      "type": "array",
      "description": "Array of Types, PINs, account IDs assigned to the card.",
      "readOnly": false,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/CardPinAssignment"
      }
    },
    "primary_account_numbers": {
      "type": "array",
      "description": "Array of PANs and their attributes.",
      "readOnly": false,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/CardPrimaryAccountNumber"
      }
    },
    "monetary_account_id_fallback": {
      "type": "integer",
      "description": "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.",
      "readOnly": false,
      "writeOnly": false
    },
    "preferred_name_on_card": {
      "type": "string",
      "description": "The user's preferred name as it will be on the card.",
      "readOnly": false,
      "writeOnly": false
    },
    "second_line": {
      "type": "string",
      "description": "The second line of text on the card",
      "readOnly": false,
      "writeOnly": false
    },
    "cancellation_reason": {
      "type": "string",
      "description": "The reason for card cancellation.",
      "readOnly": false,
      "writeOnly": true
    }
  }
}