Payment API

1.API xác nhận voucher

GET: /api/payments/voucher/validate

Validate voucher cho booking cụ thể

Request Body

Model

Request Body
  • bookingNumber (String, Required)

    Mã định danh booking

  • voucherCode (String, Required)

    Mã giảm giá

Example

Response

Code 200

OK

Model

Model

Chỉ định danh những trường/field cần thiết

  • bookingNumber (String)

    Mã định dang booking

  • discountAmount (Double)

    Số tiền giảm

  • trackingCode (String)

    Mã định danh cho booking có voucher

  • voucherCode (String)

    Mã giảm giá

  • voucherValid (Boolean)

    Mã giảm giá hợp lệ

  • duration (Integer, Optional),

  • errors (Array[Error], Optional),

  • infos (Array[Info], Optional),

  • success (Boolean, Optional),

  • textMessage (String, Optional)


2.API xác nhận sử dụng voucher

GET: /api/payments/voucher/redeem

Redeem voucher cho booking cụ thể

Request Body

Model

Request Body
  • bookingNumber (String, Required)

    Mã định danh booking

  • voucherCode (String, Required)

    Mã giảm giá

  • trackingCode (String, Required)

    Mã tracking sử dụng ở api validate

Example

Response

Code 200

OK

Model

Model

Chỉ định danh những trường/field cần thiết

  • bookingNumber (String)

    Mã định dang booking

  • redeemValid (Boolean)

    Xác nhận sử dụng voucher thành công

  • voucherCode (String)

    Mã giảm giá

  • duration (Integer, Optional),

  • errors (Array[Error], Optional),

  • infos (Array[Info], Optional),

  • success (Boolean, Optional),

  • textMessage (String, Optional)


3. API Yêu cầu thanh toán booking

GET: /api/partner/place-order

Yêu cầu thanh toán booking - khởi tạo payment order

Chú ý

Yêu cầu bảo mật: Mã hóa dữ liệu và kèm theo chữ ký điện tử

  • Request: Không yêu cầu phải được mã hóa và kèm theo chữ ký điện tử

  • Response: Một phần dữ liệu của respond được yêu cầu phải mã hóa và kèm theo chữ ký điện tử

Parameters

Parameters
  • bookingNumber query (string, required),

    Mã tham chiếu đến booking

Response

Code 200

OK

Model

Model
  • result (String, optional),

    Thông tin trả về dưới định dạng:

    <payment_url>?key=<encrypted_key>?data=<encrypted_data>

    Signature data schema:

    <access_code>|<booking_number>|<product_type>|<total_amount>

    Original data schema:

    <access_code>|<booking_number>|<product_type>|<signature>|<total_amount>
    • access_code (String, required)

      Access code do Gotadi cung cấp cho Đối tác.

    • bookingNumber (String, optional)

      Mã dùng tham chiếu đến booking

    • product_type (String, optional)

      Loại sản phẩm, có giá trị là AIR hoặc HOTEL tương ứng với loại sản phẩm được mua

    • total_amount (String, optional)

      Tổng số tiền phải thanh toán

    • payment_url (String, required)

      Đường dẫn đến trang thanh toán

    • encrypted_key (String, required)

      Key giải mã dữ liệu (đã được mã hóa). Cách giải mã tham khảo mục: Mã hóa dữ liệu truyền và xác thực chữ ký điện tử

    • encrypted_data (String, required)

      Dữ liệu kèm theo chữ ký điện tử (đã được mã hóa). Cách giải mã tham khảo mục: Mã hóa dữ liệu truyền và xác thực chữ ký điện tử

  • duration (integer, optional),

  • errors (Array[Error], optional),

  • infos (Array[Info], optional),

  • success (boolean, optional),

  • textMessage (string, optional)


4. API Ghi nhận thanh toán và commit booking

POST: /api/partner/commit

Yêu cầu commit booking được cập nhật đầy đủ thông tin và hoàn tất thanh toán

Chú ý

Yêu cầu bảo mật: Mã hóa dữ liệu và kèm theo chữ ký điện tử

  • Request: Không yêu cầu phải được mã hóa và kèm theo chữ ký điện tử

  • Response: Một phần dữ liệu của response được yêu cầu phải mã hóa và kèm theo chữ ký điện tử

Request Body

Model

Model
  • key (string, required),

    Key giải mã dữ liệu (đã được mã hóa). Cách giải mã tham khảo mục: Mã hóa dữ liệu truyền và xác thực chữ ký điện tử

  • data (string, required),

    Dữ liệu kèm theo chữ ký điện tử (đã được mã hóa). Cách giải mã tham khảo mục: Mã hóa dữ liệu truyền và xác thực chữ ký điện tử

    Signature data schema:

    <access_code>|<booking_number>|<partner_trans_id>|<product_type>

    Original data schema:

    <access_code>|<booking_number>|<partner_trans_id>|<product_type>|<signature>
    • access_code (String, required)

      Access code do Gotadi cung cấp cho Đối tác.

    • bookingNumber (String, required)

      Mã dùng tham chiếu đến booking

    • partner_trans_id (String, optional)

      Mã định danh giao dịch của đối tác. Nếu đối tác không truyền giá trị cho trường này, giá trị mặc định sẽ được gán bằng booking_number

    • product_type (String, required)

      Loại sản phẩm, có giá trị là AIR hoặc HOTEL tương ứng với loại sản phẩm được mua

Response

Code 200

OK

Model
  • key (String, required)

    Key giải mã dữ liệu (đã được mã hóa). Cách giải mã tham khảo mục: Mã hóa dữ liệu truyền và xác thực chữ ký điện tử

  • data (String, required)

    Dữ liệu kèm theo chữ ký điện tử (đã được mã hóa). Cách giải mã tham khảo mục: Mã hóa dữ liệu truyền và xác thực chữ ký điện tử

    Signature data schema:

    <access_code>|<booking_number>|<error_code>|<product_type>|<properties>|<return_url>|<total_amount>

    Original data schema:

    <access_code>|<booking_number>|<error_code>|<product_type>|<properties>|<return_url>|<signature>|<total_amount>
    • access_code (String, required)

      Access code do Gotadi cung cấp cho Đối tác.

    • booking_number (String, required)

      Mã dùng tham chiếu đến booking

    • error_code (String, required)

      Mã lỗi

    • product_type (String, optional)

      Loại sản phẩm, có giá trị là AIR hoặc HOTEL tương ứng với loại sản phẩm được mua

    • properties (String, optional)

      Các thông tin mở rộng trả về cho đối tác. Json string

    • return_url (String, optional)

      Trang hiển thị kết quả giao dịch của Gotadi. Sử dụng trong trường hợp đối tác không tự xây dựng trang hiển thị kết quả cuối cùng.

    • total_amount (Double, required)

      Tổng số tiền phải thanh toán.

Last updated