POST
Create Payment Checkout

Overview

Create a payment checkout session that allows customers to select payment method and complete payment.

Order Details

Checkout can show customer-facing order information when you send the recommended fields inside metadata. This is useful so customers can confirm what they are paying for before choosing a payment method. Recommended metadata keys: Keep sensitive data outside metadata because selected order fields can be shown on the public checkout page.

Request Body

Response Example

Features

  • Multiple payment method selection
  • Customizable checkout page
  • Customer-facing order details from safe metadata fields
  • Optional per-checkout redirect URL after payment completion
  • Automatic expiration after 24 hours
  • Real-time payment status updates

Authorizations

X-DOMPAY-API-Key
string
header
required
X-DOMPAY-Signature
string
header
required
X-DOMPAY-Timestamp
string
header
required

Body

application/json
amount
number
required
Example:

5000

currency
string
required
Example:

"IDR"

reference
string
required
Example:

"ORDER123456"

redirectUrl
string<uri>

Optional per-checkout redirect URL after payment completion. Must use http or https.

Maximum string length: 2048
Example:

"https://merchant.example.com/payment/result"

metadata
object

Optional merchant metadata. Selected order fields are shown on the public checkout page, so do not send sensitive data here.

Response

201

Checkout created successfully