Options
All
  • Public
  • Public/Protected
  • All
Menu

API Operations for Payments

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Api(axios: AxiosInstance): Api

Properties

Protected axios

axios: AxiosInstance

Methods

create

  • Request a new payment against a reservation

    Parameters

    • reservationId: number

      ID of the reservation to add the payment to

    • payment: CreatePaymentRequest

      Paramters for the payment

    Returns Promise<CreatePaymentResponse>

finalize

  • finalize(reservationId: number, paymentId: string): Promise<Payment>
  • Finalize an existing payment.

    Parameters

    • reservationId: number

      ID of the reservation the payment is against

    • paymentId: string

      ID of the payment to finalize

    Returns Promise<Payment>

find

  • find(reservationId: number, id: number): Promise<Payment>
  • Parameters

    • reservationId: number
    • id: number

    Returns Promise<Payment>

Generated using TypeDoc