- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- StatementNotificationResultCode
Thông báo cho đơn vị tích hợp bảng sao kê chuyển tiền mới.
Thông báo bảng sao kê xuất hiện mỗi khi có một bảng sao kê mới được đưa ra để thể hiện số tiền mà Google sẽ thanh toán cho đối tác tích hợp hoặc tiền mà đối tác tích hợp nợ Google.
Nếu đối tác tích hợp trả về kết quả thành công thì hệ thống sẽ xem như bảng sao kê đã được chấp nhận và sẽ được thanh toán.
requestId
cũng là mã câu lệnh (được dùng ở nơi khác). Tổ hợp requestId
trong tiêu đề và paymentIntegratorAccountId
là khoá idempotency và xác định duy nhất câu lệnh này.
Nếu điểm cuối gặp lỗi trong khi xử lý yêu cầu, thì nội dung phản hồi từ điểm cuối này phải thuộc loại
.ErrorResponse
Yêu cầu mẫu sẽ có dạng như sau:
{
"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"
}
}
}
Câu trả lời mẫu sẽ có dạng như sau:
{
"responseHeader": {
"responseTimestamp": "1502632802000"
},
"paymentIntegratorStatementId": "334a",
"result": "ACCEPTED"
}
Yêu cầu HTTP
POST https://www.integratorhost.example.com/v1/remittanceStatementNotification
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "requestHeader": { object ( |
Trường | |
---|---|
requestHeader |
BẮT BUỘC: Tiêu đề chung cho tất cả các yêu cầu. |
paymentIntegratorAccountId |
BẮT BUỘC: Đây là giá trị nhận dạng tài khoản của đối tác tích hợp thanh toán giúp xác định những điều kiện ràng buộc theo hợp đồng áp dụng cho bảng sao kê này. |
remittanceStatementSummary |
BẮT BUỘC: Bản tóm tắt bảng sao kê chuyển tiền này. |
Nội dung phản hồi
Đối tượng phản hồi cho phương thức thông báo sao kê chuyển tiền.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "responseHeader": { object ( |
Trường | |
---|---|
responseHeader |
BẮT BUỘC: Tiêu đề chung cho tất cả câu trả lời. |
paymentIntegratorStatementId |
BẮT BUỘC: Giá trị nhận dạng mà đối tác tích hợp biết câu lệnh này là. Đây là dữ liệu tích hợp do trình tích hợp tạo. |
result |
BẮT BUỘC: Kết quả của thông báo bảng sao kê này. |
RemittanceStatementSummary
Đối tượng tóm tắt về bảng sao kê chuyển tiền.
Biểu diễn dưới dạng JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
Trường | |
---|---|
statementDate |
BẮT BUỘC: Ngày (tại Hoa Kỳ/Los Angeles) mà bản tuyên bố này được tạo. |
billingPeriod |
BẮT BUỘC: Kỳ thanh toán trong bảng sao kê này. |
dateDue |
KHÔNG BẮT BUỘC: Ngày đến hạn chuyển tiền. Thời gian này được biểu thị dưới dạng mili giây từ thời gian bắt đầu của hệ thống. Đó là ngày (và do đó sẽ luôn bắt đầu từ mili giây đầu tiên của ngày theo múi giờ thanh toán). Giá trị này được thiết lập miễn là |
currencyCode |
BẮT BUỘC: Mã đơn vị tiền tệ gồm 3 chữ cái theo ISO 4217. |
totalDueByIntegrator |
BẮT BUỘC: Giá trị này tính bằng phần triệu theo đơn vị tiền tệ của |
remittanceInstructions |
BẮT BUỘC: Thông tin chi tiết về cách chuyển tiền thanh toán |
BillingPeriod
Kỳ thanh toán của bảng sao kê này.
Biểu diễn dưới dạng JSON |
---|
{ "startDate": string, "endDate": string } |
Trường | |
---|---|
startDate |
BẮT BUỘC: Ngày bắt đầu kỳ thanh toán. Thời gian này được biểu thị dưới dạng mili giây từ thời gian bắt đầu của hệ thống. Đó là ngày (và do đó sẽ luôn bắt đầu từ mili giây đầu tiên của ngày theo múi giờ thanh toán). Đây là mili giây đầu tiên trong ngày của kỳ thanh toán, 00:00:00.000 |
endDate |
BẮT BUỘC: Ngày kết thúc của kỳ thanh toán. Thời gian này được biểu thị dưới dạng mili giây từ thời gian bắt đầu của hệ thống. Đây là mili giây cuối cùng của ngày cuối cùng của kỳ thanh toán, 23:59:59,999 |
RemittanceInstructions
Cấu trúc lưu trữ thông tin về cách thanh toán thông báo chuyển tiền này.
Biểu diễn dưới dạng JSON |
---|
{ "memoLineId": string } |
Trường | |
---|---|
memoLineId |
BẮT BUỘC: Giá trị nhận dạng bắt buộc phải ghi vào dòng thư báo để nhận dạng khoản thanh toán nhằm nhận dạng khoản thanh toán được chuyển tiền. |
StatementNotificationResultCode
Mã kết quả cho thông báo bảng sao kê.
Enum | |
---|---|
UNKNOWN_RESULT |
Đừng bao giờ đặt giá trị mặc định này! |
ACCEPTED |
Nhà tích hợp đã chấp nhận tuyên bố này. |