Overview

This section will explain about Payment Link API BETA. Merchant can create & manage Payment Link using the API. Payment Link is a web-based link (URL) which can be shared to Customer to receive payments from them – like an invoice. The link will redirect them to Midtrans hosted payment web page.


📘

Payment Link API is still in BETA phase. But is currently usable on Midtrans Production & Sandbox environment. Feel free to contact our Support Team (or your Midtrans' Sales Account Manager) to share your feedback or question.




Pre-requisite


Midtrans merchant account & Midtrans API Keys.




Steps


  1. Merchant's backend sends request to Create Payment Link API, in order to retrieve payment URL.
  2. Share the payment URL to Customer (e.g. via system, messaging app, or Midtrans automated email), and then wait for them to proceed to payment.
  3. Merchant gets notified of payment status changes & handles accordingly.

Optional:


Merchant can also use other API endpoints to manage Payment Link. For example to read/delete Payment Link as needed.