Api

Payments

Recurring Payments

Paper Nach

Create Authorization Transaction

1. Create the Authorisation Transaction

Create an authorisation transaction with NACH as a payment method.

The flow to complete an authorisation transaction using paper NACH differs from the other payment method's flow.

  1. Create a customer.
  2. Create an order by passing the customer_id and the method as nach. Razorpay generates a NACH form with the customer information pre-filled and ready to sign.
  3. The customer can get the form in one of the following ways to sign it:
    • You can download the form from the Dashboard and send it to the customer.
    • A customer can download the form from the Hosted page (in the case of registration links).
  4. The signed form can be uploaded in one of the following ways:
    • Using the Standard Checkout page.
    • Hosted page (in the case of registration links).
    • The customer can send you the form and you can upload the form for the customer. The acceptable image formats and size are:
      • jpeg
      • jpg
      • png
      • Maximum accepted size is 6 MB.

Once the details are validated, the authorisation transaction is completed, and a token is generated. You can charge your customer as per your business model after the token status changes to confirmed.

You can create an authorisation transaction:

1.1. Using Razorpay Standard Checkout

To create an authorisation transaction using the Razorpay Standard Checkout, you need to:

  1. Create a Customer

    .

  2. Create an Order

    .

  3. Create Authorisation Payment using Razorpay Standard Checkout

    .

1.1.1. Create a Customer

Razorpay links recurring tokens to customers via a unique identifier. You can generate this identifier using the Customer API.

You can create

customers

with basic information such as email and contact and use them for various Razorpay offerings. The following endpoint creates a customer.

POST
/customers

Request Parameters

fail_existing

optional

string The request throws an exception by default if a customer with the exact details already exists. You can pass an additional parameter fail_existing to get the existing customer's details in the response. Possible values:

  • 1 (default): If a customer with the same details already exists, throws an error.
  • 0: If a customer with the same details already exists, fetches details of the existing customer.

notes

optional

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

id

string The unique identifier of the customer. For example cust_1Aa00000000001.

entity

string The name of the entity. Here, it is customer.

notes

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer A Unix timestamp, at which the customer was created.

You can create an order once you create a customer for the payment authorisation.

1.1.2. Create an Order

You can use the

Orders API

to create a unique Razorpay order_id that is associated with the authorisation transaction. The following endpoint creates an order.

POST
/orders

Request Parameters

amount

mandatory

integer Amount in currency subunits. For Paper NACH, the amount has to be 0.

currency

mandatory

string The 3-letter ISO currency code for the payment. Currently, we only support INR.

method

mandatory

string The authorisation method. In this case the value will be nach.

customer_id

mandatory

string The unique identifier of the customer, who is to be charged. For example, cust_D0cs04OIpPPU1F.

receipt

optional

string A user-entered unique identifier for the order. For example, rcptid #1. This parameter should be mapped to the order_id sent by Razorpay.

notes

optional

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

token

Details related to the authorisation such as max amount, bank account information and NACH information.

auth_type

mandatory

string In this case, it will be physical.

bank_account

Customer's bank account details that will be printed on the NACH form.

account_number

mandatory

string Customer's bank account number. For example 11214311215411.

ifsc_code

mandatory

string Customer's bank IFSC. For example UTIB0000001.

beneficiary_name

mandatory

string Customer's name. For example, Gaurav Kumar.

account_type

optional

string Customer's bank account type. Possible values:

  • savings (default)
  • current
  • cc (Cash Credit)
  • nre (SB-NRE)
  • nro (SB-NRO)

max_amount

optional

integer Use to set the maximum amount per debit request. The value can range from 500 - 1000000000 (1cr, default value).

expire_at

optional

integer Timestamp, in Unix, that specifies when the registration link should expire. The value can range from the current date to 01-19-2038 (2147483647).

nach

Additional information to be printed on the NACH form that your customer will sign.

form_reference1

optional

string A user-entered reference that appears on the NACH form.

form_reference2

optional

string A user-entered reference that appears on the NACH form.

description

optional

string A user-entered description that appears on the hosted page. For example, Form for Gaurav Kumar.

notes

optional

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

id

string A unique identifier of the order created. For example order_1Aa00000000001.

entity

string The entity that is created. Here it is order.

amount

integer Amount in currency subunits. For NACH, the amount should be 0.

amount_paid

integer The amount that has been paid.

amount_due

integer The amount that is yet to pay.

currency

string The 3-letter ISO currency code for the payment. Currently, we only support INR.

receipt

string A user-entered unique identifier of the order. For example, rcptid #10. You should map this parameter to the order_id sent by Razorpay.

status

string The status of the order. Here, it is created.

notes

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer The Unix timestamp at which the order was created.

token

Details related to the authorisation such as max amount and bank account information.

method

string Payment method used to make the authorisation payment. Here, it is nach.

notes

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

max_amount

integer The maximum amount in paise a customer can be charged in a transaction. The value can range from 500 to 100000000.

expire_at

integer The Unix timestamp to indicate the date till which you can use the token (authorisation on the payment method) to charge the customer subsequent payments.

auth_type

string NACH type used to make the authorisation payment. Here, it is physical.

nach

Additional information to be printed on the NACH form that your customer will sign.

create_form

boolean Indicates whether the form is created or not. Possible values:

  • true: The NACH form is created.
  • false: The NACH form is not created.

form_reference1

string A user-entered reference that appears on the NACH form.

form_reference2

string A user-entered reference that appears on the NACH form.

prefilled_form

string The link from where you can download the pre-filled NACH form.

upload_form_url

string The link where the NACH form should be uploaded once it is signed by the customer.

description

string A user-entered description that appears on the hosted page. For example, Paper NACH Gaurav Kumar.

bank_account

Customer's bank account details that should be pre-filled on the checkout.

ifsc_code

string Customer's bank IFSC. For example, HDFC0000001.

bank_name

string The bank name. For example, HDFC Bank.

name

string Name of the beneficiary. For example, Gaurav Kumar.

account_number

string Customer's bank account number.

account_type

string Customer's bank account type. Possible values:

  • savings (default)
  • current
  • cc (Cash Credit)
  • nre (SB-NRE)
  • nro (SB-NRO)

beneficiary_email

string Email address of the beneficiary. For example, gaurav.kumar@example.com.

beneficiary_mobile

integer Mobile number of the beneficiary.

Download and Upload the Pre-filled NACH Form

Once the order is created, the pre-filled form must be downloaded, signed by your customer and uploaded back to Razorpay to complete the transaction.

You receive the following parameters as part of the response:

prefilled_form

The link from where you can download the pre-filled NACH form.

upload_form_url

The link where the NACH form should be uploaded once it is signed by the customer.

Authorisation transaction + auto-charge first payment:


You can register a customer's mandate and charge them the first recurring payment as part of the same transaction. Refer to the

Paper NACH section under Registration and Charge First Payment Together

for more information.

Error Response Parameters

Given below is a list of possible errors you may face while creating an Order.

1.1.3. Create an Authorization Payment

You should create an authorisation payment after you create an order.

To create an authorisation payment:

  1. Download the Paper NACH form and send it to the customer.
  2. Ask the customers to fill the form and either

    Upload via Checkout

    or send it to you to upload the form using the

    create NACH File API

    .

1.1.3.1 Upload the NACH File via Checkout

Create a payment checkout form for customers to upload the NACH form and make the Authorisation Transaction. You can use the Handler Function or Callback URL.

Watch Out!

The Callback URL is not supported for Recurring Payments created using the registration link.

Additional Checkout Fields

You should send the following additional parameters along with the existing checkout options as a part of the authorisation transaction.

customer_id

mandatory

string Unique identifier of the customer created in the

first step

.

order_id

mandatory

string Unique identifier of the order created in the

second step

.

recurring

mandatory

boolean Determines whether the recurring is enabled or not. Possible values:

  • 1: Recurring is enabled.
  • 0: Recurring is not enabled.

Error Response Parameters

Given below is a list of possible errors you may face while making the authorisation payment.

adequate_funds_not_available_blocked

  • Description: Sufficient unblocked funds not available in customer's account. Please ask customer to add fund and try again.
  • Next Steps: Please ask customer to add sufficient unblocked funds and try again.

bad_request_error

  • Description: Invalid Mandate Sequence Number.
  • Next Steps: Retry after some time during the valid cycle.

bank_account_invalid

  • Description: Payment failed because Account linked to VPA is invalid.
  • Next Steps: Create a new mandate with the customer.

bank_account_validation_failed

  • Description: Payment was unsuccessful as the details are invalid. Please retry with the right details.
  • Next Steps: Ask the customer to retry again.

bank_not_available

  • Description: Payment was unsuccessful as the bank linked to this UPI ID is temporarily unavailable. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

bank_technical_error

Bank Temporarily Unavailable

  • Description: Payment was unsuccessful as the bank linked to this UPI ID is temporarily unavailable. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

Temporary Bank Issue

  • Description: Payment was unsuccessful due to a temporary issue at your bank. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

Bank Declined

  • Description: Payment was unsuccessful as it was declined by your bank. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

Bank or Wallet Gateway Error

  • Description: Payment processing failed due to error at bank or wallet gateway.
  • Next Steps: Retry after some time.

General Temporary Issue

  • Description: Payment was unsuccessful due to a temporary issue. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

Bank Services Halt

  • Description: Payment was unsuccessful due to a temporary halt of services at this bank.
  • Next Steps: Retry after some time.

credit_to_beneficiary_failed

  • Description: Payment was unsuccessful due to a temporary issue. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

debit_declined

  • Description: Payment was unsuccessful as it was declined by remitter bank.
  • Next Steps: Create a new mandate with the customer.

debit_instrument_blocked

  • Description: Payment was unsuccessful as the account linked to this UPI ID is blocked. Try using another account.
  • Next Steps: Create a new mandate with the customer.

duplicate_mandate_request

  • Description: Duplicate mandate request. Please try again with another mandate request.
  • Next Steps: Please try again with another mandate request.

gateway_technical_error

Bank or Wallet Gateway Error

  • Description: Payment processing failed due to error at bank or wallet gateway.
  • Next Steps: Retry after some time.

Temporary Issue with Money Deduction

  • Description: Payment was unsuccessful due to a temporary issue. If money got deducted, reach out to the seller.
  • Next Steps: Retry after some time.

incorrect_pin

  • Description: You have entered an incorrect PIN on the UPI app. Please retry with the correct PIN.
  • Next Steps: Ask the customer to retry with correct PIN.

insufficient_funds

  • Description: Transaction failed due to insufficient funds.
  • Next Steps: Ask the customer to add balance to their account and retry.

invalid_request

  • Description: Payment processing failed due to error at bank or wallet gateway.
  • Next Steps: Retry after some time.

invalid_response_from_gateway

  • Description: Payment was unsuccessful due to a temporary issue. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

invalid_transaction_beneficiary

  • Description: Beneficiary address resolution failed. Please try again after some time.
  • Next Steps: Please try again after some time.

invalid_vpa

  • Description: You have entered an incorrect UPI ID. Please retry with the correct UPI ID.
  • Next Steps: Ask the customer to retry with a valid VPA.

issuer_dispatch_failed

  • Description: Payment failed due to some issue at the issuer bank. Please try again after some time.
  • Next Steps: Please try again after some time.

limit_exceeded_remitting_bank

  • Description: Limit exceeded for remitter bank. Please ask customer to try with another bank account.
  • Next Steps: Please ask customer to try with another bank account.

mandate_debit_beyond_psp_amount_cap

  • Description: Debit amount is beyond payer PSP specified amount cap. Please reduce the amount and try again.
  • Next Steps: Please reduce the mandate amount to match customer PSP.

mandate_request_limit_breached

  • Description: Maximum number of mandate creation requests exceeded for customer's bank account. Please wait for some time before initiating new mandate creation requests.
  • Next Steps: Please wait for some time before initiating new mandate creation requests.

mobile_number_invalid

  • Description: Registered Mobile number linked to the account has been changed or removed.
  • Next Steps: Create a new mandate with the customer.

nature_of_debit_not_allowed

  • Description: Nature of debit not allowed in customer's account. Please ask the customer to use a different bank account.
  • Next Steps: Please ask the customer to use a different bank account.

no_financial_address_record_found

  • Description: No financial address record found for this VPA. Please ask customer to try with another bank account.
  • Next Steps: Please ask customer to try with other bank account.

no_original_request_found

  • Description: No mandate details were found in the record during debit. Please try after some time.
  • Next Steps: Please try after some time.

payment_collect_request_expired

  • Description: Payment was unsuccessful as you could not pay with the UPI app within time.
  • Next Steps: Retry after some time.

payment_declined

Bank Declined Payment

  • Description: Payment was unsuccessful as it was declined by your bank. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Ask the customer to retry with other account.

Customer Declined Payment

  • Description: You have declined the payment request on the UPI app. Please retry when you are ready.
  • Next Steps: Ask the customer to approve the payment.

payment_failed

  • Description: Payment was unsuccessful due to a temporary issue. If amount got deducted, it will be refunded within 5-7 working days.
  • Next Steps: Retry after 1 hour.

payment_pending

  • Description: The status of your payment is pending. You can either wait or retry to pay successfully.
  • Next Steps: Retry after some time.

payment_risk_check_failed

  • Description: Payment was unsuccessful as your account does not pass the risk checks done by your bank. Try using another account.
  • Next Steps: Retry after some time.

payment_timed_out

  • Description: Payment was unsuccessful as you could not complete it in time.
  • Next Steps: Retry after some time.

pre_debit_notification_failed

  • Description: Unable to Notify the Customer.
  • Next Steps: Retry after some time.

remitter_dispatch_failed

  • Description: Payment failed due to some issue at the customer's. Please try again after some time.
  • Next Steps: Please try again after some time.

request_timed_out

General Timeout - Temporary Issue

  • Description: Payment was unsuccessful due to a temporary issue. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

Timeout - Bank Declined

  • Description: Payment was unsuccessful as it was declined by your bank. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

Timeout - Recurring Payment Creation

  • Description: Payment was unsuccessful as the recurring payment can not be created at this time. Any amount deducted will be refunded within 5-7 working days.
  • Next Steps: Retry after some time.

transaction_frequency_limit_exceeded

  • Description: Payment failed. Please try again with another bank account.
  • Next Steps: Create a new mandate with the customer.

transaction_limit_exceeded

Amount Limit Exceeded

  • Description: Payment failed because Transaction amount limit has exceeded.
  • Next Steps: Reach out to the customer to collect the amount.

Bank Account Amount Limit

  • Description: Payment was unsuccessful as you exceeded the amount limit on the bank account linked to this UPI ID.
  • Next Steps: Ask the customer to retry after some time.

transaction_not_allowed

  • Description: Payment was unsuccessful as it was declined by your bank. Reach out to your bank for more details. Try using another account.
  • Next Steps: Create a new mandate with the customer.

upi_dummy_payment

  • Description: Payment was a dummy payment for one time mandate registration.
  • Next Steps: NA

1.1.3.2 Upload the NACH File via API

Use the following API to upload the NACH file sent by the customer.

Request Parameters

order_id

mandatory

string The unique identifier of the order that was created. For example, order_FoLdZrq6QGKUWg.

recurring

mandatory

boolean Determines whether the recurring is enabled or not. Possible values:

  • 1: Recurring is enabled.
  • 0: Recurring is not enabled.

file

mandatory

strinng The path where you have saved the NACH file.

Response Parameters

razorpay_payment_id

string The unique identifier of the payment that is created. For example, pay_FjDn43bvssCqEM.

razorpay_order_id

string The unique identifier of the order that is created. For example, order_FjDdQ6a0GluJ2c.

razorpay_signature

string The signature generated by the Razorpay. For example, f13775ea8a91e9bf229b9fdba3ad783f7ff2bdbce1c35e87a69ae7418808da04

Error Response Parameters

Given below is a list of possible errors you may face while while uploading a NACH file.

1.2. Using a Registration Link

Registration Link is an alternate way of creating an authorisation transaction. You can create a registration link using the

API

or

Dashboard

Handy Tips

You do not have to create a customer if you choose the registration link method for creating an authorisation transaction.

  • When you create a registration link, an

    invoice

    is automatically issued to the customer. They can use this invoice to make the authorisation payment.
  • A registration link should always have an order amount (in paise) the customer will be charged when making the authorisation payment. This amount should be 0 in the case of Paper NACH.

Handy Tips

You can

use Webhooks to get notifications about successful payments

against a registration link.

1.2.1. Create a Registration Link

The following endpoint creates a registration link for recurring payments.

POST
/subscription_registration/auth_links

Request Parameters

customer

object Details of the customer to whom the registration link is sent.

name

mandatory

string Customer's name.

email

mandatory

string Customer's email address.

contact

mandatory

integer Customer's contact number.

type

mandatory

string In this case, the value is link.

amount

mandatory

integer The payment amount in the smallest currency sub-unit.

currency

mandatory

string The 3-letter ISO currency code for the payment.

description

mandatory

string A description that appears on the hosted page.

subscription_registration

Details of the authorisation payment.

method

mandatory

string The Paper NACH method used to make the authorisation transaction. Here, it is physical.

auth_type

mandatory

string The payment method used to make the authorisation transaction. Here, it is nach.

bank_account

The customer's bank account details.

beneficiary_name

mandatory

string The beneficiary name. For example, Gaurav Kumar.

account_number

mandatory

integer The customer's bank account number. For example, 11214311215411.

account_type

mandatory

string The customer's bank account type. Possible values:

  • savings
  • current

ifsc_code

mandatory

string The customer's bank IFSC. For example, HDFC0000001.

max_amount

optional

integer Use to set the maximum amount, in paise, per debit request. The value can range from 500 - 1000000000. The dafault value is 1cr.

expire_at

optional

integer The Unix timestamp till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The default value is 10 years. The value can range from the current date to 31-12-2099 (4101580799).

nach

Additional information to be printed on the NACH form your customer will sign.

form_reference1

optional

string A user entered reference that appears on the NACH form.

form_reference2

optional

string A user entered reference that appears on the NACH form.

description

optional

string A user entered description that appears on the hosted page. For example, Form for Gaurav Kumar.

sms_notify

optional

boolean Indicates if SMS notifications are to be sent by Razorpay. Possible values:

  • true (default): Notifications are sent by Razorpay .
  • false: Notifications are not sent by Razorpay.

email_notify

optional

boolean Indicates if email notifications are to be sent by Razorpay. Possible values:

  • true (default): Notifications are sent by Razorpay .
  • false: Notifications are not sent by Razorpay.

expire_by

optional

integer The Unix timestamp indicates the expiry of the registration link.

receipt

optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.

notes

optional

object This is a key-value pair that is used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

id

string The unique identifier of the invoice.

entity

string The entity that has been created. Here, it is invoice.

receipt

string A user-entered unique identifier of the invoice.

invoice_number

string Unique number you added for internal reference.

customer_id

string The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI.

customer_details

Details of the customer.

id

string The unique identifier associated with the customer to whom the invoice has been issued.

name

string The customer's name.

email

string The customer's email address.

contact

integer The customer's phone number.

billing_address

string Details of the customer's billing address.

shipping_address

string Details of the customer's shipping address.

order_id

string The unique identifier of the order associated with the invoice.

line_items

string Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.

payment_id

string Unique identifier of a payment made against the invoice.

status

string The status of the invoice. Possible values:

  • draft
  • issued
  • partially_paid
  • paid
  • cancelled
  • expired
  • deleted

expire_by

integer The Unix timestamp at which the invoice will expire.

issued_at

integer The Unix timestamp at which the invoice was issued to the customer.

paid_at

integer The Unix timestamp at which the payment was made.

cancelled_at

integer The Unix timestamp at which the invoice was cancelled.

expired_at

integer The Unix timestamp at which the invoice expired.

sms_status

string The delivery status of the SMS notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

email_status

string The delivery status of the email notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

date

integer Timestamp, in Unix format, that indicates the issue date of the invoice.

terms

string Any terms to be included in the invoice. Maximum of 2048 characters.

partial_payment

boolean Indicates whether the customer can make a partial payment on the invoice. Possible values:

  • true: The customer can make partial payments.
  • false (default): The customer cannot make partial payments.

amount

integer Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is $299.95, pass the value as 29995.

amount_paid

integer Amount paid by the customer against the invoice.

amount_due

integer The remaining amount to be paid by the customer for the issued invoice.

description

string A brief description of the invoice.

notes

object Any custom notes added to the invoice. Maximum of 2048 characters.

short_url

string The short URL that is generated. This is the link that can be shared with the customer to receive payments.

type

string Here, it is invoice.

comment

string Any comments to be added in the invoice. Maximum of 2048 characters.

1.2.2. Send/Resend Notifications

The following endpoint sends/resends notifications with the short URL to the customer:

POST
/invoices/:id/notify_by/:medium

Path Parameters

id

mandatory

string The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, inv_1Aa00000000001.

medium

mandatory

string Determines through which medium you want to resend the notification. Possible values:

  • sms
  • email

Response Parameters

success

boolean Indicates whether the notifications were sent successfully. Possible values:

  • true: The notifications were successfully sent via SMS, email or both.
  • false: The notifications were not sent.

1.2.3. Cancel a Registration Link

The following endpoint cancels a registration link.

POST
/invoices/:id/cancel

Watch Out!

You can only cancel the registration link that is in the issued state.

Path Parameter

id

mandatory

string The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001.

Response Parameters

id

string The unique identifier of the invoice.

entity

string The entity that has been created. Here, it is invoice.

receipt

string A user-entered unique identifier of the invoice.

invoice_number

string Unique number you added for internal reference.

customer_id

string The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI.

customer_details

Details of the customer.

id

string The unique identifier associated with the customer to whom the invoice has been issued.

name

string The customer's name.

email

string The customer's email address.

contact

integer The customer's phone number.

billing_address

string Details of the customer's billing address.

shipping_address

string Details of the customer's shipping address.

order_id

string The unique identifier of the order associated with the invoice.

line_items

string Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.

payment_id

string Unique identifier of a payment made against the invoice.

status

string The status of the invoice. Possible values:

  • draft
  • issued
  • partially_paid
  • paid
  • cancelled
  • expired
  • deleted

expire_by

integer The Unix timestamp at which the invoice will expire.

issued_at

integer The Unix timestamp at which the invoice was issued to the customer.

paid_at

integer The Unix timestamp at which the payment was made.

cancelled_at

integer The Unix timestamp at which the invoice was cancelled.

expired_at

integer The Unix timestamp at which the invoice expired.

sms_status

string The delivery status of the SMS notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

email_status

string The delivery status of the email notification for the invoice sent to the customer. Possible values:

  • pending
  • sent

date

integer Timestamp, in Unix format, that indicates the issue date of the invoice.

terms

string Any terms to be included in the invoice. Maximum of 2048 characters.

partial_payment

boolean Indicates whether the customer can make a partial payment on the invoice. Possible values:

  • true: The customer can make partial payments.
  • false (default): The customer cannot make partial payments.

amount

integer Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is $299.95, pass the value as 29995.

amount_paid

integer Amount paid by the customer against the invoice.

amount_due

integer The remaining amount to be paid by the customer for the issued invoice.

description

string A brief description of the invoice.

notes

object Any custom notes added to the invoice. Maximum of 2048 characters.

short_url

string The short URL that is generated. This is the link that can be shared with the customer to receive payments.

type

string Here, it is invoice.

comment

string Any comments to be added in the invoice. Maximum of 2048 characters.

Was this page helpful?

ON THIS PAGE