transferData.ts

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

import { Amount } from "./amount";
import { BalanceMutation } from "./balanceMutation";
import { DirectDebitInformation } from "./directDebitInformation";
import { ExecutionDate } from "./executionDate";
import { ExternalReason } from "./externalReason";
import { PaymentInstrument } from "./paymentInstrument";
import { ResourceReference } from "./resourceReference";
import { TransactionRulesResult } from "./transactionRulesResult";
import { TransferDataCategoryData } from "./transferDataCategoryData";
import { TransferDataTracking } from "./transferDataTracking";
import { TransferEvent } from "./transferEvent";
import { TransferNotificationCounterParty } from "./transferNotificationCounterParty";
import { TransferReview } from "./transferReview";


export class TransferData {
    "accountHolder"?: ResourceReference | null;
    "amount": Amount;
    "balanceAccount"?: ResourceReference | null;
    /**
    * The unique identifier of the balance platform.
    */
    "balancePlatform"?: string;
    /**
    * The list of the latest balance statuses in the transfer.
    */
    "balances"?: Array<BalanceMutation>;
    /**
    * The category of the transfer.  Possible values:   - **bank**: A transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) or a bank account.  - **card**: A transfer involving a third-party card.  - **internal**: A transfer between [balance accounts](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id) within your platform.  - **issuedCard**: A transfer initiated by an Adyen-issued card.  - **platformPayment**: Funds movements related to payments that are acquired for your users.  - **topUp**: An incoming transfer initiated by your user to top up their balance account.
    */
    "category": TransferData.CategoryEnum;
    "categoryData"?: TransferDataCategoryData | null;
    "counterparty"?: TransferNotificationCounterParty | null;
    /**
    * The date and time when the transfer was created, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
    */
    "createdAt"?: Date;
    /**
    * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
    *
	* @deprecated since Transfer webhooks v3
	* Use createdAt or updatedAt
    */
    "creationDate"?: Date;
    /**
    * Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.  Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , \' + Space**  Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ \' \" ! ?**
    */
    "description"?: string;
    "directDebitInformation"?: DirectDebitInformation | null;
    /**
    * The direction of the transfer.  Possible values: **incoming**, **outgoing**.
    */
    "direction"?: TransferData.DirectionEnum;
    /**
    * The unique identifier of the latest transfer event. Included only when the `category` is **issuedCard**.
    */
    "eventId"?: string;
    /**
    * The list of events leading up to the current status of the transfer.
    */
    "events"?: Array<TransferEvent>;
    "executionDate"?: ExecutionDate | null;
    "externalReason"?: ExternalReason | null;
    /**
    * The ID of the resource.
    */
    "id"?: string;
    "paymentInstrument"?: PaymentInstrument | null;
    /**
    * Additional information about the status of the transfer.
    */
    "reason"?: TransferData.ReasonEnum;
    /**
    * Your reference for the transfer, used internally within your platform. If you don\'t provide this in the request, Adyen generates a unique reference.
    */
    "reference"?: string;
    /**
    *  A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.   Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends on the `category`.   - **internal**: 80 characters  - **bank**: 35 characters when transferring to an IBAN, 15 characters for others.
    */
    "referenceForBeneficiary"?: string;
    "review"?: TransferReview | null;
    /**
    * The sequence number of the transfer webhook. The numbers start from 1 and increase with each new webhook for a specific transfer.  The sequence number can help you restore the correct sequence of events even if they arrive out of order.
    */
    "sequenceNumber"?: number;
    /**
    * The result of the transfer.  For example:  - **received**: an outgoing transfer request is created. - **refused**: the transfer request is rejected by Adyen for one of the following reasons:   - Lack of funds in the balance account.   - Transfer limit exceeded.   - Transaction rule requirements violated. - **authorised**: the transfer request is authorized and the funds are reserved. - **booked**: the funds are deducted from your user\'s balance account.  - **failed**: the transfer is rejected by the counterparty\'s bank. - **returned**: the transfer is returned by the counterparty\'s bank.
    */
    "status": TransferData.StatusEnum;
    "tracking"?: TransferDataTracking | null;
    "transactionRulesResult"?: TransactionRulesResult | null;
    /**
    * The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**.
    */
    "type"?: TransferData.TypeEnum;
    /**
    * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
    */
    "updatedAt"?: Date;

    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": "accountHolder",
            "baseName": "accountHolder",
            "type": "ResourceReference | null",
            "format": ""
        },
        {
            "name": "amount",
            "baseName": "amount",
            "type": "Amount",
            "format": ""
        },
        {
            "name": "balanceAccount",
            "baseName": "balanceAccount",
            "type": "ResourceReference | null",
            "format": ""
        },
        {
            "name": "balancePlatform",
            "baseName": "balancePlatform",
            "type": "string",
            "format": ""
        },
        {
            "name": "balances",
            "baseName": "balances",
            "type": "Array<BalanceMutation>",
            "format": ""
        },
        {
            "name": "category",
            "baseName": "category",
            "type": "TransferData.CategoryEnum",
            "format": ""
        },
        {
            "name": "categoryData",
            "baseName": "categoryData",
            "type": "TransferDataCategoryData | null",
            "format": ""
        },
        {
            "name": "counterparty",
            "baseName": "counterparty",
            "type": "TransferNotificationCounterParty | null",
            "format": ""
        },
        {
            "name": "createdAt",
            "baseName": "createdAt",
            "type": "Date",
            "format": "date-time"
        },
        {
            "name": "creationDate",
            "baseName": "creationDate",
            "type": "Date",
            "format": "date-time"
        },
        {
            "name": "description",
            "baseName": "description",
            "type": "string",
            "format": ""
        },
        {
            "name": "directDebitInformation",
            "baseName": "directDebitInformation",
            "type": "DirectDebitInformation | null",
            "format": ""
        },
        {
            "name": "direction",
            "baseName": "direction",
            "type": "TransferData.DirectionEnum",
            "format": ""
        },
        {
            "name": "eventId",
            "baseName": "eventId",
            "type": "string",
            "format": ""
        },
        {
            "name": "events",
            "baseName": "events",
            "type": "Array<TransferEvent>",
            "format": ""
        },
        {
            "name": "executionDate",
            "baseName": "executionDate",
            "type": "ExecutionDate | null",
            "format": ""
        },
        {
            "name": "externalReason",
            "baseName": "externalReason",
            "type": "ExternalReason | null",
            "format": ""
        },
        {
            "name": "id",
            "baseName": "id",
            "type": "string",
            "format": ""
        },
        {
            "name": "paymentInstrument",
            "baseName": "paymentInstrument",
            "type": "PaymentInstrument | null",
            "format": ""
        },
        {
            "name": "reason",
            "baseName": "reason",
            "type": "TransferData.ReasonEnum",
            "format": ""
        },
        {
            "name": "reference",
            "baseName": "reference",
            "type": "string",
            "format": ""
        },
        {
            "name": "referenceForBeneficiary",
            "baseName": "referenceForBeneficiary",
            "type": "string",
            "format": ""
        },
        {
            "name": "review",
            "baseName": "review",
            "type": "TransferReview | null",
            "format": ""
        },
        {
            "name": "sequenceNumber",
            "baseName": "sequenceNumber",
            "type": "number",
            "format": "int32"
        },
        {
            "name": "status",
            "baseName": "status",
            "type": "TransferData.StatusEnum",
            "format": ""
        },
        {
            "name": "tracking",
            "baseName": "tracking",
            "type": "TransferDataTracking | null",
            "format": ""
        },
        {
            "name": "transactionRulesResult",
            "baseName": "transactionRulesResult",
            "type": "TransactionRulesResult | null",
            "format": ""
        },
        {
            "name": "type",
            "baseName": "type",
            "type": "TransferData.TypeEnum",
            "format": ""
        },
        {
            "name": "updatedAt",
            "baseName": "updatedAt",
            "type": "Date",
            "format": "date-time"
        }    ];

    static getAttributeTypeMap() {
        return TransferData.attributeTypeMap;
    }

    public constructor() {
    }
}

export namespace TransferData {
    export enum CategoryEnum {
        Bank = 'bank',
        Card = 'card',
        Internal = 'internal',
        IssuedCard = 'issuedCard',
        PlatformPayment = 'platformPayment',
        TopUp = 'topUp'
    }
    export enum DirectionEnum {
        Incoming = 'incoming',
        Outgoing = 'outgoing'
    }
    export enum ReasonEnum {
        AccountHierarchyNotActive = 'accountHierarchyNotActive',
        AmountLimitExceeded = 'amountLimitExceeded',
        ApprovalExpired = 'approvalExpired',
        Approved = 'approved',
        AvsDeclined = 'avsDeclined',
        BalanceAccountTemporarilyBlockedByTransactionRule = 'balanceAccountTemporarilyBlockedByTransactionRule',
        BlockCard = 'blockCard',
        CallReferral = 'callReferral',
        Cancelled = 'cancelled',
        CaptureCard = 'captureCard',
        CardExpired = 'cardExpired',
        CardholderAuthenticationRequired = 'cardholderAuthenticationRequired',
        CashbackAmountExceedsLimit = 'cashbackAmountExceedsLimit',
        CavvDeclined = 'cavvDeclined',
        ContactlessFallback = 'contactlessFallback',
        ContactlessLimitReached = 'contactlessLimitReached',
        CounterpartyAccountBlocked = 'counterpartyAccountBlocked',
        CounterpartyAccountClosed = 'counterpartyAccountClosed',
        CounterpartyAccountNotFound = 'counterpartyAccountNotFound',
        CounterpartyAddressRequired = 'counterpartyAddressRequired',
        CounterpartyBankTimedOut = 'counterpartyBankTimedOut',
        CounterpartyBankUnavailable = 'counterpartyBankUnavailable',
        CryptographicFailure = 'cryptographicFailure',
        CvcDeclined = 'cvcDeclined',
        Declined = 'declined',
        DeclinedByBapValidation = 'declinedByBapValidation',
        DeclinedByTransactionRule = 'declinedByTransactionRule',
        DeclinedNonGeneric = 'declinedNonGeneric',
        DirectDebitNotSupported = 'directDebitNotSupported',
        DoNotHonor = 'doNotHonor',
        DomesticDebitTransactionNotAllowed = 'domesticDebitTransactionNotAllowed',
        DuplicateTransmissionDetected = 'duplicateTransmissionDetected',
        Error = 'error',
        FormatError = 'formatError',
        Fraud = 'fraud',
        FraudCancelled = 'fraudCancelled',
        HonorWithId = 'honorWithId',
        InternalTimeout = 'internalTimeout',
        InvalidAccount = 'invalidAccount',
        InvalidAmount = 'invalidAmount',
        InvalidAuthorizationLifeCycle = 'invalidAuthorizationLifeCycle',
        InvalidCard = 'invalidCard',
        InvalidExpiryDate = 'invalidExpiryDate',
        InvalidFromAccount = 'invalidFromAccount',
        InvalidIssuer = 'invalidIssuer',
        InvalidMerchant = 'invalidMerchant',
        InvalidPin = 'invalidPin',
        InvalidToAccount = 'invalidToAccount',
        InvalidTransaction = 'invalidTransaction',
        IssuerSuspectedFraud = 'issuerSuspectedFraud',
        LostCard = 'lostCard',
        MobilePinRequired = 'mobilePinRequired',
        NoCheckingAccount = 'noCheckingAccount',
        NoSavingsAccount = 'noSavingsAccount',
        Not3dAuthenticated = 'not3dAuthenticated',
        NotEnoughBalance = 'notEnoughBalance',
        NotSubmitted = 'notSubmitted',
        NotSupported = 'notSupported',
        PartiallyApproved = 'partiallyApproved',
        Pending = 'pending',
        PendingApproval = 'pendingApproval',
        PendingExecution = 'pendingExecution',
        PinNotChanged = 'pinNotChanged',
        PinRequired = 'pinRequired',
        PinTriesExceeded = 'pinTriesExceeded',
        PinValidationNotPossible = 'pinValidationNotPossible',
        PurchaseAmountOnlyNoCashBack = 'purchaseAmountOnlyNoCashBack',
        RefusedByCounterpartyBank = 'refusedByCounterpartyBank',
        RefusedByCustomer = 'refusedByCustomer',
        RestrictedCard = 'restrictedCard',
        RevocationOfAuth = 'revocationOfAuth',
        RouteNotFound = 'routeNotFound',
        ScaAuthenticationRequired = 'scaAuthenticationRequired',
        ScaFailed = 'scaFailed',
        SchemeAdvice = 'schemeAdvice',
        SecurityViolation = 'securityViolation',
        ShopperCancelled = 'shopperCancelled',
        StolenCard = 'stolenCard',
        ThreedsDynamicLinkingMismatch = 'threedsDynamicLinkingMismatch',
        TransactionNotPermitted = 'transactionNotPermitted',
        TransferInstrumentDoesNotExist = 'transferInstrumentDoesNotExist',
        UnableToRouteTransaction = 'unableToRouteTransaction',
        Unknown = 'unknown',
        WithdrawalAmountExceeded = 'withdrawalAmountExceeded',
        WithdrawalCountExceeded = 'withdrawalCountExceeded'
    }
    export enum StatusEnum {
        ApprovalPending = 'approvalPending',
        AtmWithdrawal = 'atmWithdrawal',
        AtmWithdrawalReversalPending = 'atmWithdrawalReversalPending',
        AtmWithdrawalReversed = 'atmWithdrawalReversed',
        AuthAdjustmentAuthorised = 'authAdjustmentAuthorised',
        AuthAdjustmentError = 'authAdjustmentError',
        AuthAdjustmentRefused = 'authAdjustmentRefused',
        Authorised = 'authorised',
        BankTransfer = 'bankTransfer',
        BankTransferPending = 'bankTransferPending',
        Booked = 'booked',
        BookingPending = 'bookingPending',
        Cancelled = 'cancelled',
        CapturePending = 'capturePending',
        CaptureReversalPending = 'captureReversalPending',
        CaptureReversed = 'captureReversed',
        Captured = 'captured',
        CapturedExternally = 'capturedExternally',
        Chargeback = 'chargeback',
        ChargebackExternally = 'chargebackExternally',
        ChargebackPending = 'chargebackPending',
        ChargebackReversalPending = 'chargebackReversalPending',
        ChargebackReversed = 'chargebackReversed',
        Credited = 'credited',
        DepositCorrection = 'depositCorrection',
        DepositCorrectionPending = 'depositCorrectionPending',
        Dispute = 'dispute',
        DisputeClosed = 'disputeClosed',
        DisputeExpired = 'disputeExpired',
        DisputeNeedsReview = 'disputeNeedsReview',
        Error = 'error',
        Expired = 'expired',
        Failed = 'failed',
        Fee = 'fee',
        FeePending = 'feePending',
        InternalTransfer = 'internalTransfer',
        InternalTransferPending = 'internalTransferPending',
        InvoiceDeduction = 'invoiceDeduction',
        InvoiceDeductionPending = 'invoiceDeductionPending',
        ManualCorrectionPending = 'manualCorrectionPending',
        ManuallyCorrected = 'manuallyCorrected',
        MatchedStatement = 'matchedStatement',
        MatchedStatementPending = 'matchedStatementPending',
        MerchantPayin = 'merchantPayin',
        MerchantPayinPending = 'merchantPayinPending',
        MerchantPayinReversed = 'merchantPayinReversed',
        MerchantPayinReversedPending = 'merchantPayinReversedPending',
        MiscCost = 'miscCost',
        MiscCostPending = 'miscCostPending',
        PaymentCost = 'paymentCost',
        PaymentCostPending = 'paymentCostPending',
        PendingApproval = 'pendingApproval',
        PendingExecution = 'pendingExecution',
        Received = 'received',
        RefundPending = 'refundPending',
        RefundReversalPending = 'refundReversalPending',
        RefundReversed = 'refundReversed',
        Refunded = 'refunded',
        RefundedExternally = 'refundedExternally',
        Refused = 'refused',
        Rejected = 'rejected',
        ReserveAdjustment = 'reserveAdjustment',
        ReserveAdjustmentPending = 'reserveAdjustmentPending',
        Returned = 'returned',
        SecondChargeback = 'secondChargeback',
        SecondChargebackPending = 'secondChargebackPending',
        Undefined = 'undefined'
    }
    export enum TypeEnum {
        Payment = 'payment',
        Capture = 'capture',
        CaptureReversal = 'captureReversal',
        Refund = 'refund',
        RefundReversal = 'refundReversal',
        Chargeback = 'chargeback',
        ChargebackCorrection = 'chargebackCorrection',
        ChargebackReversal = 'chargebackReversal',
        ChargebackReversalCorrection = 'chargebackReversalCorrection',
        SecondChargeback = 'secondChargeback',
        SecondChargebackCorrection = 'secondChargebackCorrection',
        AtmWithdrawal = 'atmWithdrawal',
        AtmWithdrawalReversal = 'atmWithdrawalReversal',
        InternalTransfer = 'internalTransfer',
        InternalDirectDebit = 'internalDirectDebit',
        ManualCorrection = 'manualCorrection',
        InvoiceDeduction = 'invoiceDeduction',
        DepositCorrection = 'depositCorrection',
        ReserveAdjustment = 'reserveAdjustment',
        BankTransfer = 'bankTransfer',
        BankDirectDebit = 'bankDirectDebit',
        CardTransfer = 'cardTransfer',
        MiscCost = 'miscCost',
        PaymentCost = 'paymentCost',
        Fee = 'fee',
        Leftover = 'leftover',
        Grant = 'grant',
        CapitalFundsCollection = 'capitalFundsCollection',
        CashOutInstruction = 'cashOutInstruction',
        CashoutFee = 'cashoutFee',
        CashoutRepayment = 'cashoutRepayment',
        CashoutFunding = 'cashoutFunding',
        Repayment = 'repayment',
        Installment = 'installment',
        InstallmentReversal = 'installmentReversal',
        BalanceAdjustment = 'balanceAdjustment',
        BalanceRollover = 'balanceRollover',
        BalanceMigration = 'balanceMigration'
    }
}