Class Payments

Index

Methods

As Create CreateTransaction Delete DeleteTransaction Get List Patch

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
Payments.As().List() // lists Payments using the impersonated users' token
```
- Defined in api/Payments.ts:207

Create

Create<TPayment extends Payment<any, any>>(
    direction: OrderDirection,
    orderID: string,
    payment: Payment,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TPayment>>
Create a payment Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any>
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- payment: Payment
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TPayment>>
- Defined in api/Payments.ts:70

CreateTransaction

CreateTransaction<TPayment extends Payment<any, any>>(
    direction: OrderDirection,
    orderID: string,
    paymentID: string,
    paymentTransaction: PaymentTransaction,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TPayment>>
Create a payment transaction Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any>
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- paymentID: string
  ID of the payment.
- paymentTransaction: PaymentTransaction
  Required fields: Type, DateExecuted
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TPayment>>
- Defined in api/Payments.ts:164

Delete

Delete(
    direction: OrderDirection,
    orderID: string,
    paymentID: string,
    requestOptions?: RequestOptions,
): Promise<void>
Delete a payment Check out the docs for more info
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- paymentID: string
  ID of the payment.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Payments.ts:116

DeleteTransaction

DeleteTransaction(
    direction: OrderDirection,
    orderID: string,
    paymentID: string,
    transactionID: string,
    requestOptions?: RequestOptions,
): Promise<void>
Delete a payment transaction Check out the docs for more info
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- paymentID: string
  ID of the payment.
- transactionID: string
  ID of the transaction.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Payments.ts:188

Get

Get<TPayment extends Payment<any, any>>(
    direction: OrderDirection,
    orderID: string,
    paymentID: string,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TPayment>>
Retrieve a payment Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any>
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- paymentID: string
  ID of the payment.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TPayment>>
- Defined in api/Payments.ts:93

List

List<TPayment extends Payment<any, any>>(
    direction: OrderDirection,
    orderID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Description")[];
        sortBy?: (
            | "ID"
            | "DateCreated"
            | "!ID"
            | "!DateCreated"
            | "Type"
            | "CreditCardID"
            | "SpendingAccountID"
            | "!Type"
            | "!CreditCardID"
            | "!SpendingAccountID"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TPayment>>>
List payments Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any>
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Description")[];
      sortBy?: (
          | "ID"
          | "DateCreated"
          | "!ID"
          | "!DateCreated"
          | "Type"
          | "CreditCardID"
          | "SpendingAccountID"
          | "!Type"
          | "!CreditCardID"
          | "!SpendingAccountID"
      )[];
  } = {}
  - Optionalfilters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optionalpage?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "DateCreated"
        | "!ID"
        | "!DateCreated"
        | "Type"
        | "CreditCardID"
        | "SpendingAccountID"
        | "!Type"
        | "!CreditCardID"
        | "!SpendingAccountID"
    )[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TPayment>>>
- Defined in api/Payments.ts:47

Patch

Patch<TPayment extends Payment<any, any>>(
    direction: OrderDirection,
    orderID: string,
    paymentID: string,
    payment: PartialDeep<Payment>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TPayment>>
Partially update a payment PUT is not a supported method for payments due to the implications associated with modifying certain properties. Patch is only permitted on certain properties that vary depending on order status Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any>
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- paymentID: string
  ID of the payment.
- payment: PartialDeep<Payment>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TPayment>>
- Defined in api/Payments.ts:140

Class Payments

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TPayment>>

CreateTransaction

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TPayment>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

DeleteTransaction

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TPayment>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: ("ID" | "Description")[]

OptionalsortBy?: ( | "ID" | "DateCreated" | "!ID" | "!DateCreated" | "Type" | "CreditCardID" | "SpendingAccountID" | "!Type" | "!CreditCardID" | "!SpendingAccountID")[]

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TPayment>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TPayment>>

Settings

On This Page

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`filters?: Filters

`Optional`page?: number

`Optional`pageSize?: number

`Optional`search?: string

`Optional`searchOn?: ("ID" | "Description")[]

`Optional`sortBy?: (
| "ID"
| "DateCreated"
| "!ID"
| "!DateCreated"
| "Type"
| "CreditCardID"
| "SpendingAccountID"
| "!Type"
| "!CreditCardID"
| "!SpendingAccountID"
)[]

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string