Module src/UalaApiCheckout

Type declaration

• createOrder: ((NewOrderParams: NewOrderParams) => Promise<NewOrder>)

  • • (NewOrderParams: NewOrderParams): Promise<NewOrder>

    • Create an order that you can use to make a sale.

      Description

      more information https://developers.ualabis.com.ar/orders/create-order/post

      Example

      const order = await createOrder({
         amount: 10.2,
         description: 'your description',
         callbackSuccess: 'https://www.google.com/search?q=failed',
         callbackFail: 'https://www.google.com/search?q=success',
      });
      

      Parameters

      • NewOrderParams: NewOrderParams

        the params to create a order

      Returns Promise<NewOrder>

• getFailedNotifications: (() => Promise<default>)

  • • (): Promise<default>

    • Get a list of failed notifications via webhook that could not be completed with HTTP Status 200

      Description

      more information https://developers.ualabis.com.ar/notifications/failed-notifications/failed *

      Example

      const failedNotifications = await getFailedNotifications();
      

      Returns

      the failded notifications

      Returns Promise<default>

• getOrder: ((orderId: string) => Promise<OrderData>)

  • • (orderId: string): Promise<OrderData>

    • Gets a previously created order with unique identifier.

      Description

      more information https://developers.ualabis.com.ar/orders/get-order/get/order

      Example

      const order = await getOrder('d5894497-7');
      

      Returns

      the previously created order

      Parameters

      • orderId: string

        the order id

      Returns Promise<OrderData>

• getOrders: ((orderSearchParameters?: OrderSearchParams) => Promise<OrderData[]>)

  • • (orderSearchParameters?: OrderSearchParams): Promise<OrderData[]>

    • Get a list of orders that be created

      Description

      more information https://developers.ualabis.com.ar/orders/get-order/gets/orders

      Example

      // Gets first 100 orders with creation dates between 2022-08-04 and 2022-08-09
         const orders = await getOrders({limit:'1', fromDate:'2022-08-04', toDate:'2022-08-09'});
      

      Returns

      the orders

      Parameters

      • Optional orderSearchParameters: OrderSearchParams

        params to search and filter orders - not required

      Returns Promise<OrderData[]>

• setUp: ((setUpConfig: SetUpTypes) => Promise<void>)

  • • (setUpConfig: SetUpTypes): Promise<void>

    • Config with your params to auth

      Parameters

      • setUpConfig: SetUpTypes

        the params to auth

      Returns Promise<void>