Method: remittanceStatementDetails

Bir havale ekstresiyle ilgili işlem ayrıntıları bilgilerini döndürür.

Bu, sayfalandırılmış bir API'dir. Sayfa başına işlem etkinliği sayısı numberOfEvents ile belirtilebilir. Belirtilmezse sayfa başına en fazla 1.000 etkinlik döndürülür. Bu API'ye yapılan her istek, ekstrenin bir sonraki işlem etkinliğine işaret eden bir nextEventOffset ve ekstredeki toplam işlem sayısını belirten bir totalEvents döndürür. Şu anda alınan sayfada ekstrenin son işlemleri varsa yanıtta nextEventOffset bulunmaz.

statementId değeri, remittanceStatementNotificationRequest öğesindeki requestId değeridir.

Uç nokta, isteği işlerken bir hatayla karşılaşırsa bu uç noktanın yanıtı ErrorResponse türünde olur.

Bu sorguya verilen yanıtlar, bu yöntem HTTP 200 döndürmezse boş olabilir. Açık bir açıklamaya sahip ErrorResponse ile saldırganın diğer entegratörlerin ödeme entegratörü hesap tanımlayıcısını anlamasına yardımcı olabilecek durumlarda yanıt gövdesi boş olur. Bu durumlarda, imzalama anahtarı eşleşmediğinde, ödeme entegratörü tanımlayıcısı bulunamadığında veya şifreleme anahtarı bilinmediğinde bu yöntem boş gövdeli bir HTTP 404 döndürür. İstek imzası doğrulanabilirse yanıt gövdesinde hatayla ilgili ek bilgiler döndürülür.

Örnek bir istek şu şekilde görünür:


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

Örnek bir yanıtın görünümü:


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

HTTP isteği

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

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
Alanlar
requestHeader

object (RequestHeader)

ZORUNLU: Tüm istekler için ortak üstbilgi.

paymentIntegratorAccountId

string

ZORUNLU: Bu, sözleşmeyle ilgili kısıtlamaları tanımlayan ödeme entegratörü hesap tanımlayıcısıdır.

statementId

string

ZORUNLU: Bildirim isteğinin kimliği.

eventOffset

integer

İSTEĞE BAĞLI: Bu uzaklıkta başlayan etkinlikleri döndürür. Bu, bir nextEventOffset döndürülürse bu değere ayarlanmalı, ilk istekse belirtilmeden bırakılmalıdır. eventOffset sıfırsa etkinlikler, ilk etkinlikten başlayarak döndürülür. Bu sayı iki ise üçüncü etkinlikten itibaren etkinlikler döndürülür. Belirtilmezse eventOffset değerinin sıfır olduğu varsayılır.

numberOfEvents

integer

İSTEĞE BAĞLI: Sayfa başına gösterilecek etkinlik sayısı. Belirtilmemişse veya 1.000'den büyükse bu değer 1.000 olur.

Yanıt metni

Havale ekstresi ayrıntısı yöntemi için yanıt nesnesi.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "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)
    }
  ]
}
Alanlar
responseHeader

object (ResponseHeader)

ZORUNLU: Tüm yanıtlar için ortak üstbilgi.

remittanceStatementSummary

object (RemittanceStatementSummary)

ZORUNLU: Bu havale ekstresinin özeti.

eventOffset

integer

ZORUNLU: Bu yanıtın etkinlik telafisi.

nextEventOffset

integer

İSTEĞE BAĞLI: Döndürülecek sonraki etkinliğin ofseti. Belirtilmemişse bu ekstrenin alınacak başka etkinliği yoktur.

totalEvents

integer

ZORUNLU: Bu ekstrenin toplam etkinlik sayısı.

totalWithholdingTaxes

string (Int64Value format)

ZORUNLU: Bu bildirim için kesilen tüm vergilerin toplamı.

Bu değer mikro cinsindendir.

captureEvents[]

object (Event)

ZORUNLU: Yakalama etkinlikleri grubu.

refundEvents[]

object (Event)

ZORUNLU: Geri ödeme etkinlikleri grubu.

reverseRefundEvents[]

object (Event)

İSTEĞE BAĞLI: Tersine geri ödeme etkinlikleri grubu.

chargebackEvents[]

object (Event)

İSTEĞE BAĞLI: Ters ibraz etkinlikleri grubu.

reverseChargebackEvents[]

object (Event)

İSTEĞE BAĞLI: Geri döndürülen ters ibraz etkinlikleri grubu.

adjustmentEvents[]

object (Event)

İSTEĞE BAĞLI: Düzenleme etkinlikleri grubu. Faturalandırma tutarsızlıklarını gidermek için Google'ın takdirine bağlı olarak düzenleme etkinlikleri eklenebilir. Örneğin, önceki bir dizi işlem için ücretler eksik hesaplandıysa entegratörün zararını karşılamak için düzenleme kullanılabilir.

RemittanceStatementSummary

Havale ekstresiyle ilgili özet nesne.

JSON gösterimi
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
Alanlar
statementDate

string (int64 format)

ZORUNLU: Bu ekstrenin oluşturulduğu tarih (Amerika/Los Angeles saat diliminde).

billingPeriod

object (BillingPeriod)

ZORUNLU: Bu ekstrenin kapsadığı fatura dönemi.

dateDue

string (int64 format)

İSTEĞE BAĞLI: Havalenin son ödeme tarihi. Bu değer, epoch'tan itibaren geçen milisaniye sayısı olarak gösterilir. Bu bir tarihtir (bu nedenle, faturalandırma saat diliminde her zaman günün ilk milisaniyesinde başlar).

Bu, totalDueByIntegrator değeri 0'dan büyük olduğu sürece ayarlanır.

currencyCode

string

ZORUNLU: ISO 4217 3 harfli para birimi kodu.

totalDueByIntegrator

string (Int64Value format)

ZORUNLU: Bu değer, currencyCode para biriminde mikron cinsindendir. Bu değer her zaman pozitiftir.

remittanceInstructions

object (RemittanceInstructions)

ZORUNLU: Ödemenin nasıl yapılacağıyla ilgili ayrıntılar

BillingPeriod

Bu ekstrenin fatura dönemi.

JSON gösterimi
{
  "startDate": string,
  "endDate": string
}
Alanlar
startDate

string (int64 format)

ZORUNLU: Fatura döneminin başlangıç tarihi. Bu değer, epoch'tan itibaren geçen milisaniye olarak gösterilir. Bu bir tarihtir (bu nedenle, faturalandırma saat diliminde her zaman günün ilk milisaniyesinde başlar).

Bu, fatura döneminin gününün ilk milisaniyesidir (00:00:00.000).

endDate

string (int64 format)

ZORUNLU: Fatura döneminin bitiş tarihi. Bu değer, epoch'tan itibaren geçen milisaniye sayısı olarak gösterilir.

Bu, fatura döneminin son gününün son milisaniyesidir (23:59:59.999).

RemittanceInstructions

Bu havale bildirimi için nasıl ödeme yapılacağıyla ilgili bilgileri içeren yapı.

JSON gösterimi
{
  "memoLineId": string
}
Alanlar
memoLineId

string

ZORUNLU: Havale tanımlaması için ödemenin not satırına girilmesi zorunlu olan tanımlayıcı.

Etkinlik

Havale ekstresine dahil edilen tek bir etkinliği temsil eden yapı.

JSON gösterimi
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
Alanlar
eventRequestId

string

ZORUNLU: Ödeme veya geri ödeme etkinlikleri için bu, Google'ın istekle birlikte gönderdiği requestId olacaktır. Tersine geri ödeme, ters ibraz ve geri döndürülen ters ibraz etkinliklerinde bu, Ödeme Entegratörü'nün söz konusu etkinliğin bildirimiyle birlikte gönderdiği requestId olacaktır. Ayarlamalar için bu, Google tarafından ayarlama etkinliğine atanan benzersiz bir kimliktir.

paymentIntegratorEventId

string

ZORUNLU: Ödeme entegratörünün bu etkinlik için döndürdüğü kimlik. Bir yakalama için bu, capture çağrısına verilen yanıttaki paymentIntegratorTransactionId, geri ödeme için ise refund çağrısına verilen yanıttaki paymentIntegratorRefundId olur.

Bu alan değişken uzunluktadır. Entegratör olarak bu etkinlik için sağladığınız kimlik burada yansıtılır. Entegratör tarafından ilgili etkinlik için bir değer sağlanmamışsa bu alan, eventRequestId alanı ile aynı değeri içerir.

Tersine geri ödeme, ters ibraz ve geri döndürülen ters ibraz etkinliklerinde bu, Ödeme Entegratörü'nün etkinlik bildirimiyle birlikte gönderdiği requestId olacaktır.

Bu alanın uzunluğu ve biçimi, her kimliğin kaynak alanına bağlıdır. Uzunluk ve karakter kümesi şartlarıyla ilgili ayrıntılar için her kaynak alanın belgelerine bakın. Bu alanın bazen, entegrasyon uzmanı tarafından oluşturulan kimliklerden farklı maksimum uzunluk koşullarına sahip olabilen, Google tarafından oluşturulan kimlikler içerebileceğini unutmayın.

eventCharge

string (Int64Value format)

ZORUNLU: Ekstrede tanımlanan para birimi koduyla. Bu değer negatifse Google'dan ödeme entegratörüne aktarılan parasal değeri gösterir. Bu değer pozitifse Google'ın ödeme entegratörüne borcu vardır.

Örneğin, ödeme işlemleri her zaman pozitif, geri ödeme işlemleri ise her zaman negatif olur. Tersine geri ödeme ve geri döndürülen ters ibraz etkinlikleri her zaman pozitiftir. Geri ödeme etkinlikleri her zaman negatif olur.

Bu değer mikro cinsindendir.

eventFee

string (Int64Value format)

ZORUNLU: Ekstrede tanımlanan para birimi koduyla. Bu değer negatifse Google'dan ödeme entegratörüne aktarılan parasal değeri gösterir. Bu değer pozitifse Google'ın ödeme entegratörüne borcu vardır.

Örneğin, bir sözleşmede Google'ın transactionCharge tutarının% 1'ini ödeme entegratörüne ödeyeceği ve bu işlemin geri ödemesi yapıldığında% 1'lik tutarı geri alacağı belirtiliyorsa ödeme alma ücreti negatif, geri ödeme yapıldığında ise geri ödeme ücreti pozitif olur.

Bu değer mikro cinsindendir.

presentmentChargeAmount

string (Int64Value format)

İSTEĞE BAĞLI: Döviz kuru uygulanmadan önceki, sunum para birimindeki (işlem para birimi olarak da bilinir) işlem tutarı. Bu alan, eventCharge alanı ile aynı işaret kuralına uyar.

Bu değer mikro cinsindendir.

presentmentCurrencyCode

string

İSTEĞE BAĞLI: Ödeme (işlem) para birimini belirten ISO 4217 3 harfli para birimi kodu.

exchangeRate
(deprecated)

string (Int64Value format)

DEPRECATED: Gösterim tutarını ödeme (fatura) tutarına dönüştürmede kullanılan döviz kuru.

Bu değer, mikro baz puan cinsindendir (1 baz puan = 0,0001 = %0,01). Yani döviz kurunu almak için bu alanı 10^10'a bölün.

nanoExchangeRate

string (Int64Value format)

İSTEĞE BAĞLI: Sunum tutarının ödeme (fatura) tutarına dönüştürülmesinde kullanılan döviz kuru, nano baz puan cinsinden ifade edilir.

Bu değer, nano baz puanı cinsindendir (1 baz puanı = 0,0001 = %0,01). Yani döviz kurunu elde etmek için bu alanı 10^13'e bölün.

Hem bu alan hem de exchangeRate alanı doldurulur. Bunlar, farklı hassasiyetle ifade edilen eşdeğer döviz kurlarıdır. Gelecekteki sürümlerde, nanoExchangeRate lehine exchangeRate kaldırılacak.