Create Order

Creates a new order in the Limepay system

SecurityLimepay-SecretKey
Request
Request Body schema: application/json
internalOrderId
required
string

An ID field that is meaningful to the caller – can be any string

required
object (PaymentAmount)

The amount and currency of the order, unsurcharged, used if the checkout amount is the same for all payment types (ie paymentTypeAmounts is omitted)

customerEmail
string

Optional email of the customer

phoneNo
string

Optional phone number of the customer. Note, this must be in an E164 format

description
required
string
Array of objects (Item)
object (Discount)
object (Shipping)
required
object (Billing)
metadata
object (JsonObject)
Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/orders
Request samples
application/json
{
  • "internalOrderId": "string",
  • "paymentAmount": {
    },
  • "customerEmail": "lucy.diamond@star.com",
  • "phoneNo": "string",
  • "description": "string",
  • "items": [
    ],
  • "discount": {
    },
  • "shipping": {
    },
  • "billing": {
    },
  • "metadata": { }
}
Response samples
application/json
{
  • "merchantOrderId": "ordr_ZkqRkIi-rDZ4MCZU",
  • "merchantId": "mcht_ZkqRkIi-rDZ4MCZQ",
  • "marketplaceId": "mktp_ZkqRkYi-rDZ4MCZZ",
  • "internalOrderId": "string",
  • "amount": 0,
  • "currency": "AUD",
  • "paymentTypeAmounts": [
    ],
  • "amountPaid": 0,
  • "customerEmail": "lucy.diamond@star.com",
  • "phoneNo": "+61401234567",
  • "type": "online",
  • "description": "string",
  • "items": [
    ],
  • "taxIncluded": true,
  • "taxIncludedAmountOverride": 0,
  • "discount": {
    },
  • "shipping": {
    },
  • "billing": {
    },
  • "metadata": { },
  • "status": "created",
  • "request3DSOnPayment": true,
  • "emailCustomerReceipt": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}
Copyright © April Solutions 2023. All right reserved.