Payments Request

Using QuickaPay to power your checkout process

post
Create a Payment Request

https://my.quicka.co/v1/payments
This endpoint allows you to create unique payments for your customer to complete.
Request
Response
Request
Headers
X-Access-Key
required
string
The Payments Request 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
invoice_reference
optional
string
An optional reference number to display on the customers dashboard.
contact_email
required
string
The customers email address.
contact_name
required
string
The customers name.
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_pdf or invoice_url.
payment_options
required
array
A string array of payment options given to the customer on the dashboard. You must provide a minimum of one payment option to the customer. The possible payment option enums are "Card" and "Instalments".
return_url
required
string
Once a customer has completed the payment specify a url for your customer to return too.
total_amount
required
string
The total amount of the payment.
Response
200: OK
A successful payment request will return the unique payment page url for your customer to complete and get paid.
{
"invoice_id": "d30b8a79-f23e-4e5b-9af8-0eb1176e9cbf",
"payment_page_url": "https://my.quicka.co/inv/d30b8a79-f23e-4e5b-9af8-0eb1176e9cbf/"
}
500: Internal Server Error
{
"type": "Internal Server Error",
"message": "Generic Server Error"
}

Example payload for sending a Payment Request

{
"return_url": "https://business-homepage.com.au",
"contact_email": "[email protected]",
"contact_name": "Gabe Newell",
"total_amount": "100",
"payment_options": [
"Card",
"Instalments"
],
"invoice_pdf": "ZDNoNzgyM2ZoODI0Zmg4MnVoOGZ1OGgyZWZoOHUzMmg4dWYzcmg4dWdoODNyaHVyM2dodXIzZ2h1",
"invoice_url": "",
"invoice_reference": "342342"
}

post
Verify a Payment Request

https://my.quicka.co/v1/payments/verify
This endpoint allows you to verify a payment request has been completed.
Request
Response
Request
Headers
X-Access-Key
required
string
The Payments Request 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
invoice_id
required
string
The Invoice UUID provided to you when creating the invoice request.
settlement_token
required
string
The Invoice settlement token.
Response
200: OK
The successful model returned provides current information about the status of the customers payment such if it has been completed. The possible method on the returned body is either "Card" or "Instalments". If the payment request has not been paid it will be omitted. The possible status on the returned body is either "paid", "pending", "refunded", "cancelled" or "failed". If the status has been paid it will be omitted. The timestamp is encoded in Unix format.
Paid Response Example
Pending Response Example
Paid Response Example
{
"settlement_token": "2xVu5tFgEUK2abPlVI2CPA",
"method": "Card",
"status": "paid",
"paid_amount": "5000",
"remitted_amount": "4902.5",
"timestamp": 1600133975
}
Pending Response Example
{
"settlement_token": "2xVu5tFgEUK2abPlVI2CPA",
"status": "pending",
"paid_amount": "0",
"remitted_amount": "4902.5"
}
404: Not Found
This response body is returned when the invoice_id provided in the request 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"
}

Example payload for verifying a Payment Request

{
"settlement_token": "2xVu5tFgEUK2abPlVI2CPA",
"invoice_id": "7ac587ea-f06d-44b4-a408-133c0e7e73ef"
}