Phản hồi lại một chuỗi được gửi từ ứng dụng.
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": 2
},
"requestId": "G1MQ0YERJ0Q7LPM",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD"
},
"clientMessage": "Client echo message"
}
Ví dụ về phản hồi thành công:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis":"1481899950236"
}
},
"clientMessage": "Client echo message",
"serverMessage": "Debug ID 12345"
}
Yêu cầu HTTP
POST https://www.integratorhost.example.com/v2/echo
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 ( |
Các trường | |
---|---|
requestHeader |
REQUIRED: Tiêu đề chung cho tất cả các yêu cầu. |
clientMessage |
REQUIRED: Thông báo sẽ đọc lại trong phản hồi. |
Nội dung phản hồi
Đối tượng phản hồi cho phương thức phản hồi.
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 ( |
Các trường | |
---|---|
responseHeader |
REQUIRED: Tiêu đề chung cho tất cả các câu trả lời. |
clientMessage |
REQUIRED: Thông báo nhận được trong yêu cầu. |
serverMessage |
OPTIONAL: Thông báo của máy chủ, không phụ thuộc vào |
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": { object ( |
Các trường | |
---|---|
requestId |
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 |
REQUIRED: Dấu thời gian của yêu cầu này. Người nhận phải xác minh rằng dấu thời gian này là ± 60 giây tính từ "hiện tại" và từ chối yêu cầu nếu không phải. Dấu thời gian yêu cầu này không giống nhau khi thử lại. |
protocolVersion |
REQUIRED: Phiên bản của yêu cầu này. |
paymentIntegratorAccountId |
BẮT BUỘC: Xác định một tài khoản riêng biệt có những ràng buộc theo hợp đồng. |