- HTTP isteği
- İstek gövdesi
- Yanıt metni
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- Etkinlik
Bir havale ekstresiyle ilgili işlem ayrıntı bilgilerini döndürür.
Bu, sayfalara ayrı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, ifadedeki bir sonraki işlem etkinliğini gösteren bir nextEventOffset
ve ifadedeki toplam işlem sayısını belirten totalEvents
döndürür. Alınan geçerli sayfa ifadenin son işlemlerini içeriyorsa yanıtta nextEventOffset
görünmez.
statementId
değeri, remittanceStatementNotificationRequest
içindeki requestId
değeridir
Uç nokta, isteği işlerken bir hatayla karşılaşırsa bu uç noktadan gelen yanıt
türünde olur.ErrorResponse
Bu yöntem HTTP 200 döndürmezse bu sorguya verilen yanıtlar boş olabilir. Açık açıklamaya sahip bir
, saldırganların diğer entegratörlerin ödeme entegrasyon hesap tanımlayıcılarını anlamasına yardımcı olmak için kullanılabileceği durumlarda yanıt gövdesi boştur. İmzalama anahtarının eşleşmediği, ödeme entegratörü tanımlayıcısının bulunamadığı veya şifreleme anahtarının bilinmediği durumlarda bu yöntem, gövdesi boş bir HTTP 404 döndürür. İstek imzası doğrulanabilirse yanıt gövdesinde hatayla ilgili ek bilgiler döndürülür.ErrorResponse
Örnek istek:
{
"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 aşağıdaki gibidir:
{
"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 içeriği
İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:
JSON gösterimi |
---|
{
"requestHeader": {
object ( |
Alanlar | |
---|---|
requestHeader |
ZORUNLU: Tüm istekler için ortak başlık. |
paymentIntegratorAccountId |
ZORUNLU: Bu ekstreyle ilgili sözleşmeden doğan kısıtlamaları tanımlayan ödeme entegratörü hesap tanımlayıcısıdır. |
statementId |
ZORUNLU: Ekstre bildiriminin istek kimliği. |
eventOffset |
İSTEĞE BAĞLI: Bu zaman farkından başlayan etkinlikleri döndürür. Bir istek döndürüldüyse bu değer |
numberOfEvents |
İ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 olacaktır. |
Yanıt gövdesi
Havale beyanı ayrıntı 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 ( |
Alanlar | |
---|---|
responseHeader |
ZORUNLU: Tüm yanıtlar için ortak başlık. |
remittanceStatementSummary |
ZORUNLU: Bu havale ekstresinin özeti. |
eventOffset |
ZORUNLU: Bu yanıtın etkinlik ofseti. |
nextEventOffset |
İSTEĞE BAĞLI: Döndürülecek bir sonraki etkinliğin ofseti. Belirtilmemişse bu ifade için alınacak başka etkinlik yok. |
totalEvents |
ZORUNLU: Bu ifadedeki toplam etkinlik sayısı. |
totalWithholdingTaxes |
ZORUNLU: Bu beyan için kesinti yapılan tüm vergilerin toplamı. Bu değer mikro cinsindendir. |
captureEvents[] |
ZORUNLU: Yakalama etkinlikleri grubu. |
refundEvents[] |
ZORUNLU: Geri ödeme etkinlikleri grubu. |
reverseRefundEvents[] |
İSTEĞE BAĞLI: Geri ödeme etkinlikleri grubu. |
chargebackEvents[] |
İSTEĞE BAĞLI: Ters ibraz etkinlikleri grubu. |
reverseChargebackEvents[] |
İSTEĞE BAĞLI: Ters ters ibraz etkinlikleri grubu. |
adjustmentEvents[] |
İSTEĞE BAĞLI: Düzenleme etkinlikleri grubu. Faturalandırma tutarsızlıklarını telafi etmek için Google'ın takdirine bağlı olarak düzenleme etkinlikleri eklenebilir. Örneğin, önceki bir grup işlem için ücretler eksik hesaplanmışsa bir düzenleme bütünleyiciyi bütünleştirmek için bir düzenleme kullanılabilir. |
RemittanceStatementSummary
Havale özetiyle ilgili özet nesnesi.
JSON gösterimi |
---|
{ "statementDate": string, "billingPeriod": { object ( |
Alanlar | |
---|---|
statementDate |
ZORUNLU: Bu bildirimin oluşturulduğu tarih (Amerika/Los Angeles'ta). |
billingPeriod |
ZORUNLU: Bu ekstrenin yer aldığı fatura dönemidir. |
dateDue |
İSTEĞE BAĞLI: Havalenin yapılması gereken tarih. Bu değer, epoch'tan itibaren milisaniye cinsinden temsil edilir. Bu bir tarihtir (ve bu nedenle faturalandırma saat dilimine göre her zaman günün ilk milisaniyesinde başlar). Bu, |
currencyCode |
ZORUNLU: ISO 4217 3 harfli para birimi kodu. |
totalDueByIntegrator |
ZORUNLU: Bu değer mikro cinsinden |
remittanceInstructions |
ZORUNLU: Ödemenin nasıl yapılacağına ilişkin ayrıntılar |
BillingPeriod
Bu ekstrenin fatura dönemi.
JSON gösterimi |
---|
{ "startDate": string, "endDate": string } |
Alanlar | |
---|---|
startDate |
ZORUNLU: Fatura döneminin başlangıç tarihi. Bu değer, epoch'tan itibaren milisaniye cinsinden temsil edilir. Bu bir tarihtir (ve bu nedenle faturalandırma saat dilimine göre her zaman günün ilk milisaniyesinde başlar). Bu değer, fatura dönemi gününün ilk milisaniyesi olan 00:00:00.000'dır. |
endDate |
ZORUNLU: Fatura döneminin bitiş tarihi. Bu değer, epoch'tan itibaren milisaniye cinsinden temsil edilir. Bu değer, fatura döneminin son gününün son milisaniyesi olan 23:59:59.999'dur. |
RemittanceInstructions
Bu havale bildiriminin nasıl ödeneceğine dair bilgilerin bulunduğu yapı.
JSON gösterimi |
---|
{ "memoLineId": string } |
Alanlar | |
---|---|
memoLineId |
ZORUNLU: Havale kimliği ödemesi için not satırına eklenmesi zorunlu olan tanımlayıcı. |
Etkinlik
Havale beyanında yer alan 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 |
ZORUNLU: Yakalama veya geri ödeme etkinlikleri için Google'ın istekle birlikte gönderdiği |
paymentIntegratorEventId |
ZORUNLU: Bu etkinlik için döndürülen ödeme entegrasyon uzmanını tanımlayın. Bu, bir yakalama için Bu alanın uzunluğu değişkendir. Bir entegrasyon aracı olarak, bu etkinlik için sağladığınız kimlik burada gösterilir. Karşılık gelen etkinlik için entegratör tarafından bir değer sağlanmadıysa bu alan, Ters geri ödeme, ters ibraz ve ters ters ibraz etkinlikleri için, Ödeme Entegratörünün etkinlik bildirimiyle birlikte gönderdiği Bu alanın uzunluğu ve biçimi, her kimliğin kaynak alanına bağlıdır. Uzunluk ve karakter kümesi gereksinimleriyle ilgili ayrıntılar için her kaynak alanının dokümanlarına bakın. Özellikle bu alanın, entegratör tarafından oluşturulan kimliklerden farklı maksimum uzunluk gereksinimlerine sahip olabilecek, Google tarafından oluşturulan kimlikler içerebileceğini unutmayın. |
eventCharge |
ZORUNLU: İfade tarafından tanımlanan para birimi kodudur. Negatifse bu değer, Google'dan ödeme entegratörüne geçişin parasal değerini gösterir. Bu pozitifse ödeme entegrasyon uzmanından Google ile iletişime geçmiştir. Örneğin, yakalama işlemleri her zaman pozitif, geri ödeme işlemleri ise her zaman negatif olur. Ters geri ödeme ve ters ters ibraz etkinlikleri her zaman olumlu yönde olacaktır. Ters ibraz etkinlikleri her zaman olumsuz olur. Bu değer mikro cinsindendir. |
eventFee |
ZORUNLU: İfade tarafından tanımlanan para birimi kodudur. Negatifse bu değer, Google'dan ödeme entegratörüne geçişin parasal değerini gösterir. Bu pozitifse ödeme entegrasyon uzmanından Google ile iletişime geçmiştir. Örneğin, bir anlaşmada Google'ın ödeme entegrasyon sağlayıcısına Bu değer mikro cinsindendir. |
presentmentChargeAmount |
İSTEĞE BAĞLI: Döviz kurundan önceki bugünkü (işlem) para birimi cinsinden işlem tutarı. Bu alanda da Bu değer mikro cinsindendir. |
presentmentCurrencyCode |
İSTEĞE BAĞLI: Sunum (işlem) para birimini gösteren, ISO 4217 3 harfli para birimi kodu. |
exchangeRate |
İSTEĞE BAĞLI: Vadeli ödeme tutarını ödeme (fatura) tutarına dönüştürmek için kullanılan döviz kuru. Bu değer, mikro temel noktalardır (1 temel nokta = 0,0001 = %0,01). Diğer bir deyişle, döviz kurunu elde etmek için bu alanı 10^10'a bölün. |
nanoExchangeRate |
İSTEĞE BAĞLI: Vadeli ödeme tutarını takas (fatura) tutarına dönüştürmek için kullanılan döviz kuru. Nano bazlı tutar olarak ifade edilir. Bu değer, nano temel noktalardır (1 temel nokta = 0,0001 = %0,01). Diğer bir deyişle, döviz kurunu elde etmek için bu alanı 10^13'e bölün. Hem bu alan hem de exchangeRate doldurulur. Bu döviz kurları, farklı kesinlik değerleriyle ifade edilen eşdeğer döviz kurlarıdır. Gelecekteki sürümlerde exchangeRate çıkarılarak nanoExchangeRate kullanılacaktır. |