Skip to main content

The API will help you create payment links.You can chose to send the payment link to the customer via Email and SMS basis the flags specified in the API.

Request Body required
    payer_email_address string

    This is the email address of your consumer

    payer_first_name string required

    This is the first name of your consumer

    payer_last_name string

    This is the last name of your consumer

    payer_mobile_number string required

    This is the mobile number of your consumer, default country code is +91.

    currency string required

    Default value: INR

    This is the currency code in ISO-4217 format

    total_amount double required

    This is the total amount inclusive of taxes for your entire cart amount

    invoice_id uuid required

    This is your internal unique reference identifier for this payment link

    expires_at string

    This is the future date at which you want the payment link to expire. If this is not provided default expiry date will 90 days from the payment link creation date. The expiry date format will be YYYY-MM-DD HH:MM:ss.

    callback_url string

    The callback_url is the https URL where the payment link status and control will be redirected after the customer attempts to pay. It serves as a custom page for you to display either a success or failure message.

    generate_only boolean

    If true the payment link will only be generated but will not be sent to the customer.

    notification_channel_email boolean required

    If generate_only and notification_channel_email both are true, the payment link will be sent on payer_email_address provided.

    notification_channel_sms boolean required

    If generate_only and notification_channel_sms both are true, the payment link will be sent on payer_mobile_number provided.

    sms_template_name string

    The sms template name for the payment link sms which will be sent to the customer. The custom sms template will be created in the Nimbbl system. For custom sms template creation reach out to us at help@nimbbl.biz.

    email_template_name string

    The email template name for the payment link email which will be sent to the customer. The custom email template will be created in the Nimbbl system. For custom email template creation reach out to us at help@nimbbl.biz.

    products object[] nullable

    This contains the cart items against which the payment link is generated.

  • Array [
    • sku_id string

    This is the unique id of the product stored in your system

    title string

    This is the title of the product that is being sold

    description string

    This is the detailed description of the product being sold

    image_url string

    This is the public URL from which the image of the product can be fetched

    rate number

    This is the pre tax rate of the item

    quantity string

    This is the quantity that is being purchased

    amount_before_tax string

    This is the rate * quantity i.e. the amount before tax

    tax string

    This is the tax amount on the cart item

    total_amount string

    This is the sum of amount before tax and the tax amount

  • ]
Responses

When the payment link creation request is successful, the response will be as below

Schema
    status integer

    This is the status of the HTTP status of the API call

    message string

    This is the additional message for the api call.

    payment_link object
    invoice_id string

    This is your internal unique reference identifier for this payment link

    payment_link_url string

    This is the payment link url which will be sent to the customer for collecting payment.

    payment_short_link_url string

    This is the shortened payment link url/

    payment_link_hash string

    This is the unique hash generated for each payment link.

    generated_at string

    This is payment link creation date and time in DD/MM/YY HH:MM format.

    expires_at string

    This is payment link expiry date and time in DD/MM/YY HH:MM format.

Loading...