develop #38
@ -9,217 +9,291 @@ paths:
|
||||
/orders/validation:
|
||||
post:
|
||||
tags:
|
||||
- Order Validation v2
|
||||
- Order Validation v1 & v2
|
||||
summary: Validate order.
|
||||
description: Validate order.
|
||||
parameters:
|
||||
- in: header
|
||||
name: X-HTM-JWT-AUTH-HEADER
|
||||
required: true
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
- in: header
|
||||
name: Accept-version
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: "2.0"
|
||||
description: The version of the API.
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"purchaseDate": "2024-03-22",
|
||||
"customerProfileId": 1337,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"contents":
|
||||
examples:
|
||||
v1:
|
||||
summary: Order validation v1
|
||||
description: Order validation v1
|
||||
value:
|
||||
[
|
||||
{
|
||||
"productId": 1,
|
||||
"quantity": 5,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
"ovPayTokenId": 2,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"productId": 2,
|
||||
"startDate": "2024-03-22T09:00:00z",
|
||||
"quantity": 1,
|
||||
},
|
||||
{
|
||||
"productId": 2,
|
||||
"quantity": 3,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"ovPayTokenId": 3,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 89,
|
||||
"ovpasNumber": "OV34567",
|
||||
"productId": 4,
|
||||
"startDate": "2024-03-22T09:00:00z",
|
||||
"quantity": 4,
|
||||
},
|
||||
],
|
||||
"customer":
|
||||
]
|
||||
v2:
|
||||
summary: Order validation v2
|
||||
description: Order validation v2
|
||||
value:
|
||||
{
|
||||
"birthname": "Jan",
|
||||
"surname": "Vries",
|
||||
"prefix": "de",
|
||||
"emailAddress": "jandevries@outlook.com",
|
||||
"dateOfBirth": "1970-01-01",
|
||||
"addresses":
|
||||
"purchaseDate": "2024-03-22",
|
||||
"customerProfileId": 1337,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"contents":
|
||||
[
|
||||
{
|
||||
"addressTypeId": 1,
|
||||
"street": "Kon. Julianaplein",
|
||||
"houseNumber": 10,
|
||||
"houseNumberSuffix": "a",
|
||||
"postalCode": "2595 AA",
|
||||
"city": "Den Haag",
|
||||
"country": "NL",
|
||||
"productId": 1,
|
||||
"quantity": 5,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"productId": 2,
|
||||
"quantity": 3,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": 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",
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"validContents": true,
|
||||
"purchaseDate": "2024-03-22",
|
||||
"customerProfileId": 1337,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"totalAmount": 121,
|
||||
"contents":
|
||||
[
|
||||
{
|
||||
"productId": 1,
|
||||
"quantity": 5,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"isRenewable": true,
|
||||
"nextDebitDate": "2024-04-22",
|
||||
"termAmountExclTax": 100,
|
||||
"termAmountInclTax": 121,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
"additionalRemarks": [],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/contents[0]/validFrom",
|
||||
},
|
||||
{
|
||||
"detail": "Combination of product and token type is not valid.",
|
||||
"pointer": "#/contents[0]/tokens[0]/ovPayTokenId",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"productId": 2,
|
||||
"quantity": 3,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"isRenewable": true,
|
||||
"nextDebitDate": "2024-04-22",
|
||||
"termAmountExclTax": 100,
|
||||
"termAmountInclTax": 121,
|
||||
},
|
||||
],
|
||||
"customer":
|
||||
examples:
|
||||
v1:
|
||||
summary: Order validation v1
|
||||
description: Order validation v1
|
||||
value:
|
||||
{
|
||||
"birthname": "Jan",
|
||||
"surname": "Vries",
|
||||
"prefix": "de",
|
||||
"emailAddress": "jandevries@outlook.com",
|
||||
"dateOfBirth": "1970-01-01",
|
||||
"addresses":
|
||||
"validContents": true,
|
||||
"amountExclTax": 0,
|
||||
"taxPercentage": 0,
|
||||
"amountInclTax": 0,
|
||||
"contents":
|
||||
[
|
||||
{
|
||||
"addressTypeId": 1,
|
||||
"street": "Kon. Julianaplein",
|
||||
"houseNumber": 10,
|
||||
"houseNumberSuffix": "a",
|
||||
"postalCode": "2595 AA",
|
||||
"city": "Den Haag",
|
||||
"country": "NL",
|
||||
"ovPayTokenId": 0,
|
||||
"serviceReferenceId": "string",
|
||||
"ovpasNumber": "string",
|
||||
"productId": 0,
|
||||
"quantity": 0,
|
||||
"amountExclTax": 0,
|
||||
"taxPercentage": 0,
|
||||
"amountInclTax": 0,
|
||||
"startDate": "string",
|
||||
"endDate": "string",
|
||||
"isRenewable": true,
|
||||
"nextDebitDate": "string",
|
||||
"termAmountExclTax": 0,
|
||||
"termAmountInclTax": 0,
|
||||
"additionalRemarks":
|
||||
[{ "code": "string", "parameter": "string" }],
|
||||
"validationErrors":
|
||||
[{ "detail": "string", "pointer": "string" }],
|
||||
},
|
||||
],
|
||||
"additionalRemarks":
|
||||
}
|
||||
v2:
|
||||
summary: Order validation v2
|
||||
description: Order validation v2
|
||||
value:
|
||||
{
|
||||
"validContents": true,
|
||||
"purchaseDate": "2024-03-22",
|
||||
"customerProfileId": 1337,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"totalAmount": 121,
|
||||
"contents":
|
||||
[
|
||||
{
|
||||
"code": "PERSONAL_DATA_NEEDED",
|
||||
"parameter": "dateOfBirth",
|
||||
"productId": 1,
|
||||
"quantity": 5,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"isRenewable": true,
|
||||
"nextDebitDate": "2024-04-22",
|
||||
"termAmountExclTax": 100,
|
||||
"termAmountInclTax": 121,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
"additionalRemarks": [],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/contents[0]/validFrom",
|
||||
},
|
||||
{
|
||||
"detail": "Combination of product and token type is not valid.",
|
||||
"pointer": "#/contents[0]/tokens[0]/ovPayTokenId",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"code": "PERSONAL_DATA_NEEDED",
|
||||
"parameter": "photo",
|
||||
},
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"parameter": "directDebitMandateId",
|
||||
"productId": 2,
|
||||
"quantity": 3,
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"isRenewable": true,
|
||||
"nextDebitDate": "2024-04-22",
|
||||
"termAmountExclTax": 100,
|
||||
"termAmountInclTax": 121,
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/contents[1]/validFrom",
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
"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",
|
||||
},
|
||||
],
|
||||
"additionalRemarks":
|
||||
[
|
||||
{
|
||||
"code": "PERSONAL_DATA_NEEDED",
|
||||
"parameter": "dateOfBirth",
|
||||
},
|
||||
{
|
||||
"code": "PERSONAL_DATA_NEEDED",
|
||||
"parameter": "photo",
|
||||
},
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"parameter": "directDebitMandateId",
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/contents[1]/validFrom",
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
/orders/{orderId}/fulfillment:
|
||||
post:
|
||||
tags:
|
||||
- Order Fulfillment v2
|
||||
- Order Fulfillment v1 & v2
|
||||
summary: Fulfill an order.
|
||||
description: Fulfill an order.
|
||||
parameters:
|
||||
- in: header
|
||||
name: X-HTM-JWT-AUTH-HEADER
|
||||
required: true
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
@ -233,116 +307,168 @@ paths:
|
||||
type: string
|
||||
format: uuid
|
||||
example: a0ef57fa-395c-4a03-96e9-234c26dccea9
|
||||
- in: header
|
||||
name: Accept-version
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: "2.0"
|
||||
description: The version of the API.
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
|
||||
"customerProfileId": 1337,
|
||||
"totalAmount": 121,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"orderStatusId": 4,
|
||||
"orderLines":
|
||||
[
|
||||
{
|
||||
"orderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f",
|
||||
"productId": 1,
|
||||
"productName": "HTM Maandkorting 20%",
|
||||
"productCode": "HTM-MND-20",
|
||||
"productDescription": "HTM Maandkorting 20%",
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"quantity": 1,
|
||||
"terms":
|
||||
[
|
||||
"generalTermsAndConditions.pdf",
|
||||
"productTermsAndConditions.pdf",
|
||||
],
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"orderLineStatusId": 4,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"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":
|
||||
examples:
|
||||
v1:
|
||||
summary: Order fulfillment v1
|
||||
description: Order fulfillment v1
|
||||
value:
|
||||
{
|
||||
"birthname": "Jan",
|
||||
"surname": "Vries",
|
||||
"prefix": "de",
|
||||
"emailAddress": "jandevries@outlook.com",
|
||||
"dateOfBirth": "1970-01-01",
|
||||
"addresses":
|
||||
"customerProfileID": 123415,
|
||||
"customerProfileData": { "dateOfBirth": "09-03-1989" },
|
||||
"personalAccountData": { "birthdate": "09-03-1989" },
|
||||
"directDebitMandate":
|
||||
{
|
||||
"consumerName": "J. de Tèster",
|
||||
"consumerBic": "RABONL2U",
|
||||
"consumerIban": "NL44RABO0123456789",
|
||||
},
|
||||
"orderContents":
|
||||
[
|
||||
{
|
||||
"addressTypeId": 1,
|
||||
"street": "Kon. Julianaplein",
|
||||
"houseNumber": 10,
|
||||
"houseNumberSuffix": "a",
|
||||
"postalCode": "2595 AA",
|
||||
"city": "Den Haag",
|
||||
"country": "NL",
|
||||
"ovPayTokenId": 123,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 450,
|
||||
"ovpasNumber": "63AW974",
|
||||
"productId": 2,
|
||||
"startDate": "2024-03-22T09:00:00Z",
|
||||
"quantity": 1,
|
||||
"orderlineId": "2d7fadc9-b64b-4516-9a7d-cf550f201372",
|
||||
},
|
||||
{
|
||||
"ovPayTokenId": 123,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 450,
|
||||
"ovpasNumber": "63AW974",
|
||||
"productId": 3,
|
||||
"startDate": "2024-03-16T09:00:00Z",
|
||||
"quantity": 1,
|
||||
"orderlineId": "9d7fadc9-b64b-4516-9a7d-cf550f201378",
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
"orderStatus": "succeededPayment",
|
||||
}
|
||||
v2:
|
||||
summary: Order fulfillment v2
|
||||
description: Order fulfillment v2
|
||||
value:
|
||||
{
|
||||
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
|
||||
"customerProfileId": 1337,
|
||||
"totalAmount": 121,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"orderStatusId": 4,
|
||||
"orderLines":
|
||||
[
|
||||
{
|
||||
"orderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f",
|
||||
"productId": 1,
|
||||
"productName": "HTM Maandkorting 20%",
|
||||
"productCode": "HTM-MND-20",
|
||||
"productDescription": "HTM Maandkorting 20%",
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"quantity": 1,
|
||||
"terms":
|
||||
[
|
||||
"generalTermsAndConditions.pdf",
|
||||
"productTermsAndConditions.pdf",
|
||||
],
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"orderLineStatusId": 4,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"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",
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@ -350,112 +476,120 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
|
||||
"orderNumber": "123456",
|
||||
"customerProfileId": 1337,
|
||||
"totalAmount": 121,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"orderStatusId": 4,
|
||||
"orderLines":
|
||||
[
|
||||
{
|
||||
"orderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f",
|
||||
"productId": 1,
|
||||
"productName": "HTM Maandkorting 20%",
|
||||
"productCode": "HTM-MND-20",
|
||||
"productDescription": "HTM Maandkorting 20%",
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"quantity": 1,
|
||||
"terms":
|
||||
[
|
||||
"generalTermsAndConditions.pdf",
|
||||
"productTermsAndConditions.pdf",
|
||||
],
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"orderLineStatusId": 4,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"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":
|
||||
examples:
|
||||
v1:
|
||||
summary: Order fulfillment v1
|
||||
description: Order fulfillment v1
|
||||
value: {}
|
||||
v2:
|
||||
summary: Order fulfillment v2
|
||||
description: Order fulfillment v2
|
||||
value:
|
||||
{
|
||||
"birthname": "Jan",
|
||||
"surname": "Vries",
|
||||
"prefix": "de",
|
||||
"emailAddress": "jandevries@outlook.com",
|
||||
"dateOfBirth": "1970-01-01",
|
||||
"addresses":
|
||||
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
|
||||
"orderNumber": "123456",
|
||||
"customerProfileId": 1337,
|
||||
"totalAmount": 121,
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"orderStatusId": 4,
|
||||
"orderLines":
|
||||
[
|
||||
{
|
||||
"addressTypeId": 1,
|
||||
"street": "Kon. Julianaplein",
|
||||
"houseNumber": 10,
|
||||
"houseNumberSuffix": "a",
|
||||
"postalCode": "2595 AA",
|
||||
"city": "Den Haag",
|
||||
"country": "NL",
|
||||
"orderLineId": "2ba39cae-c401-446b-ae5c-2d6d85b3df1f",
|
||||
"productId": 1,
|
||||
"productName": "HTM Maandkorting 20%",
|
||||
"productCode": "HTM-MND-20",
|
||||
"productDescription": "HTM Maandkorting 20%",
|
||||
"taxAmount": 21,
|
||||
"taxCode": "V21",
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"quantity": 1,
|
||||
"terms":
|
||||
[
|
||||
"generalTermsAndConditions.pdf",
|
||||
"productTermsAndConditions.pdf",
|
||||
],
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": null,
|
||||
"orderLineStatusId": 4,
|
||||
"tokens":
|
||||
[
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeTypeId": 1,
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
"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",
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
/customers/{customerProfileId}/orders:
|
||||
parameters:
|
||||
- in: path
|
||||
@ -900,7 +1034,7 @@ paths:
|
||||
example:
|
||||
{
|
||||
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
|
||||
"orderNumber": "ORD-123456"
|
||||
"orderNumber": "ORD-123456",
|
||||
}
|
||||
delete:
|
||||
tags:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user