Function PayerInvitesApiFactory

Returns {
    acceptPayerInvite(paymentInviteAcceptCreateDeets?: PaymentInviteAcceptCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PayerInviteResponse>;
    getPayerInviteById(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PayerInviteResponse>;
    getPayerInviteProfile(options?: RawAxiosRequestConfig): AxiosPromise<PayerInviteProfileResponse>;
    listPayerInvites(emailAddress?: string, inviteStatus?: PayerInviteStatus, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PayerInviteResponseListResponse>;
    sendPayerInvite(paymentInviteCreateDeets?: PaymentInviteCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PayerInviteResponse>;
}

• acceptPayerInvite:function

  • acceptPayerInvite(paymentInviteAcceptCreateDeets?, options?): AxiosPromise<PayerInviteResponse>

  • summary Accept payer invite

    Parameters

    • OptionalpaymentInviteAcceptCreateDeets: PaymentInviteAcceptCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PayerInviteResponse>

    Throws

• getPayerInviteById:function

  • getPayerInviteById(id, options?): AxiosPromise<PayerInviteResponse>

  • summary Get payer invite details by id

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PayerInviteResponse>

    Throws

• getPayerInviteProfile:function

  • getPayerInviteProfile(options?): AxiosPromise<PayerInviteProfileResponse>

  • summary Get the current user payer profile

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PayerInviteProfileResponse>

    Throws

• listPayerInvites:function

  • listPayerInvites(emailAddress?, inviteStatus?, limit?, page?, userId?, options?): AxiosPromise<PayerInviteResponseListResponse>

  • summary Retrieve a list of sent payer invites

    Parameters

    • OptionalemailAddress: string
    • OptionalinviteStatus: PayerInviteStatus

      sent accepted expired
    • 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 AxiosPromise<PayerInviteResponseListResponse>

    Throws

• sendPayerInvite:function

  • sendPayerInvite(paymentInviteCreateDeets?, options?): AxiosPromise<PayerInviteResponse>

  • summary Send payer invite request.

    Parameters

    • OptionalpaymentInviteCreateDeets: PaymentInviteCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PayerInviteResponse>

    Throws