@getopenpay/client/models/ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { PaymentProviderType } from './PaymentProviderType';
import type { PaymentMethodMappingExternal } from './PaymentMethodMappingExternal';
import type { CardSubType } from './CardSubType';
import type { CompleteAddress } from './CompleteAddress';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
 */
export interface ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet {
    /**
     *
     * @type {CompleteAddress}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    billingAddress?: CompleteAddress;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardBrand?: string;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardCountry?: string;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardFingerprint?: string;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardFirstIp?: string;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardIin?: string;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardIssuer?: string;
    /**
     *
     * @type {CardSubType}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardSubtype?: CardSubType;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cardType?: string;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    cdeExternalId?: string;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    createdAt: Date;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    customerId?: string;
    /**
     * Display name for the payment method to show on the UI.
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    displayName: string;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    expiryDate: string;
    /**
     * Extra metadata used to create the payment method.
     * @type {object}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    extraMetadata?: object;
    /**
     * Unique Identifier of the payment_method.
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    id: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    isDeleted?: boolean;
    /**
     * Indicates if full details of the card are known
     * @type {boolean}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    isFullDetailsKnown: boolean;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    lastFour?: string;
    /**
     * List of payment method mappings associated with this payment method. Include "mappings" in the expand parameter to retrieve this data.
     * @type {Array<PaymentMethodMappingExternal>}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    mappings?: Array<PaymentMethodMappingExternal>;
    /**
     *
     * @type {object}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    metadata?: object;
    /**
     *
     * @type {ObjectName}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    object?: ObjectName;
    /**
     * The provider type for this payment method
     * @type {PaymentProviderType}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    provider: PaymentProviderType;
    /**
     *
     * @type {string}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    shortDisplayName?: string;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet interface.
 */
export declare function instanceOfResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet(value: object): value is ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet;
export declare function ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGetFromJSON(json: any): ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet;
export declare function ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet;
export declare function ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGetToJSON(json: any): ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet;
export declare function ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGetToJSONTyped(value?: ResponseGetPaymentMethodPaymentMethodsPaymentMethodIdGet | null, ignoreDiscriminator?: boolean): any;