Objek: ErrorResponse

Isi respons

Isi HTTP untuk semua respons HTTP non-200.

Contoh respons terlihat seperti ini:


  {
    "responseHeader": {
      "responseTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
Representasi JSON 
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
Kolom
responseHeader

object(ResponseHeader)

WAJIB: Header umum untuk semua respons.

errorResponseCode

string

OPTIONAL: Berikan salah satu kode yang tercantum dalam tabel di bawah.

Kode Respons Error dan Kode HTTP yang Disarankan
INVALID_API_VERSION 400

Digunakan jika integrator tidak mendukung versi API permintaan.

INVALID_PAYLOAD_SIGNATURE 401

Digunakan jika tanda tangan payload adalah untuk kunci yang tidak diketahui atau tidak aktif.

INVALID_PAYLOAD_ENCRYPTION 400

Digunakan jika enkripsi payload adalah ke kunci yang tidak diketahui atau tidak aktif.

REQUEST_TIMESTAMP_OUT_OF_RANGE 400

Digunakan jika request_timestamp bukan ± 60 detik saat ini.

INVALID_IDENTIFIER 404

Digunakan jika ID yang dikirim dalam permintaan tidak valid atau tidak diketahui. Ini dapat mencakup paymentIntegratorAccountId, googlePaymentToken, captureRequestId, dll. Jenis ID yang tidak valid harus ditentukan di errorDescription.

IDEMPOTENCY_VIOLATION 412

Digunakan jika permintaan melanggar persyaratan idempotensi untuk permintaan.

INVALID_FIELD_VALUE 400

Digunakan jika permintaan berisi nilai untuk kolom yang tidak ada dalam kumpulan nilai yang didukung.

MISSING_REQUIRED_FIELD 400

Digunakan jika kolom yang diperlukan tidak ditetapkan dalam permintaan.

PRECONDITION_VIOLATION 400

Digunakan jika terjadi pembatasan pada operasi (misalnya, saat permintaan pengembalian dana melebihi jumlah yang tersisa di transaksi).

USER_ACTION_IN_PROGRESS 400

Digunakan jika permintaan tidak dapat diproses saat ini karena akan mengganggu tindakan pengguna dalam proses yang secara efektif bertindak sebagai penguncian sistem. Kode ini tidak boleh digunakan untuk menunjukkan kegagalan akibat error serentak internal khusus implementasi.

INVALID_DECRYPTED_REQUEST 400

Digunakan jika payload permintaan dapat didekripsi, tetapi pesan yang dihasilkan tidak dapat diuraikan.

errorDescription

string

OPSIONAL: Berikan deskripsi tentang status ini kepada perwakilan dukungan untuk melakukan debug pada error. Perhatikan bahwa ini tidak pernah ditampilkan kepada pengguna. File ini dapat berisi teks deskriptif dan tidak sensitif yang digunakan untuk proses debug. Perhatikan bahwa beberapa nilai untuk errorResponseCode harus disertai dengan detail tambahan dalam kolom ini (misalnya, INVALID_IDENTIFIER harus disertai dengan informasi di kolom ini mengenai jenis ID mana yang tidak valid).