Method: remittanceStatementNotification

Memberi tahu integrator laporan mutasi transfer dana baru.

Notifikasi pernyataan muncul setiap kali pernyataan baru dimunculkan yang mewakili uang yang akan dibayarkan Google kepada integrator atau uang yang menjadi utang integrator kepada Google.

Jika integrator menunjukkan keberhasilan, maka integrator akan mengonfirmasi penerimaan pernyataan.

requestId juga merupakan ID pernyataan (digunakan di tempat lain). Kombinasi requestId dalam header dan paymentIntegratorAccountId adalah kunci idempotensi serta mengidentifikasi pernyataan ini secara unik.

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

Contoh permintaan terlihat seperti ini:


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

Contoh respons terlihat seperti ini:


{
  "responseHeader": {
    "responseTimestamp": "1502632802000"
  },
  "paymentIntegratorStatementId": "334a",
  "result": "ACCEPTED"
}

Permintaan HTTP

POST https://www.integratorhost.example.com/v1/remittanceStatementNotification

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
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.

remittanceStatementSummary

object (RemittanceStatementSummary)

WAJIB: Ringkasan laporan mutasi pembayaran ini.

Isi respons

Objek respons untuk metode notifikasi laporan mutasi pembayaran.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
Kolom
responseHeader

object (ResponseHeader)

WAJIB: Header umum untuk semua respons.

paymentIntegratorStatementId

string

WAJIB: ID integrator mengetahui pernyataan ini. Ini adalah integrator yang dihasilkan.

result

enum (StatementNotificationResultCode)

WAJIB: Hasil dari notifikasi pernyataan ini.

RequestHeader

Objek header yang ditentukan pada semua permintaan yang dikirim ke server.

Representasi JSON
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
Kolom
requestId

string

WAJIB: ID unik permintaan ini.

String ini memiliki panjang maksimal 100 karakter, dan hanya berisi karakter "a-z", "A-Z", "0-9", ":", "-", dan "_".

requestTimestamp

string (int64 format)

WAJIB: Stempel waktu permintaan ini yang dinyatakan sebagai milidetik sejak epoch. Penerima harus memverifikasi bahwa stempel waktu ini adalah ± 60 detik dari 'sekarang'. Stempel waktu permintaan ini tidak idempoten setelah percobaan ulang.

userLocale
(deprecated)

string

TIDAK DIGUNAKAN LAGI: Kode bahasa ISO 639-2 Alpha 3 dua atau tiga huruf secara opsional diikuti dengan tanda hubung dan kode negara ISO 3166-1 Alpha-2, misalnya 'pt', 'pt-BR', 'fil', atau 'fil-PH'. Gunakan ini untuk membantu mendorong kolom userMessage dalam respons.

protocolVersion

object (Version)

WAJIB: Versi permintaan ini.

Versi

Objek versi yang merupakan bentuk terstruktur dari struktur versi a.b.c klasik. Versi utama nomor yang sama dijamin kompatibel. Perhatikan bahwa minor dan revisi dapat sering berubah dan tanpa pemberitahuan. Integrator harus mendukung semua permintaan untuk versi utama yang sama.

Representasi JSON
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
Kolom
major

integer

WAJIB: Versi utama. Hal ini ditandai untuk permintaan kompatibilitas dengan versi yang berbeda tidak dijamin kompatibel.

minor

integer

WAJIB: Versi minor. Hal ini menunjukkan perbaikan bug yang signifikan.

revision

integer

WAJIB: Versi minor. Hal ini menunjukkan perbaikan bug minor.

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.

ResponseHeader

Objek header yang ditentukan pada semua respons yang dikirim dari server.

Representasi JSON
{
  "responseTimestamp": string
}
Kolom
responseTimestamp

string (int64 format)

WAJIB: Stempel waktu respons ini dinyatakan sebagai milidetik sejak epoch. Penerima harus memverifikasi bahwa stempel waktu ini adalah ± 60 detik dari 'sekarang'.

StatementNotificationResultCode

Kode hasil untuk notifikasi pernyataan.

Enum
UNKNOWN_RESULT Jangan pernah menetapkan nilai default ini.
ACCEPTED Integrator telah menerima pernyataan ini.