Class Payments

Hierarchy

Payments

Index

Properties

impersonating

Methods

As Create CreateTransaction Delete DeleteTransaction Get List Patch

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): Payments
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
Payments.As().List() // lists Payments using the impersonated users' token
```
Returns Payments
- Defined in api/Payments.ts:207

Create

Create<TPayment>(direction: OrderDirection, orderID: string, payment: Payment<any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPayment>>
Create a new payment. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any, TPayment>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- payment: Payment<any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPayment>>
- Defined in api/Payments.ts:70

CreateTransaction

CreateTransaction<TPayment>(direction: OrderDirection, orderID: string, paymentID: string, paymentTransaction: PaymentTransaction<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TPayment>>
Create a new payment transaction. Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any, TPayment>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- paymentID: string
  
  ID of the payment.
- paymentTransaction: PaymentTransaction<any>
  
  Required fields: Type, DateExecuted
- requestOptions: RequestOptions = {}
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. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- paymentID: string
  
  ID of the payment.
- requestOptions: RequestOptions = {}
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. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- paymentID: string
  
  ID of the payment.
- transactionID: string
  
  ID of the transaction.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Payments.ts:188

Get

Get<TPayment>(direction: OrderDirection, orderID: string, paymentID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TPayment>>
Get a single payment. Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any, TPayment>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- paymentID: string
  
  ID of the payment.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPayment>>
- Defined in api/Payments.ts:93

List

List<TPayment>(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>>>
Get a list of payments. Check out the docs for more info
Type Parameters
- TPayment extends Payment<any, any, TPayment>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- 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")[];
  } = {}
  - Optional filters?: 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.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "DateCreated" | "!ID" | "!DateCreated" | "Type" | "CreditCardID" | "SpendingAccountID" | "!Type" | "!CreditCardID" | "!SpendingAccountID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TPayment>>>
- Defined in api/Payments.ts:47

Patch

Patch<TPayment>(direction: OrderDirection, orderID: string, paymentID: string, payment: PartialObjectDeep<Payment<any, any>>, 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, TPayment>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- paymentID: string
  
  ID of the payment.
- payment: PartialObjectDeep<Payment<any, any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TPayment>>
- Defined in api/Payments.ts:140

Class Payments

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Payments

Create

Type Parameters

TPayment extends Payment<any, any, TPayment>

Parameters

direction: OrderDirection

orderID: string

payment: Payment<any, any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPayment>>

CreateTransaction

Type Parameters

TPayment extends Payment<any, any, TPayment>

Parameters

direction: OrderDirection

orderID: string

paymentID: string

paymentTransaction: PaymentTransaction<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPayment>>

Delete

Parameters

direction: OrderDirection

orderID: string

paymentID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteTransaction

Parameters

direction: OrderDirection

orderID: string

paymentID: string

transactionID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TPayment extends Payment<any, any, TPayment>

Parameters

direction: OrderDirection

orderID: string

paymentID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPayment>>

List

Type Parameters

TPayment extends Payment<any, any, TPayment>

Parameters

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")[]; } = {}

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")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TPayment>>>

Patch

Type Parameters

TPayment extends Payment<any, any, TPayment>

Parameters

direction: OrderDirection

orderID: string

paymentID: string

payment: PartialObjectDeep<Payment<any, any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TPayment>>

`Private` impersonating

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Description")[];
sortBy?: ("ID" | "DateCreated" | "!ID" | "!DateCreated" | "Type" | "CreditCardID" | "SpendingAccountID" | "!Type" | "!CreditCardID" | "!SpendingAccountID")[];
} = {}

`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")[]