Invoice Raising

Using QuickaPay to power your checkout process

post
Create an Invoice Request

https://my.quicka.co/v1/invoices
This endpoint allows you to create an invoice request.
Request
Response
Request
Headers
X-Access-Key
required
string
The Invoice Raising Access Key provided on the Configure API Access settings.
X-Business-Id
required
string
The Business ID provided on the Configure API Access settings.
Body Parameters
contact_email
required
string
The customers email address.
contact_name
required
string
The customers name.
contact_number
optional
string
An option customer phone number.
customer_invoice_ref
optional
string
An optional invoice reference number to display to the customers payment page.
due_date
optional
string
An optional due date of the invoice in the RFC 3339 format.
amount
required
string
The total amount of the payment
payment_options
required
array
A string array of payment options given to the customer. You must provide a minimum of one payment option to the customer.
invoice_pdf
required
string
A base64 encoded invoice pdf file to be displayed to the customer. The body must provide either an invoice_pdf or invoice_url.
invoice_url
required
string
An invoice url to be displayed to the customer. The body must provide either an invoice_url or invoice_url.
Response
200: OK
Below is an example of a successful creation of an invoice request.
{
"invoice_id": "03adf0a0-3fed-4ea7-aa22-461516b54139",
"status": "pending"
}
500: Internal Server Error
{
"type": "Internal Server Error",
"message": "Generic Server Error"
}

Example payload for sending an Invoice Request

{
"contact_email": "[email protected]",
"contact_name": "Gabe Newell",
"contact_number": "",
"customer_invoice_ref": "342342",
"due_date": "2020-09-15T13:41:50.864528+10:00",
"amount": "100",
"payment_options": [
"Card",
"Instalments"
],
"invoice_pdf": "",
"invoice_url": "https://business-home.com.au/invoices/ca27e056-6ea7-43e5-8e37-f33def88f9f3"
}

get
Get an Invoice

https://my.quicka.co/v1/invoices/{invoice_id}
This endpoint allows you to retrieve an invoice.
Request
Response
Request
Path Parameters
invoice_id
required
string
The invoice UUID wanting to be retrieved.
Headers
X-Access-Key
required
string
The Invoice Raising Access Key provided on the Configure API Access settings.
X-Business-Id
required
string
The Business ID provided on the Configure API Access settings.
Response
200: OK
Below is an example of a successful request of a paid invoice object being returned. The possible method on the returned body is either "Card" or "Instalments". If the invoice has not been paid it will be omitted. The timestamp is encoded in Unix format.
{
"invoice_id": "5beb74a7-d492-4ff8-8dc5-ef06c2f61bb9",
"settlement_token": "wt5bKT9PMndFmA5ffdKDZT",
"method": "Card",
"status": "paid",
"paid_amount": "380",
"remitted_amount": "380",
"timestamp": 1600060455
}
404: Not Found
This response body is returned when the invoice_id provided in the response body does not exist.
{
"type": "Not Found",
"message": "The invoiceID given does not exist"
}
500: Internal Server Error
{
"type": "Internal Server Error",
"message": "Generic Server Error"
}

‚Äč