NAV undefined
bash php javascript java go python

2019-02-04

Callback Status Pembayaran

Anda butuh menyediakan endpoint pada sistem anda untuk menerima callback notifikasi pembayaran dari sistem kami. Anda akan menerima callback ketika pelanggan anda menyelesaikan pembayaran DANA dan LINKAJA.

Callback notifikasi pembayaran akan dikirim melalui request POST ke "callback_url" yang anda isi di request pembuatan pembayaran. Catatan: Mohon berikan respon kembali dengan status 200 agar kami tahu bahwa notifkasi telah diterima.

Versi

Anda sedang melihat API versi 2019-02-04. Versi yang terbaru telah tersedia!

Contoh Callback Status Pembayaran

DANA

{
  "external_id": "dana-ewallet",
  "amount": 1001,
  "business_id": "5850eteStin791bd40096364",
  "payment_status": "PAID",
  "transaction_date": "2019-04-07T01:35:46.658Z",
  "callback_authentication_token": "sample-token-id=="
}
Parameter Tipe Deskripsi
external_id string Identifikasi dari pembayaran Anda, yang ada isi ketika mengirimkan Generate Checkout URL request.
amount string Nominal transaksi.
business_id string business_id Anda yang terdaftar pada sistem kami.
payment_status string Status pembayaran.
Catatan: Status yang ada adalah EXPIRED dan PAID.
transaction_date string Waktu ketika pembayaran dibuat.
callback_authentication_token string Verifikasi API Key callback Anda yang dapat ditemukan pada dasbor Xendit Anda. Anda butuh melakukan verifikasi nilai ini apakah memiliki nilai yang sama.

LINKAJA

LINKAJA

{
  "external_id": "linkaja-ewallet",
  "amount": 300000,
  "items": [
    {
      "id": "123123",
      "name": "Phone Case",
      "price": 100000,
      "quantity": 1
    },
    {
      "id": "345678",
      "name": "Powerbank",
      "price": 200000,
      "quantity": 1
    }
  ],
  "status": "SUCCESS_COMPLETED",
  "ewallet_type": "LINKAJA",
  "callback_authentication_token": "sample-token-id=="
}
Parameter Tipe Deskripsi
external_id string Identifikasi dari pembayaran Anda, yang ada isi ketika mengirimkan Generate Checkout URL request.
amount number Nominal pembayaran yang telah Anda isi ketika melakukan Generate Checkout URL request.
items array of item Daftar dari barang / produk yang ada isi ketika mengirimkan Generate Checkout URL request.
item object
 item detail Informasi dari barang / produk, akan mengandung: id [string], name [string], price [number], type [string], url [string], quantity [number]
status string Status dari pembayaran.
Catatan: Status yang ada adalah FAILED dan SUCCESS_COMPLETED
ewallet_type string Tipe eWallet yang Anda pilih ketika membuat request pembayaran.
Supported ewallet types: OVO, DANA, dan LINKAJA
callback_authentication_token string Berisi Callback Verification API Key yang Anda bisa temukan di Dashboard Xendit. Anda perlu verifikasi kembali apakah ini memiliki isi yang sama

Callback Status Pembayaran

Anda butuh menyediakan endpoint pada sistem anda untuk menerima callback notifikasi pembayaran dari sistem kami. Anda akan menerima callback ketika pelanggan anda menyelesaikan pembayaran OVO, DANA, LINKAJA dan Shopeepay.

Callback notifikasi pembayaran akan dikirim melalui request POST ke "callback_url" yang anda isi di request pembuatan pembayaran. Catatan: Mohon berikan respon kembali dengan status 200 agar kami tahu bahwa notifkasi telah diterima.

Versi

Anda sedang melihat API versi 2020-02-01. Klik di sini untuk melihat versi sebelumnya.

Versi Changelog
2020-02-01 (terbaru) Berisi flow yang asynchronous dengan callback dari pembuatan pembayaran OVO.
2019-02-04 Mengembalikan respon secara langsung tanpa adanya callback.

Contoh Callback Status Pembayaran

OVO

Data Callback

Contoh: Callback Status Pembayaran Berhasil

{
  "event": "ewallet.payment",
  "id": "6bb25ae6-cf57-437a-9b36-7ad2ee17b727",
  "external_id": "ECLrAZPq8F6",
  "business_id": "5850eteStin791bd40096364",
  "phone": "081234567890",
  "ewallet_type": "OVO",
  "amount": 20000,
  "created": "2019-11-01T12:34:56.007Z",
  "status": "COMPLETED"
}
Parameter Tipe Deskripsi
event required string Available value: "ewallet.payment"
id required string Unique identifier generated for the payment (payment_id)
external_id
required		 string ID yang merupakan identifikasi unik dari setiap request
business_id
required		 string ID yang merupakan identifikasi unik untuk merchant
phone
required		 string Nomor telepon pelanggan
ewallet_type
required		 string Tipe dari e-wallet. Nilai: OVO
amount
required		 number Nominal yang diinginkan
status
required		 string Status pembayaran.
Nilai: FAILED, COMPLETED
failure_code optional string Bila pembayaran berstatus FAILED, kami memasukkan failure_code untuk detil dari kegagalan.
Nilai: Lihat kolom Kode Kegagalan pada tabel ini
created
required		 string Timestamp ISO 8601 saat request pembuatan pembayaran dilakukan (dalam UTC)

Kode Kegagalan (Failure Code)

Contoh: Callback Status Pembayaran Gagal

{
  "event": "ewallet.payment",
  "id": "6bb25ae6-cf57-437a-9b36-7ad2ee17b727",
  "external_id": "ECLrAZPq8F6",
  "business_id": "5850eteStin791bd40096364",
  "phone": "081234567890",
  "ewallet_type": "OVO",
  "amount": 20000,
  "failure_code": "USER_DECLINED_THE_TRANSACTION",
  "status": "FAILED"
}
Kode Kegagalan Deskripsi
USER_DID_NOT_AUTHORIZE_THE_PAYMENT
Pengguna tidak melakukan autorisasi pembayaran dalam kurun waktu yang ditentukan
USER_DECLINED_THE_TRANSACTION
Pengguna menolak request pembayaran
PHONE_NUMBER_NOT_REGISTERED
Nomor handphone tidak terdaftar
EWALLET_APP_UNREACHABLE
eWallet provide/server tidak dapat dijangkau oleh aplikasi ewallet/handphone pengguna. Kasus umum yang terjadi adalah karena aplikasi ewallet di-uninstalled/isu pada jaringan.
OVO_TIMEOUT_ERROR
Terdapat timeout connection dari aplikasi OVO ke server OVO
CREDENTIALS_ERROR
Merchant tidak terdaftar di sistem penyedia eWallet
ACCOUNT_AUTHENTICATION_ERROR
Autentikasi user gagal
ACCOUNT_BLOCKED_ERROR
Tidak dapat memproses transaksi karena akun pengguna diblok
SENDING_TRANSACTION_ERROR
Eror ketika mengirimkan notifikasi transaksi ke OVO
EXTERNAL_ERROR
Terdapat eror pada sisi penyedia eWallet

DANA

Contoh: Callback Status Pembayaran Berhasil

{
  "external_id": "dana-ewallet",
  "amount": 1001,
  "business_id": "5850eteStin791bd40096364",
  "payment_status": "PAID",
  "transaction_date": "2020-03-20T04:54:10+07:00",
  "ewallet_type": "DANA",
  "callback_authentication_token": "sample-token-id=="
}
Parameter Tipe Deskripsi
external_id string Identifikasi dari pembayaran Anda, yang ada isi ketika mengirimkan Generate Checkout URL request.
amount number Nominal transaksi.
business_id string business_id Anda yang terdaftar pada sistem kami.
payment_status string Status pembayaran.
Catatan: Status yang ada adalah EXPIRED dan PAID.
transaction_date string Waktu ketika pembayaran dibuat.
ewallet_type string Tipe eWallet yang Anda pilih ketika membuat request pembayaran.
Supported ewallet types: OVO, DANA, dan LINKAJA
callback_authentication_token string Verifikasi API Key callback Anda yang dapat ditemukan pada dasbor Xendit Anda. Anda butuh melakukan verifikasi nilai ini apakah memiliki nilai yang sama.

LINKAJA

Contoh: Callback Status Pembayaran Berhasil

{
  "external_id": "linkaja-ewallet",
  "amount": 300000,
  "items": [
    {
      "id": "123123",
      "name": "Phone Case",
      "price": 100000,
      "quantity": 1
    },
    {
      "id": "345678",
      "name": "Powerbank",
      "price": 200000,
      "quantity": 1
    }
  ],
  "status": "SUCCESS_COMPLETED",
  "ewallet_type": "LINKAJA",
  "callback_authentication_token": "sample-token-id=="
}
Parameter Tipe Deskripsi
external_id string Identifikasi dari pembayaran Anda, yang ada isi ketika mengirimkan Generate Checkout URL request.
amount number Nominal pembayaran yang telah Anda isi ketika melakukan Generate Checkout URL request.
items array of item Daftar dari barang / produk yang ada isi ketika mengirimkan Generate Checkout URL request.
item object
 item detail Informasi dari barang / produk, akan mengandung: id [string], name [string], price [number], type [string], url [string], quantity [number]
status string Status dari pembayaran.
Catatan: Status yang ada adalah FAILED dan SUCCESS_COMPLETED
ewallet_type string Tipe eWallet yang Anda pilih ketika membuat request pembayaran.
Supported ewallet types: OVO, DANA, dan LINKAJA
callback_authentication_token string Berisi Callback Verification API Key yang Anda bisa temukan di Dashboard Xendit. Anda perlu verifikasi kembali apakah ini memiliki isi yang sama

Shopeepay

{}

Saluran pembayaran Shopeepay akan tersedia di Xendit [eWallet BETA endpoint] (https://developers.xendit.co/ewallets-beta/#tag/eWallets-Callback-Notifications).

Seluruh saluran pembayaran eWallet kami akan digabungkan ke dalam endpoint ini. Seluruh endpoint yang ada saat ini akan tetap tersedia dan dipertahankan.

Changelog

Versi 2020-02-01 (terbaru)

Request pembayaran dengan OVO menggunakan flow baru yang asynchronous dengan callback dari pembuatan pembayaran e-wallet.

Versi 2019-02-04

Mengembalikan respon secara langsung secara synchronous tanpa adanya callback.