- คำขอ HTTP
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- RequestHeader
- เวอร์ชัน
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- ResponseHeader
- StatementNotificationResultCode
แจ้งผู้รวมบริการเกี่ยวกับใบแจ้งยอดการส่งเงินใหม่
การแจ้งเตือนใบแจ้งยอดจะเกิดขึ้นทุกครั้งที่มีการเพิ่มใบแจ้งยอดใหม่ซึ่งเป็นตัวแทนของเงินที่ Google จะจ่ายให้ผู้ผสานรวมหรือจำนวนเงินที่ผู้ผสานรวมต้องชำระให้กับ Google
หากผู้ผสานการทำงานส่งคืนสำเร็จ ก็จะถือว่าได้รับคำชี้แจงแล้ว
requestId
ยังเป็นรหัสใบแจ้งยอด (ใช้ที่อื่น) อีกด้วย ชุดค่าผสมของ requestId
ภายในส่วนหัวและ paymentIntegratorAccountId
เป็นคีย์ประจำตัวที่ใช้ระบุคำสั่งนี้โดยไม่ซ้ำกัน
หากปลายทางพบข้อผิดพลาดขณะประมวลผลคำขอ เนื้อหาการตอบสนองจากปลายทางนี้ควรเป็นประเภท ErrorResponse
คำขอตัวอย่างมีลักษณะดังนี้
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "0123434-statement-abc",
"requestTimestamp": "1502632800000"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"remittanceStatementSummary": {
"statementDate": "1502607600000",
"billingPeriod": {
"startDate": "1502434800000",
"endDate": "1502521199000"
},
"dateDue": "1503212400000",
"currencyCode": "INR",
"totalDueByIntegrator": "1076000000",
"remittanceInstructions": {
"memoLineId": "stmt-1AB-pp0-invisi"
}
}
}
ตัวอย่างการตอบกลับจะมีลักษณะดังนี้
{
"responseHeader": {
"responseTimestamp": "1502632802000"
},
"paymentIntegratorStatementId": "334a",
"result": "ACCEPTED"
}
คำขอ HTTP
POST https://www.integratorhost.example.com/v1/remittanceStatementNotification
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "requestHeader": { object ( |
ช่อง | |
---|---|
requestHeader |
ต้องระบุ: ส่วนหัวทั่วไปสำหรับคำขอทั้งหมด |
paymentIntegratorAccountId |
ต้องระบุ: นี่คือตัวระบุบัญชีของผู้รวมการชำระเงินที่ระบุข้อจำกัดทางสัญญาเกี่ยวกับใบแจ้งยอดนี้ |
remittanceStatementSummary |
ต้องระบุ: สรุปใบแจ้งยอดการส่งเงินนี้ |
เนื้อหาการตอบกลับ
ออบเจ็กต์การตอบกลับสำหรับวิธีการแจ้งเตือนใบแจ้งยอดการส่งเงิน
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "responseHeader": { object ( |
ช่อง | |
---|---|
responseHeader |
ต้องระบุ: ส่วนหัวทั่วไปสำหรับคำตอบทั้งหมด |
paymentIntegratorStatementId |
ต้องระบุ: ระบุว่าผู้ผสานรวมจะรู้จักคำสั่งนี้ เครื่องมือนี้สร้างขึ้นโดยผู้ผสานการทำงานระบบ |
result |
ต้องระบุ: ผลของการแจ้งเตือนตามใบแจ้งยอดนี้ |
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 |
ต้องระบุ: เวอร์ชันย่อย ซึ่งหมายถึงการแก้ไขข้อบกพร่องเล็กน้อย |
RemittanceStatementSummary
ออบเจ็กต์สรุปเกี่ยวกับใบแจ้งยอดการส่งเงิน
การแสดง JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
ช่อง | |
---|---|
statementDate |
ต้องระบุ: วันที่ (ในอเมริกา/ลอสแอนเจลิส) ที่ใบแจ้งยอดนี้สร้างขึ้น |
billingPeriod |
ต้องระบุ: ช่วงเวลาที่เรียกเก็บเงินนี้ครอบคลุม |
dateDue |
ไม่บังคับ: วันที่ครบกำหนดการส่งเงิน ซึ่งแสดงเป็นมิลลิวินาทีจาก Epoch แต่เป็นวันที่ (ดังนั้นจะเริ่มต้นที่มิลลิวินาทีแรกของวันในเขตเวลาสำหรับการเรียกเก็บเงินเสมอ) หากตั้งค่า |
currencyCode |
ต้องระบุ: รหัสสกุลเงิน 3 ตัวอักษรตามมาตรฐาน ISO 4217 |
totalDueByIntegrator |
REQUIRED: ค่านี้จะเป็นไมโครในสกุลเงิน |
remittanceInstructions |
ต้องระบุ: รายละเอียดเกี่ยวกับวิธีการชำระเงิน |
BillingPeriod
ช่วงเวลาที่เรียกเก็บเงินของใบแจ้งยอดนี้
การแสดง JSON |
---|
{ "startDate": string, "endDate": string } |
ช่อง | |
---|---|
startDate |
ต้องระบุ: วันที่เริ่มต้นของช่วงเวลาที่เรียกเก็บเงิน ซึ่งแสดงเป็นมิลลิวินาทีจาก Epoch แต่เป็นวันที่ (ดังนั้นจะเริ่มต้นที่มิลลิวินาทีแรกของวันในเขตเวลาสำหรับการเรียกเก็บเงินเสมอ) นี่คือมิลลิวินาทีแรกของช่วงเวลาที่เรียกเก็บเงิน 00:00:00.000 |
endDate |
ต้องระบุ: วันที่สิ้นสุดของช่วงเวลาที่เรียกเก็บเงิน ซึ่งแสดงเป็นมิลลิวินาทีจาก Epoch นี่คือมิลลิวินาทีสุดท้ายของวันสุดท้ายของช่วงเวลาที่เรียกเก็บเงิน 23:59:59.999 |
RemittanceInstructions
โครงสร้างที่มีข้อมูลเกี่ยวกับวิธีชำระเงินสำหรับการแจ้งเตือนการส่งเงินนี้
การแสดง JSON |
---|
{ "memoLineId": string } |
ช่อง | |
---|---|
memoLineId |
ต้องระบุ: ตัวระบุที่จำเป็นต้องกรอกในบรรทัดบันทึกการชำระเงินเพื่อระบุการส่งเงิน |
ResponseHeader
ออบเจ็กต์ส่วนหัวที่กําหนดไว้ในการตอบกลับทั้งหมดที่ส่งจากเซิร์ฟเวอร์
การแสดง JSON |
---|
{ "responseTimestamp": string } |
ช่อง | |
---|---|
responseTimestamp |
REQUIRED: การประทับเวลาของการตอบกลับนี้ซึ่งแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch ผู้รับควรยืนยันว่าการประทับเวลานี้ ± 60s ของ "now" |
StatementNotificationResultCode
รหัสผลลัพธ์สำหรับการแจ้งเตือนใบแจ้งยอด
Enum | |
---|---|
UNKNOWN_RESULT |
ห้ามตั้งค่าเริ่มต้นนี้เป็นอันขาด |
ACCEPTED |
ผู้รวมได้ยอมรับคำชี้แจงนี้แล้ว |