chargebee/types/resources/PaymentSource.d.ts

A library for integrating with Chargebee.

///<reference path='./../core.d.ts'/>
///<reference path='./../index.d.ts'/>
///<reference path='./filter.d.ts'/>
declare module 'chargebee' {
  export interface PaymentSource {
    id: string;
    resource_version?: number;
    updated_at?: number;
    created_at: number;
    customer_id: string;
    type: TypeEnum;
    reference_id: string;
    status:
      | 'valid'
      | 'expiring'
      | 'expired'
      | 'invalid'
      | 'pending_verification';
    gateway: GatewayEnum;
    gateway_account_id?: string;
    ip_address?: string;
    issuing_country?: string;
    card?: PaymentSource.Card;
    bank_account?: PaymentSource.BankAccount;
    boleto?: PaymentSource.CustVoucherSource;
    billing_address?: PaymentSource.BillingAddress;
    amazon_payment?: PaymentSource.AmazonPayment;
    upi?: PaymentSource.Upi;
    paypal?: PaymentSource.Paypal;
    venmo?: PaymentSource.Venmo;
    klarna_pay_now?: PaymentSource.KlarnaPayNow;
    mandates?: PaymentSource.Mandate[];
    deleted: boolean;
    business_entity_id?: string;
  }

  export namespace PaymentSource {
    export class PaymentSourceResource {
      createUsingTempToken(
        input: CreateUsingTempTokenInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateUsingTempTokenResponse>>;

      createUsingPermanentToken(
        input: CreateUsingPermanentTokenInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateUsingPermanentTokenResponse>>;

      createUsingToken(
        input: CreateUsingTokenInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateUsingTokenResponse>>;

      createUsingPaymentIntent(
        input: CreateUsingPaymentIntentInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateUsingPaymentIntentResponse>>;

      createVoucherPaymentSource(
        input: CreateVoucherPaymentSourceInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateVoucherPaymentSourceResponse>>;

      createCard(
        input: CreateCardInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateCardResponse>>;

      createBankAccount(
        input: CreateBankAccountInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateBankAccountResponse>>;

      updateCard(
        cust_payment_source_id: string,
        input?: UpdateCardInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<UpdateCardResponse>>;

      updateBankAccount(
        cust_payment_source_id: string,
        input?: UpdateBankAccountInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<UpdateBankAccountResponse>>;

      verifyBankAccount(
        cust_payment_source_id: string,
        input: VerifyBankAccountInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<VerifyBankAccountResponse>>;

      retrieve(
        cust_payment_source_id: string,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<RetrieveResponse>>;

      list(
        input?: ListInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<ListResponse>>;

      switchGatewayAccount(
        cust_payment_source_id: string,
        input: SwitchGatewayAccountInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<SwitchGatewayAccountResponse>>;

      exportPaymentSource(
        cust_payment_source_id: string,
        input: ExportPaymentSourceInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<ExportPaymentSourceResponse>>;

      delete(
        cust_payment_source_id: string,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<DeleteResponse>>;

      deleteLocal(
        cust_payment_source_id: string,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<DeleteLocalResponse>>;
    }

    export interface CreateUsingTempTokenResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface CreateUsingPermanentTokenResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface CreateUsingTokenResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface CreateUsingPaymentIntentResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface CreateVoucherPaymentSourceResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface CreateCardResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface CreateBankAccountResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface UpdateCardResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface UpdateBankAccountResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface VerifyBankAccountResponse {
      payment_source: PaymentSource;
    }

    export interface RetrieveResponse {
      payment_source: PaymentSource;
    }

    export interface ListResponse {
      list: { payment_source: PaymentSource }[];
      next_offset?: string;
    }

    export interface SwitchGatewayAccountResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface ExportPaymentSourceResponse {
      third_party_payment_method: ThirdPartyPaymentMethod;
    }

    export interface DeleteResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface DeleteLocalResponse {
      customer: Customer;
      payment_source: PaymentSource;
    }

    export interface Card {
      first_name?: string;
      last_name?: string;
      iin: string;
      last4: string;
      brand:
        | 'visa'
        | 'mastercard'
        | 'american_express'
        | 'discover'
        | 'jcb'
        | 'diners_club'
        | 'other'
        | 'bancontact'
        | 'cmr_falabella'
        | 'tarjeta_naranja'
        | 'nativa'
        | 'cencosud'
        | 'cabal'
        | 'argencard'
        | 'elo'
        | 'hipercard'
        | 'carnet'
        | 'rupay'
        | 'maestro'
        | 'dankort'
        | 'cartes_bancaires'
        | 'not_applicable';
      funding_type:
        | 'credit'
        | 'debit'
        | 'prepaid'
        | 'not_known'
        | 'not_applicable';
      expiry_month: number;
      expiry_year: number;
      billing_addr1?: string;
      billing_addr2?: string;
      billing_city?: string;
      billing_state_code?: string;
      billing_state?: string;
      billing_country?: string;
      billing_zip?: string;
      masked_number?: string;
    }
    export interface BankAccount {
      last4: string;
      name_on_account?: string;
      first_name?: string;
      last_name?: string;
      direct_debit_scheme?: DirectDebitSchemeEnum;
      bank_name?: string;
      mandate_id?: string;
      account_type?: AccountTypeEnum;
      echeck_type?: EcheckTypeEnum;
      account_holder_type?: AccountHolderTypeEnum;
      email?: string;
    }
    export interface CustVoucherSource {
      last4: string;
      first_name?: string;
      last_name?: string;
      email?: string;
    }
    export interface BillingAddress {
      first_name?: string;
      last_name?: string;
      email?: string;
      company?: string;
      phone?: string;
      line1?: string;
      line2?: string;
      line3?: string;
      city?: string;
      state_code?: string;
      state?: string;
      country?: string;
      zip?: string;
      validation_status?: ValidationStatusEnum;
    }
    export interface AmazonPayment {
      email?: string;
      agreement_id?: string;
    }
    export interface Upi {
      vpa?: string;
    }
    export interface Paypal {
      email?: string;
      agreement_id?: string;
    }
    export interface Venmo {
      user_name?: string;
    }
    export interface KlarnaPayNow {
      email?: string;
    }
    export interface Mandate {
      id: string;
      subscription_id: string;
      created_at: number;
    }
    // REQUEST PARAMS
    //---------------

    export interface CreateUsingTempTokenInputParam {
      customer_id: string;
      gateway_account_id?: string;
      type: TypeEnum;
      tmp_token: string;
      issuing_country?: string;
      replace_primary_payment_source?: boolean;
      additional_information?: any;
    }
    export interface CreateUsingPermanentTokenInputParam {
      customer_id: string;
      type: TypeEnum;
      gateway_account_id?: string;
      reference_id?: string;
      issuing_country?: string;
      replace_primary_payment_source?: boolean;
      payment_method_token?: string;
      customer_profile_token?: string;
      network_transaction_id?: string;
      mandate_id?: string;
      skip_retrieval?: boolean;
      additional_information?: any;
      card?: CardCreateUsingPermanentTokenInputParam;
      billing_address?: BillingAddressCreateUsingPermanentTokenInputParam;
    }
    export interface CreateUsingTokenInputParam {
      customer_id: string;
      replace_primary_payment_source?: boolean;
      token_id: string;
    }
    export interface CreateUsingPaymentIntentInputParam {
      customer_id: string;
      replace_primary_payment_source?: boolean;
      payment_intent?: PaymentIntentCreateUsingPaymentIntentInputParam;
    }
    export interface CreateVoucherPaymentSourceInputParam {
      customer_id: string;
      voucher_payment_source?: VoucherPaymentSourceCreateVoucherPaymentSourceInputParam;
    }
    export interface CreateCardInputParam {
      customer_id: string;
      replace_primary_payment_source?: boolean;
      card?: CardCreateCardInputParam;
    }
    export interface CreateBankAccountInputParam {
      customer_id: string;
      issuing_country?: string;
      replace_primary_payment_source?: boolean;
      bank_account?: BankAccountCreateBankAccountInputParam;
    }
    export interface UpdateCardInputParam {
      gateway_meta_data?: any;
      reference_transaction?: string;
      card?: CardUpdateCardInputParam;
    }
    export interface UpdateBankAccountInputParam {
      bank_account?: BankAccountUpdateBankAccountInputParam;
    }
    export interface VerifyBankAccountInputParam {
      amount1: number;
      amount2: number;
    }
    export interface ListInputParam {
      limit?: number;
      offset?: string;
      subscription_id?: string;
      include_deleted?: boolean;
      customer_id?: filter.String;
      type?: filter.Enum;
      status?: filter.Enum;
      updated_at?: filter.Timestamp;
      created_at?: filter.Timestamp;
      'sort_by[asc]'?: string;
      'sort_by[desc]'?: string;
    }
    export interface SwitchGatewayAccountInputParam {
      gateway_account_id: string;
    }
    export interface ExportPaymentSourceInputParam {
      gateway_account_id: string;
    }
    export interface BillingAddressCreateUsingPermanentTokenInputParam {
      first_name?: string;
      last_name?: string;
      email?: string;
      line1?: string;
      line2?: string;
      line3?: string;
      city?: string;
      state_code?: string;
      state?: string;
      zip?: string;
      country?: string;
    }
    export interface CardCreateUsingPermanentTokenInputParam {
      last4?: string;
      iin?: string;
      expiry_month?: number;
      expiry_year?: number;
      brand?:
        | 'visa'
        | 'mastercard'
        | 'american_express'
        | 'discover'
        | 'jcb'
        | 'diners_club'
        | 'other'
        | 'bancontact'
        | 'cmr_falabella'
        | 'tarjeta_naranja'
        | 'nativa'
        | 'cencosud'
        | 'cabal'
        | 'argencard'
        | 'elo'
        | 'hipercard'
        | 'carnet'
        | 'rupay'
        | 'maestro'
        | 'dankort'
        | 'cartes_bancaires';
      funding_type?: 'credit' | 'debit' | 'prepaid' | 'not_known';
    }

    export interface PaymentIntentCreateUsingPaymentIntentInputParam {
      id?: string;
      gateway_account_id?: string;
      gw_token?: string;
      payment_method_type?:
        | 'card'
        | 'ideal'
        | 'sofort'
        | 'bancontact'
        | 'google_pay'
        | 'dotpay'
        | 'giropay'
        | 'apple_pay'
        | 'upi'
        | 'netbanking_emandates'
        | 'paypal_express_checkout'
        | 'direct_debit'
        | 'boleto'
        | 'venmo'
        | 'amazon_payments'
        | 'pay_to'
        | 'faster_payments'
        | 'sepa_instant_transfer'
        | 'klarna_pay_now'
        | 'online_banking_poland'
        | 'payconiq_by_bancontact';
      reference_id?: string;
      /**
       * @deprecated Please refer API docs to use other attributes
       */
      gw_payment_method_id?: string;
      additional_info?: any;
      additional_information?: any;
    }

    export interface VoucherPaymentSourceCreateVoucherPaymentSourceInputParam {
      voucher_type: VoucherTypeEnum;
      gateway_account_id?: string;
      tax_id?: string;
      billing_address?: any;
    }

    export interface CardCreateCardInputParam {
      gateway_account_id?: string;
      first_name?: string;
      last_name?: string;
      number: string;
      expiry_month: number;
      expiry_year: number;
      cvv?: string;
      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
      billing_addr1?: string;
      billing_addr2?: string;
      billing_city?: string;
      billing_state_code?: string;
      billing_state?: string;
      billing_zip?: string;
      billing_country?: string;
      additional_information?: any;
    }

    export interface BankAccountCreateBankAccountInputParam {
      gateway_account_id?: string;
      iban?: string;
      first_name?: string;
      last_name?: string;
      company?: string;
      email?: string;
      phone?: string;
      bank_name?: string;
      account_number?: string;
      routing_number?: string;
      bank_code?: string;
      account_type?: AccountTypeEnum;
      account_holder_type?: AccountHolderTypeEnum;
      echeck_type?: EcheckTypeEnum;
      swedish_identity_number?: string;
      billing_address?: any;
    }

    export interface CardUpdateCardInputParam {
      first_name?: string;
      last_name?: string;
      expiry_month?: number;
      expiry_year?: number;
      billing_addr1?: string;
      billing_addr2?: string;
      billing_city?: string;
      billing_zip?: string;
      billing_state_code?: string;
      billing_state?: string;
      billing_country?: string;
      additional_information?: any;
    }

    export interface BankAccountUpdateBankAccountInputParam {
      first_name?: string;
      last_name?: string;
      email?: string;
    }
  }
}