Function OrchestrationsApiAxiosParamCreator

OrchestrationsApi - axios parameter creator export

  • OrchestrationsApiAxiosParamCreator(configuration?): {
        orchectrationsATTACHFunding: ((id: string, fundingAttachDeets?: FundingAttachDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsATTACHPaymentPush: ((id: string, paymentPushCreateDeets?: PaymentPushCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsCREATE: ((orchestrationCreateDeets?: OrchestrationCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsGETById: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsGETList: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsRUNFunding: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsRUNPayments: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        orchectrationsATTACHFunding: ((id: string, fundingAttachDeets?: FundingAttachDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsATTACHPaymentPush: ((id: string, paymentPushCreateDeets?: PaymentPushCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsCREATE: ((orchestrationCreateDeets?: OrchestrationCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsGETById: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsGETList: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsRUNFunding: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        orchestrationsRUNPayments: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • orchectrationsATTACHFunding: ((id: string, fundingAttachDeets?: FundingAttachDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Throws

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

        • Parameters

          • id: string

            The Orchestration ID

          • OptionalfundingAttachDeets: FundingAttachDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • orchestrationsATTACHPaymentPush: ((id: string, paymentPushCreateDeets?: PaymentPushCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Throws

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

        • Parameters

          • id: string

            The Orchestration Identifier

          • OptionalpaymentPushCreateDeets: PaymentPushCreateDeets

            The payment push details

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • orchestrationsCREATE: ((orchestrationCreateDeets?: OrchestrationCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      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`

      Throws

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

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

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • orchestrationsGETList: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      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`

      Throws

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

        • 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<RequestArgs>

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

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

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      summary Runs the payments phase for the specified Orchestration

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility