@sumup/sdk
    Preparing search index...

    Type Alias PaymentInstrumentResponse

    Payment Instrument Response

    type PaymentInstrumentResponse = {
        active?: boolean;
        card?: {
            last_4_digits?: string;
            type?:
                | "AMEX"
                | "CUP"
                | "DINERS"
                | "DISCOVER"
                | "ELO"
                | "ELV"
                | "HIPERCARD"
                | "JCB"
                | "MAESTRO"
                | "MASTERCARD"
                | "VISA"
                | "VISA_ELECTRON"
                | "VISA_VPAY"
                | "UNKNOWN";
        };
        created_at?: string;
        mandate?: SumUp.Customers.MandateResponse;
        token?: string;
        type?: "card";
    }
    Index

    Properties

    active? card? created_at? mandate? token? type?

    Properties

    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.

    card?: {
        last_4_digits?: string;
        type?:
            | "AMEX"
            | "CUP"
            | "DINERS"
            | "DISCOVER"
            | "ELO"
            | "ELV"
            | "HIPERCARD"
            | "JCB"
            | "MAESTRO"
            | "MASTERCARD"
            | "VISA"
            | "VISA_ELECTRON"
            | "VISA_VPAY"
            | "UNKNOWN";
    }

    Details of the payment card.

    Type Declaration

    • Optionallast_4_digits?: string

      Last 4 digits of the payment card number.

    • Optionaltype?:
          | "AMEX"
          | "CUP"
          | "DINERS"
          | "DISCOVER"
          | "ELO"
          | "ELV"
          | "HIPERCARD"
          | "JCB"
          | "MAESTRO"
          | "MASTERCARD"
          | "VISA"
          | "VISA_ELECTRON"
          | "VISA_VPAY"
          | "UNKNOWN"

      Issuing card network of the payment card.

    created_at?: string

    Creation date of payment instrument. Response format expressed according to ISO8601 code.

    mandate?: SumUp.Customers.MandateResponse
    token?: string

    Unique token identifying the saved payment card for a customer.

    type?: "card"

    Type of the payment instrument.

    Settings

    Member Visibility

    On This Page

    Properties