Obiekt: ErrorResponse

Treść odpowiedzi

Treść HTTP dla wszystkich odpowiedzi HTTP innych niż 200.

Przykładowa odpowiedź wygląda tak:


  {
    "responseHeader": {
      "requestTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
Zapis JSON 
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
Pola
responseHeader

object(ResponseHeader)

REQUIRED: wspólny nagłówek wszystkich odpowiedzi.

errorResponseCode

string

OPCJONALNIE: podaj jeden z kodów wymienionych w tabeli poniżej.

Kody odpowiedzi na błędy i zalecane kody HTTP
INVALID_API_VERSION 400

Używana, jeśli integrator nie obsługuje wersji interfejsu API żądania.

INVALID_PAYLOAD_SIGNATURE 401

Używana, jeśli podpis ładunku jest przeznaczony dla nieznanego lub nieaktywnego klucza.

INVALID_PAYLOAD_ENCRYPTION 400

Używana, jeśli szyfrowanie ładunku jest kierowane do nieznanego lub nieaktywnego klucza.

REQUEST_TIMESTAMP_OUT_OF_RANGE 400

Używana, jeśli request_timestamp nie mieści się w zakresie ± 60 s od bieżącej wartości.

INVALID_IDENTIFIER 404

Używana, jeśli identyfikator wysłany w żądaniu był nieprawidłowy lub nieznany. Mogą to być paymentIntegratorAccountId, googlePaymentToken, captureRequestId itp. Typ nieprawidłowego identyfikatora należy określić w errorDescription.

IDEMPOTENCY_VIOLATION 412

Używana, jeśli żądanie narusza wymagania dotyczące idempotentności.

INVALID_FIELD_VALUE 400

Używana, jeśli żądanie zawiera wartość pola, którego nie ma w zestawie obsługiwanych wartości.

MISSING_REQUIRED_FIELD 400

Używana, jeśli wymagane pole nie jest ustawione w żądaniu.

PRECONDITION_VIOLATION 400

Używana, jeśli ograniczenie operacji zostanie naruszone (np. gdy żądanie zwrotu środków przekracza kwotę pozostałą w transakcji).

USER_ACTION_IN_PROGRESS 400

Używana, jeśli żądanie nie może zostać obecnie przetworzone, ponieważ spowodowałoby to przerwanie trwającego działania użytkownika, które w efekcie działa jak blokada systemu. Tego kodu nie można używać do wskazywania błędów spowodowanych wewnętrznymi błędami równoczesności związanymi z implementacją.

INVALID_DECRYPTED_REQUEST 400

Używana, jeśli można odszyfrować ładunek żądania, ale nie udało się przeanalizować wynikowego komunikatu.

errorDescription

string

OPCJONALNY: podaj opis tego stanu, aby przedstawiciele zespołu pomocy mogli debugować błędy. Pamiętaj, że użytkownicy nigdy nie zobaczą tych informacji. Może zawierać opis bez danych poufnych, który jest używany do debugowania. Niektóre wartości parametru errorResponseCode powinny być uzupełnione o dodatkowe informacje w tym polu (np. przy wartości INVALID_IDENTIFIER powinny być podane informacje o nieprawidłowym typie identyfikatora).