Welcome to Xendit’s latest documentation. For legacy content, access the previous documentation here or the previous API reference here.

Cara kerja Payments API

Prev Next

API pembayaran kami dirancang agar merchant kami dapat menskalakan pembayaran mereka dengan lebih banyak channel atau volume yang lebih besar sambil menikmati pekerjaan pengembangan yang berkurang untuk setiap tambahan baru. Konsep integrasi dirancang agar sederhana dan dapat digunakan kembali. Rata-rata, pedagang dapat mengharapkan pasar cepat dalam beberapa minggu untuk kasus penggunaan sederhana sementara kasus penggunaan yang lebih kompleks dapat memakan waktu hingga satu bulan.

Endpoint

Ada 3 endpoint integrasi yang membantu melayani fitur Payments API kami:

  1. v3/payment_requests - untuk memulai pembayaran dan mengonfigurasi alur pembayaran

  2. v3/payment_tokens - untuk menyimpan informasi pembayaran untuk digunakan kembali

  3. /refunds - untuk mengembalikan uang kembali ke pengguna akhir


Anda dapat terhubung ke titik akhir ini berdasarkan kebutuhan Anda. Untuk sebagian besar kasus penggunaan pembayaran, kami merekomendasikan v3/payment_requests karena mencakup cakupan skenario pembayaran yang luas.

Membuat pembayaran

Membuat pembayaran semudah menekan titik akhir kita v3/payment_requests dengan beberapa baris kode. You can find our detailed integration guides here.

Contoh payload permintaan

Request - POST /payment_requests

{
  "reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
  "type": "PAY",
  "country": "PH",
  "currency": "PHP",
  "request_amount": 10000.01,
  "capture_method": "AUTOMATIC",
  "channel_code": "GCASH",
  "channel_properties": {
    "failure_return_url": "https://xendit.co/failure",
    "success_return_url": "https://xendit.co/success"
  },
  "description": "Description examples",
  "metadata": {
    "metametadata": "metametametadata"
  }
}

Response - POST /payment requests

{
  "business_id": "5f27a14a9bf05c73dd040bc8",
  "reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
  "payment_request_id": "pr-90392f42-d98a-49ef-a7f3-abcezas123",
  "type": "PAY",
  "country": "PH",
  "currency": "PHP",
  "request_amount": 10000.01,
  "capture_method": "AUTOMATIC",
  "channel_code": "GCASH",
  "channel_properties": {
    "failure_return_url": "https://xendit.co/failure",
    "success_return_url": "https://xendit.co/success"
  },
  "actions": [
    {
      "type": "REDIRECT_CUSTOMER",
      "value": "xendit.co/example",
      "descriptor": "WEB_URL"
    }
  ],
  "status": "REQUIRES_ACTION",
  "description": "Description examples",
  "metadata": {
    "metametadata": "metametametadata"
  },
  "created": "2021-12-31T23:59:59Z",
  "updated": "2021-12-31T23:59:59Z"
}


Endpoint kami v3/payment_requests mengikuti standar REST API dan mencakup kemampuan untuk mengumpulkan pembayaran untuk skenario berikut:

Setelah endpoint dipanggil untuk membuat transaksi pembayaran, API kami akan secara dinamis memandu sistem Anda pada langkah berikutnya yang harus dilakukan dengan pengguna akhir.

Konfirmasi pembayaran

API kami menyediakan konfirmasi pembayaran waktu nyata untuk menjaga sistem Anda tetap sinkron. Ketika pembayaran tidak memerlukan tindakan lebih lanjut dari pengguna akhir dan selesai, API kami langsung memberi tahu sistem Anda secara sinkron di endpoint kami dan saat ini mengirimkan notifikasi webhook ke sistem Anda. Untuk pembayaran yang memerlukan tindakan pengguna akhir, seperti autentikasi 3D Secure, kami akan mengirimkan notifikasi webhook ke sistem Anda saat pembayaran selesai. Anda dapat menemukan rekomendasi kami untuk mengelola webhook di sini..

Kami berusaha untuk konfirmasi pembayaran instan dan menyampaikan konfirmasi dari penyedia pembayaran kepada Anda segera setelah kami menerimanya. Harap diperhatikan bahwa beberapa penyedia pembayaran mungkin mengalami alur konfirmasi yang tertunda, yang dapat memengaruhi kelangsungan pemberitahuan.