Function TransactionsApiAxiosParamCreator

TransactionsApi - axios parameter creator export

  • TransactionsApiAxiosParamCreator(configuration?): {
        getTransactionById: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        listTransactions: ((paymentSource?: PaymentSourceEnum, paymentSourceId?: string, paymentAcceptStatuses?: AcceptPaymentStatusEnum[], limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        searchTransactions: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toIsAcceptedContact?: boolean, toCountryCode?: string, toExternalId?: string, toAvatar?: AvatarSize[], toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        getTransactionById: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        listTransactions: ((paymentSource?: PaymentSourceEnum, paymentSourceId?: string, paymentAcceptStatuses?: AcceptPaymentStatusEnum[], limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        searchTransactions: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toIsAcceptedContact?: boolean, toCountryCode?: string, toExternalId?: string, toAvatar?: AvatarSize[], toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getTransactionById: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Returns a single transaction if found summary Retrieve a transaction by ID

      Throws

        • (id, userId?, options?): Promise<RequestArgs>

        • Parameters

          • id: string

            The id of the record you wish to retrieve

          • OptionaluserId: string

            The user id to operate on their behalf (tenants only)

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • listTransactions: ((paymentSource?: PaymentSourceEnum, paymentSourceId?: string, paymentAcceptStatuses?: AcceptPaymentStatusEnum[], limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve a list of transactions

      Throws

        • (paymentSource?, paymentSourceId?, paymentAcceptStatuses?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalpaymentSource: PaymentSourceEnum

            push-payment contract simple-contract payment-cycle tip-link transfer

          • OptionalpaymentSourceId: string
          • OptionalpaymentAcceptStatuses: AcceptPaymentStatusEnum[]
          • Optionallimit: number

            A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

          • Optionalpage: number

            1-based page index for paginated results

          • OptionaluserId: string

            The user id to operate on their behalf (tenants only)

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • searchTransactions: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toIsAcceptedContact?: boolean, toCountryCode?: string, toExternalId?: string, toAvatar?: AvatarSize[], toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Search transactions (payments, payouts) (e.g. between dates, amounts, etc.)

      Throws

        • (minAmount?, maxAmount?, fromDate?, toDate?, statuses?, id?, shortId?, toHandle?, toEmail?, toPhone?, toName?, toPersonaId?, toUserId?, toUserAccountId?, toIsAcceptedContact?, toCountryCode?, toExternalId?, toAvatar?, toId?, toCreated?, toShortId?, toObjectName?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalminAmount: number

            The minimum amount for filtering

          • OptionalmaxAmount: number

            The maximum amount for filtering

          • OptionalfromDate: string

            The starting date for filtering

          • OptionaltoDate: string

            The end date for filtering

          • Optionalstatuses: string[]

            A list of statuses for filtering

          • Optionalid: string
          • OptionalshortId: string
          • OptionaltoHandle: string

            The Mozaic handle for a contact

          • OptionaltoEmail: string

            The email address of the contact

          • OptionaltoPhone: string

            The fully qualified phone number of the contact

          • OptionaltoName: string

            Loosely, the name of the contact. May be changed during registration

          • OptionaltoPersonaId: string

            Specifies the persona associated with this contact record

          • OptionaltoUserId: string

            Specifies the user associated with this contact record

          • OptionaltoUserAccountId: string

            Specifies the user account id associated with this contact record

          • OptionaltoIsAcceptedContact: boolean

            Specifies whether this contact is in network or out of network

          • OptionaltoCountryCode: string
          • OptionaltoExternalId: string
          • OptionaltoAvatar: AvatarSize[]

            contact avatar

          • OptionaltoId: string
          • OptionaltoCreated: string
          • OptionaltoShortId: string
          • OptionaltoObjectName: string

            The name of this object

          • Optionallimit: number

            A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

          • Optionalpage: number

            1-based page index for paginated results

          • OptionaluserId: string

            The user id to operate on their behalf (tenants only)

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility