- คำขอ HTTP
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- RequestHeader
- เวอร์ชัน
- PaymentLookupCriteria
- ArnCriteria
- GoogleTransactionReferenceNumberCriteria
- RequestOriginator
- GetDisputeInquiryReportResultCode
- PurchaseReport
- CustomerAccount
- คำสั่งซื้อ
- ที่อยู่
- รายการ
- ภาษี
- การชำระเงิน
- คืนเงิน
- PaymentCardDetails
- AuthResult
รับรายงานที่ให้ข้อมูลเพื่ออำนวยความสะดวกในการสนทนากับฝ่ายสนับสนุนลูกค้าเกี่ยวกับการโต้แย้งการชำระเงินที่อาจเกิดขึ้น
หากปลายทางพบข้อผิดพลาดขณะประมวลผลคำขอ การตอบกลับจากปลายทางนี้จะเป็นประเภท ErrorResponse
การตอบกลับการค้นหานี้อาจว่างเปล่าหากเมธอดนี้ไม่ได้แสดงผล HTTP 200 เนื้อหาการตอบกลับจะว่างเปล่าในกรณีที่สามารถใช้
พร้อมคำอธิบายที่ชัดเจนเพื่อช่วยให้ผู้โจมตีเข้าใจตัวระบุบัญชีผู้รวมระบบการชำระเงินของผู้รวมบริการรายอื่นๆ ในสถานการณ์เช่นนี้ เมื่อคีย์การรับรองไม่ตรงกัน ไม่พบตัวระบุผู้ผสานการชำระเงิน หรือไม่ทราบคีย์การเข้ารหัส เมธอดนี้จะส่งคืน HTTP 404 ที่มีเนื้อหาว่างเปล่า หากสามารถยืนยันลายเซ็นของคำขอได้ ข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดจะแสดงในเนื้อหาการตอบกลับErrorResponse
คำขอตัวอย่างมีลักษณะดังนี้
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 1,
"revision": 0
},
"requestId": "HsKv5pvtQKTtz7rdcw1YqE",
"requestTimestamp": "1519996751331"
},
"paymentIntegratorAccountId": "InvisiCashUSA",
"paymentLookupCriteria": {
"googleTransactionReferenceNumberCriteria": {
"googleTransactionReferenceNumber": "714545417102363157911822",
"authorizationCode": "111111"
}
},
"existingGoogleClaimId": "138431383281",
"requestOriginator": {
"organizationId": "ISSUER_256",
"organizationDescription": "Community Bank of Some City",
"agentId": "982749"
}
}
ตัวอย่างการตอบกลับจะมีลักษณะดังนี้
{
"responseHeader": {
"responseTimestamp": "1519996752221"
},
"result": "SUCCESS",
"googleClaimId": "138431383281",
"report": {
"customerAccount": {
"customerEmail": "example@gmail.com",
"customerName" : "Example Customer"
},
"order": {
"timestamp": "1517992525972",
"orderId": "SOP.8976-1234-1234-123456..99",
"currencyCode": "USD",
"subTotalAmount": "206990000",
"totalAmount": "212990000",
"shippingAddress": {
"name": "Example Customer",
"addressLine": ["123 Main St"],
"localityName": "Springfield",
"administrativeAreaName": "CO",
"postalCodeNumber": "80309",
"countryCode": "US"
},
"taxes": [
{
"description": "Colorado Sales Tax",
"amount": "6000000"
}
],
"items": [
{
"description": "Super cool gizmo",
"merchant": "HTC",
"googleProductName": "Google Store",
"quantity": "2",
"totalPrice": "198000000"
},
{
"description": "Gizmo charger",
"merchant": "HTC",
"googleProductName": "Google Store",
"quantity": "1",
"totalPrice": "8990000"
}
]
},
"payment": {
"billingAddress" : {
"name": "Example Customer",
"addressLine": ["123 Main St"],
"localityName": "Springfield",
"administrativeAreaName": "CO",
"postalCodeNumber": "80309",
"countryCode": "US"
},
"amount": "100000000",
"refunds": [
{
"amount": "9250000",
"initiatedTimestamp": "1518811245384"
}
],
"cardDetails": {
"authResult": "APPROVED"
}
}
}
}
คำขอ HTTP
POST https://vgw.googleapis.com/secure-serving/gsp/v1/getDisputeInquiryReport/:PIAID
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "requestHeader": { object ( |
ช่อง | |
---|---|
requestHeader |
ต้องระบุ: ส่วนหัวทั่วไปสำหรับคำขอทั้งหมด |
paymentIntegratorAccountId |
ต้องระบุ: ตัวระบุบัญชีของผู้รวมการชำระเงินที่ระบุผู้โทรและข้อจำกัดทางสัญญาที่เกี่ยวข้องสำหรับการโต้ตอบนี้ |
paymentLookupCriteria |
ต้องระบุ: เกณฑ์ที่ระบุการชำระเงินที่ต้องได้รับการตรวจสอบสำหรับการสอบถามนี้ |
existingGoogleClaimId |
ไม่บังคับ: สตริงที่ Google สร้างขึ้นซึ่งแสดงผลโดยการเรียก หากไม่มี ระบบจะสร้างรหัสการอ้างสิทธิ์ใหม่ ผู้โทรอาจระบุ รหัสการอ้างสิทธิ์ที่ป้อนที่นี่หรือที่สร้างขึ้นจะแสดงในช่อง ระบุ |
requestOriginator |
ต้องระบุ: ข้อมูลเกี่ยวกับองค์กรหรือกลุ่มย่อยขององค์กรที่สร้างคำขอนี้ |
เนื้อหาการตอบกลับ
เปย์โหลดการตอบกลับสำหรับเมธอด getDisputeInquiryReport
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "responseHeader": { object ( |
ช่อง | |
---|---|
responseHeader |
ต้องระบุ: ส่วนหัวทั่วไปสำหรับคำตอบทั้งหมด |
result |
ต้องระบุ: ผลของการโทรนี้ |
googleClaimId |
ไม่บังคับ: สตริงที่ Google สร้างขึ้นซึ่งระบุการโต้แย้งของลูกค้าโดยไม่ซ้ำกัน (แสดงก็ต่อเมื่อ หากมีการป้อนข้อมูล |
report |
ไม่บังคับ: รายละเอียดที่เกี่ยวข้องกับการโต้แย้งการชำระเงินที่ระบุในคำขอ (แสดงก็ต่อเมื่อ |
RequestHeader
ออบเจ็กต์ส่วนหัวที่กำหนดไว้ในคำขอทั้งหมดที่ส่งไปยังเซิร์ฟเวอร์
การแสดง JSON |
---|
{
"requestId": string,
"requestTimestamp": string,
"userLocale": string,
"protocolVersion": {
object ( |
ช่อง | |
---|---|
requestId |
ต้องระบุ: ตัวระบุที่ไม่ซ้ำกันของคำขอนี้ โดยเป็นสตริงที่มีความยาวสูงสุด 100 อักขระ และมีเฉพาะอักขระ "a-z", "A-Z", "0-9", ":", "-" และ "_" เท่านั้น |
requestTimestamp |
REQUIRED: การประทับเวลาของคำขอนี้ซึ่งแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch ผู้รับควรยืนยันว่าการประทับเวลานี้ ± 60s ของ "now" การประทับเวลาของคำขอนี้จะไม่แสดงซ้ำเมื่อมีการลองอีกครั้ง |
userLocale |
เลิกใช้งานแล้ว: รหัสภาษา ISO 639-2 Alpha 3 ที่เป็นตัวอักษร 2 หรือ 3 ตัว (ไม่บังคับ) ตามด้วยเครื่องหมายขีดกลางและรหัสประเทศ ISO 3166-1 Alpha-2 เช่น "pt", "pt-BR", "fil" หรือ "fil-PH" ใช้ค่านี้เพื่อช่วยเพิ่มช่อง |
protocolVersion |
ต้องระบุ: เวอร์ชันของคำขอนี้ |
เวอร์ชัน
ออบเจ็กต์เวอร์ชันซึ่งเป็นรูปแบบที่มีโครงสร้างของโครงสร้างเวอร์ชัน a.b.c
แบบคลาสสิก ระบบรับประกันว่าเวอร์ชันหลักของหมายเลขเดียวกันจะใช้งานร่วมกันได้ โปรดทราบว่าการแก้ไขเล็กน้อยและการแก้ไขอาจเปลี่ยนแปลงได้บ่อยครั้งโดยไม่ต้องแจ้งให้ทราบล่วงหน้า ผู้ผสานการทำงานต้องรองรับคำขอทั้งหมดสำหรับเวอร์ชันหลักเดียวกัน
การแสดง JSON |
---|
{ "major": integer, "minor": integer, "revision": integer } |
ช่อง | |
---|---|
major |
ต้องระบุ: เวอร์ชันหลัก ซึ่งจะมีการทำเครื่องหมายไว้ว่าสำหรับคำขอความเข้ากันได้ที่มีเวอร์ชันต่างๆ กัน เราไม่รับประกันว่าจะทำงานร่วมกันได้ |
minor |
ต้องระบุ: เวอร์ชันย่อย ซึ่งหมายถึงการแก้ไขข้อบกพร่องที่สำคัญ |
revision |
ต้องระบุ: เวอร์ชันย่อย ซึ่งหมายถึงการแก้ไขข้อบกพร่องเล็กน้อย |
PaymentLookupCriteria
คอนเทนเนอร์สำหรับเกณฑ์ที่ค้นหาการชำระเงินได้โดยไม่ซ้ำกัน ต้องใส่ข้อมูลในช่องสมาชิก 1 ช่อง (ช่องเดียวเท่านั้น)
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม
|
|
arnCriteria |
ไม่บังคับ: ค้นหาตามหมายเลขอ้างอิงผู้รับ (ARN) |
googleTransactionReferenceNumberCriteria |
ไม่บังคับ: ค้นหาตามหมายเลขอ้างอิงธุรกรรมของ Google |
ArnCriteria
เกณฑ์การค้นหาการชำระเงินที่อิงจากหมายเลขอ้างอิงผู้รับ (ARN)
การแสดง JSON |
---|
{ "acquirerReferenceNumber": string, "authorizationCode": string } |
ช่อง | |
---|---|
acquirerReferenceNumber |
ต้องระบุ: หมายเลขอ้างอิงการชำระเงิน (ARN) ที่ระบุการชำระเงินโดยไม่ซ้ำกัน ต้องมีความยาว 23 หลัก |
authorizationCode |
ต้องระบุ: รหัสการให้สิทธิ์สำหรับธุรกรรม |
GoogleTransactionReferenceNumberCriteria
เกณฑ์การค้นหาการชำระเงินจะอิงตามหมายเลขอ้างอิงธุรกรรมที่ Google สร้างขึ้น
การแสดง JSON |
---|
{ "googleTransactionReferenceNumber": string, "authorizationCode": string } |
ช่อง | |
---|---|
googleTransactionReferenceNumber |
ต้องระบุ: หมายเลขอ้างอิงธุรกรรมที่ Google สร้างขึ้นซึ่งระบุการชำระเงินโดยไม่ซ้ำกัน |
authorizationCode |
ต้องระบุ: รหัสการให้สิทธิ์สำหรับธุรกรรม |
RequestOriginator
ข้อมูลเกี่ยวกับองค์กรหรือกลุ่มย่อยขององค์กร และพนักงานซึ่งเป็นแหล่งที่มาของคำขอนี้ (ไม่บังคับ) วิธีนี้ช่วยให้ Google ระบุปัญหาหรือการละเมิด และใช้การควบคุมได้ในระดับที่ละเอียดกว่าpaymentIntegratorAccountId
ซึ่งจะมีประโยชน์อย่างยิ่งเมื่อผู้โทรเป็นผู้ให้บริการตัวกลางที่จัดหาคำขอจากลูกค้าภายนอกหลายราย
การแสดง JSON |
---|
{ "organizationId": string, "organizationDescription": string, "agentId": string } |
ช่อง | |
---|---|
organizationId |
ต้องระบุ: ตัวระบุบริษัท องค์กร หรือกลุ่มองค์กรที่สร้างคำขอนี้ ต้องไม่ซ้ำกันภายใน |
organizationDescription |
ต้องระบุ: ชื่อหรือคำอธิบายขององค์กรที่มนุษย์อ่านเข้าใจได้ เพื่อช่วยให้พนักงานของ Google และผู้ผสานรวมขององค์กรดังกล่าวสื่อสารเกี่ยวกับองค์กรได้ง่ายขึ้น |
agentId |
ไม่บังคับ: ตัวระบุที่ไม่ซ้ำกันสำหรับตัวแทนเฉพาะ (พนักงาน) ขององค์กรที่ |
GetDisputeInquiryReportResultCode
ผลของการเรียกใช้เมธอด getDisputeInquiryReport
Enum | |
---|---|
UNKNOWN_RESULT |
ห้ามตั้งค่าเริ่มต้นนี้เป็นอันขาด |
SUCCESS |
พบการชำระเงินและส่งรายงานแล้ว |
PAYMENT_NOT_FOUND |
ไม่พบการชำระเงินตามที่ระบุ |
PAYMENT_TOO_OLD |
พบการชำระเงินที่ขอแล้ว แต่ไม่มีการส่งรายงานเนื่องจากอายุของการชำระเงินนี้ |
ORDER_CANNOT_BE_RETURNED |
การชำระเงินที่ร้องขอเป็นของคำสั่งซื้อที่มีอยู่ แต่ไม่สามารถส่งคืนได้ โดยสาเหตุรวมถึงกรณีที่มีการนำคำสั่งศาลออกตามคำขอของเจ้าของ |
NO_ADDITIONAL_DETAILS |
พบการชำระเงินที่ขอ แต่ไม่มีรายงาน |
PurchaseReport
รายงานที่มีรายละเอียดการซื้อที่เกี่ยวข้องกับการชำระเงินที่ร้องขอ
การแสดง JSON |
---|
{ "customerAccount": { object ( |
ช่อง | |
---|---|
customerAccount |
ต้องระบุ: ข้อมูลเกี่ยวกับลูกค้าและบัญชีของลูกค้า |
order |
ต้องระบุ: ข้อมูลเกี่ยวกับคำสั่งซื้อที่ชำระเงิน |
payment |
ไม่บังคับ: ข้อมูลเกี่ยวกับการชำระเงิน หมายเหตุ: คุณสามารถชำระเงินได้หลายครั้งในคำสั่งซื้อเดียว แต่ตัวเลือกนี้จะมีเฉพาะข้อมูลสำหรับการชำระเงินที่ระบุไว้ในคำขอครั้งแรกเท่านั้น ใช้ได้กับคำสั่งซื้อบางประเภท |
CustomerAccount
ข้อมูลเกี่ยวกับบัญชีของลูกค้า
การแสดง JSON |
---|
{ "customerEmail": string, "customerName": string } |
ช่อง | |
---|---|
customerEmail |
ต้องระบุ: อีเมลที่เชื่อมโยงกับบัญชี Google ของลูกค้า |
customerName |
ต้องระบุ: ชื่อลูกค้า |
สั่งซื้อ
ข้อมูลเกี่ยวกับคำสั่งซื้อ
การแสดง JSON |
---|
{ "timestamp": string, "orderId": string, "currencyCode": string, "subTotalAmount": string, "totalAmount": string, "shippingAddress": { object ( |
ช่อง | |
---|---|
timestamp |
ไม่บังคับ: การประทับเวลาที่สั่งซื้อ ซึ่งแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch ใช้ได้กับคำสั่งซื้อบางประเภท |
orderId |
ไม่บังคับ: สตริงที่ระบุลำดับนี้โดยไม่ซ้ำกัน ใช้ได้กับคำสั่งซื้อบางประเภท |
currencyCode |
ไม่บังคับ: รหัสสกุลเงิน 3 ตัวอักษรตามมาตรฐาน ISO 4217 สำหรับจำนวนเงินทั้งหมดในคำสั่งซื้อนี้ ใช้ได้กับคำสั่งซื้อบางประเภท |
subTotalAmount |
ไม่บังคับ: จำนวนเงินรวมของคำสั่งซื้อนี้ก่อนหักภาษี ซึ่งแสดงเป็นไมโครของสกุลเงินที่ระบุใน |
totalAmount |
ไม่บังคับ: จำนวนเงินทั้งหมดของคำสั่งซื้อนี้รวมภาษี ซึ่งแสดงเป็นไมโครของสกุลเงินที่ระบุไว้ใน |
shippingAddress |
ไม่บังคับ: ที่อยู่สำหรับจัดส่งสินค้าที่จับต้องได้ในคำสั่งซื้อนี้ |
items[] |
ต้องระบุ: รายการสินค้าที่เป็นส่วนหนึ่งของคำสั่งซื้อนี้ |
taxes[] |
ต้องระบุ: รายการสินค้าที่เป็นส่วนหนึ่งของคำสั่งซื้อนี้ รายการนี้อาจว่างเปล่า |
ที่อยู่
โครงสร้างที่เก็บข้อมูลที่อยู่
การแสดง JSON |
---|
{ "name": string, "addressLine": [ string ], "localityName": string, "administrativeAreaName": string, "postalCodeNumber": string, "countryCode": string } |
ช่อง | |
---|---|
name |
ไม่บังคับ: ชื่อและนามสกุลของลูกค้า |
addressLine[] |
ไม่บังคับ: ไฟล์นี้มีข้อความที่อยู่ที่ไม่มีโครงสร้าง |
localityName |
ไม่บังคับ: เป็นคำที่คลุมเครือ แต่โดยทั่วไปจะหมายถึงเมืองของที่อยู่ ในภูมิภาคของโลกซึ่งมีการกำหนดย่านไม่ถูกต้องหรือไม่อยู่ในโครงสร้างนี้ (เช่น ญี่ปุ่นและจีน) ให้ปล่อย localityName ว่างไว้และใช้ addressLine ตัวอย่าง: เมืองในสหรัฐอเมริกา ชุมชนด้านไอที เมืองตามเขตไปรษณีย์ของสหราชอาณาจักร |
administrativeAreaName |
ไม่บังคับ: เขตการปกครองระดับสูงสุดของประเทศนี้" เช่น รัฐในสหรัฐอเมริกา ภูมิภาคไอที จังหวัดในจีน จังหวัดญี่ปุ่น" |
postalCodeNumber |
ไม่บังคับ: แม้ว่าจะชื่อ แต่ค่าPostalCodeNumber มักเป็นตัวอักษรและตัวเลขคละกัน เช่น "94043", "SW1W", "SW1W 9TQ" |
countryCode |
ไม่บังคับ: รหัสประเทศในที่อยู่ของลูกค้า ควรเป็น ISO-3166-1 Alpha-2 |
รายการ
ข้อมูลเกี่ยวกับสินค้าในคำสั่งซื้อ
การแสดง JSON |
---|
{ "description": string, "merchant": string, "quantity": string, "totalPrice": string, "googleProductName": string } |
ช่อง | |
---|---|
description |
ไม่บังคับ: รายละเอียดของสินค้าที่ซื้อ ใช้ได้กับคำสั่งซื้อบางประเภท |
merchant |
ต้องระบุ: ผู้ขาย ศิลปิน หรือผู้ผลิตสินค้า |
quantity |
ไม่บังคับ: จำนวนที่สั่งซื้อของสินค้านี้ ช่องนี้จะถูกละเว้นหากปริมาณจำนวนเต็มใช้ไม่ได้กับผลิตภัณฑ์ (ผลิตภัณฑ์ที่มีการจำกัดปริมาณอาจมีปริมาณเป็นเศษส่วน เป็นต้น) |
totalPrice |
ไม่บังคับ: ราคารวมของรายการนี้ซึ่งแสดงเป็นไมโครของสกุลเงินที่ระบุไว้ใน |
googleProductName |
ต้องระบุ: ชื่อบริการผลิตภัณฑ์ Google ของสินค้า |
ภาษี
ข้อมูลเกี่ยวกับภาษีที่ใช้กับคำสั่งซื้อนี้
การแสดง JSON |
---|
{ "description": string, "amount": string } |
ช่อง | |
---|---|
description |
ต้องระบุ: คำอธิบายภาษี |
amount |
ต้องระบุ: จำนวนภาษีซึ่งแสดงเป็น Micros ของสกุลเงินที่ระบุไว้ใน |
การชำระเงิน
ข้อมูลเกี่ยวกับการชำระเงิน
การแสดง JSON |
---|
{ "billingAddress": { object ( |
ช่อง | |
---|---|
billingAddress |
ต้องระบุ: ที่อยู่สำหรับการเรียกเก็บเงินสำหรับการชำระเงินนี้ |
amount |
REQUIRED: จำนวนเงินของการชำระเงินนี้ ซึ่งแสดงเป็นไมโครของสกุลเงินที่ระบุไว้ใน |
refunds[] |
ต้องระบุ: รายการการคืนเงินสำหรับการชำระเงินนี้ รายการนี้อาจว่างเปล่า |
ฟิลด์การรวม
|
|
cardDetails |
ไม่บังคับ: รายละเอียดการชำระเงินสำหรับ FoP บัตรเครดิตและบัตรเดบิตโดยเฉพาะ |
การคืนเงิน
ข้อมูลเกี่ยวกับการคืนเงินที่ชำระ
การแสดง JSON |
---|
{ "amount": string, "initiatedTimestamp": string } |
ช่อง | |
---|---|
amount |
REQUIRED: จำนวนเงินที่คืน ซึ่งเป็นจำนวนบวกไมโครของสกุลเงินที่ระบุไว้ใน |
initiatedTimestamp |
ต้องระบุ: การประทับเวลาที่เริ่มการคืนเงิน ซึ่งแสดงเป็นมิลลิวินาทีนับจาก Epoch |
PaymentCardDetails
รายละเอียดการชำระเงินสำหรับบัตรเครดิตและบัตรเดบิตโดยเฉพาะ
การแสดง JSON |
---|
{
"authResult": enum ( |
ช่อง | |
---|---|
authResult |
ต้องระบุ: ผลการตรวจสอบสิทธิ์การชำระเงิน |
AuthResult
ผลการตรวจสอบสิทธิ์การชำระเงิน
Enum | |
---|---|
UNKNOWN_RESULT |
ห้ามตั้งค่าเริ่มต้นนี้เป็นอันขาด |
APPROVED |
อนุมัติการตรวจสอบสิทธิ์แล้ว |
DENIED |
การตรวจสอบสิทธิ์ถูกปฏิเสธ |
NOT_ATTEMPTED |
ไม่ได้พยายามตรวจสอบสิทธิ์ |