Create Invoice

This endpoint is used to create invoice details for invoice plugin

Method

POST https://api.ninjapay.me/webextension/api/v1/fiat/invoice/create

Parameters

  • business_logo (string): URL of the business logo.

  • business_name (string, required): Name of the business.

  • phone (string): Contact phone number (without country code).

  • phone_code (string): Country code for the phone number.

  • email (string, required): Contact email address.

  • billing_address (string): Billing address.

  • city (string): City of the business.

  • state (string): State of the business.

  • zipcode (string): Zipcode of the business.

  • country (string): Country of the business.

  • documents (object): Contains document details.

    • doc_1 (object): First document.

      • title (string): Title of the document.

      • value (string): Value of the document.

    • doc_2 (object): Second document.

      • title (string): Title of the document.

      • value (string): Value of the document.

  • default_currency (string): Default currency for transactions.

  • enable_qr (boolean): Enable or disable QR code generation.

  • redirect_url (string): URL to redirect after payment.

  • include_invoice_id (boolean): Include invoice ID in the documentation.

  • webhook_url (string): URL for webhook callbacks.

  • terms_condition_url (string): URL for terms and conditions.

  • custom_thanks_message (string): Custom thank you message.

  • custom_button_text (string): Custom text for the payment button.

  • green_donation_link (string): URL for green donation link.

  • donation_percentage (number): Percentage of donation.

  • donation_message (string): Message regarding donations.

  • tax_details (object): Contains tax details.

    • tax_title (string): Title for tax.

    • tax_percentage (number): Tax percentage.

    • tax_country (string): Country where the tax is applicable.

    • is_all_states (boolean): If tax is applicable to all states.

    • tax_states (array): List of states where tax is applicable (empty if all states).

  • invoice_date (string): Date when the invoice was generated (ISO 8601 format).

  • theme_color (string): Theme color for the invoice.

  • client_details (object): Details of the client.

    • name (string): Name of the client.

    • phone_code (string): Country code for the client's phone number.

    • phone (string): Client's phone number.

    • email (string): Client's email address.

    • website (string): Client's website URL.

    • street_address (string): Street address of the client.

    • state (string): State of the client.

    • city (string): City of the client.

    • country (string): Country of the client.

    • zip_code (string): Zip code of the client.

    • details (array): Additional details of the client.

      • PAN (string): Client's PAN number.

      • GST (string): Client's GST number.

  • product_details * (array): Details of the products or services.

    • name (string): Name of the product.

    • price (string): Price of the product.

    • description (string): Description of the product.

    • logo (string): Logo of the product.

    • product_created_at (string): Date when the product was created (ISO 8601 format).

    • currency (string): Currency for the product price.

    • quantity (number): Quantity of the product.

    • amount (number): Amount for the product (price * quantity).

    • final (number): Final amount after any discounts or taxes.

  • total (number, required): Total amount before any additional charges.

  • total_details (array): Breakdown of additional charges or discounts.

    • title (string): Title for the charge or discount.

    • amount (number): Amount for the charge or discount.

    • percentage (number): Percentage for the charge or discount.

  • net_total (number): Net total after all deductions and additions.

  • allow_partial (boolean): Whether partial payments are allowed.

  • allow_tip (boolean): Whether tips are allowed.

  • due_date (string): Due date for the payment (ISO 8601 format).

  • note_to_customer (string): Note to the customer regarding payment.

  • terms_message (string): Additional terms or messages.

  • tracking_number (string): Tracking number for the shipment.

  • tracking_url (string): URL to track the shipment.

  • extras (object): Additional key-value pairs.

    • key1 (string): Extra key 1.

    • key2 (string): Extra key 2.

  • funding_source (string): Source of funding for the transaction.

Request Body

Response

Code Example

Last updated