API Reference

Create Invoice

post
https://api.eukapay.com/invoices

Create a new invoice

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
double
required
Defaults to 12.34

The cost of the invoice. If invoiceItems is used, the total of invoiceItems takes precedence and this price is ignored. The minimum invoice price is 1 and the maximum invoice price is 100,000

int32
required
Defaults to 1

The currency id to charge the invoice with. Supported currencies are here https://docs.eukapay.com/docs/supported-currencies

string
Defaults to D1BA1F0C-5

The invoice number. The default format is INV-yymmdd-No.

string
Defaults to The message

Additional message to describe invoice

metadata
object

This parameter allows for the inclusion of customizable data intended exclusively for internal use. It is not visible to customers.

date
Defaults to 2024-04-06

The issue date of the invoice. The default is the invoice created date. The format is YYYY-MM-DD.

date
Defaults to 2024-04-06

The due date of the invoice. The format is YYYY-MM-DD.

string
Defaults to cus_q06lpsoz2v7cwd5mn2tlxkr2jvjxxi

The code of the customer invoice is generated for. If total invoice price is greater than or equal to 1,000, this param is required and fields address1, city, state, country are required in the customer object.

string
Defaults to https://example.com/orderCompleted

The url to redirect to once payment is completed

invoiceItems
array of objects

The invoice items in this invoice.

invoiceItems
invoiceTaxes
array of objects

The invoice taxes for this invoice.

invoiceTaxes
invoiceDiscounts
array of objects

The invoice discounts for this invoice.

invoiceDiscounts
Headers
string
Responses

Updated 11 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 months ago