PaymentsApi - functional programming interface export

  • Parameters

    Returns {
        apiPaymentsCreatePaymentIntentPost(paymentIntentRequestDeets?: PaymentIntentRequestDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        cancelPayment(id: string, paymentCancelDeets?: PaymentCancelDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>;
        getPayment(id: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>;
        getPaymentsByTransactionId(transactionId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment[]>)>;
        getPendingPayments(status?: AcceptPaymentStatusEnum, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PersonaPendingPaymentsResponseListResponse>)>;
        getTransactionStatuses(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>)>;
        getVirtualReceivingAccount(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualReceivingAccountInfo>)>;
        hasPaymentsOrContacts(xCaller?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>;
        listPayments(orchestrationId?: string, paymentSource?: PaymentSourceEnum, paymentSourceId?: string, paymentAcceptStatuses?: AcceptPaymentStatusEnum[], limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentListResponse>)>;
        searchPayments(minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], paymentTypes?: 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentListResponse>)>;
        updatePaymentDetails(id: string, paymentDetailsUpdateDeets?: PaymentDetailsUpdateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>;
        updatePendingPayments(paymentAcceptDeets?: PaymentAcceptDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>;
    }

    • apiPaymentsCreatePaymentIntentPost:function
      • summary Test method for invoice payment intent generation

        Parameters

        • OptionalpaymentIntentRequestDeets: PaymentIntentRequestDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • cancelPayment:function
      • summary Cancel a payment

        Parameters

        • id: string
        • OptionalpaymentCancelDeets: PaymentCancelDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>

    • getPayment:function
      • Returns a single payment if found summary Retrieve a payment by ID

        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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>

    • getPaymentsByTransactionId:function
      • Returns a list of payments if found summary Retrieves all payments for a transaction id

        Parameters

        • transactionId: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment[]>)>

    • getPendingPayments:function
      • summary List aggregated Pending or Suspended payments

        Parameters

        • Optionalstatus: AcceptPaymentStatusEnum

          pending accepted suspended

        • 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PersonaPendingPaymentsResponseListResponse>)>

    • getTransactionStatuses:function
      • summary List Transaction Statuses

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>)>

    • getVirtualReceivingAccount:function
      • summary Retrieve Customer Virtual Receiving Account

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualReceivingAccountInfo>)>

    • hasPaymentsOrContacts:function
      • Returns a true/false for any payment or contact if found summary Retrieve if has any payment or contact. Only use this to detect if the user should be sent to the waitlist. Do not use it to check if the user currently has payments or contacts as the results are cached in AccountSettings.

        Parameters

        • OptionalxCaller: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>)>

    • listPayments:function
      • summary Retrieve a list of payments

        Parameters

        • OptionalorchestrationId: string

          The id of the payment cycle for which to list the payments

        • 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentListResponse>)>

    • searchPayments:function
      • summary Search payments (e.g. between dates, amounts, etc.)

        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

        • OptionalpaymentTypes: string[]

          A list of payment types 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentListResponse>)>

    • updatePaymentDetails:function
      • Updates a Payment

        summary Update a Payment Details

        Parameters

        • id: string
        • OptionalpaymentDetailsUpdateDeets: PaymentDetailsUpdateDeets

          PaymentDetails_UpdateDeets

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>

    • updatePendingPayments:function
      • summary Accept or Suspend payments from an account.

        Parameters

        • OptionalpaymentAcceptDeets: PaymentAcceptDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Payment>)>