HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

DHIL-3731, DHIL-3732 - POST and GET Order.

Browse Source
This commit is contained in:
Bas Boterman 2024-09-24 17:19:34 +02:00
parent b0f2e5529a
commit db4ee7c2af
1 changed files with 323 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

325
src/openapi/orders/orders-crud.yaml
View File

@ -18,10 +18,305 @@ paths:
schema:
$ref: "#/components/schemas/unavailable"
example:
null
{
"externalOrderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
"orderNumber": "123456",
"customerProfileId": 1337,
"totalAmount": 121,
"touchPointId": 1,
"languageId": 1,
"billingAddressId": 1,
"shippingAddressId": 1,
"createdOn": "2024-03-22T09:00:00",
"order_OrderStatus":
{
"orderStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"description": "Order succesvol betaald",
},
"orderLines":
[
{
"externalOrderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f",
"productId": 1,
"productName": "HTM Maandkorting 20%",
"productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%",
"taxAmount": 21,
"taxCodeId": "V21",
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"terms": "generalTermsAndConditions.pdf",
"validFrom": "2024-03-22T09:00:00",
"validUntil": "2025-03-22T09:00:00",
"orderLineStatusId": 4,
"createdOn": "2024-03-22T09:00:00",
"customerTokens":
[
{
"tokenTypeId": 1,
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6",
"xTAT": "3b5f2354-d8a1-4317-bb6e-2c32458bc061",
"xBOT": "0fbdb14c-9306-462e-aca7-765a4980a2f7",
"personalAccountData":
{
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeTypeId": 1,
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
],
"orderAccountingStatuses":
[
{
"accountingStatusId": 1,
"createdOn": "2024-03-22T09:00:00",
"description": "Financiele transactie voor de FIKO.",
},
],
},
],
"payments":
[
{
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
{
"mandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
},
},
],
"orderCustomer":
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
[
{
"orderAddressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
}
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example: { "orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d" }
/orders/{orderId}:
parameters:
- in: path
name: orderId
schema:
type: string
format: uuid
example: d1dd439b-6072-4b97-89c9-724268865b93
required: true
description: The id of the order to get.
get:
summary: Get a single order.
description: Get a single order.
tags:
- Order
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
"externalOrderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
"orderNumber": "123456",
"customerProfileId": 1337,
"totalAmount": 121,
"touchPointId": 1,
"language":
{
"languageId": 1,
"name": "Nederlands",
"iso639Code": "nl-NL",
"ietfCode": "nl",
},
"billingAddressId": 1,
"shippingAddressId": 1,
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
"orderStatus": { "orderStatusId": 4, "status": "paid" },
"createdOn": "2024-03-22T09:00:00",
"description": "Order succesvol betaald",
},
"orderLines":
[
{
"orderLineId": "7a7a9d1a-3fc8-4058-a28b-082860aaa311",
"externalOrderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f",
"productId": 1,
"productName": "HTM Maandkorting 20%",
"productCode": "HTM-MND-20",
"productDescription": "HTM Maandkorting 20%",
"taxAmount": 21,
"taxCodeId": "V21",
"amountExclTax": 100,
"amountInclTax": 121,
"quantity": 1,
"terms": "generalTermsAndConditions.pdf",
"validFrom": "2024-03-22T09:00:00",
"validUntil": "2025-03-22T09:00:00",
"orderLineStatus":
{ "orderLineStatusId": 4, "status": "delivered" },
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"customerTokens":
[
{
"customerTokeId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenType": { "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
"ovpasNumber": "OV34567",
"verificationCode": "A7H6",
"xTAT": "3b5f2354-d8a1-4317-bb6e-2c32458bc061",
"xBOT": "0fbdb14c-9306-462e-aca7-765a4980a2f7",
"personalAccountData":
{
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeType":
{ "challengeTypeId": 1, "name": "email" },
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
],
"orderAccountingStatuses":
[
{
"orderAccountingStatusId": "7c5118d0-8535-4464-9239-83a7ba8fd2db",
"accountingStatus":
{ "accountingStatusId": 1, "status": "open" },
"createdOn": "2024-03-22T09:00:00",
"description": "Financiele transactie voor de FIKO.",
},
],
},
],
"payments":
[
{
"paymentId": "3ba4a3c7-0803-4214-800b-365851b8903d",
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethod":
{
"paymentMethodId": 1,
"name": "ideal",
"provider": "Buckaroo",
},
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"paymentStatusId": 1,
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
{
"mandateInputId": "0a875e67-dc9f-4825-a030-d732a2adbfbc",
"mandateType": {
"mandateTypeId": 1,
"name": "import"
},
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
},
},
],
"orderCustomer":
{
"orderCustomerId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
[
{
"orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
"orderAddressType": {
"orderAddressTypeId": 1,
"name": "Billing",
},
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
}
components:
securitySchemes:
bearerToken:
@ -30,4 +325,30 @@ components:
bearerFormat: JWT
schemas:
unavailable:
type: object
type: object
rfc9457:
type: object
properties:
type:
type: string
format: url
example: "https://example.com/probs/out-of-credit"
title:
type: string
example: "You do not have enough credit."
detail:
type: string
example: "Your current balance is 30, but that costs 50."
instance:
type: string
example: "/account/12345/msgs/abc"
balance:
type: string
example: "30"
accounts:
type: array
items:
type: string
example:
- "/account/12345"
- "/account/67890"