API Reference

Setting up Partial Payments in a Payment Link

To enable partial payments via API, you need to send the following attribute along with the other Create Payment Links Request Body Attributes.

Request Parameter🔗

partial_payment mandatory
boolean Possible values:
  • 0 (default) - Customer cannot make a partial payment using this Payment Link.
  • 1 - Customer can make partial payments.

Response Parameters🔗

id

string The unique identifier of the Payment Link generated.

receipt

string The unique number added for each Payment Link by you for internal reference.

customer_id

string Unique identifier of the customer to whom the Payment Link has been sent.

customer

Customer details

name
string The customer's name.
contact
string The customer's mobile number.
email
string The customer's email address.
status

string Indicates the current status of the Payment Link. Refer to the Payment Links Life Cycle to learn about the different statuses.

expire_by

integer Timestamp, in Unix, when the Payment Link will expire.

issued_at

integer Timestamp, in Unix, at which the Payment Link was issued to the customer.

paid_at

integer Timestamp, in Unix, at which the payment was made against this Payment Link. Here, the value will be null as the link has just been created.

cancelled_at

integer Timestamp, in Unix, at which the Payment Link was cancelled by you. Here, the value will be null.

expired_at

integer Timestamp, in Unix, at which the Payment Link expired.

sms_status

string Indicates whether the SMS notification for the Payment Link was sent to the customer. Possible values:

  • pending
  • sent
email_status

string Indicates whether the email notification for the Payment Link was sent to the customer. Possible values:

  • pending
  • sent
partial_payment

string Indicates if partial payment was enabled for the Payment Link. Two possible values:

  • true - Partial payment is enabled.
  • false - Partial payment is disabled.
amount

integer Amount to be paid using the Payment Link. Must be in the smallest unit of the currency. For example, if you want to receive a payment of ₹299.95, you must enter 29995.

amount_paid

integer Amount paid using the Payment Link.

amount_due

integer Remaining amount to be paid using the Payment Link.

currency

string Currency in which the payment is made. Defaults to INR. We accept payments in international currencies.

description

string A brief description of the Payment Link.

notes

object You can enter notes for internal reference. You can enter a maximum of 15 key-value pairs.

short_url

string The short URL that is generated. This is the Payment Link that can be shared with customers to accept payments. Once cancelled, no payments can be accepted using the Payment Link.

view_less

boolean Used when the Payment Link's description is lengthy and you want to make the text collapsible. The text can be expanded by the customer using the Show MoreF link. Possible values:

  • 0 - Payment Link's description appears expanded.
  • 1 - Payment Link's description appears collapsed, with a Show More link.
type

string Here, it will be link.

‹›
×