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

Bayar (One-off payment)

Prev Next

Bentuk transaksi yang paling dasar adalah guest checkout, juga disebut one-off payment. Guest checkout digunakan oleh sebagian besar merchant sebagai titik awal penagihan pembayaran sebelum beralih ke alur yang lebih maju untuk mengoptimalkan tingkat keberhasilan.

Di artikel ini, kita akan membahas integrasi dasar dengan Payments API kami untuk guest checkout untuk jenis alur PAY pada /payment_requests. Sebelum memulai, pastikan Anda telah menyelesaikan pengaturan environment integrasi Anda.

Alur Integrasi

Cara integrasi

  1. Buat halaman checkout untuk channel pembayaran yang dipilih

    Di aplikasi Anda, siapkan alur checkout untuk memfasilitasi langkah-langkah pembayaran yang akan dilalui pengguna akhir. Untuk langkah pertama, buat halaman checkout tempat channel pembayaran ditampilkan. Pengguna akhir akan memilih channelpembayaran yang mereka inginkan di sini.

    Kami menyarankan untuk mengurutkan daftar channel pembayaran berdasarkan yang disukai oleh grup pengguna yang Anda targetkan. Anda juga dapat mempertimbangkan biaya atau batas jumlah pembayaran.

  2. Kumpulkan data yang diperlukan untuk channel pembayaran yang dipilih
    Setelah pengguna akhir memilih channel, kumpulkan data yang diperlukan untuk memulai pembayaran dengan penyedia channel pembayaran. Lihat Routing channel pembayaran untuk daftar lengkap informasi yang diperlukan.

  3. Buat permintaan pembayaran
    Buat API request body dengan informasi yang diperlukan oleh channel pembayaran Anda. Dalam skenario guest checkout, permintaan type pembayaran Anda harus .PAY

    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"
    }


    Fitur tambahan dapat dikonfigurasi jika channel pembayaran mengizinkannya. Misalnya, Anda akan dapat mengatur waktu kedaluwarsa permintaan pembayaran kustom jika kolom properti channel menerima parameter expires_at.

  4. Tangani tindakan yang diperlukan

    Setelah berhasil membuat permintaan pembayaran dengan Xendit, Anda akan menerima objek permintaan pembayaran kami. Jika status permintaan pembayaran adalah REQUIRES_ACTION, Anda harus melakukan beberapa tindakan pada aplikasi klien agar pengguna akhir dapat menyelesaikan pembayaran. Jika tidak ada tindakan yang diperlukan, status pembayaran akhir akan dikembalikan secara sinkron dan webhook dengan pembaruan status pembayaran akan dikirim.

    1. Presentasikan kepada pelanggan

      1. Tindakan "ketik": "PRESENT_TO_CUSTOMER"

      2. Di aplikasi klien, tampilkan nilai tindakan kepada pengguna. Jika itu adalah string QR, Anda mungkin perlu merendernya menjadi kode QR yang dapat dipindai. Untuk memaksimalkan tingkat keberhasilan pembayaran, Anda harus menyertakan beberapa instruksi pembayaran di samping nilai yang ditampilkan.

    2. Pengalihan

      1. Tindakan "type": "REDIRECT_CUSTOMER"

      2. Di aplikasi klien, arahkan pengguna ke nilai url dalam tindakan. Untuk memaksimalkan tingkat keberhasilan pembayaran, Anda harus menangani pengalihan berdasarkan jenis perangkat pengguna. Perhatikan bahwa untuk channel pembayaran tertentu, ada aturan pengalihan untuk tertunda atau pembatalan. Aplikasi Anda harus dirancang untuk menangani skenario tersebut.

  5. Terima webhook event pembayaran untuk konfirmasi pembayaran
    Setelah pengguna akhir menyelesaikan langkah otentikasi pembayaran mereka dan penyedia metode pembayaran memberi tahu Xendit tentang pembaruan, Xendit akan melanjutkan untuk mengirim webhook ke url webhook yang Anda konfigurasikan di halaman pengaturan dasbor Xendit Anda.

    {
      "event": "payment.capture",
      "business_id": "5f27a14a9bf05c73dd040bc8",
      "created": "2021-12-02T14:52:21.566Z",
      "data": {
        "payment_id": "py-1402feb0-bb79-47ae-9d1e-e69394d3949c",
        "business_id": "5f27a14a9bf05c73dd040bc8",
        "reference_id": "90392f42-d98a-49ef-a7f3-abcezas123",
        "payment_request_id": "pr-1102feb0-bb79-47ae-9d1e-e69394d3949c",
        "type": "PAY",
        "country": "PH",
        "currency": "PHP",
        "request_amount": 10000.01,
        "capture_method": "AUTOMATIC",
        "channel_code": "GCASH",
        "channel_properties": {
          "success_return_url": "https://xendit.co/success",
          "failure_return_url": "https://xendit.co/failure"
        },
        "captures": [
          {
            "capture_timestamp": "2029-12-31T23:59:59Z",
            "capture_id": "cap-1502feb0-bb79-47ae-9d1e-e69394d3949c",
            "capture_amount": 10000.01
          }
        ],
        "status": "SUCCEEDED",
        "payment_details": {
          "remark": "example remark"
        },
        "metadata": {
          "metametadata": "metametametadata"
        },
        "created": "2029-12-31T23:59:59Z",
        "updated": "2029-12-31T23:59:59Z"
      }
    }

  6. Tampilkan status pembayaran kepada pengguna

    Dengan status webhook, Anda seharusnya dapat menyelesaikan perjalanan pembayaran untuk pengguna akhir dengan berhasil menyelesaikan transaksi atau mengarahkan mereka kembali untuk dicoba lagi jika gagal.

    Di semua sistem pesan waktu nyata, ada kemungkinan webhook tidak mencapai sistem Anda. Aplikasi Anda juga harus melayani skenario di mana webhook tidak diterima saat pengguna akhir masih menunggu di layar mereka. Dalam kasus seperti itu, disarankan untuk pemberitahuan pembayaran yang tertunda diberikan kepada pengguna akhir saat Anda menunggu webhook dari Xendit.

Status Lifecycle

Perlukan tindakan dari pengguna

Berikut adalah status lifecycle untuk permintaan pembayaran yang memerlukan tindakan pengguna:

Status

Deskripsi

Event Webhook

REQUIRES_ACTION

Permintaan pembayaran memasuki status ini secara sinkron setelah respons API jika tindakan pengguna diperlukan untuk menyelesaikan otorisasi. Tangani actions objek pada tahap ini.

-

BERHASIL

Permintaan pembayaran beralih ke status ini saat pembayaran berhasil diselesaikan. Xendit akan mengirimkan webhook payment.capture yang berisi payment_request_id untuk mengidentifikasi permintaan. Anda harus menyimpan bukti pembayaran payment_id .

  • payment.capture

GAGAL

Permintaan pembayaran beralih ke status ini saat pembayaran gagal. Xendit akan mengirimkan webhook payment.failure yang berisi payment_request_id untuk mengidentifikasi permintaan. Centang untuk failure_code menentukan tindakan berikutnya.

Catatan: Tidak semua channelpembayaran memberikan notifikasi untuk pembayaran yang gagal.

  • payment.failure

DIBATALKAN

Anda dapat membatalkan permintaan pembayaran yang berstatus REQUIRES_ACTION . Pembatalan akan segera mentransisikan permintaan pembayaran ke CANCELED, dan pengguna akhir tidak akan dapat lagi menyelesaikan file actions.

-

KEDALUWARSA

Permintaan pembayaran beralih ke status ini saat kedaluwarsa karena kedaluwarsa partner pembayaran.

-


Tidak perlu tindakan

Berikut adalah status lifecycle untuk permintaan pembayaran yang tidak memerlukan tindakan:

Status

Deskripsi

Event Webhook

BERHASIL

Permintaan pembayaran bertransisi ke status ini secara sinkron saat pembayaran segera berhasil. Anda masih akan menerima webhook payment.capture yang berisi detail pembayaran.

  • payment.capture

GAGAL

Permintaan pembayaran bertransisi ke status ini secara sinkron saat pembayaran segera gagal. Anda masih akan menerima webhook payment.failure .

Catatan: Tidak semua channel pembayaran memberikan notifikasi untuk pembayaran yang gagal.

  • payment.failure

TERTUNDA

Permintaan pembayaran memasuki status ini secara sinkron setelah respons API jika mitra pembayaran belum merespons dengan hasil pembayaran. Tunggu hingga webhook pembayaran tiba di URL webhook yang dikonfigurasi.

-