Create Invoice

post

https://uat1.billdesk.com/u2/pgsi/ve1_2/invoice/create

An invoice represents the billed amount that needs to be collected from the customer for a subscription. This API can be used to create an invoice with the specific reference of the underlying mandateid.

The invoice details are sent to the customer as a pre-debit notification for the card and upi payment methods, as required by regulatory guidelines. For UPI, pre-debit-notifications are sent by bank via (sms, email)

To ensure that the pre-debit notification is received by the customer atleast 24 hours prior to the recurring charge (regulatory requirement), it is recommended that the invoice request is initiated 36 hrs prior to the recurring charge request.

If the recurring charge debit amount is higher than the permissible limit (as per regulations), the customer requires to provide an additional AFA for processing the recurring charge. This is not applicable for upi mandates

Body Params

invoice_number

string

required

Unique number assigned by merchant for the invoice

invoice_display_number

string

required

Invoice number to be displayed to the customer

mercid

string

required

Unique identifier as defined by BillDesk for each merchant

mandateid

string

required

Unique mandateid created by BillDesk

currency

string

required

ISO currency of the transaction amount, for INR this value will be 356

amount

string

required

Invoice amount in two decimals, eg. 2400.00

subscription_refid

string

required

Unique reference assigned by merchant for a subscription

customer_refid

string

required

Unique reference of the customer in the merchant system, and can be linked to different subscriptions of the same customer Required for mandate and tokenization

debit_date

date

required

Date on which the SI debit needs to be executed to the payment method

invoice_date

date

required

Invoice generation date in the YYYYMMDD format

description

string

required

Brief description for the invoice

duedate

date

required

Invoice due date in the YYYYMMDD format

net_amount

string

required

Current payable amount, adjusted for discount or late payment charges as applicable

early_payment_amount

string

Amount after adjusting any discount applicable.

early_payment_discount

string

Discount amount for early payment of invoice

early_payment_duedate

date

Early payment date for invoice

late_payment_amount

string

Payment amount after due date

late_payment_charges

string

Late payment charges if any

additional_info

object

Array of 7 additional_info values that can be attached to the transaction. Note: Merchant is advised to not pass customer PII information in additional info fields.

Headers

BD-Traceid

string

required

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

BD-Timestamp

string

required

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

Content-Type

string

required

Request Content-Type to take the values application/jose

string

required

Accept Response Content-Type to take the values application/jose

Responses

200OK

403Forbidden

500Internal Server Error

defaultAny bad or invalid request will lead to following error object