Create Payment Link

post

https://openapi.sandbox.xenithpay.com/v1/payment-links

You can use this endpoint to create a Payment Link. A Payment Link allows you to generate a hosted checkout page for your customers to complete payments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

number

required

Requested amount of the payment link in the actual value in the provided currency. Must be greater than zero.

currency

string

required

ISO 4217 three-letter code of the transaction's currency.

expiredTime

date-time | null

Expiration time for the payment link in RFC3339 format (UTC+0). Must be in the future. If not provided, defaults to 24 hours from creation time.

redirectUrl

uri

required

URL where the end-customer is redirected to after the payment is completed.

paymentLinkCallbackUrl

uri

Your webhook URL to receive payment link status change notifications (e.g., completed, expired).

payinCallbackUrl

uri

Your webhook URL to receive pay in transaction notifications for payments made through this payment link.

customerReference

string

required

Merchant-provided identifier of the Customer for this payment link.

customerName

string

required

Merchant-provided name of the Customer for this payment link.

customerPhoneNumber

string

Customer's phone number (numeric, starts with 08, 628, or +628). Required when paymentChannel is OVO else it will not appear as an available payment option.

referenceCode

string

required

Merchant-provided identifier for this payment link.

metadata

object

Metadata required for THB payment requests when using the PROMPTPAY payment channel. This object must include the required bank account name and account number to enable payment processing.

Metadata required for LAK payment requests when using LAOQR payment channel. This object must include the required bank id, bank account name and account number to enable payment processing.

paymentChannels

array of objects

List of payment channels to be made available for this payment link. If not provided, all available channels for the merchant will be used.

paymentChannels

Headers

Content-Type

string

required

Specifies the format of the request body (JSON).

Xenith-Api-Key

string

required

API Key will be delivered to you by email

Xenith-Request-Timestamp

string

required

ISO 8601 date time format, should be in (UTC+0)

Xenith-Request-Signature

string

required

Refer to page Build Signature and Set Headers for instructions on how to build a signature

X-Idempotency-Key

string

required

A unique key to prevent duplicate requests. Must be unique across all payment link transactions for the merchant.

Responses

Callback

201Successfully created payment link

400Payment link creation failed due to failing request validation.

500An unexpected server error occurred. Wait briefly and retry. If the error persists after multiple attempts, contact support.