Method: remittanceStatementNotification

Entegratöre yeni bir havale beyanını bildirir.

Google'ın entegratöre ödeyeceği tutarı veya entegratörün Google'a borçlu olduğu parayı temsil eden her yeni ifade ile birlikte ekstre bildirimleri gönderilir.

Entegratör başarılı bir sonuç verirse beyanı aldığını onaylar.

requestId, aynı zamanda ifade kimliğidir (başka bir yerde kullanılır). Başlık içindeki requestId ile paymentIntegratorAccountId kombinasyonu kimlik anahtarı anahtarıdır ve bu ifadeyi benzersiz bir şekilde tanımlar.

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

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


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

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


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

HTTP isteği

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

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

JSON gösterimi
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
Alanlar
requestHeader

object (RequestHeader)

ZORUNLU: Tüm istekler için ortak başlık.

paymentIntegratorAccountId

string

ZORUNLU: Bu ifadeyle ilgili sözleşmeden doğan kısıtlamaları tanımlayan ödeme entegratörü hesap kimliğidir.

remittanceStatementSummary

object (RemittanceStatementSummary)

ZORUNLU: Bu havale özeti.

Yanıt gövdesi

Havale bildirimi bildirim 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)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
Alanlar
responseHeader

object (ResponseHeader)

ZORUNLU: Tüm yanıtlar için ortak başlık.

paymentIntegratorStatementId

string

ZORUNLU: Entegratörün bu ifadeyi bildiği tanımlayıcı. Bu, entegratör tarafından oluşturulmuştur.

result

enum (StatementNotificationResultCode)

ZORUNLU: Bu bildirim bildiriminin sonucu.

RequestHeader

Sunucuya gönderilen tüm isteklerde tanımlanan başlık nesnesi.

JSON gösterimi
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
Alanlar
requestId

string

ZORUNLU: Bu isteğin benzersiz tanımlayıcısı.

Bu dize en fazla 100 karakter uzunluğunda olup yalnızca "a-z", "A-Z", "0-9", ":", "-" ve "_" karakterlerinden oluşur.

requestTimestamp

string (int64 format)

ZORUNLU: Bu isteğin epoch'tan beri geçen milisaniye cinsinden zaman damgası. Alıcı, bu zaman damgasının "şimdi" ± 60 saniyesi olduğunu doğrulamalıdır. Bu istek zaman damgası yeniden denemelerden sonra eş değerde değil.

userLocale
(deprecated)

string

KULLANIMDAN KALDIRILDI: İsteğe bağlı olarak, kısa çizgi ve ISO 3166-1 Alpha-2 ülke kodundan oluşan iki veya üç harfli ISO 639-2 Alfa 3 dil kodu (ör. "pt", "pt-BR", "fil" veya "fil-PH"). Yanıttaki userMessage alanlarını artırmak için bunu kullanın.

protocolVersion

object (Version)

ZORUNLU: Bu isteğin sürümü.

Sürüm

Klasik a.b.c sürüm yapısının yapılandırılmış bir biçimi olan sürüm nesnesi. Aynı numaranın ana sürümlerinin uyumlu olması garanti edilir. Küçük çaplı ayarların ve düzeltmelerin sık sık ve önceden haber verilmeksizin değişebileceğini unutmayın. Entegre edici, aynı ana sürüme yönelik tüm istekleri desteklemelidir.

JSON gösterimi
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
Alanlar
major

integer

ZORUNLU: Ana sürüm. Bu, farklı sürümlere sahip uyumluluk isteklerinin uyumlu olacağı garanti edilmediği için işaretlenir.

minor

integer

ZORUNLU: Alt sürüm. Bu, önemli hata düzeltmelerinin olduğunu gösterir.

revision

integer

ZORUNLU: Alt sürüm. Bu, küçük hata düzeltmelerini belirtir.

RemittanceStatementSummary

Havale özetiyle ilgili özet nesnesi.

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

string (int64 format)

ZORUNLU: Bu bildirimin oluşturulduğu tarih (Amerika/Los Angeles'ta).

billingPeriod

object (BillingPeriod)

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

dateDue

string (int64 format)

İSTEĞE BAĞLI: Havalenin ödenmesi gereken tarih. Dönemden itibaren milisaniye olarak 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, totalDueByIntegrator 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 birimi cinsinden mikro 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. Dönemden itibaren milisaniye olarak temsil edilir. Bu bir tarihtir (ve bu nedenle, faturalandırma saat dilimine göre her zaman günün ilk milisaniyesinde başlar).

Bu, fatura dönemindeki günün ilk milisaniyesidir, 00:00:00.000

endDate

string (int64 format)

ZORUNLU: Fatura döneminin bitiş tarihi. Dönemden itibaren milisaniye olarak temsil edilir.

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

RemittanceInstructions

Bu havale bildiriminin nasıl ödeneceğiyle ilgili bilgileri tutan yapı.

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

string

ZORUNLU: Havale kimliği için ödeme notu satırına eklenmesi zorunlu olan kimlik.

ResponseHeader

Sunucudan gönderilen tüm yanıtlarda tanımlanan başlık nesnesi.

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

string (int64 format)

ZORUNLU: Bu yanıtın zaman damgası, dönemden beri milisaniye olarak gösterilir. Alıcı, bu zaman damgasının "şimdi" ± 60 saniyesi olduğunu doğrulamalıdır.

StatementNotificationResultCode

Ekstre bildirimi için sonuç kodları.

Sıralamalar
UNKNOWN_RESULT Bu varsayılan değeri hiçbir zaman ayarlamayın.
ACCEPTED Entegratör bu ifadeyi kabul etti.