Transaction API

Api transaction dùng để lấy thông tin về các lịch sử thanh toán hoặc hoàn hủy phí vận chuyển theo vận đơn. Sử dụng API này để liệt kê và tìm kiếm thông tin về lịch sử giao dịch phí vận chuyển.

Lấy tất cả thông tin

GET http://sandbox.goship.io/api/v2/transactions

Response data:

{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id": "9293C9889259AE9",
      "amount": 40000,
      "description": "Nạp tiền vào tài khoản qua Bảo Kim",
      "opening_debit": 300000,
      "closing_debit": 340000,
      "created_at": "03\/12\/2016 05:26"
    },
    {
      "id": "GSox6or6q5",
      "amount": 17600,
      "description": "Thanh toán phí vận đơn GS3y6xj58k",
      "opening_debit": 40000,
      "closing_debit": 22400,
      "created_at": "05\/12\/2016 06:40"
    }
  ]
}

Trong đó:

id: Mã giao dịch
amount: Số tiền tiền giao dịch
description : Mô tả về giao dịch
opening_debit : Thông tin số tiền đầu kỳ (trước giao dịch)
closing_debit : Thông tin số tiền cuối kỳ (sau giao dịch)
created_at: Thời gian phát sinh giao dịch

Phân trang:

Mặc định url này sẽ trả về 25 bản ghi, để lấy nhiều hơn hoặc ít hơn 25 bản ghi mặc định, chúng ta sử dụng tham số size trên query string, ví dụ:

GET http://sandbox.goship.io/api/v2/transactions?size=30

Để di chuyển giữa các trang, chúng ta sử dụng tham số page trên query string

GET http://sandbox.goship.io/api/v2/transactions?size=30&page=2

Tìm kiếm giao dịch

Chúng ta sử dụng tham số code trên query string để tìm kiếm cụ thể 1 giao dịch. code là mã giao dịch.

GET http://sandbox.goship.io/api/v2/transactions?code=GSox6or6q5

Hoặc tìm kiếm 1 danh sách các phiên đối soát theo thời gian sử dụng tham số from và to

from: Integer - Thời gian bắt đầu
to: Integer - Thời gian kết thúc

GET http://sandbox.goship.io/api/v2/transactions?from=12345678&to=87654321

Sử dụng phân trang tương tự như API Lấy tất cả phiên chuyển COD.

Tham khảo tài liệu mô tả về Phân trang