SumUp · Schema

Payment Instrument Response

PaymentsPOSPoint of SaleCard ReadersCheckoutFintechMobile PaymentsOnline Payments

Properties

Name	Type	Description
token	string	Unique token identifying the saved payment card for a customer.
active	boolean	Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a `DELETE` request to the resource endpoint.
type	string	Type of the payment instrument.
card	object	Details of the payment card.
mandate	object
created_at	string	Creation date of payment instrument. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Payment Instrument Response",
  "description": "Payment Instrument Response",
  "type": "object",
  "properties": {
    "token": {
      "description": "Unique token identifying the saved payment card for a customer.",
      "type": "string",
      "readOnly": true
    },
    "active": {
      "description": "Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a `DELETE` request to the resource endpoint.",
      "type": "boolean",
      "default": true,
      "readOnly": true
    },
    "type": {
      "description": "Type of the payment instrument.",
      "type": "string",
      "enum": [
        "card"
      ]
    },
    "card": {
      "description": "Details of the payment card.",
      "type": "object",
      "properties": {
        "last_4_digits": {
          "description": "Last 4 digits of the payment card number.",
          "type": "string",
          "example": "3456",
          "maxLength": 4,
          "minLength": 4,
          "readOnly": true
        },
        "type": {
          "$ref": "#/components/schemas/CardType"
        }
      }
    },
    "mandate": {
      "$ref": "#/components/schemas/MandateResponse"
    },
    "created_at": {
      "description": "Creation date of payment instrument. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.",
      "type": "string",
      "format": "date-time"
    }
  },
  "example": {
    "token": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3",
    "active": true,
    "type": "card",
    "mandate": {
      "type": "recurrent",
      "status": "active",
      "merchant_code": "MH4H92C7"
    },
    "card": {
      "last_4_digits": "0001",
      "type": "VISA"
    },
    "created_at": "2021-03-30T10:06:07+00:00"
  }
}