Method: remittanceStatementDetails

ส่งคืนข้อมูลรายละเอียดธุรกรรมเกี่ยวกับใบแจ้งยอดการส่งเงิน

นี่คือ API ที่ใส่เลขหน้า สามารถระบุจํานวนเหตุการณ์ธุรกรรมต่อหน้าได้ด้วย numberOfEvents หากไม่ระบุ ระบบจะแสดงผลกิจกรรมได้สูงสุด 1, 000 รายการต่อหน้า แต่ละคําขอที่ส่งไปยัง API นี้จะแสดง nextEventOffset ที่ชี้ไปยังเหตุการณ์ธุรกรรมถัดไปในใบแจ้งยอด รวมถึง totalEvents ซึ่งระบุจํานวนธุรกรรมทั้งหมดในใบแจ้งยอด หากหน้าที่เรียกดูปัจจุบันมีธุรกรรมล่าสุดของใบแจ้งยอด nextEventOffset จะไม่แสดงในการตอบกลับ

ค่า statementId คือ requestId จาก remittanceStatementNotificationRequest

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

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

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


{
  "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": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
ช่อง
requestHeader

object (RequestHeader)

ต้องระบุ: ส่วนหัวร่วมสําหรับคําขอทั้งหมด

paymentIntegratorAccountId

string

ต้องระบุ: นี่คือตัวระบุบัญชีของผู้ผสานรวมการชําระเงินที่ระบุข้อจํากัดทางสัญญาเกี่ยวกับใบแจ้งยอดนี้

statementId

string

ต้องระบุ: ขอรหัสการแจ้งเตือนใบแจ้งยอด

eventOffset

integer

ไม่บังคับ: ส่งคืนเหตุการณ์โดยเริ่มจากออฟเซ็ตนี้ ควรตั้งค่าเป็น nextEventOffset หากมีการส่งรายการคืนหรือไม่ได้ระบุคําขอหากเป็นคําขอแรก หาก eventOffset เป็นศูนย์ ระบบจะส่งคืนเหตุการณ์ซึ่งเริ่มต้นจากกิจกรรมแรก หากเป็น 2 รายการ ระบบจะคืนค่าเหตุการณ์โดยเริ่มจากเหตุการณ์ที่ 3 หากไม่ระบุ จะถือว่า eventOffset เป็น 0

numberOfEvents

integer

ไม่บังคับ: จํานวนเหตุการณ์ที่จะแสดงใน 1 หน้า หากไม่ระบุหรือมากกว่า 1000 จะเท่ากับ 1000

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

ออบเจ็กต์การตอบกลับสําหรับวิธีการแสดงรายละเอียดการส่งเงิน

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

การแสดง JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  },
  "eventOffset": integer,
  "nextEventOffset": integer,
  "totalEvents": integer,
  "totalWithholdingTaxes": string,
  "captureEvents": [
    {
      object (Event)
    }
  ],
  "refundEvents": [
    {
      object (Event)
    }
  ],
  "reverseRefundEvents": [
    {
      object (Event)
    }
  ],
  "chargebackEvents": [
    {
      object (Event)
    }
  ],
  "reverseChargebackEvents": [
    {
      object (Event)
    }
  ],
  "adjustmentEvents": [
    {
      object (Event)
    }
  ]
}
ช่อง
responseHeader

object (ResponseHeader)

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

remittanceStatementSummary

object (RemittanceStatementSummary)

ต้องระบุ: สรุปใบแจ้งยอดการส่งเงินนี้

eventOffset

integer

ต้องระบุ: การชดเชยเหตุการณ์ของการตอบกลับนี้

nextEventOffset

integer

ไม่บังคับ: ออฟเซ็ตของเหตุการณ์ถัดไปที่จะแสดงผล หากไม่ระบุ ไม่มีเหตุการณ์ใดที่จะเรียกได้อีกต่อไปสําหรับคําสั่งนี้

totalEvents

integer

ต้องระบุ: จํานวนกิจกรรมทั้งหมดในใบแจ้งยอดนี้

totalWithholdingTaxes

string (Int64Value format)

ต้องระบุ: ผลรวมของภาษีหัก ณ ที่จ่ายทั้งหมดสําหรับใบแจ้งยอดนี้

ค่านี้เป็นไมโคร

captureEvents[]

object (Event)

ต้องระบุ: ชุดเหตุการณ์การบันทึก

refundEvents[]

object (Event)

ต้องระบุ: ชุดกิจกรรมการคืนเงิน

reverseRefundEvents[]

object (Event)

ไม่บังคับ: ชุดกิจกรรมการคืนเงินแบบย้อนกลับ

chargebackEvents[]

object (Event)

ไม่บังคับ: ชุดเหตุการณ์การปฏิเสธการชําระเงิน

reverseChargebackEvents[]

object (Event)

ไม่บังคับ: ชุดเหตุการณ์การปฏิเสธการชําระเงินย้อนกลับ

adjustmentEvents[]

object (Event)

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

สรุปใบแจ้งยอดการส่งเงิน

ออบเจ็กต์สรุปเกี่ยวกับใบแจ้งยอดการส่งเงิน

การแสดง JSON
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
ช่อง
statementDate

string (int64 format)

ต้องระบุ: วันที่ (ในอเมริกา/ลอสแอนเจลิส) ที่สร้างรายงานนี้

billingPeriod

object (BillingPeriod)

ต้องระบุ: ช่วงเวลาที่เรียกเก็บเงินที่ใบแจ้งยอดนี้ครอบคลุม

dateDue

string (int64 format)

ไม่บังคับ: วันที่ครบกําหนดส่งเงิน ค่านี้จะแสดงเป็นมิลลิวินาทีจาก Epoch ซึ่งเป็นวันที่ (ดังนั้นจึงเริ่มต้นที่ 1 มิลลิวินาทีแรกของวันในเขตเวลาสําหรับการเรียกเก็บเงิน)

โดยจะตั้งค่าตราบเท่าที่ totalDueByIntegrator มากกว่า 0

currencyCode

string

ต้องระบุ: รหัสสกุลเงิน 3 ตัวอักษรตามมาตรฐาน ISO 4217

totalDueByIntegrator

string (Int64Value format)

ต้องระบุ: ค่านี้อยู่ในไมโครในสกุลเงินของ currencyCode ค่านี้จะเป็นบวกเสมอ

remittanceInstructions

object (RemittanceInstructions)

ต้องระบุ: รายละเอียดเกี่ยวกับวิธีส่งเงิน

ช่วงเวลาที่เรียกเก็บเงิน

ช่วงเวลาที่เรียกเก็บเงินของใบแจ้งยอดนี้

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

string (int64 format)

ต้องระบุ: วันที่เริ่มต้นของช่วงเวลาที่เรียกเก็บเงิน ค่านี้จะแสดงเป็นมิลลิวินาทีจาก Epoch ซึ่งเป็นวันที่ (ดังนั้นจึงเริ่มต้นที่ 1 มิลลิวินาทีแรกของวันในเขตเวลาสําหรับการเรียกเก็บเงิน)

นี่เป็นมิลลิวินาทีแรกของวันที่ในช่วงเวลาที่เรียกเก็บเงิน 00:00:00.000

endDate

string (int64 format)

ต้องระบุ: วันที่สิ้นสุดของช่วงเวลาที่เรียกเก็บเงิน ค่านี้จะแสดงเป็นมิลลิวินาทีจาก Epoch

นี่คือมิลลิวินาทีสุดท้ายของวันสุดท้ายของช่วงเวลาที่เรียกเก็บเงิน 23:59:59.999

วิธีการส่งเงิน

โครงสร้างข้อมูลเกี่ยวกับวิธีชําระเงินในการส่งเงินนี้

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

string

ต้องระบุ: ตัวระบุที่ต้องระบุในบรรทัดบันทึกสําหรับการชําระเงินสําหรับการส่งเงิน

เหตุการณ์

โครงสร้างที่แสดงเหตุการณ์เดียวที่รวมอยู่ในใบแจ้งยอดการส่งเงิน

การแสดง JSON
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
ช่อง
eventRequestId

string

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

paymentIntegratorEventId

string

ต้องระบุ: รหัสของผู้รวมการชําระเงินที่ส่งกลับสําหรับกิจกรรมนี้ สําหรับการบันทึกภาพ นี่คือ paymentIntegratorTransactionId จากการตอบกลับการโทร capture สําหรับการคืนเงิน นี่คือ paymentIntegratorRefundId จากการตอบกลับการโทร refund

ช่องนี้มีความยาวแปรผันได้ เนื่องจากผู้รวมรหัสที่คุณระบุไว้สําหรับกิจกรรมนี้จะปรากฏที่นี่ ถ้าผู้ผนวกไม่ได้ระบุค่าสําหรับเหตุการณ์ที่เกี่ยวข้อง ช่องนี้จะมีค่าเดียวกันกับช่อง eventRequestId

สําหรับการคืนเงินแบบย้อนกลับ กิจกรรมการปฏิเสธการชําระเงินและการดึงเงินคืน จะเป็น requestId ที่ผู้รวมการชําระเงินส่งไปพร้อมกับการแจ้งเตือนกิจกรรม

ความยาวและรูปแบบของช่องนี้ขึ้นอยู่กับช่องแหล่งที่มาสําหรับแต่ละรหัส โปรดดูรายละเอียดเกี่ยวกับข้อกําหนดความยาวและการเข้ารหัสข้อความในเอกสารในแต่ละช่องของแหล่งที่มา โดยเฉพาะอย่างยิ่ง โปรดทราบว่าช่องนี้อาจมีรหัสที่ Google สร้างขึ้นซึ่งอาจมีข้อกําหนดความยาวสูงสุดต่างจากรหัสที่ผู้ผสานรวมสร้างขึ้น

eventCharge

string (Int64Value format)

ต้องระบุ: ในรหัสสกุลเงินที่กําหนดโดยใบแจ้งยอด ถ้าค่านี้เป็นค่าลบ ค่านี้แสดงถึงมูลค่าทางการเงินที่ย้ายจาก Google ไปยังผู้รวมบริการการชําระเงิน หากเป็นกรณีนี้ เงินมาจากผู้ผสานรวมการชําระเงินกับ Google

ตัวอย่างเช่น ธุรกรรมการจับธุรกรรมจะเป็นบวกเสมอ และธุรกรรมคืนเงินจะเป็นลบเสมอ การคืนเงินและเหตุการณ์การปฏิเสธการชําระเงินย้อนหลังจะเป็นค่าบวกเสมอ เหตุการณ์การปฏิเสธการชําระเงินจะเป็นลบเสมอ

ค่านี้เป็นไมโคร

eventFee

string (Int64Value format)

ต้องระบุ: ในรหัสสกุลเงินที่กําหนดโดยใบแจ้งยอด ถ้าค่านี้เป็นค่าลบ ค่านี้แสดงถึงมูลค่าทางการเงินที่ย้ายจาก Google ไปยังผู้รวมบริการการชําระเงิน หากเป็นกรณีนี้ เงินมาจากผู้ผสานรวมการชําระเงินกับ Google

ตัวอย่างเช่น หากข้อตกลงระบุว่า Google จะจ่าย 1% ของ transactionCharge ให้กับผู้ให้บริการการรวมบริการ และจะคืนเงิน 1% นั้นเมื่อทําการคืนเงินสําหรับธุรกรรมนั้น ค่าธรรมเนียมการจับจ่ายจะเป็นค่าลบ และเมื่อมีการคืนเงิน ค่าธรรมเนียมการคืนเงินจะเป็นค่าบวก

ค่านี้เป็นไมโคร

presentmentChargeAmount

string (Int64Value format)

ไม่บังคับ: จํานวนเงินของธุรกรรมในสกุลเงินนําเสนอ (หรือที่เรียกว่าธุรกรรม) ก่อนการแลกเปลี่ยนเงินตราต่างประเทศ ช่องนี้มีข้อกําหนดเดียวกับเครื่องหมาย eventCharge

ค่านี้เป็นไมโคร

presentmentCurrencyCode

string

ไม่บังคับ: รหัสสกุลเงิน 3 ตัวอักษรตามมาตรฐาน ISO 4217 ที่แทนสกุลเงินของการนําเสนอ (ธุรกรรม)

exchangeRate

string (Int64Value format)

ไม่บังคับ: อัตราแลกเปลี่ยนที่ใช้ในการแปลงจํานวนงานนําเสนอเป็นมูลค่าในข้อตกลง (ใบแจ้งหนี้)

ค่านี้อยู่ในเกณฑ์พื้นฐาน micro (1 จุดพื้นฐาน = .0001 = .01%) นั่นคือ หากต้องการได้รับอัตราแลกเปลี่ยน ให้นําฟิลด์นี้ไปหารด้วย 10^10

nanoExchangeRate

string (Int64Value format)

ไม่บังคับ: อัตราแลกเปลี่ยนที่ใช้ในการแปลงจํานวนงานนําเสนอเป็นมูลค่าการชําระเงิน (ใบแจ้งหนี้) ซึ่งแสดงในหน่วยฐานนาโน

ค่านี้จะอยู่ในจุดฐาน nano (1 จุดพื้นฐาน = .0001 = .01%) นั่นคือ หากต้องการได้รับอัตราแลกเปลี่ยน ให้นําฟิลด์นี้ไปหารด้วย 10^13

ทั้งช่องนี้และ exchangeRate ซึ่งเป็นอัตราการแลกเปลี่ยนที่เทียบเท่าและแสดงความแม่นยําต่างกัน เราจะนํา ExchangeRate ออกในอนาคตด้วยการใช้ nanoExchangeRate แทน