- Permintaan HTTP
- Isi permintaan
- Isi respons
- PaymentLookupCriteria
- ArnCriteria
- GoogleTransactionReferenceNumberCriteria
- CaptureRequestCriteria
- RequestOriginator
- GetDisputeInquiryReportResultCode
- PurchaseReport
- AkunPelanggan
- Pesanan
- Alamat
- Item
- Pajak
- Pembayaran
- Pengembalian dana
- PaymentCardDetails
- AuthResult
Dapatkan laporan yang menyediakan informasi untuk memfasilitasi percakapan dukungan pelanggan dengan pengguna terkait kemungkinan sengketa pembayaran.
Jika endpoint mengalami error saat memproses permintaan, respons dari endpoint ini akan berjenis
.ErrorResponse
Respons terhadap kueri ini mungkin kosong jika metode ini tidak menampilkan HTTP 200. Isi respons kosong jika
dengan deskripsi yang jelas dapat digunakan untuk membantu penyerang memahami ID akun integrator pembayaran dari integrator lainnya. Dalam situasi ini, jika kunci penandatanganan tidak cocok, ID integrator pembayaran tidak ditemukan, atau kunci enkripsi tidak diketahui, metode ini akan menampilkan HTTP 404 dengan isi kosong. Jika tanda tangan permintaan dapat diverifikasi, informasi tambahan terkait error akan ditampilkan dalam isi respons.ErrorResponse
Contoh permintaan terlihat seperti ini:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 1,
"revision": 0
},
"requestId": "HsKv5pvtQKTtz7rdcw1YqE",
"requestTimestamp": "1519996751331"
},
"paymentIntegratorAccountId": "InvisiCashUSA",
"paymentLookupCriteria": {
"googleTransactionReferenceNumberCriteria": {
"googleTransactionReferenceNumber": "714545417102363157911822",
"authorizationCode": "111111"
}
},
"existingGoogleClaimId": "138431383281",
"requestOriginator": {
"organizationId": "ISSUER_256",
"organizationDescription": "Community Bank of Some City",
"agentId": "982749"
}
}
Contoh respons terlihat seperti ini:
{
"responseHeader": {
"responseTimestamp": "1519996752221"
},
"result": "SUCCESS",
"googleClaimId": "138431383281",
"report": {
"customerAccount": {
"customerEmail": "example@gmail.com",
"customerName" : "Example Customer"
},
"order": {
"timestamp": "1517992525972",
"orderId": "SOP.8976-1234-1234-123456..99",
"currencyCode": "USD",
"subTotalAmount": "206990000",
"totalAmount": "212990000",
"shippingAddress": {
"name": "Example Customer",
"addressLine": ["123 Main St"],
"localityName": "Springfield",
"administrativeAreaName": "CO",
"postalCodeNumber": "80309",
"countryCode": "US"
},
"taxes": [
{
"description": "Colorado Sales Tax",
"amount": "6000000"
}
],
"items": [
{
"description": "Super cool gizmo",
"merchant": "HTC",
"googleProductName": "Google Store",
"quantity": "2",
"totalPrice": "198000000"
},
{
"description": "Gizmo charger",
"merchant": "HTC",
"googleProductName": "Google Store",
"quantity": "1",
"totalPrice": "8990000"
}
]
},
"payment": {
"billingAddress" : {
"name": "Example Customer",
"addressLine": ["123 Main St"],
"localityName": "Springfield",
"administrativeAreaName": "CO",
"postalCodeNumber": "80309",
"countryCode": "US"
},
"amount": "100000000",
"refunds": [
{
"amount": "9250000",
"initiatedTimestamp": "1518811245384"
}
],
"cardDetails": {
"authResult": "APPROVED"
}
}
}
}
Permintaan HTTP
POST https://vgw.googleapis.com/secure-serving/gsp/v1/getDisputeInquiryReport/:PIAID
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "requestHeader": { object ( |
Kolom | |
---|---|
requestHeader |
DIPERLUKAN: Header umum untuk semua permintaan. |
paymentIntegratorAccountId |
DIPERLUKAN: ID akun integrator pembayaran yang mengidentifikasi pemanggil dan batasan kontraktual terkait untuk interaksi ini. |
paymentLookupCriteria |
DIPERLUKAN: Kriteria yang menunjukkan pembayaran yang akan dicari untuk pertanyaan ini. |
existingGoogleClaimId |
OPSIONAL: String yang dibuat Google yang ditampilkan oleh panggilan sebelumnya ke Jika tidak ada, ID klaim baru akan dibuat. Penelepon dapat memberikan ID klaim yang diisi di sini atau yang dibuat akan ditampilkan dalam kolom Tidak valid untuk memberikan |
requestOriginator |
DIPERLUKAN: Informasi tentang organisasi atau subgrup organisasi yang membuat permintaan ini. |
Isi respons
Payload respons untuk metode getDisputeInquiryReport
.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "responseHeader": { object ( |
Kolom | |
---|---|
responseHeader |
DIPERLUKAN: Header umum untuk semua respons. |
result |
REQUIRED: Hasil dari panggilan ini. |
googleClaimId |
OPSIONAL: String yang dibuat Google yang mengidentifikasi sengketa pelanggan ini secara unik. (Presentasikan jika dan hanya jika Jika |
report |
OPSIONAL: Detail yang relevan dengan sengketa pembayaran yang diidentifikasi dalam permintaan. (Presentasikan jika dan hanya jika |
Kriteria PaymentLookup
Penampung untuk kriteria yang dapat mencari pembayaran secara unik. Satu (dan hanya satu) kolom anggota harus diisi.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
arnCriteria |
OPSIONAL: Pencarian berdasarkan Nomor Referensi Acquirer (ARN). |
googleTransactionReferenceNumberCriteria |
OPSIONAL: Cari berdasarkan Nomor Referensi Transaksi Google. |
captureRequestCriteria |
OPSIONAL: Cari berdasarkan ID Permintaan Pengambilan. |
Kriteria Arn
Kriteria pencarian pembayaran berdasarkan Acquirer Reference Number (ARN).
Representasi JSON |
---|
{ "acquirerReferenceNumber": string, "authorizationCode": string } |
Kolom | |
---|---|
acquirerReferenceNumber |
DIPERLUKAN: Nomor Referensi Acquirer (ARN) yang mengidentifikasi pembayaran secara unik. Harus 23 digit. |
authorizationCode |
REQUIRED: Kode Otorisasi untuk transaksi. |
GoogleReferenceReferenceNumberCriteria
Kriteria pencarian pembayaran berdasarkan Nomor Referensi Transaksi yang dibuat Google.
Representasi JSON |
---|
{ "googleTransactionReferenceNumber": string, "authorizationCode": string } |
Kolom | |
---|---|
googleTransactionReferenceNumber |
DIPERLUKAN: Nomor Referensi Transaksi yang dibuat Google yang mengidentifikasi pembayaran secara unik. |
authorizationCode |
REQUIRED: Kode Otorisasi untuk transaksi. |
KriteriaRequestRequest
Kriteria pencarian pembayaran berdasarkan permintaan pengambilan asli.
Representasi JSON |
---|
{ "captureRequestId": string } |
Kolom | |
---|---|
captureRequestId |
DIPERLUKAN: ID unik untuk transaksi ini. Ini adalah |
Asal Permintaan
Informasi tentang organisasi atau subgrup organisasi dan, secara opsional, karyawan tempat permintaan ini berasal. Hal ini memungkinkan Google mengidentifikasi masalah atau penyalahgunaan dan menerapkan kontrol pada tingkat yang lebih terperinci daripada paymentIntegratorAccountId
. Hal ini sangat berharga jika pemanggil adalah penyedia layanan perantara yang menerima permintaan dari beberapa klien eksternal.
Representasi JSON |
---|
{ "organizationId": string, "organizationDescription": string, "agentId": string } |
Kolom | |
---|---|
organizationId |
DIPERLUKAN: ID perusahaan, organisasi, atau grup organisasi tempat permintaan ini berasal. Harus unik dalam |
organizationDescription |
DIPERLUKAN: Nama atau deskripsi organisasi yang dapat dibaca manusia yang dapat digunakan untuk memudahkan komunikasi antara karyawan Google dan integrator terkait organisasi tersebut. |
agentId |
OPSIONAL: ID unik untuk agen tertentu (karyawan) organisasi yang diidentifikasi oleh |
GetDisputeInquiryReportResultCode
Hasil panggilan metode getDisputeInquiryReport
.
Enumerasi | |
---|---|
UNKNOWN_RESULT |
Jangan pernah menetapkan nilai default ini. |
SUCCESS |
Pembayaran ditemukan dan laporan diberikan. |
PAYMENT_NOT_FOUND |
Pembayaran yang diminta tidak ditemukan. |
PAYMENT_TOO_OLD |
Pembayaran yang diminta ditemukan, tetapi laporan tidak diberikan karena usia pembayaran. |
ORDER_CANNOT_BE_RETURNED |
Pembayaran yang diminta adalah milik pesanan yang sudah ada, tetapi tidak dapat dikembalikan. Alasannya mencakup kasus saat pesanan dihapus atas permintaan pemiliknya. |
NO_ADDITIONAL_DETAILS |
Pembayaran yang diminta ditemukan, tetapi laporan tidak tersedia. |
LaporanPembelian
Laporan yang berisi detail pembelian yang relevan yang terkait dengan pembayaran yang diminta.
Representasi JSON |
---|
{ "customerAccount": { object ( |
Kolom | |
---|---|
customerAccount |
DIPERLUKAN: Informasi terkait pelanggan dan akunnya. |
order |
DIPERLUKAN: Informasi terkait pesanan yang digunakan untuk melakukan pembayaran. |
payment |
OPSIONAL: Informasi terkait pembayaran. Catatan: Beberapa pembayaran dapat dilakukan pada satu pesanan, tetapi ini hanya akan berisi info untuk pembayaran yang diidentifikasi dalam permintaan asli. Hanya tersedia untuk jenis pesanan tertentu. |
AkunPelanggan
Informasi tentang akun pelanggan
Representasi JSON |
---|
{ "customerEmail": string, "customerName": string } |
Kolom | |
---|---|
customerEmail |
DIPERLUKAN: Alamat email yang terkait dengan Akun Google pelanggan. |
customerName |
DIPERLUKAN: Nama pelanggan. |
Susunan
Informasi tentang pesanan.
Representasi JSON |
---|
{ "timestamp": string, "orderId": string, "currencyCode": string, "subTotalAmount": string, "totalAmount": string, "shippingAddress": { object ( |
Kolom | |
---|---|
timestamp |
OPSIONAL: Stempel waktu saat pesanan dibuat, dinyatakan sebagai milidetik sejak epoch. Hanya tersedia untuk jenis pesanan tertentu. |
orderId |
OPSIONAL: String yang mengidentifikasi pesanan ini secara unik. Hanya tersedia untuk jenis pesanan tertentu. |
currencyCode |
OPSIONAL: Kode mata uang 3 huruf ISO 4217 untuk semua jumlah dalam urutan ini. Hanya tersedia untuk jenis pesanan tertentu. |
subTotalAmount |
OPSIONAL: Jumlah total pesanan ini sebelum pajak, yang dinyatakan sebagai mikro mata uang yang ditentukan dalam |
totalAmount |
OPSIONAL: Jumlah total pesanan ini termasuk pajak, yang dinyatakan sebagai mikro mata uang yang ditentukan dalam |
shippingAddress |
OPSIONAL: Alamat pengiriman untuk item fisik dalam pesanan ini. |
items[] |
DIPERLUKAN: Daftar item yang merupakan bagian dari pesanan ini. |
taxes[] |
DIPERLUKAN: Daftar item yang merupakan bagian dari pesanan ini. Daftar ini mungkin kosong. |
Alamat
Struktur menyimpan informasi tentang alamat.
Representasi JSON |
---|
{ "name": string, "addressLine": [ string ], "localityName": string, "administrativeAreaName": string, "postalCodeNumber": string, "countryCode": string } |
Kolom | |
---|---|
name |
OPSIONAL: Nama lengkap pelanggan. |
addressLine[] |
OPSIONAL: Opsi ini menyimpan teks Alamat yang tidak terstruktur. |
localityName |
OPSIONAL: Ini adalah istilah yang tidak jelas, tetapi umumnya mengacu pada bagian kota dari sebuah alamat. Di wilayah dunia dengan lokalitas yang tidak didefinisikan dengan baik atau tidak cocok dengan struktur ini (misalnya, Jepang dan China), biarkan lokalitasName kosong dan gunakan addressLine. Contoh: US city, IT comune, UK post town. |
administrativeAreaName |
OPSIONAL: Subdivisi administrasi tingkat teratas di negara ini" Contoh: negara bagian AS, wilayah IT, provinsi CN, prefektur JP." |
postalCodeNumber |
OPSIONAL: Terlepas dari nama, nilai posCodeNumber sering kali berupa alfanumerik. Contoh: "94043", "SW1W", "SW1W 9TQ". |
countryCode |
OPSIONAL: Kode negara alamat pelanggan, diharapkan ISO-3166-1 Alpha-2. |
Item
Informasi tentang item dalam pesanan.
Representasi JSON |
---|
{ "description": string, "merchant": string, "quantity": string, "totalPrice": string, "googleProductName": string } |
Kolom | |
---|---|
description |
OPSIONAL: Deskripsi item yang dibeli. Hanya tersedia untuk jenis pesanan tertentu. |
merchant |
DIPERLUKAN: Penjual, artis, atau produsen item. |
quantity |
OPSIONAL: Jumlah yang dipesan dari item ini. Kolom ini akan dihilangkan jika kuantitas bilangan bulat tidak berlaku untuk produk (misalnya, produk terukur dapat memiliki jumlah pecahan). |
totalPrice |
OPSIONAL: Harga total item ini, yang direpresentasikan sebagai mikro mata uang yang ditentukan dalam |
googleProductName |
REQUIRED: Nama layanan produk Google untuk item. |
Pajak
Informasi tentang pajak yang berlaku untuk pesanan ini.
Representasi JSON |
---|
{ "description": string, "amount": string } |
Kolom | |
---|---|
description |
DIPERLUKAN: Deskripsi pajak. |
amount |
DIPERLUKAN: Jumlah pajak, yang direpresentasikan sebagai mikro mata uang yang ditentukan dalam |
Pembayaran
Informasi tentang pembayaran.
Representasi JSON |
---|
{ "billingAddress": { object ( |
Kolom | |
---|---|
billingAddress |
DIPERLUKAN: Alamat penagihan untuk pembayaran ini. |
amount |
DIPERLUKAN: Jumlah pembayaran ini, yang direpresentasikan sebagai mikro mata uang yang ditentukan dalam |
refunds[] |
DIPERLUKAN: Daftar pengembalian dana yang dilakukan untuk pembayaran ini. Daftar ini mungkin kosong. |
Kolom union
|
|
cardDetails |
OPSIONAL: Detail pembayaran khusus untuk FoP kartu kredit & debit. |
Pengembalian Dana
Informasi tentang pengembalian dana yang dilakukan saat pembayaran.
Representasi JSON |
---|
{ "amount": string, "initiatedTimestamp": string } |
Kolom | |
---|---|
amount |
REQUIRED: Jumlah yang dikembalikan, jumlah positif mikro dari mata uang yang ditentukan dalam |
initiatedTimestamp |
DIPERLUKAN: Stempel waktu saat pengembalian dana dimulai, yang dinyatakan sebagai milidetik sejak epoch. |
Detail KartuPembayaran
Detail pembayaran khusus kartu kredit & debit.
Representasi JSON |
---|
{
"authResult": enum ( |
Kolom | |
---|---|
authResult |
DIPERLUKAN: Hasil autentikasi pembayaran. |
AuthResult
Hasil autentikasi pembayaran.
Enumerasi | |
---|---|
UNKNOWN_RESULT |
Jangan pernah menetapkan nilai default ini. |
APPROVED |
Auth Disetujui. |
DENIED |
Auth ditolak. |
NOT_ATTEMPTED |
Auth tidak dicoba. |