Create Order Invoice

Creates a new order and sends the invoice via specified comm method (phone, email or both)

SecurityLimepay-SecretKey

Request

Request Body schema: application/json

sendSms	boolean Whether to send the payment link via SMS
sendEmail	boolean Whether to send the payment link via email
required	object (MerchantOrderRequest) Details of the order

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/orders/invoices

Request samples

Payload
Curl
JavaScript

application/json

{"sendSms": true,
"sendEmail": true,
"orderRequest": {"orderType": "online",
"internalOrderId": "string",
"paymentAmount": {"amount": 0,
"currency": "AUD"
},
"paymentTypeAmounts": [{"checkoutPayType": "payplan",
"amount": 0
}
],
"customerEmail": "lucy.diamond@star.com",
"phoneNo": "+61401234567",
"description": "string",
"items": [{"amount": 0,
"currency": "AUD",
"description": "string",
"sku": "string",
"quantity": 0,
"imageUrl": "string"
}
],
"taxIncluded": true,
"taxIncludedAmountOverride": 0,
"discount": {"amount": 0
},
"shipping": {"amount": 0,
"address": {"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
},
"carrier": "string",
"name": "string",
"phone": "string",
"trackingNumber": "string"
},
"billing": {"address": {"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
},
"name": "string",
"phone": "string"
},
"metadata": { },
"request3DSOnPayment": true,
"emailCustomerReceipt": true
}
}

Response samples

application/json

{"order": {"merchantOrderId": "ordr_Zz5FyPz_YQaAoSHY",
"merchantId": "mcht_Zz5Fx_z_YQaAoSHU",
"marketplaceId": "mktp_Zz5FyPz_YQaAoSHe",
"internalOrderId": "string",
"amount": 0,
"currency": "AUD",
"paymentTypeAmounts": [{"checkoutPayType": "payplan",
"amount": 0
}
],
"amountPaid": 0,
"customerEmail": "lucy.diamond@star.com",
"phoneNo": "+61401234567",
"type": "online",
"description": "string",
"items": [{"amount": 0,
"currency": "AUD",
"description": "string",
"sku": "string",
"quantity": 0,
"imageUrl": "string"
}
],
"invoiceLineItems": [{"totalFee": 0,
"totalTax": 0,
"totalValue": 0,
"unitCount": 0,
"itemDescription": "string",
"category": "string",
"itemNotes": "string"
}
],
"taxIncluded": true,
"taxIncludedAmountOverride": 0,
"discount": {"amount": 0
},
"shipping": {"amount": 0,
"address": {"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
},
"carrier": "string",
"name": "string",
"phone": "string",
"trackingNumber": "string"
},
"billing": {"address": {"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
},
"name": "string",
"phone": "string"
},
"metadata": { },
"status": "created",
"request3DSOnPayment": true,
"emailCustomerReceipt": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"token": "string",
"magicLink": "string"
}