LayUp Technologies OrderService API
The OrderService API from LayUp Technologies — 7 operation(s) for orderservice.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/layup-technologies-orderservice-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Layup endpoints Order Service API
version: 1.4.16
description: Welcome to The Layup Swagger page.
servers:
- url: http://localhost:3000
- url: https://localhost:3000
- url: wss://localhost:3000
security:
- apiKey:
- read
- write
tags:
- name: OrderService
paths:
/v1/orders:
get:
operationId: OrderService_GetMany
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderResponseMany'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: populate
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: limit
in: query
required: false
schema:
type: integer
format: int32
- name: skip
in: query
required: false
schema:
type: integer
format: int32
- name: userId
in: query
required: false
schema:
type: string
- name: state
in: query
required: false
schema:
type: string
enum:
- PARTIAL
- EXPIRED
- PLACED
- COMPLETED
- SUSPENDED
- CANCELLING
- CANCELLED
description: See the Enumerated Values below
- name: from
in: query
required: false
schema:
type: string
format: date
default: '2000-03-20'
- name: to
in: query
required: false
schema:
type: string
format: date
default: '2030-03-20'
- name: select
in: query
required: false
schema:
type: string
- name: populateObject.path
in: query
required: false
schema:
type: string
- name: populateObject.select
in: query
required: false
schema:
type: string
- name: populateObject.populate.path
in: query
required: false
schema:
type: string
- name: populateObject.populate.select
in: query
required: false
schema:
type: string
- name: search
in: query
required: false
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
- name: sort
in: query
required: false
schema:
type: string
- name: stateUpdatedAt
in: query
required: false
schema:
type: string
- name: cloneOriginalId
in: query
required: false
schema:
type: string
- name: groupPaymentPlan
in: query
required: false
schema:
type: string
tags:
- OrderService
summary: Order service get many
x-summary-source: derived
post:
operationId: OrderService_Create
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: _id
in: query
required: false
schema:
type: string
- name: clone
in: query
required: false
schema:
type: string
tags:
- OrderService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderRequest'
required: true
summary: Order service create
x-summary-source: derived
/v1/orders-send-request:
post:
operationId: OrderService_SendOrderRequest
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderSendRequestResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
tags:
- OrderService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderSendRequest'
required: true
summary: Order service send order request
x-summary-source: derived
/v1/orders/attach/{_id}:
get:
operationId: OrderService_Attach
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: _id
in: path
required: true
schema:
type: string
tags:
- OrderService
summary: Order service attach
x-summary-source: derived
/v1/orders/reference/{reference}/cellNumber/{cellNumber}:
get:
operationId: OrderService_GetByReferenceAndCellNumber
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderResponseMany'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: reference
in: path
required: true
schema:
type: string
- name: cellNumber
in: path
required: true
schema:
type: string
tags:
- OrderService
summary: Order service get by reference and cell number
x-summary-source: derived
/v1/orders/{_id}:
get:
operationId: OrderService_Get
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: _id
in: path
required: true
schema:
type: string
- name: populate
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
tags:
- OrderService
summary: Order service get
x-summary-source: derived
delete:
operationId: OrderService_Del
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: _id
in: path
required: true
schema:
type: string
tags:
- OrderService
summary: Order service del
x-summary-source: derived
put:
operationId: OrderService_Update
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: _id
in: path
required: true
schema:
type: string
- name: collectMissed
description: now, next or ISO 8601 Date
in: query
required: false
schema:
type: string
default: '2040-11-28'
tags:
- OrderService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderUpdateRequest'
required: true
summary: Order service update
x-summary-source: derived
/v1/orders/{_id}/cancellation-terms:
get:
operationId: OrderService_GetCancellationTerms
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelOrderCancellationTermsResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
parameters:
- name: _id
in: path
required: true
schema:
type: string
tags:
- OrderService
summary: Order service get cancellation terms
x-summary-source: derived
/v1/statement:
post:
operationId: OrderService_StatementRequest
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/modelStatementRequestResponse'
'204':
description: Successfully processed the request, no content.
'403':
description: Returned when the user does not have permission to access the resource.
'404':
description: Returned when the resource does not exist.
tags:
- OrderService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modelStatementRequest'
required: true
summary: Order service statement request
x-summary-source: derived
components:
schemas:
modelPaymentPlanResponse:
type: object
properties:
_id:
type: string
orderId:
type: string
benefactorId:
type: string
completed:
type: boolean
quantity:
type: integer
format: int32
depositDue:
type: integer
format: int32
amountDue:
type: integer
format: int32
automaticBilling:
type: boolean
timestamp:
type: number
format: double
payments:
type: array
items:
type: object
$ref: '#/components/schemas/modelPlanPayment'
benefactor:
$ref: '#/components/schemas/modelPaymentPlanBenefactor'
frequency:
type: string
enum:
- WEEKLY
- MONTHLY
offset:
type: integer
format: int32
depositDueExcludingFee:
type: integer
format: int32
amountDueExcludingFee:
type: integer
format: int32
order:
$ref: '#/components/schemas/modelOrderResponse'
debicheckStatus:
type: string
debicheckLastFailedReasons:
type: array
items:
type: string
debicheckMandateActiveId:
type: string
debicheckMandateIds:
type: array
items:
type: string
payAtReferenceNumber:
type: string
agreedToTerms:
type: boolean
modelSupplier:
type: object
properties:
_id:
type: string
name:
type: string
merchantId:
type: string
modelPaymentWidgetLogo:
type: object
properties:
enabled:
type: boolean
value:
type: string
modelOrderUpdateRequest:
type: object
example:
state: PLACED
properties:
depositAmount:
type: integer
format: int32
products:
type: array
items:
type: object
$ref: '#/components/schemas/modelProductCreateRequest'
endDateMax:
type: string
endDateMin:
type: string
state:
type: string
depositPerc:
type: number
format: double
reference:
type: string
name:
type: string
imageUrl:
type: string
absorbsFee:
type: boolean
enablesSplit:
type: boolean
depositType:
type: string
expire:
type: integer
format: int32
cancellationTerms:
$ref: '#/components/schemas/modelCancellationTermRequest'
weeklyPayments:
type: boolean
paymentMethods:
$ref: '#/components/schemas/modelPaymentMethod'
cancellationPolicy:
$ref: '#/components/schemas/modelCancellationPolicy'
groupPaymentPlan:
$ref: '#/components/schemas/modelGroupPayment'
cloneExpiry:
type: integer
format: int32
orderCancellationRequest:
type: string
notifications:
type: array
items:
type: object
$ref: '#/components/schemas/modelNote'
acceptedProposedCancellationTerms:
type: boolean
customFeatures:
$ref: '#/components/schemas/modelCustomize'
amortiseOnMissed:
type: boolean
amortiseOnAmend:
type: boolean
suspendOnCancel:
type: boolean
orderRefundRequest:
type: string
completedOrderRefundRequest:
type: boolean
orderRefundAmount:
type: integer
format: int32
orderRefundFee:
type: integer
format: int32
monthlyPayments:
type: boolean
type:
type: string
description:
type: string
modelOrderSendRequest:
type: object
example:
amount: 10000
paymentMethod: CARD
type: sms
orderId: 123f7f1496bd78001d6852f3
customerId: 123f7f1496bd78001d6852f3
message: string
properties:
type:
type: string
enum:
- sms
- email
- none
orderId:
type: string
orderUrl:
type: string
contact:
type: string
pattern: ^\+27\d{9}$
message:
type: string
customerId:
type: string
amount:
type: integer
format: int32
paymentMethod:
type: string
enum:
- CARD
- EFT
- DEBICHECK
modelNote:
type: object
properties:
change:
type: string
date:
type: string
name:
type: string
reason:
type: string
details:
type: string
read:
type: boolean
userId:
type: string
type:
type: string
hide:
type: boolean
unread:
type: boolean
modelPaymentProviderResponses:
type: object
modelCancellationTypeDefinition:
type: object
properties:
missed:
type: integer
format: int32
percentage:
type: integer
format: int32
modelStatementRequest:
type: object
properties:
type:
type: string
orderId:
type: string
email:
type: string
paymentPlanId:
type: string
modelCustomize:
type: object
properties:
logo:
$ref: '#/components/schemas/modelLogo'
imageUrl:
$ref: '#/components/schemas/modelImageUrl'
paymentWidget:
$ref: '#/components/schemas/modelPaymentWidgetLogo'
modelCancellationDefinition:
type: object
properties:
type:
$ref: '#/components/schemas/modelCancellationType'
policy:
$ref: '#/components/schemas/modelCancellationPolicy'
start:
type: integer
format: int32
end:
type: integer
format: int32
gracePeriod:
type: integer
format: int32
modelPlanPaymentConnectorData:
type: object
properties:
_id:
type: string
amount:
type: integer
format: int32
paymentProviderPaymentId:
type: string
paymentReference:
type: string
paymentMethod:
type: string
paymentProvider:
type: string
paymentProviderResponses:
$ref: '#/components/schemas/modelPaymentProviderResponses'
modelCancellationTermRequest:
type: object
properties:
active:
type: boolean
definition:
type: array
items:
type: object
$ref: '#/components/schemas/modelCancellationDefinition'
modelImageUrl:
type: object
properties:
enabled:
type: boolean
value:
type: string
modelPaymentMethod:
type: object
properties:
creditOrDebitCard:
type: boolean
eft:
type: boolean
debiCheck:
type: boolean
payAt:
type: boolean
capitecPay:
type: boolean
dashpay:
type: boolean
terminalCard:
type: boolean
offline:
type: boolean
embeddedCheckout:
type: boolean
modelLogo:
type: object
properties:
enabled:
type: boolean
value:
type: string
modelOrderResponseMany:
type: object
properties:
orders:
type: array
items:
type: object
$ref: '#/components/schemas/modelOrderResponse'
modelCancellationPolicyDefinition:
type: object
properties:
deposit:
type: boolean
percentage:
type: integer
format: int32
flatFee:
type: integer
format: int32
percentageShouldUseTotalPaid:
type: boolean
modelPlanPayment:
type: object
properties:
_id:
type: string
due:
type: string
amount:
type: integer
format: int32
paid:
type: boolean
timestamp:
type: number
format: double
paymentMethod:
type: string
paymentType:
type: string
amountExcludingFee:
type: integer
format: int32
fee:
type: integer
format: int32
pending:
type: boolean
failed:
type: boolean
reconciliated:
type: boolean
refundedAmount:
type: integer
format: int32
refundPaymentId:
type: string
connectorData:
$ref: '#/components/schemas/modelPlanPaymentConnectorData'
verifiedAt:
type: string
dueAt:
type: string
modelOrderSendRequestResponse:
type: object
example:
success: true
orderUrl: https://sandbox.layup.co.za/order/123f7f1496bd78001d6852f3?paymentMethod=CARD&amount=10000
properties:
success:
type: boolean
orderUrl:
type: string
modelGroupPayment:
type: object
properties:
enabled:
type: boolean
cloneLimit:
type: integer
format: int32
expiry:
type: integer
format: int32
modelOrderRequest:
type: object
example:
products: ProductCreateRequest
endDateMax: '2019-08-24T14:15:22Z'
depositPerc: 5
reference: string
name: string
depositType: INSTALMENT
properties:
depositAmount:
type: integer
format: int32
products:
type: array
items:
type: object
$ref: '#/components/schemas/modelProductCreateRequest'
endDateMax:
type: string
format: date-time
endDateMin:
type: string
format: date-time
depositPerc:
type: number
format: double
reference:
type: string
name:
type: string
imageUrl:
type: string
absorbsFee:
type: boolean
enablesSplit:
type: boolean
depositType:
type: string
enum:
- INSTALMENT
- FLAT
- PERCENTAGE
required:
- 'true'
expire:
type: integer
format: int32
cancellationTerms:
$ref: '#/components/schemas/modelCancellationTermRequest'
weeklyPayments:
type: boolean
paymentMethods:
$ref: '#/components/schemas/modelPaymentMethod'
cancellationPolicy:
$ref: '#/components/schemas/modelCancellationPolicy'
groupPaymentPlan:
$ref: '#/components/schemas/modelGroupPayment'
cloneExpiry:
type: integer
format: int32
orderCancellationRequest:
type: string
notifications:
type: array
items:
type: object
$ref: '#/components/schemas/modelNote'
acceptedProposedCancellationTerms:
type: boolean
customFeatures:
$ref: '#/components/schemas/modelCustomize'
amortiseOnMissed:
type: boolean
amortiseOnAmend:
type: boolean
suspendOnCancel:
type: boolean
orderRefundRequest:
type: string
completedOrderRefundRequest:
type: boolean
orderRefundAmount:
type: integer
format: int32
orderRefundFee:
type: integer
format: int32
monthlyPayments:
type: boolean
type:
type: string
description:
type: string
voucherSettings:
$ref: '#/components/schemas/modelVoucherSettings'
merchantId:
type: string
modelCancellationPolicy:
type: object
properties:
name:
type: string
enum:
- Deposit
- Percentage
- FlatFee
- Combination
definition:
$ref: '#/components/schemas/modelCancellationPolicyDefinition'
modelOrderResponse:
type: object
properties:
_id:
type: string
endDateMax:
type: string
format: date-time
required:
- 'true'
endDateMin:
type: string
format: date-time
initiatorId:
type: string
products:
type: array
items:
type: object
$ref: '#/components/schemas/modelProductResponse'
state:
enum:
- PARTIAL
- PLACED
- COMPLETED
- CANCELLED
- CANCELLING
- EXPIRED
- SUSPENDED
default: PARTIAL
supplierId:
type: string
cancelledBy:
type: string
amountDue:
type: integer
format: int32
flatFee:
type: integer
format: int32
percFee:
type: number
format: double
depositPerc:
type: number
format: double
absorbsFee:
type: boolean
reference:
type: string
name:
type: string
imageUrl:
type: string
plans:
type: array
items:
type: object
$ref: '#/components/schemas/modelPaymentPlanResponse'
createdAt:
type: string
timestamp:
type: number
format: double
enablesSplit:
type: boolean
depositAmount:
type: integer
format: int32
depositType:
type: string
enum:
- INSTALMENT
- FLAT
- PERCENTAGE
required:
- 'true'
expire:
type: string
cancellationTerms:
$ref: '#/components/schemas/modelCancellationTermRequest'
weeklyPayments:
type: boolean
paymentMethods:
$ref: '#/components/schemas/modelPaymentMethod'
stateUpdatedAt:
type: string
updatedAt:
type: string
groupPaymentPlan:
$ref: '#/components/schemas/modelGroupPayment'
cloneExpiry:
type: integer
format: int32
cloneCount:
type: integer
format: int32
orderCancellationRequest:
type: string
notifications:
type: array
items:
type: object
$ref: '#/components/schemas/modelNote'
acceptedProposedCancellationTerms:
type: boolean
customFeatures:
$ref: '#/components/schemas/modelCustomize'
merchantName:
type: string
merchantTermsLink:
type: string
merchantLink:
type: string
debiCheckMinimum:
$ref: '#/components/schemas/modelValueEnabledPair'
supplier:
$ref: '#/components/schemas/modelSupplier'
orderRefundRequest:
type: string
orderRefundAmount:
type: integer
format: int32
orderRefundFee:
type: integer
format: int32
monthlyPayments:
type: boolean
type:
type: string
balance:
type: integer
format: int32
description:
type: string
isIncreasedDepositAmountAllowed:
type: boolean
suspendOnCancel:
type: boolean
voucherSettings:
$ref: '#/components/schemas/modelVoucherSettings'
modelCancellationType:
type: object
properties:
name:
type: string
definition:
$ref: '#/components/schemas/modelCancellationTypeDefinition'
finalPaymentMissed:
type: boolean
modelPaymentPlanBenefactor:
type: object
properties:
_id:
type: string
name:
type: string
email:
type: string
modelOrderCancellationTermsResponse:
type: object
properties:
autoCancellation:
type: boolean
definition:
type: array
items:
type: object
$ref: '#/components/schemas/modelCancellationDefinition'
modelProductResponse:
type: object
properties:
_id:
type: string
amount:
type: integer
format: int32
link:
type: string
format: uri
sku:
type: string
name:
type: string
depositType:
type: string
modelProductCreateRequest:
type: object
properties:
_id:
type: string
amount:
type: integer
format: int32
link:
type: string
format: uri
sku:
type: string
name:
type: string
description:
type: string
depositType:
type: string
modelValueEnabledPair:
type: object
properties:
enabled:
type: boolean
value:
type: integer
format: int32
modelStatementRequestResponse:
type: object
properties:
success:
type: boolean
modelVoucherSettings:
type: object
properties:
active:
type: boolean
minimumSavingGoalInCents:
type: integer
format: int32
maximumSavingGoalInCents:
type: integer
format: int32
rewardType:
type: string
rewardFlatAmountInCents:
type: integer
format: int32
rewardPercentage:
type: integer
format: int32
voucherProvider:
type: string
securitySchemes:
apiKey:
type: apiKey
name: apikey
in: header