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

This commit is contained in:
Bas Boterman 2025-03-25 16:02:05 +01:00
parent ceb0137aca
commit 8ac15a7b09

View File

@ -381,7 +381,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"payPush":
@ -489,7 +489,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"payPush":
@ -651,7 +651,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"payPush":
@ -801,7 +801,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"mandateInput":
@ -951,7 +951,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"mandateInput":
@ -1118,7 +1118,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"mandateInput":
@ -1246,7 +1246,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"mandateInput":
@ -1369,6 +1369,7 @@ paths:
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeType":
{
"challengeTypeId": 1,
"name": "email",
@ -1620,7 +1621,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"mandateInput":
@ -1777,7 +1778,8 @@ paths:
[
{
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenTypeId": { "tokenTypeId": 1, "name": "EMV" },
"tokenTypeId":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -1790,7 +1792,11 @@ paths:
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeType":
{
"challengeTypeId": 1,
"name": "email",
},
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
@ -2062,7 +2068,11 @@ paths:
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeType":
{
"challengeTypeId": 1,
"name": "email",
},
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
@ -2183,8 +2193,8 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Orderline update v2.0
description: Orderline update v2.0
summary: Update order line v2.0
description: Update order line v2.0
value:
{
"quantity": 1,
@ -2192,7 +2202,7 @@ paths:
"validUntil": null,
}
v1.2:
summary: Orderline updatev1.2
summary: Orderline update v1.2
description: Orderline update v1.2
value:
{
@ -2277,7 +2287,8 @@ paths:
[
{
"customerTokenId": "ca15ccfb-ff5c-4c3b-b7c5-d65fc39f499d",
"tokenType": { "tokenTypeId": 1, "name": "EMV" },
"tokenType":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -2290,7 +2301,11 @@ paths:
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeType":
{
"challengeTypeId": 1,
"name": "email",
},
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
@ -2471,7 +2486,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"mandateInput":
@ -2577,11 +2592,19 @@ paths:
"dateOfBirth": "01-01-1970",
"photoReference": "DSC_0502.JPG",
"fileType": "image/jpg",
"challengeType":
{
"challengeTypeId": 1,
"name": "email",
},
"oneTimePassword": "H5Iiz3JTaQeIV8p",
},
},
],
"orderAccountingStatuses": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks": [],
},
{
"orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71",
@ -2609,7 +2632,8 @@ paths:
[
{
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenType": { "tokenTypeId": 1, "name": "EMV" },
"tokenType":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 4,
"serviceReferenceId": null,
"amount": null,
@ -2618,49 +2642,51 @@ paths:
"personalAccountData": null,
},
],
"orderAccountingStatuses": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks": [],
},
],
"payments":
[
{
"paymentId": "1a973c85-7a96-41b5-bbf2-7919d6a6db15",
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
"touchPointId": 1,
"isRefund": false,
"htmPaymentReference": "HTM-1234",
"pspPaymentReference": "Buckaroo-1234",
"pspPaymentReference": null,
"paymentStatuses":
[
{
"paymentStatusId": "42eee610-1a17-4f02-be14-7e25d69d35f3",
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusCode": "?",
"statusDescription": "Initiated",
"statusSubCode": "?",
"statusSubDescription": "PaymentInitiated",
},
],
"payPush":
{
"consumerIssuer": "ABN AMRO",
"transactionId": "0000000000000001",
"consumerName": "J. de Vries",
"consumerIBAN": "NL44RABO0123456789",
"consumerBIC": "RABONL2U",
},
"mandateInput": null,
},
],
"customer":
"orderCustomer":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
"orderCustomerAddresses":
[
{
"addressTypeId": 1,
"orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
"addressType":
{ "addressTypeId": 1, "name": "Billing" },
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
@ -2702,8 +2728,8 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Order payment update v2.0
description: Order payment update v2.0
summary: Update payment v2.0
description: Update payment v2.0
value:
{
"htmPaymentReference": "HTM-1234",
@ -2715,7 +2741,7 @@ paths:
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"mandateInput":
@ -2798,10 +2824,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,
@ -2809,20 +2837,30 @@ paths:
"verificationCode": "A7H6",
"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": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks": [],
},
],
"payments":
[
{
"paymentId": "1a973c85-7a96-41b5-bbf2-7919d6a6db15",
"createdOn": "2024-03-22T09:00:00",
"amountDebit": 121,
"paymentMethodId": 1,
@ -2833,6 +2871,15 @@ paths:
"paymentStatuses":
[
{
"paymentStatusId": "42eee610-1a17-4f02-be14-7e25d69d35f3",
"createdOn": "2024-03-22T09:00:00",
"statusCode": "?",
"statusDescription": "Initiated",
"statusSubCode": "?",
"statusSubDescription": "PaymentInitiated",
},
{
"paymentStatusId": "b9893367-0cab-45a8-89f9-03a14d6cd138",
"createdOn": "2024-03-22T09:00:00",
"statusCode": "791",
"statusDescription": "Pending processing",
@ -2840,15 +2887,17 @@ paths:
"statusSubDescription": "PendingProcessing",
},
{
"paymentStatusId": "9edfb9ad-f5b3-4edc-8216-7cd0070b03f3",
"createdOn": "2024-03-22T09:01:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
"statusSubDescription": "PaymentSuccessful",
},
],
"payPush":
"mandateInput":
{
"mandateInputId": "7e3c7b4e-2b4d-4e0b-8f8b-0e8d9f0a2c3b",
"consumerIssuer": "ABN AMRO",
"transactionId": "0000000000000001",
"consumerName": "J. de Vries",
@ -2857,17 +2906,20 @@ paths:
},
},
],
"customer":
"orderCustomers":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
"orderCustomerAddresses":
[
{
"addressTypeId": 1,
"orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
"addressTypeId":
{ "addressTypeId": 1, "name": "Billing" },
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
@ -2909,8 +2961,8 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Order payment update v2.0
description: Order payment update v2.0
summary: Add order customer v2.0
description: Add order customer v2.0
value:
{
"birthname": "Jan",
@ -2932,8 +2984,8 @@ paths:
],
}
v1.2:
summary: Order payment update v1.2
description: Order payment update v1.2
summary: Add order customer v1.2
description: Add order customer v1.2
value:
{
"birthname": "Jan",
@ -3022,10 +3074,12 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"tokenTypeId": 1,
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenTypeId":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -3033,29 +3087,41 @@ paths:
"verificationCode": "A7H6",
"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": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks": [],
},
],
"payments": null,
"customer":
"payments": [],
"orderCustomer":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
"orderCustomerAddresses":
[
{
"addressTypeId": 1,
"orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
"addressType":
{ "addressTypeId": 1, "name": "Billing" },
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
@ -3100,8 +3166,8 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Order customer update v2.0
description: Order customer update v2.0
summary: Update order customer v2.0
description: Update order customer v2.0
value:
{
"birthname": "Jan",
@ -3111,8 +3177,8 @@ paths:
"dateOfBirth": "1970-01-01",
}
v1.2:
summary: Order customer update v1.2
description: Order customer update v1.2
summary: Update order customer v1.2
description: Update order customer v1.2
value:
{
"birthname": "Jan",
@ -3189,10 +3255,12 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"tokenTypeId": 1,
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
"tokenTypeId":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -3200,30 +3268,41 @@ paths:
"verificationCode": "A7H6",
"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": [],
"validationResult": true,
"validationErrors": [],
"additionalRemarks": [],
},
],
"payments": null,
"customer":
"payments": [],
"orderCustomer":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
"orderCustomerAddresses":
[
{
"addressTypeId": 1,
"orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
"addressType":
{ "addressTypeId": 1, "name": "Billing" },
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
@ -3268,6 +3347,19 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Add order customer address v2.0
description: Add order customer address v2.0
value:
{
"addressTypeId": 1,
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
"postalCode": "2595 AA",
"city": "Den Haag",
"country": "NL",
}
v1.2:
summary: Order customer address create v1.2
description: Order customer address create v1.2
value:
@ -3348,10 +3440,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,
@ -3359,15 +3453,23 @@ paths:
"verificationCode": "A7H6",
"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": [],
"validationResult": false,
"validationErrors": [],
"additionalRemarks":
[
{
@ -3377,18 +3479,21 @@ paths:
],
},
],
"payments": null,
"customer":
"payments": [],
"orderCustomer":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
"orderCustomerAddresses":
[
{
"addressTypeId": 1,
"orderCustomerAddressId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
"addressType":
{ "addressTypeId": 1, "name": "Billing" },
"street": "Kon. Julianaplein",
"houseNumber": 10,
"houseNumberSuffix": "a",
@ -3428,8 +3533,8 @@ paths:
$ref: "#/components/schemas/unavailable"
examples:
v2.0:
summary: Order customer address create v1.2
description: Order customer address create v1.2
summary: Update order customer address v2.0
description: Update order customer address v2.0
value:
{
"addressTypeId": 1,
@ -3508,10 +3613,12 @@ paths:
"validUntil": null,
"orderLineStatus":
{ "orderLineStatusId": 1, "name": "pending" },
"tokens":
"customerTokens":
[
{
"tokenTypeId": 1,
"customerTokenId": "53a23772-0631-4eb8-b06a-8b4b74d120d5",
"tokenType":
{ "tokenTypeId": 1, "name": "EMV" },
"ovPayTokenId": 1,
"serviceReferenceId": "NLOV1234567ABCDEFG",
"amount": 34,
@ -3519,15 +3626,23 @@ paths:
"verificationCode": "A7H6",
"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": [],
"validationResult": false,
"validationErrors": [],
"additionalRemarks":
[
{
@ -3537,18 +3652,21 @@ paths:
],
},
],
"payments": null,
"customer":
"payments": [],
"orderCustomer":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",
"emailAddress": "jandevries@outlook.com",
"dateOfBirth": "1970-01-01",
"addresses":
"orderCusotmerAddresses":
[
{
"addressTypeId": 1,
"orderCustomerAddressId": "94270188-4cf6-447e-bd49-e8186bcec073",
"addressType":
{ "addressTypeId": 1, "name": "Billing" },
"street": "Kon. Julianaplein",
"houseNumber": 101,
"houseNumberSuffix": "a",
@ -3562,8 +3680,8 @@ paths:
delete:
tags:
- Order Creation v2
summary: Delete an existing order address
description: Delete an existing order address
summary: Delete an existing order address.
description: Delete an existing order address.
parameters:
- in: path
name: orderCustomerAddressId
@ -3624,10 +3742,11 @@ paths:
"description": "Order is aangemaakt",
},
],
"orderLines": null,
"payments": null,
"customer":
"orderLines": [],
"payments": [],
"orderCustomer":
{
"orderCustomerId": "94270188-4cf6-447e-bd49-e8186bcec073",
"birthname": "Jan",
"surname": "Vries",
"prefix": "de",