API v1FiatPe Home
FiatPeDocs

Create Payment Link

POSThttps://api.fiatpe.com/v1/payment-links//v1/payment-links/
Copy

A unique URL generated by FiatPe that allows customers to securely complete a payment using their preferred payment method.

Headers

Sent as Authorization: Basic base64(Api Key:Salt Key)

Body Parameters

amount*integer

The total order amount in the smallest currency unit. For INR, enter the amount in paise. For example, ₹100.00 should be provided as 10000.

currency*string

The three-letter ISO currency code for the order amount. For example, use INR for Indian Rupees.

allow_partialboolean

Indicates whether the payment link allows customers to make partial payments instead of paying the full amount in a single transaction. When enabled, customers can pay the amount in multiple installments, subject to the configured minimum partial payment amount.

min_partial_amountinteger

Specifies the minimum amount a customer must pay in a single partial payment when allow_partial is enabled. It should be provided in the smallest currency unit, such as paise for INR.

customer_idstring

Unique identifier of the customer associated with the payment link. Use this field to link the payment request to an existing customer in FiatPe.

descriptionstring

A brief description of the payment link or the purpose of the payment. This information can be used to provide additional context about the transaction.

expires_atinteger

Specifies the date and time when the payment link will expire and no longer accept payments. Provide the value as a Unix timestamp.

metadatajson object

A set of custom key-value pairs that can be attached to the payment link to store additional information for your internal reference, such as invoice number, order reference, or other business-specific details.

reference_idstring

A unique identifier provided by the merchant to associate the payment link with an internal order, invoice, or business reference for tracking and reconciliation.

enable_remindersboolean

Indicates whether automatic payment reminders should be sent to the customer for an unpaid or partially paid payment link before it expires.

allow_upi_linkboolean

Indicates whether the customer is allowed to make the payment using a UPI payment link. When enabled, the payment link can provide a UPI-based payment option for supported devices and applications.

allow_whatsapp_linkboolean

Indicates whether the payment link can be shared with the customer through WhatsApp for convenient access and payment.

notificationjson object
SMS
email
whatsapp

Select which notification channels FiatPe should use.

customerjson object

Contains the customer details associated with the payment link, such as name, email, and phone. Use this object when providing customer information directly instead of using an existing customer_id