OVPAY-1564 - Improvements in validation objects, part 2.

This commit is contained in:
Bas Boterman 2025-03-24 15:35:30 +01:00
parent a6005c6f2f
commit ceb0137aca

View File

@ -742,9 +742,9 @@ paths:
schema:
$ref: "#/components/schemas/unavailable"
examples:
v2:
summary: Order list for customer v2
description: Order list for customer v2
v2.0:
summary: Order list for customer v2.0
description: Order list for customer v2.0
value:
{
"orders":
@ -773,7 +773,7 @@ paths:
"shippingAddressId": 1,
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
"orderStatus":
@ -923,7 +923,7 @@ paths:
"shippingAddressId": 1,
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
"orderStatus":
@ -1032,10 +1032,12 @@ paths:
"verificationCode": "A7H6",
"personalAccountData":
{
"name": "John Doe",
"dateOfBirth": "1980-01-01",
"gender": "male",
"countryOfResidence": "NL",
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeTypeId": 1,
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
],
@ -1315,7 +1317,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -1363,10 +1365,15 @@ paths:
"personalAccountData":
{
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
"name": "John Doe",
"dateOfBirth": "1980-01-01",
"gender": "male",
"countryOfResidence": "NL",
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
{
"challengeTypeId": 1,
"name": "email",
},
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
],
@ -1456,9 +1463,9 @@ paths:
schema:
$ref: "#/components/schemas/unavailable"
examples:
v2:
summary: Order details v2
description: Order details v2
v2.0:
summary: Order details v2.0
description: Order details v2.0
value:
{
"orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
@ -1484,7 +1491,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -1732,7 +1739,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -1770,7 +1777,7 @@ paths:
[
{
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenTypeId": 1,
"tokenTypeId": { "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -1788,7 +1795,9 @@ paths:
},
},
],
"orderAccountingStatuses": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks":
[
{
@ -1796,65 +1805,10 @@ paths:
"parameter": "directDebitMandateId",
},
],
"validationErrors": [],
},
],
"payments":
[
{
"paymentId": "94270188-4cf6-447e-bd49-e8186bcec073",
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"paymentStatuses":
[
{
"paymentStatusId": "42eee610-1a17-4f02-be14-7e25d69d35f3",
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
{
"mandateInputId": "1d6626cd-b93b-4ea6-85d5-a8e3a24a2725",
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
"place": "Den Haag",
},
},
],
"orderCustomer":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"orderCustomerAddresses":
[
{
"orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
"addressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
"payments": [],
"orderCustomer": null,
}
v1.2:
value:
@ -1948,8 +1902,8 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Create orderLine v2.0
description: Create orderLine v2.0
summary: Create order line v2.0
description: Create order line v2.0
value:
{
"externalOrderLineId": null,
@ -1958,7 +1912,7 @@ paths:
"validFrom": "2024-03-22T09:00:00",
"validUntil": null,
"createdOn": "2024-03-22T09:00:00",
"tokens":
"customerTokens":
[
{
"tokenTypeId": 1,
@ -2057,7 +2011,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -2091,9 +2045,10 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenTypeId": 1,
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
@ -2102,6 +2057,7 @@ paths:
"verificationCode": "A7H6",
"personalAccountData":
{
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
@ -2111,6 +2067,9 @@ paths:
},
},
],
"orderAccountingStatuses": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks":
[
{
@ -2141,9 +2100,10 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenTypeId": 1,
"ovPayTokenId": 4,
"serviceReferenceId": null,
@ -2153,30 +2113,14 @@ paths:
"personalAccountData": null,
},
],
"orderAccountingStatuses": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks": [],
},
],
"payments": [],
"customer":
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
[
{
"addressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
"orderCustomer": null,
},
}
v1.2:
@ -2295,7 +2239,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -2329,10 +2273,11 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"tokenTypeId": 1,
"customerTokenId": "ca15ccfb-ff5c-4c3b-b7c5-d65fc39f499d",
"tokenType": { "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -2340,6 +2285,7 @@ paths:
"verificationCode": "A7H6",
"personalAccountData":
{
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
@ -2349,6 +2295,9 @@ paths:
},
},
],
"orderAccountingStatuses": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks":
[
{
@ -2358,56 +2307,8 @@ paths:
],
},
],
"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",
},
],
"payPush":
{
"consumerIssuer": "ABN AMRO",
"transactionId": "0000000000000001",
"consumerName": "J. de Vries",
"consumerIBAN": "NL44RABO0123456789",
"consumerBIC": "RABONL2U",
},
},
],
"customer":
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
[
{
"addressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
"payments": [],
"orderCustomer": null,
}
v1.2:
value:
@ -2446,7 +2347,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
examples:
v2.0:
value:
{
@ -2473,7 +2374,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -2483,28 +2384,9 @@ paths:
"description": "Order is aangemaakt",
},
],
"orderLines": null,
"payments": null,
"customer":
{
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
[
{
"addressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
},
],
},
"orderLines": [],
"payments": [],
"orderCustomer": null,
}
"400":
description: Bad request
@ -2557,8 +2439,8 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Order Creation v2
description: Order Creation v2
summary: Add a payment v2.0
description: Add a payment v2.0
value:
{
"createdOn": "2024-03-22T09:00:00",
@ -2566,26 +2448,9 @@ paths:
"paymentMethodId": 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":
{
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
"place": "Den Haag",
},
"pspPaymentReference": null,
"paymentStatuses": [],
"mandateInput": null,
}
v1.2:
summary: Order creation v1.2
@ -2653,8 +2518,15 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "99137e30-2bf5-4c9b-95f0-ca432adcae5f",
"orderStatus":
{ "orderStatusId": 2, "name": "awaitingPayment" },
"createdOn": "2024-03-22T09:05:00",
"description": "Betaling is geinitieerd",
},
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
"orderStatus":
@ -2687,10 +2559,12 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"tokenTypeId": 1,
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenType":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -2698,6 +2572,7 @@ paths:
"verificationCode": "A7H6",
"personalAccountData":
{
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
"name": "Jan de Vries",
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
@ -2730,10 +2605,11 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"tokenTypeId": 1,
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenType": { "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 4,
"serviceReferenceId": null,
"amount": null,
@ -2888,7 +2764,7 @@ paths:
"touchpointId": 3,
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -3112,7 +2988,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -3279,7 +3155,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -3438,7 +3314,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -3598,7 +3474,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
@ -3738,7 +3614,7 @@ paths:
},
"createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus":
"order_OrderStatuses":
[
{
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",