Function OrchestrationsApiFp

Returns {
    orchectrationsATTACHFunding(id: string, fundingAttachDeets?: FundingAttachDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>;
    orchestrationsATTACHPaymentPush(id: string, paymentPushCreateDeets?: PaymentPushCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>;
    orchestrationsCREATE(orchestrationCreateDeets?: OrchestrationCreateDeets, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>;
    orchestrationsGETById(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>;
    orchestrationsGETList(limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration[]>)>;
    orchestrationsRUNFunding(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrchestrationRun>)>;
    orchestrationsRUNPayments(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrchestrationRun>)>;
}

• orchectrationsATTACHFunding:function

  • orchectrationsATTACHFunding(id, fundingAttachDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>

  • summary Attach a funding source to an Orchestration. This defines funding origin.

    Parameters

    • id: string

      The Orchestration ID
    • OptionalfundingAttachDeets: FundingAttachDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• orchestrationsATTACHPaymentPush:function

  • orchestrationsATTACHPaymentPush(id, paymentPushCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>

  • summary Attaches a payment push to an Orchestration in a pending state.

    Parameters

    • id: string

      The Orchestration Identifier
    • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets

      The payment push details
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• orchestrationsCREATE:function

  • orchestrationsCREATE(orchestrationCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>

  • Orchestrations greatly simplify payment routines and facilitate split payments. Orchestrations can import sales data, distill catalog information, requests payments, send payouts, and automatically reconcile funding with just a few API calls.

    summary Create an `Orchestration`

    Parameters

    • OptionalorchestrationCreateDeets: OrchestrationCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• orchestrationsGETById:function

  • orchestrationsGETById(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration>)>

  • Returns a single Orchestration if found summary Retrieve an Orchestration by ID

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• orchestrationsGETList:function

  • orchestrationsGETList(limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Orchestration[]>)>

  • An Orchestration represents the lifecycle of moving funds from start to finish. Once an Orchestration completes, it provides the resulting invoices and payment ledgers for double-entry accounting.

    summary Retrieve a list of `Orchestrations`

    Parameters

    • 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<Orchestration[]>)>

    Throws

• orchestrationsRUNFunding:function

  • orchestrationsRUNFunding(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrchestrationRun>)>

  • This phase behaves differently depending on the mode. summary Runs the funding phase for an Orchestration

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• orchestrationsRUNPayments:function

  • orchestrationsRUNPayments(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrchestrationRun>)>

  • summary Runs the payments phase for the specified Orchestration

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws