Method: remittanceStatementNotification

Thông báo cho bên tích hợp về một bảng sao kê chuyển tiền mới.

Thông báo về bảng sao kê xuất hiện mỗi khi một báo cáo mới được tạo, thể hiện số tiền mà Google sẽ thanh toán cho đơn vị tích hợp hoặc số tiền mà bên tích hợp nợ Google.

Nếu bên tích hợp trả về thành công thì tức là bên tích hợp đã nhận được tuyên bố.

requestId cũng là mã bảng sao kê (được dùng ở nơi khác). Tổ hợp requestId trong tiêu đề và paymentIntegratorAccountId là khoá giá trị nhận dạng 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"
    }
  }
}

Phản hồ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 (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
Các trường
requestHeader

object (RequestHeader)

REQUIRED: Tiêu đề chung cho tất cả các yêu cầu.
paymentIntegratorAccountId

string

REQUIRED: Đây là mã nhận dạng tài khoản của đơn vị tích hợp thanh toán, giúp xác định những ràng buộc theo hợp đồng xung quanh tuyên bố này.
remittanceStatementSummary

object (RemittanceStatementSummary)

REQUIRED: Bản tóm tắt của 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 (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
Các trường
responseHeader

object (ResponseHeader)

REQUIRED: Tiêu đề chung cho tất cả các câu trả lời.
paymentIntegratorStatementId

string

BẮT BUỘC: Giá trị nhận dạng mà trình tích hợp biết là câu lệnh này. Đây là trình tích hợp tạo ra.
result

enum (StatementNotificationResultCode)

REQUIRED: Kết quả của thông báo này.

RequestHeader

Đối tượng tiêu đề được xác định trên tất cả các yêu cầu được gửi đến máy chủ.

Biểu diễn dưới dạng JSON 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
Các trường
requestId

string

REQUIRED: Giá trị nhận dạng duy nhất của yêu cầu này.

Đây là chuỗi có độ dài tối đa 100 ký tự và chỉ chứa các ký tự "a-z", "A-Z", "0-9", ":", "-" và "_".
requestTimestamp

string (int64 format)

BẮT BUỘC: Dấu thời gian của yêu cầu này được thể hiện dưới dạng mili giây kể từ thời gian bắt đầu của hệ thống. Bộ nhận phải xác minh rằng dấu thời gian này là ± 60 giây của "hiện tại". Dấu thời gian yêu cầu này không giống nhau khi thử lại.
userLocale
(deprecated)

string

KHÔNG DÙNG NỮA: Mã ngôn ngữ gồm hai hoặc ba chữ cái theo tiêu chuẩn ISO 639-2 Alpha-3 (không bắt buộc) theo sau là dấu gạch nối và mã quốc gia theo tiêu chuẩn ISO 3166-1 Alpha-2, ví dụ: 'pt', 'pt-BR', 'fil' hoặc 'fil-PH'. Dùng công cụ này để giúp thúc đẩy các trường userMessage trong phản hồi.
protocolVersion

object (Version)

REQUIRED: Phiên bản của yêu cầu này.

Phiên bản

Đối tượng phiên bản là một dạng cấu trúc của cấu trúc phiên bản a.b.c cổ điển. Các phiên bản chính của cùng một số sẽ đảm bảo tương thích. Lưu ý rằng các nội dung sửa đổi nhỏ và nội dung sửa đổi có thể thay đổi thường xuyên mà không cần thông báo trước. Trình tích hợp phải hỗ trợ tất cả các yêu cầu cho cùng một phiên bản lớn.

Biểu diễn dưới dạng JSON 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
Các trường
major

integer

BẮT BUỘC: Phiên bản lớn. Thuộc tính này được đánh dấu cho các yêu cầu về khả năng tương thích với nhiều phiên bản nhưng không đảm bảo sẽ tương thích.
minor

integer

BẮT BUỘC: Phiên bản nhỏ. Điều này biểu thị các bản sửa lỗi quan trọng.
revision

integer

BẮT BUỘC: Phiên bản nhỏ. Điều này biểu thị các bản sửa lỗi nhỏ.

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 (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
Các trường
statementDate

string (int64 format)

REQUIRED: Ngày (ở Mỹ/Los Angeles) mà tuyên bố này được tạo.
billingPeriod

object (BillingPeriod)

BẮT BUỘC: Kỳ thanh toán được áp dụng trong bảng sao kê này.
dateDue

string (int64 format)

KHÔNG BẮT BUỘC: Ngày đến hạn của giao dịch chuyển tiền. Thời gian này được biểu thị dưới dạng mili giây tính từ thời gian bắt đầu của hệ thống. Đây là ngày (và do đó sẽ luôn bắt đầu vào mili giây đầu tiên của ngày trong múi giờ thanh toán).

Giá trị này được đặt miễn là totalDueByIntegrator lớn hơn 0.
currencyCode

string

BẮT BUỘC: Mã đơn vị tiền tệ gồm 3 chữ cái theo ISO 4217.
totalDueByIntegrator

string (Int64Value format)

BẮT BUỘC: Giá trị này được tính bằng micrô theo đơn vị tiền tệ của currencyCode. Giá trị này luôn là số dương.
remittanceInstructions

object (RemittanceInstructions)

REQUIRED: Chi tiết về cách 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
}
Các trường
startDate

string (int64 format)

REQUIRED: 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ính từ thời gian bắt đầu của hệ thống. Đây là ngày (và do đó sẽ luôn bắt đầu vào mili giây đầu tiên của ngày trong 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

string (int64 format)

REQUIRED: Ngày kết thúc kỳ thanh toán. Thời gian này được biểu thị dưới dạng mili giây tính 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

Nhà chứa 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
}
Các trường
memoLineId

string

BẮT BUỘC: Mã nhận dạng bắt buộc phải được đưa vào dòng thư báo để nhận dạng giao dịch chuyển tiền.

ResponseHeader

Đối tượng tiêu đề được xác định trên tất cả phản hồi gửi từ máy chủ.

Biểu diễn dưới dạng JSON 
{
  "responseTimestamp": string
}
Các trường
responseTimestamp

string (int64 format)

REQUIRED: Dấu thời gian của phản hồi này được thể hiện dưới dạng mili giây kể từ thời gian bắt đầu của hệ thống. Bộ nhận phải xác minh rằng dấu thời gian này là ± 60 giây của "hiện tại".

StatementNotificationResultCode

Mã kết quả cho thông báo về câu lệnh.

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.