- คำขอ HTTP
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- เหตุการณ์
แสดงข้อมูลรายละเอียดธุรกรรมเกี่ยวกับใบแจ้งยอดการส่งเงิน
นี่คือ API ที่มีเลขหน้า ระบุจำนวนเหตุการณ์การทำธุรกรรมต่อหน้าได้ด้วย numberOfEvents
หากไม่ระบุ ระบบจะแสดงผลเหตุการณ์สูงสุด 1, 000 รายการต่อหน้า คำขอแต่ละรายการที่ส่งไปยัง API นี้จะแสดง nextEventOffset
ที่ชี้ไปยังเหตุการณ์การทำธุรกรรมถัดไปในใบแจ้งยอด รวมถึง totalEvents
ที่ระบุจำนวนธุรกรรมทั้งหมดในใบแจ้งยอด หากหน้าที่ดึงข้อมูลปัจจุบันมีธุรกรรมสุดท้ายของคำสั่งดังกล่าว จะไม่มี nextEventOffset
ในการตอบกลับ
ค่า statementId
คือ requestId
จาก remittanceStatementNotificationRequest
หากปลายทางพบข้อผิดพลาดขณะประมวลผลคำขอ การตอบกลับจากปลายทางนี้จะเป็นประเภท ErrorResponse
การตอบสนองต่อการค้นหานี้อาจว่างเปล่าหากวิธีนี้ไม่แสดงผล HTTP 200 เนื้อหาการตอบสนองจะว่างเปล่าในกรณีที่อาจใช้
ที่มีคำอธิบายที่ชัดเจนเพื่อช่วยให้ผู้โจมตีเข้าใจตัวระบุบัญชีของผู้รวมระบบการชำระเงินรายอื่น ในสถานการณ์เหล่านี้ ในกรณีที่คีย์ Signing ไม่ตรงกัน ไม่พบตัวระบุผู้ผสานการชำระเงิน หรือไม่ทราบคีย์การเข้ารหัส วิธีนี้จะส่งกลับ HTTP 404 พร้อมเนื้อหาว่างเปล่า หากยืนยันลายเซ็นคำขอได้ ระบบจะแสดงข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดในเนื้อหาการตอบกลับErrorResponse
ตัวอย่างคำขอมีลักษณะดังนี้
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "statement_detail_request_139932019",
"requestTimestamp": "1502551332087"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"statementId": "0123434-statement-abc",
"numberOfEvents": 4
}
ตัวอย่างคำตอบจะมีลักษณะดังนี้
{
"responseHeader": {
"responseTimestamp": "1481900013178"
},
"eventOffset": 0,
"nextEventOffset": 4,
"totalEvents": 15,
"remittanceStatementSummary": {
"statementDate": "1502521200000",
"billingPeriod": {
"startDate": "1502434800000",
"endDate": "1502434800000"
},
"dateDue": "1502348400000",
"currencyCode": "INR",
"totalDueByIntegrator": "1076000000",
"remittanceInstructions": {
"memoLineId": "stmt-1AB-pp0-invisi"
}
},
"captureEvents": [
{
"eventRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
"paymentIntegratorEventId": "ioj32SOIjf23oijSDfoij",
"eventCharge": "700000000",
"eventFee": "-28000000"
},
{
"eventRequestId": "Ggghvh78200PQ3Yrpb",
"paymentIntegratorEventId": "iasdf23dSdfijSDfoij",
"eventCharge": "800000000",
"eventFee": "-32000000"
}
],
"refundEvents": [
{
"eventRequestId": "liUrreQY233839dfFFb24gaQM",
"paymentIntegratorEventId": "asd3SDf3f3oijSDfoij",
"eventCharge": "-200000000",
"eventFee": "8000000"
},
{
"eventRequestId": "IIghhhUrreQY233839II9qM==",
"paymentIntegratorEventId": "DFjidoso12FSDFSDE",
"eventCharge": "-150000000",
"eventFee": "6000000"
}
]
}
คำขอ HTTP
POST https://vgw.googleapis.com/secure-serving/gsp/v1/remittanceStatementDetails/:PIAID
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{
"requestHeader": {
object ( |
ช่อง | |
---|---|
requestHeader |
ต้องระบุ: ส่วนหัวทั่วไปสำหรับคำขอทั้งหมด |
paymentIntegratorAccountId |
ต้องระบุ: นี่คือตัวระบุบัญชีผู้รวมการชำระเงินที่ระบุข้อจำกัดทางสัญญาเกี่ยวกับใบแจ้งยอดนี้ |
statementId |
ต้องระบุ: รหัสคำขอของการแจ้งเตือนใบแจ้งยอด |
eventOffset |
ไม่บังคับ: แสดงผลเหตุการณ์ที่เริ่มต้นที่ออฟเซ็ตนี้ ควรตั้งค่าเป็น |
numberOfEvents |
ไม่บังคับ: จำนวนกิจกรรมที่จะแสดงในแต่ละหน้า หากไม่ระบุหรือมากกว่า 1000 ค่านี้จะเป็น 1000 |
เนื้อหาการตอบกลับ
ออบเจ็กต์การตอบกลับสำหรับเมธอดรายละเอียดของคำสั่งส่งเงิน
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "responseHeader": { object ( |
ช่อง | |
---|---|
responseHeader |
ต้องระบุ: ส่วนหัวทั่วไปของคำตอบทั้งหมด |
remittanceStatementSummary |
ต้องระบุ: สรุปใบแจ้งยอดการส่งเงินนี้ |
eventOffset |
ต้องระบุ: การชดเชยกิจกรรมของคำตอบนี้ |
nextEventOffset |
ไม่บังคับ: ออฟเซ็ตของเหตุการณ์ถัดไปที่จะแสดงผล หากไม่ระบุ จะไม่มีเหตุการณ์ให้ดึงข้อมูลสำหรับคำสั่งนี้เพิ่มเติม |
totalEvents |
ต้องระบุ: จำนวนกิจกรรมทั้งหมดในคำสั่งนี้ |
totalWithholdingTaxes |
ต้องระบุ: ผลรวมของภาษีหัก ณ ที่จ่ายทั้งหมดสำหรับใบแจ้งยอดนี้ ค่านี้อยู่ในหน่วยไมโคร |
captureEvents[] |
ต้องระบุ: ชุดเหตุการณ์บันทึกเหตุการณ์ |
refundEvents[] |
ต้องระบุ: ชุดเหตุการณ์การคืนเงิน |
reverseRefundEvents[] |
ไม่บังคับ: ชุดเหตุการณ์การคืนเงินแบบย้อนกลับ |
chargebackEvents[] |
ไม่บังคับ: ชุดเหตุการณ์การปฏิเสธการชำระเงิน |
reverseChargebackEvents[] |
ไม่บังคับ: ชุดเหตุการณ์การปฏิเสธการชำระเงินแบบย้อนกลับ |
adjustmentEvents[] |
ไม่บังคับ: ชุดเหตุการณ์การปรับเปลี่ยน Google อาจเพิ่มเหตุการณ์การปรับค่าใช้จ่ายตามดุลยพินิจของ Google ในการปรับยอดความคลาดเคลื่อนในการเรียกเก็บเงิน เช่น หากมีการคำนวณค่าธรรมเนียมสำหรับธุรกรรมชุดหนึ่งๆ ต่ำกว่าความเป็นจริง อาจมีการปรับค่าใช้จ่ายเพื่อให้ผู้รวมบริการทั้งหมดได้รับ |
RemittanceStatementSummary
ออบเจ็กต์สรุปเกี่ยวกับใบแจ้งยอดการส่งเงิน
การแสดง JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
ช่อง | |
---|---|
statementDate |
ต้องระบุ: วันที่ (ในอเมริกา/ลอสแอนเจลิส) ที่จัดทำคำชี้แจงนี้ |
billingPeriod |
ต้องระบุ: ช่วงเวลาที่เรียกเก็บเงินนี้ครอบคลุมใบแจ้งยอด |
dateDue |
ไม่บังคับ: วันที่ครบกำหนดการส่งเงิน ค่านี้จะแสดงเป็นมิลลิวินาทีจาก Epoch ซึ่งเป็นวันที่ (ดังนั้นจะเริ่มต้นในมิลลิวินาทีแรกของวันในเขตเวลาสำหรับการเรียกเก็บเงินเสมอ) โดยจะตั้งค่าได้ตราบใดที่ |
currencyCode |
ต้องระบุ: รหัสสกุลเงิน 3 ตัวอักษรตามมาตรฐาน ISO 4217 |
totalDueByIntegrator |
ต้องระบุ: ค่านี้อยู่ในหน่วยไมโครในสกุลเงิน |
remittanceInstructions |
ต้องระบุ: รายละเอียดเกี่ยวกับวิธีชำระเงิน |
BillingPeriod
ช่วงเวลาที่เรียกเก็บเงินของใบแจ้งยอดนี้
การแสดง JSON |
---|
{ "startDate": string, "endDate": string } |
ช่อง | |
---|---|
startDate |
ต้องระบุ: วันที่เริ่มต้นของช่วงเวลาที่เรียกเก็บเงิน ค่านี้จะแสดงเป็นมิลลิวินาทีจาก Epoch ซึ่งเป็นวันที่ (ดังนั้นจะเริ่มต้นในมิลลิวินาทีแรกของวันในเขตเวลาสำหรับการเรียกเก็บเงินเสมอ) นี่คือมิลลิวินาทีแรกของวันในช่วงเวลาที่เรียกเก็บเงิน 00:00:00.000 |
endDate |
ต้องระบุ: วันที่สิ้นสุดของช่วงเวลาที่เรียกเก็บเงิน ค่านี้จะแสดงเป็นมิลลิวินาทีจาก Epoch นี่คือมิลลิวินาทีสุดท้ายของวันสุดท้ายของช่วงเวลาที่เรียกเก็บเงิน 23:59:59.999 |
RemittanceInstructions
โครงสร้างที่มีข้อมูลเกี่ยวกับวิธีชำระเงินในการแจ้งเตือนการส่งเงินนี้
การแสดง JSON |
---|
{ "memoLineId": string } |
ช่อง | |
---|---|
memoLineId |
ต้องระบุ: ตัวระบุที่จำเป็นต้องใส่ไว้ในบรรทัดใบเพิ่มหนี้สำหรับการชำระเงินเพื่อระบุการส่งเงิน |
กิจกรรม
โครงสร้างที่แสดงเหตุการณ์เดียวซึ่งรวมอยู่ในใบแจ้งยอดการส่งเงิน
การแสดง JSON |
---|
{ "eventRequestId": string, "paymentIntegratorEventId": string, "eventCharge": string, "eventFee": string, "presentmentChargeAmount": string, "presentmentCurrencyCode": string, "exchangeRate": string, "nanoExchangeRate": string } |
ช่อง | |
---|---|
eventRequestId |
ต้องระบุ: สำหรับกิจกรรมการบันทึกหรือการคืนเงิน นี่คือ |
paymentIntegratorEventId |
ต้องระบุ: รหัสผู้รวมการชำระเงินที่ส่งคืนสำหรับกิจกรรมนี้ สำหรับการจับภาพ นี่คือ ช่องนี้มีความยาวไม่แปรผัน เนื่องจากรหัสใดก็ตามที่คุณระบุสำหรับเหตุการณ์นี้จะแสดงที่นี่ในฐานะผู้ผสานรวม หากผู้ผสานรวมไม่ได้ระบุค่าสำหรับเหตุการณ์ที่เกี่ยวข้อง ช่องนี้จะมีค่าเดียวกับช่อง สำหรับเหตุการณ์การคืนเงินแบบย้อนกลับ การปฏิเสธการชำระเงิน และการปฏิเสธการชำระเงินแบบย้อนกลับ กรณีนี้จะเป็น ความยาวและรูปแบบของช่องนี้จะขึ้นอยู่กับช่องแหล่งที่มาของแต่ละรหัส โปรดดูรายละเอียดเกี่ยวกับข้อกำหนดด้านความยาวและชุดอักขระในเอกสารประกอบของช่องแหล่งที่มาแต่ละช่อง กล่าวอย่างเจาะจงคือ โปรดทราบว่าในบางครั้งช่องนี้อาจมีรหัสที่ Google สร้างขึ้น ซึ่งอาจมีข้อกําหนดความยาวสูงสุดแตกต่างจากรหัสที่ผู้ผสานรวมระบบสร้างขึ้น |
eventCharge |
ต้องระบุ: เป็นรหัสสกุลเงินตามที่กำหนดโดยใบแจ้งยอด หากค่านี้เป็นลบ ก็จะหมายถึงมูลค่าทางการเงินที่เปลี่ยนจาก Google ไปยังผู้ผสานการชำระเงิน หากผลบวกคือเงินจากผู้รวมการชำระเงินที่ครบกำหนดให้ Google ตัวอย่างเช่น การบันทึกธุรกรรมจะเป็นบวกเสมอ และธุรกรรมการคืนเงินจะเป็นลบเสมอ เหตุการณ์การคืนเงินและการปฏิเสธการชำระเงินแบบย้อนกลับจะเป็นบวกเสมอ เหตุการณ์การปฏิเสธการชำระเงินจะเป็นลบเสมอ ค่านี้อยู่ในหน่วยไมโคร |
eventFee |
ต้องระบุ: เป็นรหัสสกุลเงินตามที่กำหนดโดยใบแจ้งยอด หากค่านี้เป็นลบ ก็จะหมายถึงมูลค่าทางการเงินที่เปลี่ยนจาก Google ไปยังผู้ผสานการชำระเงิน หากผลบวกคือเงินจากผู้รวมการชำระเงินที่ครบกำหนดให้ Google ตัวอย่างเช่น หากข้อตกลงระบุว่า Google จะจ่าย 1% ของ ค่านี้อยู่ในหน่วยไมโคร |
presentmentChargeAmount |
ไม่บังคับ: จำนวนเงินของธุรกรรมเป็นสกุลเงินที่แสดง (หรือที่เรียกว่าธุรกรรม) ก่อนการแลกเปลี่ยนเงินตราต่างประเทศ ช่องนี้เป็นไปตามแบบแผนเดียวกับช่อง ค่านี้อยู่ในหน่วยไมโคร |
presentmentCurrencyCode |
ไม่บังคับ: รหัสสกุลเงิน 3 ตัวอักษรตามมาตรฐาน ISO 4217 ที่กำหนดสกุลเงินในการนำเสนอ (ธุรกรรม) |
exchangeRate |
ไม่บังคับ: อัตราแลกเปลี่ยนที่ใช้ในการแปลงมูลค่านำเสนอเป็นมูลค่าการชำระเงิน (ใบแจ้งหนี้) ค่านี้อยู่ในคะแนนพื้นฐานไมโคร (1 คะแนนพื้นฐาน = .0001 = .01%) กล่าวคือ หากต้องการได้รับอัตราแลกเปลี่ยน ให้นำฟิลด์นี้หารด้วย 10^10 |
nanoExchangeRate |
ไม่บังคับ: อัตราแลกเปลี่ยนที่ใช้ในการแปลงจำนวนเงินในการจัดซื้อเป็นมูลค่าตามข้อตกลง (ใบแจ้งหนี้) ซึ่งแสดงเป็นคะแนนแบบนาโน ค่านี้อยู่ในคะแนนพื้นฐานnano (1 คะแนนพื้นฐาน = .0001 = .01%) กล่าวคือ หากต้องการได้รับอัตราแลกเปลี่ยน ให้นำฟิลด์นี้หารด้วย 10^13 ระบบจะป้อนข้อมูลทั้งฟิลด์นี้และ ExchangeRate เป็นอัตราแลกเปลี่ยนเทียบเท่า ซึ่งแสดงด้วยความแม่นยำที่ต่างกัน ในเวอร์ชันในอนาคต ระบบจะนำ ExchangeRate ออกเพื่อใช้ nanoExchangeRate |