Class OrchestrationsApi

OrchestrationsApi - object-oriented interface export OrchestrationsApi

Hierarchy (view full)

BaseAPI
- OrchestrationsApi

Index

Constructors

constructor

new OrchestrationsApi(configuration?, basePath?, axios?): OrchestrationsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns OrchestrationsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

orchectrationsATTACHFunding

orchectrationsATTACHFunding(id, fundingAttachDeets?, options?): Promise<AxiosResponse<Orchestration, any>>
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<AxiosResponse<Orchestration, any>>
Throws
memberof OrchestrationsApi
- Defined in src/api/api.ts:18677

orchestrationsATTACHPaymentPush

orchestrationsATTACHPaymentPush(id, paymentPushCreateDeets?, options?): Promise<AxiosResponse<Orchestration, any>>
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<AxiosResponse<Orchestration, any>>
Throws
memberof OrchestrationsApi
- Defined in src/api/api.ts:18690

orchestrationsCREATE

orchestrationsCREATE(orchestrationCreateDeets?, options?): Promise<AxiosResponse<Orchestration, any>>
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<AxiosResponse<Orchestration, any>>
Throws
memberof OrchestrationsApi
- Defined in src/api/api.ts:18702

orchestrationsGETById

orchestrationsGETById(id, options?): Promise<AxiosResponse<Orchestration, any>>
Returns a single Orchestration if found summary Retrieve an Orchestration by ID
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Orchestration, any>>
Throws
memberof OrchestrationsApi
- Defined in src/api/api.ts:18714

orchestrationsGETList

orchestrationsGETList(limit?, page?, userId?, options?): Promise<AxiosResponse<Orchestration[], any>>
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<AxiosResponse<Orchestration[], any>>
Throws
memberof OrchestrationsApi
- Defined in src/api/api.ts:18728

orchestrationsRUNFunding

orchestrationsRUNFunding(id, options?): Promise<AxiosResponse<OrchestrationRun, any>>
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<AxiosResponse<OrchestrationRun, any>>
Throws
memberof OrchestrationsApi
- Defined in src/api/api.ts:18740

orchestrationsRUNPayments

orchestrationsRUNPayments(id, options?): Promise<AxiosResponse<OrchestrationRun, any>>
summary Runs the payments phase for the specified Orchestration
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<OrchestrationRun, any>>
Throws
memberof OrchestrationsApi
- Defined in src/api/api.ts:18752

Class OrchestrationsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OrchestrationsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

orchectrationsATTACHFunding

Parameters

Returns Promise<AxiosResponse<Orchestration, any>>

Throws

orchestrationsATTACHPaymentPush

Parameters

Returns Promise<AxiosResponse<Orchestration, any>>

Throws

orchestrationsCREATE

Parameters

Returns Promise<AxiosResponse<Orchestration, any>>

Throws

orchestrationsGETById

Parameters

Returns Promise<AxiosResponse<Orchestration, any>>

Throws

orchestrationsGETList

Parameters

Returns Promise<AxiosResponse<Orchestration[], any>>

Throws

orchestrationsRUNFunding

Parameters

Returns Promise<AxiosResponse<OrchestrationRun, any>>

Throws

orchestrationsRUNPayments

Parameters

Returns Promise<AxiosResponse<OrchestrationRun, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration