Method: getOrderDetails

รับคำสั่งซื้อที่เป็นพื้นฐานให้แก่พาร์ทเนอร์ของ Google สำหรับการเรียกเก็บเงินของผู้ใช้ปลายทาง

หากปลายทางพบข้อผิดพลาดขณะประมวลผลคำขอ การตอบกลับจากปลายทางนี้จะเป็นประเภท ErrorResponse

การตอบกลับการค้นหานี้อาจว่างเปล่าหากเมธอดนี้ไม่ได้แสดงผล HTTP 200 เนื้อหาการตอบกลับจะว่างเปล่าในกรณีที่สามารถใช้ ErrorResponse พร้อมคำอธิบายที่ชัดเจนเพื่อช่วยให้ผู้โจมตีเข้าใจตัวระบุบัญชีผู้รวมระบบการชำระเงินของผู้รวมบริการรายอื่นๆ ในสถานการณ์เช่นนี้ เมื่อคีย์การรับรองไม่ตรงกัน ไม่พบตัวระบุผู้ผสานการชำระเงิน หรือไม่ทราบคีย์การเข้ารหัส เมธอดนี้จะส่งคืน HTTP 404 ที่มีเนื้อหาว่างเปล่า หากสามารถยืนยันลายเซ็นของคำขอได้ ข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดจะแสดงในเนื้อหาการตอบกลับ

คำขอตัวอย่างมีลักษณะดังนี้


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "HsKv5pvtQKTtz7rdcw1YqE",
    "requestTimestamp": "1519996751331"
  },
  "paymentIntegratorAccountId": "IntegratorFakeAccount",
  "orderLookupCriteria": {
    "googleTransactionReferenceNumberCriteria": {
      "googleTransactionReferenceNumber": "714545417102363157911822",
      "authorizationCode": "111111"
    }
  },
  "requestOriginator": {
    "organizationId": "ISSUER_256",
    "organizationDescription": "Community Bank of Some City"
  }
}

ตัวอย่างการตอบกลับจะมีลักษณะดังนี้


{
  "responseHeader": {
    "responseTimestamp": "1519996752221"
  },
  "result": "SUCCESS",
  "order": {
    "timestamp": "1517992525972",
    "orderId": "UPG.DEFC.X6F4.MEOM.CDWF",
    "currencyCode": "USD",
    "subTotalAmount": "399000000",
    "totalAmount": "459000000",
    "taxes": [],
    "items": [
      {
        "description": "YouTube TV membership",
        "merchant": "fake org",
        "googleProductName": "YouTube TV",
        "quantity": "1",
        "totalPrice": "399000000"
      },
      {
        "description": "Showtime",
        "merchant": "fake org",
        "googleProductName": "YouTube TV",
        "quantity": "1",
        "totalPrice": "6000000"
      }
    ]
  }
}

คำขอ HTTP

POST https://vgw.googleapis.com/secure-serving/gsp/v1/getOrderDetails/:PIAID

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "orderLookupCriteria": {
    object (OrderLookupCriteria)
  },
  "requestOriginator": {
    object (RequestOriginator)
  }
}
ช่อง
requestHeader

object (RequestHeader)

ต้องระบุ: ส่วนหัวทั่วไปสำหรับคำขอทั้งหมด
paymentIntegratorAccountId

string

ต้องระบุ: ตัวระบุบัญชีของผู้รวมการชำระเงินที่ระบุผู้โทรและข้อจำกัดทางสัญญาที่เกี่ยวข้องสำหรับการโต้ตอบนี้
orderLookupCriteria

object (OrderLookupCriteria)

ต้องระบุ: เกณฑ์ที่ระบุลำดับที่ต้องค้นหา
requestOriginator

object (RequestOriginator)

ไม่บังคับ: ข้อมูลเกี่ยวกับองค์กรหรือกลุ่มย่อยขององค์กรที่สร้างคำขอนี้ (หากผู้รวมบริการโทรหาเราในนามขององค์กรอื่น)

เนื้อหาการตอบกลับ

เปย์โหลดการตอบกลับสำหรับเมธอด getOrderDetails

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": enum (GetOrderDetailsResultCode),
  "order": {
    object (Order)
  }
}
ช่อง
responseHeader

object (ResponseHeader)

ต้องระบุ: ส่วนหัวทั่วไปสำหรับคำตอบทั้งหมด
result

enum (GetOrderDetailsResultCode)

ต้องระบุ: ผลของการโทรนี้
order

object (Order)

ไม่บังคับ: ข้อมูลเกี่ยวกับคำสั่งซื้อที่ชำระเงิน (แสดงก็ต่อเมื่อ result สำเร็จเท่านั้น)

RequestHeader

ออบเจ็กต์ส่วนหัวที่กำหนดไว้ในคำขอทั้งหมดที่ส่งไปยังเซิร์ฟเวอร์

การแสดง JSON 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
ช่อง
requestId

string

ต้องระบุ: ตัวระบุที่ไม่ซ้ำกันของคำขอนี้

โดยเป็นสตริงที่มีความยาวสูงสุด 100 อักขระ และมีเฉพาะอักขระ "a-z", "A-Z", "0-9", ":", "-" และ "_" เท่านั้น
requestTimestamp

string (int64 format)

REQUIRED: การประทับเวลาของคำขอนี้ซึ่งแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch ผู้รับควรยืนยันว่าการประทับเวลานี้ ± 60s ของ "now" การประทับเวลาของคำขอนี้จะไม่แสดงซ้ำเมื่อมีการลองอีกครั้ง
userLocale
(deprecated)

string

เลิกใช้งานแล้ว: รหัสภาษา ISO 639-2 Alpha 3 ที่เป็นตัวอักษร 2 หรือ 3 ตัว (ไม่บังคับ) ตามด้วยเครื่องหมายขีดกลางและรหัสประเทศ ISO 3166-1 Alpha-2 เช่น "pt", "pt-BR", "fil" หรือ "fil-PH" ใช้ค่านี้เพื่อช่วยเพิ่มช่อง userMessage ในการตอบสนอง
protocolVersion

object (Version)

ต้องระบุ: เวอร์ชันของคำขอนี้

เวอร์ชัน

ออบเจ็กต์เวอร์ชันซึ่งเป็นรูปแบบที่มีโครงสร้างของโครงสร้างเวอร์ชัน a.b.c แบบคลาสสิก ระบบรับประกันว่าเวอร์ชันหลักของหมายเลขเดียวกันจะใช้งานร่วมกันได้ โปรดทราบว่าการแก้ไขเล็กน้อยและการแก้ไขอาจเปลี่ยนแปลงได้บ่อยครั้งโดยไม่ต้องแจ้งให้ทราบล่วงหน้า ผู้ผสานการทำงานต้องรองรับคำขอทั้งหมดสำหรับเวอร์ชันหลักเดียวกัน

การแสดง JSON 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
ช่อง
major

integer

ต้องระบุ: เวอร์ชันหลัก ซึ่งจะมีการทำเครื่องหมายไว้ว่าสำหรับคำขอความเข้ากันได้ที่มีเวอร์ชันต่างๆ กัน เราไม่รับประกันว่าจะทำงานร่วมกันได้
minor

integer

ต้องระบุ: เวอร์ชันย่อย ซึ่งหมายถึงการแก้ไขข้อบกพร่องที่สำคัญ
revision

integer

ต้องระบุ: เวอร์ชันย่อย ซึ่งหมายถึงการแก้ไขข้อบกพร่องเล็กน้อย

OrderLookupCriteria

เกณฑ์การค้นหาคำสั่งซื้อ

การแสดง JSON 
{

  // Union field criteria can be only one of the following:
  "dcb3CorrelationId": string,
  "arnCriteria": {
    object (ArnCriteria)
  },
  "googleTransactionReferenceNumberCriteria": {
    object (GoogleTransactionReferenceNumberCriteria)
  }
  // End of list of possible types for union field criteria.
}
ช่อง

ฟิลด์การรวม criteria

criteria ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dcb3CorrelationId

string

ค้นหาตามรหัสความสัมพันธ์ DCB ที่ Google สร้างขึ้นซึ่งระบุการชำระเงินโดยไม่ซ้ำกัน Google สร้างค่านี้และส่งไปยังผู้รวมชำระเงินโดยการเรียกเก็บเงินผ่านผู้ให้บริการมือถือในระหว่างการโทรเพื่อตรวจสอบสิทธิ์
arnCriteria

object (ArnCriteria)

ค้นหาตามหมายเลขอ้างอิงผู้รับ (ARN)
googleTransactionReferenceNumberCriteria

object (GoogleTransactionReferenceNumberCriteria)

ค้นหาตามหมายเลขอ้างอิงธุรกรรมของ Google

ArnCriteria

เกณฑ์การค้นหาการชำระเงินที่อิงจากหมายเลขอ้างอิงผู้รับ (ARN)

การแสดง JSON 
{
  "acquirerReferenceNumber": string,
  "authorizationCode": string
}
ช่อง
acquirerReferenceNumber

string

ต้องระบุ: หมายเลขอ้างอิงการชำระเงิน (ARN) ที่ระบุการชำระเงินโดยไม่ซ้ำกัน ต้องมีความยาว 23 หลัก
authorizationCode

string

ต้องระบุ: รหัสการให้สิทธิ์สำหรับธุรกรรม

GoogleTransactionReferenceNumberCriteria

เกณฑ์การค้นหาการชำระเงินจะอิงตามหมายเลขอ้างอิงธุรกรรมที่ Google สร้างขึ้น

การแสดง JSON 
{
  "googleTransactionReferenceNumber": string,
  "authorizationCode": string
}
ช่อง
googleTransactionReferenceNumber

string

ต้องระบุ: หมายเลขอ้างอิงธุรกรรมที่ Google สร้างขึ้นซึ่งระบุการชำระเงินโดยไม่ซ้ำกัน
authorizationCode

string

ต้องระบุ: รหัสการให้สิทธิ์สำหรับธุรกรรม

RequestOriginator

ข้อมูลเกี่ยวกับองค์กรหรือกลุ่มย่อยขององค์กรที่สร้างคำขอนี้ วิธีนี้ช่วยให้ Google ระบุปัญหาหรือการละเมิด และใช้การควบคุมได้ในระดับที่ละเอียดกว่าpaymentIntegratorAccountId ซึ่งจะมีประโยชน์อย่างยิ่งเมื่อผู้โทรเป็นผู้ให้บริการตัวกลางที่จัดหาคำขอจากลูกค้าภายนอกหลายราย

การแสดง JSON 
{
  "organizationId": string,
  "organizationDescription": string
}
ช่อง
organizationId

string

ต้องระบุ: ตัวระบุบริษัท องค์กร หรือกลุ่มองค์กรที่สร้างคำขอนี้ ต้องไม่ซ้ำกันภายใน paymentIntegratorAccountId นี้
organizationDescription

string

ต้องระบุ: ชื่อหรือคำอธิบายขององค์กรที่มนุษย์อ่านเข้าใจได้ เพื่อช่วยให้พนักงานของ Google และผู้ผสานรวมขององค์กรดังกล่าวสื่อสารเกี่ยวกับองค์กรได้ง่ายขึ้น

ResponseHeader

ออบเจ็กต์ส่วนหัวที่กําหนดไว้ในการตอบกลับทั้งหมดที่ส่งจากเซิร์ฟเวอร์

การแสดง JSON 
{
  "responseTimestamp": string
}
ช่อง
responseTimestamp

string (int64 format)

REQUIRED: การประทับเวลาของการตอบกลับนี้ซึ่งแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch ผู้รับควรยืนยันว่าการประทับเวลานี้ ± 60s ของ "now"

GetOrderDetailsResultCode

ผลของการเรียกใช้เมธอด getOrderDetails

Enum
GET_ORDER_DETAILS_RESULT_CODE_UNKNOWN ห้ามตั้งค่าเริ่มต้นนี้เป็นอันขาด
SUCCESS พบคำสั่งซื้อและส่งคืนแล้ว
ORDER_CANNOT_BE_RETURNED

คำสั่งซื้อที่ขอที่มีอยู่ แต่ส่งคืนไม่ได้ โดยสาเหตุรวมถึงกรณีที่มีการนำคำสั่งศาลออกตามคำขอของเจ้าของ

PAYMENT_TOO_OLD พบการชำระเงินตามที่ร้องขอ แต่ไม่ได้ให้รายละเอียดคำสั่งซื้อเนื่องจากอายุการชำระเงิน
PAYMENT_NOT_FOUND ไม่พบการชำระเงินตามที่ระบุ
NO_ADDITIONAL_DETAILS พบการชำระเงินที่ร้องขอ แต่ไม่มีรายละเอียดคำสั่งซื้อ

สั่งซื้อ

ข้อมูลเกี่ยวกับคำสั่งซื้อ

การแสดง JSON 
{
  "timestamp": string,
  "orderId": string,
  "currencyCode": string,
  "subTotalAmount": string,
  "totalAmount": string,
  "items": [
    {
      object (Item)
    }
  ],
  "taxes": [
    {
      object (Tax)
    }
  ]
}
ช่อง
timestamp

string (int64 format)

ไม่บังคับ: การประทับเวลาที่สั่งซื้อ ซึ่งแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch ใช้ได้กับคำสั่งซื้อบางประเภท
orderId

string

ไม่บังคับ: สตริงที่ระบุลำดับนี้โดยไม่ซ้ำกัน ใช้ได้กับคำสั่งซื้อบางประเภท
currencyCode

string

ไม่บังคับ: รหัสสกุลเงิน 3 ตัวอักษรตามมาตรฐาน ISO 4217 สำหรับจำนวนเงินทั้งหมดในคำสั่งซื้อนี้ ใช้ได้กับคำสั่งซื้อบางประเภท
subTotalAmount

string (Int64Value format)

ไม่บังคับ: จำนวนเงินรวมของคำสั่งซื้อนี้ก่อนหักภาษี ซึ่งแสดงเป็นไมโครของสกุลเงินที่ระบุไว้ใน order.currencyCode ซึ่งเท่ากับ SUM(items.totalPrice) ใช้ได้กับคำสั่งซื้อบางประเภท
totalAmount

string (Int64Value format)

ไม่บังคับ: จำนวนเงินทั้งหมดของคำสั่งซื้อนี้รวมภาษี ซึ่งแสดงเป็นไมโครของสกุลเงินที่ระบุไว้ใน order.currencyCode ซึ่งเท่ากับ subTotalAmount + SUM(taxes.amount) ใช้ได้กับคำสั่งซื้อบางประเภท
items[]

object (Item)

ต้องระบุ: รายการสินค้าที่เป็นส่วนหนึ่งของคำสั่งซื้อนี้
taxes[]

object (Tax)

ไม่บังคับ: รายการภาษีที่เป็นส่วนหนึ่งของคำสั่งซื้อนี้

รายการ

ข้อมูลเกี่ยวกับสินค้าในคำสั่งซื้อ

การแสดง JSON 
{
  "description": string,
  "merchant": string,
  "quantity": string,
  "totalPrice": string,
  "googleProductName": string
}
ช่อง
description

string

ไม่บังคับ: รายละเอียดของสินค้าที่ซื้อ ใช้ได้กับคำสั่งซื้อบางประเภท
merchant

string

ต้องระบุ: ผู้ขาย ศิลปิน หรือผู้ผลิตสินค้า
quantity

string (Int64Value format)

ไม่บังคับ: จำนวนที่สั่งซื้อของสินค้านี้

ช่องนี้จะถูกละเว้นหากปริมาณจำนวนเต็มใช้ไม่ได้กับผลิตภัณฑ์ (ผลิตภัณฑ์ที่มีการจำกัดปริมาณอาจมีปริมาณเป็นเศษส่วน เป็นต้น)
totalPrice

string (Int64Value format)

ไม่บังคับ: ราคารวมของรายการนี้ซึ่งแสดงเป็นไมโครของสกุลเงินที่ระบุไว้ใน order.currencyCode หากมีการระบุ quantity จะแสดงราคารวมของจำนวนทั้งหมด ใช้ได้กับคำสั่งซื้อบางประเภท
googleProductName

string

ต้องระบุ: ชื่อบริการผลิตภัณฑ์ Google ของสินค้า

ภาษี

ข้อมูลเกี่ยวกับภาษีที่ใช้กับคำสั่งซื้อนี้

การแสดง JSON 
{
  "description": string,
  "amount": string
}
ช่อง
description

string

ต้องระบุ: คำอธิบายภาษี
amount

string (Int64Value format)

ต้องระบุ: จำนวนภาษีที่แสดงเป็นไมโครของสกุลเงินที่ระบุใน order.currencyCode