paymentInstrument.ts

/*
 * The version of the OpenAPI document: v2
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit this class manually.
 */

import { BankAccountDetails } from "./bankAccountDetails";
import { Card } from "./card";
import { PaymentInstrumentAdditionalBankAccountIdentificationsInner } from "./paymentInstrumentAdditionalBankAccountIdentificationsInner";


export class PaymentInstrument {
    /**
    * Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
    *
	* @deprecated since Configuration webhooks v2
	* Please use `bankAccount` object instead
    */
    "additionalBankAccountIdentifications"?: Array<PaymentInstrumentAdditionalBankAccountIdentificationsInner>;
    /**
    * The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
    */
    "balanceAccountId": string;
    "bankAccount"?: BankAccountDetails;
    "card"?: Card;
    /**
    * Your description for the payment instrument, maximum 300 characters.
    */
    "description"?: string;
    /**
    * The unique identifier of the payment instrument.
    */
    "id": string;
    /**
    * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.
    */
    "issuingCountryCode": string;
    /**
    * The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.
    */
    "paymentInstrumentGroupId"?: string;
    /**
    * Your reference for the payment instrument, maximum 150 characters.
    */
    "reference"?: string;
    /**
    * The unique identifier of the payment instrument that replaced this payment instrument.
    */
    "replacedById"?: string;
    /**
    * The unique identifier of the payment instrument that is replaced by this payment instrument.
    */
    "replacementOfId"?: string;
    /**
    * The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.  Possible values:    * **active**:  The payment instrument is active and can be used to make payments.    * **inactive**: The payment instrument is inactive and cannot be used to make payments.    * **suspended**: The payment instrument is suspended, either because it was stolen or lost.    * **closed**: The payment instrument is permanently closed. This action cannot be undone.   
    */
    "status"?: PaymentInstrument.StatusEnum;
    /**
    * The status comment provides additional information for the statusReason of the payment instrument.
    */
    "statusComment"?: string;
    /**
    * The reason for the status of the payment instrument.  Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change.
    */
    "statusReason"?: PaymentInstrument.StatusReasonEnum;
    /**
    * The type of payment instrument.  Possible values: **card**, **bankAccount**.
    */
    "type": PaymentInstrument.TypeEnum;

    static readonly discriminator: string | undefined = undefined;

    static readonly mapping: {[index: string]: string} | undefined = undefined;

    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
        {
            "name": "additionalBankAccountIdentifications",
            "baseName": "additionalBankAccountIdentifications",
            "type": "Array<PaymentInstrumentAdditionalBankAccountIdentificationsInner>",
            "format": ""
        },
        {
            "name": "balanceAccountId",
            "baseName": "balanceAccountId",
            "type": "string",
            "format": ""
        },
        {
            "name": "bankAccount",
            "baseName": "bankAccount",
            "type": "BankAccountDetails",
            "format": ""
        },
        {
            "name": "card",
            "baseName": "card",
            "type": "Card",
            "format": ""
        },
        {
            "name": "description",
            "baseName": "description",
            "type": "string",
            "format": ""
        },
        {
            "name": "id",
            "baseName": "id",
            "type": "string",
            "format": ""
        },
        {
            "name": "issuingCountryCode",
            "baseName": "issuingCountryCode",
            "type": "string",
            "format": ""
        },
        {
            "name": "paymentInstrumentGroupId",
            "baseName": "paymentInstrumentGroupId",
            "type": "string",
            "format": ""
        },
        {
            "name": "reference",
            "baseName": "reference",
            "type": "string",
            "format": ""
        },
        {
            "name": "replacedById",
            "baseName": "replacedById",
            "type": "string",
            "format": ""
        },
        {
            "name": "replacementOfId",
            "baseName": "replacementOfId",
            "type": "string",
            "format": ""
        },
        {
            "name": "status",
            "baseName": "status",
            "type": "PaymentInstrument.StatusEnum",
            "format": ""
        },
        {
            "name": "statusComment",
            "baseName": "statusComment",
            "type": "string",
            "format": ""
        },
        {
            "name": "statusReason",
            "baseName": "statusReason",
            "type": "PaymentInstrument.StatusReasonEnum",
            "format": ""
        },
        {
            "name": "type",
            "baseName": "type",
            "type": "PaymentInstrument.TypeEnum",
            "format": ""
        }    ];

    static getAttributeTypeMap() {
        return PaymentInstrument.attributeTypeMap;
    }

    public constructor() {
    }
}

export namespace PaymentInstrument {
    export enum StatusEnum {
        Active = 'active',
        Closed = 'closed',
        Inactive = 'inactive',
        Suspended = 'suspended'
    }
    export enum StatusReasonEnum {
        AccountClosure = 'accountClosure',
        Damaged = 'damaged',
        EndOfLife = 'endOfLife',
        Expired = 'expired',
        Lost = 'lost',
        Other = 'other',
        Stolen = 'stolen',
        SuspectedFraud = 'suspectedFraud',
        TransactionRule = 'transactionRule'
    }
    export enum TypeEnum {
        BankAccount = 'bankAccount',
        Card = 'card'
    }
}