BokaMera.API.Host

<back to all web services

PaymentSettingsQuery

export class AdminPaymentOptionsResponse
{
    /** @description The payment options id */
    // @ApiMember(Description="The payment options id")
    public Id: number;

    /** @description The payment options name */
    // @ApiMember(Description="The payment options name")
    public Name: string;

    /** @description The payment options description */
    // @ApiMember(Description="The payment options description")
    public Description: string;

    public constructor(init?: Partial<AdminPaymentOptionsResponse>) { (Object as any).assign(this, init); }
}

export class PaymentProviderOptionsResponse
{
    /** @description The payment provider id */
    // @ApiMember(Description="The payment provider id")
    public Id: number;

    /** @description The payment provider name */
    // @ApiMember(Description="The payment provider name")
    public Name: string;

    /** @description The payment provider description */
    // @ApiMember(Description="The payment provider description")
    public Description: string;

    public constructor(init?: Partial<PaymentProviderOptionsResponse>) { (Object as any).assign(this, init); }
}

export class PaymentSettingsQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description The payment is enabled */
    // @ApiMember(Description="The payment is enabled")
    public Enabled: boolean;

    /** @description Automatically refund customer on canceled booking */
    // @ApiMember(Description="Automatically refund customer on canceled booking")
    public RefundOnCancelBooking: boolean;

    /** @description The default option when admin creates a new booking */
    // @ApiMember(Description="The default option when admin creates a new booking")
    public DefaultPaymentOptionId?: number;

    /** @description What payment provider to use */
    // @ApiMember(Description="What payment provider to use")
    public PaymentProviderId: number;

    /** @description If you want to include the admin payment options to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the admin payment options to select from", ParameterType="query")
    public AdminPaymentOptions: AdminPaymentOptionsResponse[] = [];

    /** @description If you want to include the payment provider options to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the payment provider options to select from", ParameterType="query")
    public PaymentProviderOptions: PaymentProviderOptionsResponse[] = [];

    public constructor(init?: Partial<PaymentSettingsQueryResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class PaymentSettingsQuery implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description If you want to include the admin payment options to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the admin payment options to select from")
    public IncludeAdminPaymentOptions: boolean;

    /** @description If you want to include the payment provider options to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the payment provider options to select from")
    public IncludePaymentProviderOptions: boolean;

    public constructor(init?: Partial<PaymentSettingsQuery>) { (Object as any).assign(this, init); }
}

TypeScript PaymentSettingsQuery DTOs

GET /payment/settings HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Enabled: False,
	RefundOnCancelBooking: False,
	DefaultPaymentOptionId: 0,
	PaymentProviderId: 0,
	AdminPaymentOptions: 
	[
		{
			Id: 0,
			Name: String,
			Description: String
		}
	],
	PaymentProviderOptions: 
	[
		{
			Id: 0,
			Name: String,
			Description: String
		}
	]
}