Create a new Payment Link

post

https://api.crossborder.jiopay.co.in/api/v1/payin

Create a shareable URL for a hosted payment page in one of two ways:

Payment link without quote — specify the amount, currency, expiry and payment methods inline (PaymentLink).
Payment link with quote — pass a quote_id from POST /quotes (with resource: payin) to bind the payment link to a quote. When supplied, the quote is the single source of truth for amount, currency, payment method and expiry; the locked fields (amount, currency, expires_at, price_id, payment_methods) must not be sent (CreatePaymentLinkWithQuoteRequest). When a quote_id is supplied, the payment link's expiry is set to the quote's expiry.

The request variant is selected by the presence of quote_id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payment link without a quote. Amount, currency, expiry and payment methods are specified inline.

customer_id

string

required

The unique identifier of customer linked to payment_link.

document_id

string

The unique identifier of document linked to payment_link. This document entity should contain the required documents to process incoming payments. Refer to the Document entity for more details.

payment_methods

array of objects

Array of payment methods that should be available for the customer on the checkout page. This field allows you to control which payment options your customers can use to complete the payment. You can specify one or multiple payment methods in the array.

payment_methods

Allowed:

currency

string

required

The currency code in ISO 4217 format. Supported currencies: USD, EUR and GBP.

amount

number

required

The amount you want to receive, a positive integer representing the smallest currency unit. For example, if the amount is $299.00, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ¥295, pass the value as 295.

purpose_code

string

required

Purpose code for why you want to receive this payment

invoice_number

string

Number/Id of the invoice submitted with payment_link.

invoice_description

string

Description about the invoice submitted with payment_link

reference_number

string

Optional identifier to be sent for reconciliations

expires_at

string

required

Date when the payment_link will expire. Expiry can not be less than or equal to current date and can be upto 6 months in future.

invoice_amount

number

The amount in cents for which invoice was generated. It can be more than the amount requested in this payment_link

notify_customer

boolean

Whether to notify the customer via email when the payment link is created. Defaults to true. Set to false to suppress the notification email.

reminder_frequency

number

The frequency at which you want to remind customers, valid values are 1 (remind everyday), 2 (remind every alternate day), 7 (remind every week), 14 (remind every alternate week).

price_id

string

The unique identifier of 'Price' entity linked to the payment link. This is the referral fee for this payment link. Note: price_id is only applicable for platform businesses.

product

object

Details of the product that the payment is related to.

notes

object | null

Optional key-value pairs for attaching custom metadata (e.g. invoice references, project codes). Keys must be strings and cannot collide with reserved field names. If your business has custom field rules configured (e.g. enum constraints), values are validated against those rules. Each key appears as a separate column in CSV report exports, with corresponding values populating the rows.

bank_account_details

object

Optional bank account details to associate with the customer for this payment link. When provided, the bank account will be linked to the customer and associated with this payment link. Either bic_primary or bic_secondary must be provided when including this field.

Responses

201Created

400Bad Request