Method: remittanceStatementDetails

Menampilkan informasi detail transaksi tentang laporan mutasi pembayaran.

Ini adalah API yang telah dipaginasi. Jumlah peristiwa transaksi per halaman dapat ditentukan dengan numberOfEvents. Jika tidak ditentukan, maksimum 1.000 peristiwa akan ditampilkan per halaman. Setiap permintaan ke API ini akan menampilkan nextEventOffset yang mengarah ke peristiwa transaksi berikutnya dalam laporan, serta totalEvents yang menentukan jumlah total transaksi dalam laporan. Jika halaman yang diambil saat ini berisi transaksi terakhir dari pernyataan, nextEventOffset tidak akan ada dalam respons.

Nilai statementId adalah requestId dari remittanceStatementNotificationRequest

Jika endpoint mengalami error saat memproses permintaan, respons dari endpoint ini akan berjenis ErrorResponse.

Respons kueri ini mungkin kosong jika metode ini tidak menampilkan HTTP 200. Isi respons akan kosong jika ErrorResponse dengan deskripsi yang jelas dapat digunakan untuk membantu penyerang memahami ID akun integrator pembayaran dari integrator lain. 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 tersebut akan ditampilkan dalam isi respons.

Contoh permintaan terlihat seperti ini:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "statement_detail_request_139932019",
    "requestTimestamp": "1502551332087"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "statementId": "0123434-statement-abc",
  "numberOfEvents": 4
}

Contoh respons terlihat seperti ini:


{
  "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"
    }
  ]
}

Permintaan HTTP

POST https://vgw.googleapis.com/secure-serving/gsp/v1/remittanceStatementDetails/:PIAID

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
Kolom
requestHeader

object (RequestHeader)

WAJIB: Header umum untuk semua permintaan.

paymentIntegratorAccountId

string

WAJIB: Ini adalah ID akun integrator pembayaran yang mengidentifikasi batasan kontraktual terkait pernyataan ini.

statementId

string

WAJIB: ID permintaan notifikasi pernyataan.

eventOffset

integer

OPSIONAL: Menampilkan peristiwa yang dimulai dari offset ini. Nilai ini harus disetel ke nextEventOffset jika salah satunya ditampilkan atau tidak ditentukan jika ini adalah permintaan pertama. Jika eventOffset adalah nol, peristiwa akan ditampilkan dimulai dari peristiwa pertama. Jika nilainya dua, peristiwa akan ditampilkan dimulai dari peristiwa ketiga. Jika tidak ditentukan, eventOffset akan diasumsikan sebagai nol.

numberOfEvents

integer

OPSIONAL: Jumlah peristiwa yang ditampilkan per halaman. Jika tidak ditentukan atau lebih besar dari 1.000, nilainya adalah 1.000.

Isi respons

Objek respons untuk metode detail laporan mutasi pembayaran.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi 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)
    }
  ]
}
Kolom
responseHeader

object (ResponseHeader)

WAJIB: Header umum untuk semua respons.

remittanceStatementSummary

object (RemittanceStatementSummary)

WAJIB: Ringkasan laporan mutasi pembayaran ini.

eventOffset

integer

WAJIB: Offset peristiwa respons ini.

nextEventOffset

integer

OPSIONAL: Offset peristiwa berikutnya yang akan ditampilkan. Jika tidak ditentukan, tidak ada lagi peristiwa yang akan diambil untuk pernyataan ini.

totalEvents

integer

WAJIB: Jumlah total peristiwa dalam pernyataan ini.

totalWithholdingTaxes

string (Int64Value format)

WAJIB: Jumlah semua pajak yang dipotong/dipungut untuk laporan ini.

Nilai ini dalam micros.

captureEvents[]

object (Event)

WAJIB: Kumpulan peristiwa pengambilan gambar.

refundEvents[]

object (Event)

WAJIB: Kumpulan peristiwa pengembalian dana.

reverseRefundEvents[]

object (Event)

OPSIONAL: Kumpulan peristiwa pengembalian dana terbalik.

chargebackEvents[]

object (Event)

OPSIONAL: Kumpulan peristiwa penagihan balik.

reverseChargebackEvents[]

object (Event)

OPSIONAL: Kumpulan peristiwa penagihan balik terbalik.

adjustmentEvents[]

object (Event)

OPSIONAL: Kumpulan peristiwa penyesuaian. Peristiwa penyesuaian dapat ditambahkan atas diskresi Google untuk merekonsiliasi perbedaan penagihan, misalnya jika biaya kurang dihitung untuk serangkaian transaksi sebelumnya, penyesuaian dapat digunakan untuk membuat integrator utuh.

RemittanceStatementSummary

Objek ringkasan tentang laporan mutasi pembayaran.

Representasi JSON
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
Kolom
statementDate

string (int64 format)

WAJIB: Tanggal (di Amerika/Los Angeles) pernyataan ini dibuat.

billingPeriod

object (BillingPeriod)

WAJIB: Periode penagihan yang dicakup dalam laporan mutasi ini.

dateDue

string (int64 format)

OPSIONAL: Tanggal jatuh tempo transfer dana. Waktu ini direpresentasikan dalam milidetik dari epoch. Ini adalah tanggal (sehingga akan selalu dimulai pada milidetik pertama dalam hari tersebut dalam zona waktu penagihan).

Nilai ini disetel selama totalDueByIntegrator lebih besar dari 0.

currencyCode

string

WAJIB: Kode mata uang 3 huruf ISO 4217.

totalDueByIntegrator

string (Int64Value format)

WAJIB: Nilai ini dalam mikro mata uang currencyCode. Nilai ini selalu positif.

remittanceInstructions

object (RemittanceInstructions)

WAJIB: Detail cara mengirim pembayaran

BillingPeriod

Periode penagihan laporan mutasi ini.

Representasi JSON
{
  "startDate": string,
  "endDate": string
}
Kolom
startDate

string (int64 format)

WAJIB: Tanggal mulai periode penagihan. Waktu ini direpresentasikan dalam milidetik dari epoch. Ini adalah tanggal (sehingga akan selalu dimulai pada milidetik pertama dalam hari tersebut dalam zona waktu penagihan).

Ini adalah milidetik pertama dalam hari periode penagihan, yaitu 00:00:00.000

endDate

string (int64 format)

WAJIB: Tanggal akhir periode penagihan. Waktu ini direpresentasikan dalam milidetik dari epoch.

Ini adalah milidetik terakhir dari hari terakhir periode penagihan, 23:59:59.999

RemittanceInstructions

Struktur yang menyimpan informasi tentang cara membayar notifikasi pembayaran ini.

Representasi JSON
{
  "memoLineId": string
}
Kolom
memoLineId

string

WAJIB: Tanda pengenal yang wajib dicantumkan dalam nota untuk pembayaran identifikasi transfer dana.

Event

Struktur yang mewakili satu peristiwa yang termasuk dalam laporan transfer dana.

Representasi JSON
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
Kolom
eventRequestId

string

WAJIB: Untuk peristiwa penangkapan atau pengembalian dana, peristiwa ini akan berupa requestId yang dikirim Google dengan permintaan tersebut. Untuk peristiwa pengembalian dana balik, penagihan balik, dan penagihan balik terbalik, ini akan menjadi requestId yang dikirim Integrator Pembayaran dengan notifikasi peristiwa tersebut. Untuk penyesuaian, ini akan berupa ID unik yang ditetapkan oleh Google untuk peristiwa penyesuaian.

paymentIntegratorEventId

string

WAJIB: Identifikasi integrator pembayaran yang ditampilkan untuk acara ini. Untuk rekaman, ini adalah paymentIntegratorTransactionId dari respons terhadap panggilan capture, untuk pengembalian dana, ini adalah paymentIntegratorRefundId dari respons ke panggilan refund.

Kolom ini memiliki panjang yang bervariasi. Sebagai integrator, ID apa pun yang Anda berikan untuk peristiwa ini akan ditampilkan di sini. Jika nilai tidak diberikan oleh integrator untuk peristiwa yang sesuai, kolom ini akan berisi nilai yang sama dengan kolom eventRequestId.

Untuk pengembalian dana balik, penagihan balik, dan peristiwa penagihan balik terbalik, ini akan menjadi requestId yang dikirim Integrator Pembayaran dengan notifikasi peristiwa tersebut.

Panjang dan format kolom ini bergantung pada kolom sumber untuk setiap ID. Lihat dokumentasi untuk setiap kolom sumber untuk mengetahui detail tentang persyaratan panjang dan himpunan karakter. Secara khusus, perhatikan bahwa kolom ini terkadang dapat berisi ID yang dibuat Google yang mungkin memiliki persyaratan panjang maksimum yang berbeda dari ID yang dibuat integrator.

eventCharge

string (Int64Value format)

WAJIB: Dalam kode mata uang yang ditentukan oleh pernyataan. Jika nilai ini negatif, berarti nilai uang yang berpindah dari Google ke integrator pembayaran. Jika hasilnya positif, uang tersebut berasal dari integrator pembayaran yang ditujukan ke Google.

Misalnya, transaksi yang ditangkap akan selalu positif, dan transaksi pengembalian dana akan selalu negatif. Peristiwa pengembalian dana dan penagihan balik terbalik akan selalu positif. Peristiwa penagihan balik akan selalu negatif.

Nilai ini dalam micros.

eventFee

string (Int64Value format)

WAJIB: Dalam kode mata uang yang ditentukan oleh pernyataan. Jika nilai ini negatif, berarti nilai uang yang berpindah dari Google ke integrator pembayaran. Jika hasilnya positif, uang tersebut berasal dari integrator pembayaran yang ditujukan ke Google.

Misalnya, jika perjanjian menyatakan bahwa Google akan membayar 1% dari transactionCharge kepada integrator pembayaran, dan akan mengembalikan 1% tersebut setelah pengembalian dana transaksi tersebut, biaya tangkapan akan menjadi negatif dan setelah pengembalian dana, biaya pengembalian dana akan menjadi positif.

Nilai ini dalam micros.

presentmentChargeAmount

string (Int64Value format)

OPSIONAL: Jumlah transaksi dalam mata uang saat ini (disebut juga transaksi) sebelum mata uang asing. Kolom ini mengikuti konvensi tanda yang sama dengan kolom eventCharge.

Nilai ini dalam micros.

presentmentCurrencyCode

string

OPSIONAL: Kode mata uang 3 huruf ISO 4217 yang menentukan mata uang presentasi (transaksi).

exchangeRate

string (Int64Value format)

OPSIONAL: Nilai tukar yang digunakan untuk mengonversi jumlah hadiah ke jumlah penyelesaian (invoice).

Nilai ini dalam poin basis mikro (1 basis poin = 0,0001 = ,01%). Yaitu, untuk mendapatkan nilai tukar, bagi bidang ini dengan 10^10.

nanoExchangeRate

string (Int64Value format)

OPSIONAL: Nilai tukar yang digunakan dalam mengonversi jumlah presentasi ke jumlah penyelesaian (invoice), yang dinyatakan dalam poin basis nano.

Nilai ini dalam nano basis poin (1 basis poin = 0,0001 = ,01%). Yaitu, untuk mendapatkan nilai tukar, bagi bidang ini dengan 10^13.

Kolom dan exchangeRate ini akan terisi. Nilai tukar tersebut setara dengan yang dinyatakan dengan presisi berbeda. Pada versi mendatang, exchangeRate akan dihapus untuk mengganti nanoExchangeRate.