@getopenpay/client/models/PaymentMethodExternal.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 { CompleteAddress } from './CompleteAddress';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface PaymentMethodExternal
 */
export interface PaymentMethodExternal {
    /**
     *
     * @type {CompleteAddress}
     * @memberof PaymentMethodExternal
     */
    billingAddress?: CompleteAddress | null;
    /**
     *
     * @type {string}
     * @memberof PaymentMethodExternal
     */
    cardBrand?: string | null;
    /**
     *
     * @type {string}
     * @memberof PaymentMethodExternal
     */
    cardType?: string | null;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentMethodExternal
     */
    createdAt: Date;
    /**
     *
     * @type {string}
     * @memberof PaymentMethodExternal
     */
    customerId?: string | null;
    /**
     * Display name for the payment method to show on the UI.
     * @type {string}
     * @memberof PaymentMethodExternal
     */
    displayName: string;
    /**
     * Unique Identifier of the payment_method.
     * @type {string}
     * @memberof PaymentMethodExternal
     */
    id: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof PaymentMethodExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {string}
     * @memberof PaymentMethodExternal
     */
    lastFour?: string | null;
    /**
     * List of payment method mappings associated with this payment method. Include "mappings" in the expand parameter to retrieve this data.
     * @type {Array<PaymentMethodMappingExternal>}
     * @memberof PaymentMethodExternal
     */
    mappings?: Array<PaymentMethodMappingExternal>;
    /**
     *
     * @type {object}
     * @memberof PaymentMethodExternal
     */
    metadata?: object | null;
    /**
     *
     * @type {ObjectName}
     * @memberof PaymentMethodExternal
     */
    object?: ObjectName;
    /**
     * The provider type for this payment method
     * @type {PaymentProviderType}
     * @memberof PaymentMethodExternal
     */
    provider: PaymentProviderType;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentMethodExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the PaymentMethodExternal interface.
 */
export declare function instanceOfPaymentMethodExternal(value: object): value is PaymentMethodExternal;
export declare function PaymentMethodExternalFromJSON(json: any): PaymentMethodExternal;
export declare function PaymentMethodExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentMethodExternal;
export declare function PaymentMethodExternalToJSON(json: any): PaymentMethodExternal;
export declare function PaymentMethodExternalToJSONTyped(value?: PaymentMethodExternal | null, ignoreDiscriminator?: boolean): any;