Method: disburseFundsResultNotification

Powiadom Google o wyniku wypłaty po wykonaniu wywołania metody disburseFunds.

Wartość disburseFundsResult jest idempotentna dla disburseFundsRequestId, więc jej wartość musi być identyczna z wartością zwracaną w wywołaniu funkcji disburseFunds i nie można jej zmienić przez kolejne wywołanie tej metody.

Jeśli podczas przetwarzania żądania punkt końcowy otrzyma błąd, odpowiedź z tego punktu końcowego będzie typu ErrorResponse.

Jeśli ta metoda nie zwraca kodu HTTP 200, odpowiedzi na to zapytanie mogą być puste. Treść odpowiedzi jest pusta w sytuacjach, gdy można użyć ErrorResponse z wyraźnym opisem, aby ułatwić atakującemu rozpoznanie identyfikatora konta integratora płatności innych integratorów. W takich przypadkach, jeśli klucz podpisywania nie pasuje, nie znaleziono identyfikatora integratora płatności lub klucz szyfrowania jest nieznany, ta metoda zwraca kod HTTP 404 z pustą treścią. Jeśli będzie można zweryfikować podpis w żądaniu, w treści odpowiedzi zostaną zwrócone dodatkowe informacje o błędzie.

Przykładowe żądanie wygląda tak:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "KcgwSKrV76eVNDUbsZ4UA3",
    "requestTimestamp": "1481852928293"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "disburseFundsRequestId": "awNaC510cefae3IJdNEvW2",
  "disburseFundsResult": {
    "disburseFundsResultCode": "SUCCESS"
  }
}

Przykładowa odpowiedź:


{
  "responseHeader": {
    "responseTimestamp": "1481852928324"
  },
  "result": "SUCCESS"
}

Żądanie HTTP

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

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "disburseFundsRequestId": string,
  "disburseFundsResult": {
    object (DisburseFundsResult)
  }
}
Pola
requestHeader

object (RequestHeader)

REQUIRED: wspólny nagłówek dla wszystkich żądań,
paymentIntegratorAccountId

string

WYMAGANE: identyfikator konta integratora płatności, na którym miała miejsce płatność.
disburseFundsRequestId

string

WYMAGANE: unikalny identyfikator tej transakcji. To jest requestId wygenerowane przez Google podczas wywołania disburseFunds, z którym powiązane jest to żądanie.

Jest to ciąg znaków o maksymalnej długości 100 znaków zawierający tylko znaki „a–z”, „A–Z”, „0–9”, „:”, „-” i „_”.
disburseFundsResult

object (DisburseFundsResult)

WYMAGANE: wynik wywołania tej wypłaty środków.

Treść odpowiedzi

Obiekt odpowiedzi na metodę disburseFundsResultNotification.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": enum (DisburseFundsResultNotificationResultCode)
}
Pola
responseHeader

object (ResponseHeader)

WYMAGANE: wspólny nagłówek wszystkich odpowiedzi.
result

enum (DisburseFundsResultNotificationResultCode)

WYMAGANE: wynik tego połączenia.

Wynik wypłaty

Informacje o ostatecznym wyniku wypłaty.

Zapis JSON 
{
  "disburseFundsResultCode": enum (DisburseFundsResultCode),
  "rawResult": {
    object (RawResult)
  },

  // Union field FailureDetail can be only one of the following:
  "transactionMaxLimit": string,
  "transactionMinLimit": string
  // End of list of possible types for union field FailureDetail.
}
Pola
disburseFundsResultCode

enum (DisburseFundsResultCode)

WYMAGANE: kod wyniku tej wypłaty.
rawResult

object (RawResult)

OPTIONAL: nieprzetworzony wynik tej wypłaty. Dane służą do opracowywania silnika Google Analytics do analizy ryzyka. W przypadku mapowania kodu odrzucenia czasami dochodzi do utraty danych. Integrator może podać nieprzetworzony kod. Brama karty kredytowej (integrator) może na przykład użyć tego pola, by przekazać Google dokładny kod odrzucenia otrzymany od sieci VISA. W tym przypadku scope to „wiza”, a rawCode to wartość zwrócona przez sieć VISA.

Ta wartość jest wymagana, jeśli result nie jest SUCCESS.

Pole sumy FailureDetail.

FailureDetail może mieć tylko jedną z tych wartości:
transactionMaxLimit

string (Int64Value format)

OPCJONALNIE: jeśli disburseFundsResultCode to DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT, jest to wartość maksymalnej dozwolonej transakcji. Służy do tworzenia uporządkowanej wiadomości dla użytkowników i analizowania współczynnika odrzuceń.

Ta kwota to mikro, czyli tyle samo co currencyCode wywołania metody disburseFunds.
transactionMinLimit

string (Int64Value format)

OPCJONALNIE: jeśli disburseFundsResultCode to DISBURSEMENT_UNDER_TRANSACTION_LIMIT, jest to wartość minimalnej dozwolonej transakcji. Służy do tworzenia uporządkowanej wiadomości dla użytkowników i analizowania współczynnika odrzuceń.

Ta kwota to mikro, czyli tyle samo co currencyCode wywołania metody disburseFunds.

Kod wyników wypłaty

Kody połączeń dotyczących wypłaty środków.

Wartości w polu enum
UNKNOWN_RESULT Nie ustawiaj nigdy tej wartości domyślnej!
SUCCESS Płatność zrealizowana.
DISBURSEMENT_UNDER_TRANSACTION_LIMIT Żądana kwota wypłaty nie przekracza minimalnej kwoty integratora dotyczącej danej transakcji. Jeśli używasz tego kodu, w polu transactionMinLimit wpisz minimalną kwotę transakcji do wykorzystania w wiadomościach dla użytkowników.
DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT Żądana kwota wypłaty przekracza maksymalny limit integratora na transakcję. Jeśli używasz tego kodu, w polu transactionMaxLimit wypełnij limit transakcji na potrzeby przesyłania wiadomości do użytkowników.
ACCOUNT_CLOSED Konto użytkownika z integratorem zostało zamknięte. Ta wartość zwrotu spowoduje zamknięcie instrumentu użytkownika w Google. Użytkownik będzie musiał dodać nowy instrument.
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER Konto użytkownika u integratora zostało zamknięte. Podejrzewamy, że konto zostało przejęte. Ta wartość zwrotu spowoduje zamknięcie instrumentu użytkownika w Google. Użytkownik będzie musiał dodać nowy instrument.
ACCOUNT_CLOSED_FRAUD Konto użytkownika z integratorem zostało zamknięte z powodu oszustwa. Ta wartość zwrotu spowoduje zamknięcie instrumentu użytkownika w Google. Użytkownik będzie musiał dodać nowy instrument.
ACCOUNT_ON_HOLD Konto użytkownika jest wstrzymane.

Nieprzetworzony wynik

Nieprzetworzony obiekt wyniku.

Zapis JSON 
{
  "scope": string,
  "rawCode": string
}
Pola
scope

string

OPTIONAL: zakres rawCode może być pusty.
rawCode

string

WYMAGANE: nieprzetworzony kod z integratora lub jego podsystemów.

Kod wyniku zwrotu środków

Kody wyników metody metody disburseFundsResultNotification.

Wartości w polu enum
UNKNOWN_RESULT Nie ustawiaj nigdy tej wartości domyślnej!
SUCCESS Powiadomienie zostało przetworzone.