2 Commits
Author SHA1 Message Date
bboterm cb6f1f6f48 OVPAY-1116 - Added missing fields. 2024-11-18 14:05:08 +01:00
bboterm 85c9872e19 Merge pull request 'develop' (#5) from develop into main
Reviewed-on: #5
2024-11-07 12:43:22 +00:00
9 changed files with 662 additions and 7376 deletions

No files matched your search

+15 -6
View File
@@ -27,7 +27,7 @@ paths:
type: integer type: integer
example: 1 example: 1
required: false required: false
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated, 6 = pending cancellation, 7 = pending termination. description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated.
responses: responses:
"200": "200":
description: OK description: OK
@@ -53,6 +53,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
{ {
@@ -69,6 +70,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
], ],
@@ -96,6 +98,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 0, "highestInvoiceTerm": 0,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractVersions": "contractVersions":
[ [
{ {
@@ -149,7 +152,7 @@ paths:
type: integer type: integer
explode: false explode: false
required: false required: false
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated, 6 = pending cancellation, 7 = pending termination. description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated.
- in: query - in: query
name: billingDay name: billingDay
schema: schema:
@@ -203,6 +206,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractInvoices": "contractInvoices":
[ [
{ {
@@ -261,6 +265,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractInvoices": "contractInvoices":
[ [
{ {
@@ -346,6 +351,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractVersions": "contractVersions":
[ [
{ {
@@ -423,6 +429,7 @@ paths:
"productName": "HTM 20% korting 2024", "productName": "HTM 20% korting 2024",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 2, "highestInvoiceTerm": 2,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
}, },
} }
responses: responses:
@@ -871,8 +878,6 @@ paths:
{ "contractStatusId": 3, "name": "suspended" }, { "contractStatusId": 3, "name": "suspended" },
{ "contractStatusId": 4, "name": "cancelled" }, { "contractStatusId": 4, "name": "cancelled" },
{ "contractStatusId": 5, "name": "terminated" }, { "contractStatusId": 5, "name": "terminated" },
{ "contractStatusId": 6, "name": "pending cancellation" },
{ "contractStatusId": 7, "name": "pending termination" },
], ],
} }
/actiontypes: /actiontypes:
@@ -887,7 +892,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ActionType" $ref: "#/components/schemas/ContractStatus"
example: example:
{ {
"actionTypes": "actionTypes":
@@ -952,6 +957,10 @@ components:
highestInvoiceTerm: highestInvoiceTerm:
type: integer type: integer
example: 1 example: 1
xSpit:
type: string
format: uuid
example: 1c345237-4d84-47f0-93c2-7b94338e3355
contractVersions: contractVersions:
type: array type: array
items: items:
@@ -1068,7 +1077,7 @@ components:
example: 2 example: 2
name: name:
type: string type: string
enum: [new, active, suspended, cancelled, terminated, pending cancellation, pending termination] enum: [new, active, suspended, cancelled, terminated]
example: active example: active
ActionType: ActionType:
type: object type: object
+3
View File
@@ -43,6 +43,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
{ {
@@ -58,6 +59,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"created": "2024-08-01 15:01:00.000", "created": "2024-08-01 15:01:00.000",
}, },
] ]
@@ -126,6 +128,7 @@ paths:
"termDuration": "P0Y1M0D", "termDuration": "P0Y1M0D",
"billingDay": 15, "billingDay": 15,
"highestInvoiceTerm": 1, "highestInvoiceTerm": 1,
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
"contractVersions": "contractVersions":
[ [
{ {
@@ -1,285 +0,0 @@
openapi: "3.0.3"
info:
title: ABT Customers CRUD APIs v2
version: "1.0"
description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine.
servers:
- url: https://api.integratielaag.nl/v1
paths:
/ovpaytokens:
get:
tags:
- Token
summary: Find OVpay tokens.
description: Find OVpay tokens.
parameters:
- in: query
name: ovPayTokenId
schema:
type: integer
example: 71
required: false
description: The id of the token.
- in: query
name: customerProfileId
schema:
type: integer
example: 12
required: false
description: The id of the customer profile.
- in: query
name: tokenTypeId
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
required: false
description: Filter on possible token types. 1 = EMV, 2 = OV-pas physical, 3 = OV-pas digital.
- in: query
name: xTat
schema:
type: string
format: uuid
example: 700b0516-bf8b-4e6e-bf16-13bfeb078e23
explode: false
required: false
description: The XTAT of the token.
- in: query
name: xBot
schema:
type: string
format: uuid
example: de1a9a7a-a777-4473-889c-44a3bb07daae
explode: false
required: false
description: The XBOT of the token.
- in: query
name: alias
schema:
type: string
example: Mijn OV-pas
required: false
description: The alias of the token.
- in: query
name: lastDigits
schema:
type: integer
example: 3301
required: false
description: The last digits of the token.
- in: query
name: ovpasNumber
schema:
type: string
example: 63AW974
required: false
description: Number of the OVpas.
- in: query
name: tokenStatusId
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
required: false
description: Filter on possible token statuses. 1 = expired, 2 = active, 3 = replaced, 4 = inactive, 5 = suspended, 6 = removed by customer.
- in: query
name: expirationDate
schema:
type: string
format: date-time
example: 2029-03-22T09:00:00
required: false
description: The expiration date of the token.
- in: query
name: replacedByTokenId
schema:
type: integer
example: 12
required: false
description: The id of the token that replaced this token.
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"ovPayTokens":
[
{
"ovPayTokenId": 71,
"customerProfileId": 12,
"tokenType":
{ "tokenTypeId": 2, "name": "OV-pas physical" },
"xTat": "700b0516-bf8b-4e6e-bf16-13bfeb078e23",
"xBot": "de1a9a7a-a777-4473-889c-44a3bb07daae",
"alias": "Mijn OV-pas",
"lastDigits": 3301,
"ovpasNumber": "63AW974",
"tokenStatus": { "tokenStatusId": 2, "name": "Active" },
"expirationDate": "2029-03-22T09:00:00",
"replacedByTokenId": 12,
},
],
"href": null,
}
/directdebitmandates:
get:
tags:
- Mandates
summary: Find direct debit mandates.
description: Find direct debit mandates.
parameters:
- in: query
name: directDebitMandateId
schema:
type: integer
example: 71
required: false
description: The id of the direct debit mandate.
- in: query
name: customerProfileId
schema:
type: integer
example: 12
required: false
description: The id of the customer related to the mandate.
- in: query
name: billingInformationId
schema:
type: integer
example: 51
required: false
description: The id of the billing information related to the mandate.
- in: query
name: directDebitMandateTypeId
schema:
type: array
items:
type: integer
example: [1, 2]
explode: false
required: false
description: The id of the direct debit mandate type. 1 = Paper contract, 2 = PIN transaction, 3 = SEPA eMandate, 4 = Digital signature, 5 = iDEAL transaction.
- in: query
name: mandateAddressId
schema:
type: integer
example: 21
required: false
description: The id of the address related to the mandate.
- in: query
name: createdBefore
schema:
type: string
format: date-time
example: 2020-12-31T23:59:59
required: false
description: Filter on created before.
- in: query
name: createdAfter
schema:
type: string
format: date-time
example: 2020-01-01T00:00:00
required: false
description: Filter on created after.
- in: query
name: mandateReference
schema:
type: string
example: CORE01
required: false
description: Filter on mandate reference.
- in: query
name: mandateState
schema:
type: array
items:
type: string
example: [SIGNED, PREPARED]
explode: false
required: false
description: Filter on possible states of the mandate. SIGNED = signed, PREPARED = prepared, CANCELLED = cancelled.
- in: query
name: updatedBefore
schema:
type: string
format: date-time
example: 2020-12-31T23:59:59
required: false
description: Filter on updated before.
- in: query
name: updatedAfter
schema:
type: string
format: date-time
example: 2020-01-01T00:00:00
required: false
description: Filter on updated after.
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
[
{
"directDebitMandateId": 71,
"customerProfileId": 12,
"billingInformationId": 51,
"directDebitMandateType": {
"directDebitMandateTypeId": 1,
"name": "import",
"description": "import"
},
"mandateAddressId": 21,
"created": "2024-03-22T08:55:00",
"mandateReference": "CORE01",
"mandateState": "SINGED",
"updateTimestamp": "2024-03-22T08:55:00"
},
]
components:
securitySchemes:
bearerToken:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
unavailable:
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
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
@@ -59,12 +59,6 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": null, "sellableTouchPointIds": null,
"amountInclTax": null, "amountInclTax": null,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
@@ -89,7 +83,6 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
1, 1,
2, 2,
@@ -119,7 +112,6 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@@ -147,12 +139,6 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": null, "sellableTouchPointIds": null,
"amountInclTax": null, "amountInclTax": null,
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg", "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
@@ -168,7 +154,6 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
1, 1,
2, 2,
@@ -189,12 +174,6 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": [ "sellableTouchPointIds": [
1, 1,
2 2
@@ -213,12 +192,6 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@@ -246,7 +219,6 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Barcode" "name": "Barcode"
}, },
"tokenTypes": null,
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@@ -265,12 +237,6 @@ paths:
"isTravelProduct": true, "isTravelProduct": true,
"name": "Kortingsabonnement" "name": "Kortingsabonnement"
}, },
"tokenTypes": [
{
"tokenTypeId": 1,
"name": "EMV"
}
],
"sellableTouchPointIds": [ "sellableTouchPointIds": [
3, 3,
4 4
@@ -2108,20 +2074,6 @@ components:
name: name:
type: string type: string
example: Kortingsabonnement example: Kortingsabonnement
tokenTypes:
type: array
items:
type: object
required:
- tokenTypeId
- name
properties:
tokenTypeId:
type: integer
example: 1
name:
type: string
example: EMV
sellableTouchPointIds: sellableTouchPointIds:
type: array type: array
items: items:
@@ -21,7 +21,7 @@ paths:
required: false required: false
description: The technical id of the product. description: The technical id of the product.
- in: query - in: query
name: createdBefore name: createdOnBefore
schema: schema:
type: string type: string
format: date-time format: date-time
@@ -29,7 +29,7 @@ paths:
required: false required: false
description: The purchased product should be created before this timestamp. description: The purchased product should be created before this timestamp.
- in: query - in: query
name: createdAfter name: createdOnAfter
schema: schema:
type: string type: string
format: date-time format: date-time
@@ -37,7 +37,7 @@ paths:
required: false required: false
description: The purchased product should be created after this timestamp. description: The purchased product should be created after this timestamp.
- in: query - in: query
name: lastUpdatedBefore name: lastUpdatedOnBefore
schema: schema:
type: string type: string
format: date-time format: date-time
@@ -45,7 +45,7 @@ paths:
required: false required: false
description: The purchased product should be last updated before this timestamp. description: The purchased product should be last updated before this timestamp.
- in: query - in: query
name: lastUpdatedAfter name: lastUpdatedOnAfter
schema: schema:
type: string type: string
format: date-time format: date-time
@@ -101,12 +101,18 @@ paths:
"purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd", "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
"salesTimestamp": "2024-10-04T12:34:56.000", "salesTimestamp": "2024-10-04T12:34:56.000",
"refundTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000",
"fromInclusive": "2024-10-04T12:34:56.000",
"unitilInclusive": "2024-10-04T12:34:56.000",
"packageTemplateId": "30003", "packageTemplateId": "30003",
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
"ovPayTokenId": 13, "ovPayTokenId": 13,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "someuser",
"lastUpdatedBy": null,
}, },
], ],
}, },
@@ -144,12 +150,18 @@ paths:
{ {
"salesTimestamp": "2024-10-04T12:34:56.000", "salesTimestamp": "2024-10-04T12:34:56.000",
"refundTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000",
"fromInclusive": "2024-10-04T12:34:56.000",
"unitilInclusive": "2024-10-04T12:34:56.000",
"packageTemplateId": "30003", "packageTemplateId": "30003",
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
"ovPayTokenId": 13, "ovPayTokenId": 13,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "someuser",
"lastUpdatedBy": null,
}, },
], ],
} }
@@ -208,12 +220,18 @@ paths:
{ {
"salesTimestamp": "2024-10-04T12:34:56.000", "salesTimestamp": "2024-10-04T12:34:56.000",
"refundTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000",
"fromInclusive": "2024-10-04T12:34:56.000",
"unitilInclusive": "2024-10-04T12:34:56.000",
"packageTemplateId": "30003", "packageTemplateId": "30003",
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
"ovPayTokenId": 13, "ovPayTokenId": 13,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "someuser",
"lastUpdatedBy": null,
}, },
], ],
} }
@@ -300,12 +318,18 @@ paths:
{ {
"salesTimestamp": "2024-10-04T12:34:56.000", "salesTimestamp": "2024-10-04T12:34:56.000",
"refundTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000",
"fromInclusive": "2024-10-04T12:34:56.000",
"unitilInclusive": "2024-10-04T12:34:56.000",
"packageTemplateId": "30003", "packageTemplateId": "30003",
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
"ovPayTokenId": 13, "ovPayTokenId": 13,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "someuser",
"lastUpdatedBy": null,
} }
responses: responses:
"201": "201":
@@ -367,6 +391,34 @@ paths:
format: date-time format: date-time
example: 2024-10-04T12:34:56.000 example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be refunded after this timestamp. description: The purchased GBO product should be refunded after this timestamp.
- in: query
name: fromInclusiveBefore
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be valid before this timestamp.
- in: query
name: fromInclusiveAfter
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be valid after this timestamp.
- in: query
name: unitilInclusiveBefore
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be valid before this timestamp.
- in: query
name: unitilInclusiveAfter
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be valid after this timestamp.
- in: query - in: query
name: packageTemplateId name: packageTemplateId
schema: schema:
@@ -408,6 +460,46 @@ paths:
type: integer type: integer
example: 13 example: 13
description: The id of the ov pay token. description: The id of the ov pay token.
- in: query
name: createdOnBefore
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be created before this timestamp.
- in: query
name: createdOnAfter
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be created after this timestamp.
- in: query
name: lastUpdatedOnBefore
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be updated before this timestamp.
- in: query
name: lastUpdatedOnAfter
schema:
type: string
format: date-time
example: 2024-10-04T12:34:56.000
description: The purchased GBO product should be updated after this timestamp.
- in: query
name: createdBy
schema:
type: string
example: someuser
description: The user that created the purchased GBO product.
- in: query
name: lastUpdatedBy
schema:
type: string
example: someuser
description: The user that last updated the purchased GBO product.
responses: responses:
"201": "201":
description: Created description: Created
@@ -422,24 +514,36 @@ paths:
"purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3", "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
"salesTimestamp": "2024-10-04T12:34:56.000", "salesTimestamp": "2024-10-04T12:34:56.000",
"refundTimestamp": "2024-10-05T12:34:56.000", "refundTimestamp": "2024-10-05T12:34:56.000",
"fromInclusive": "2024-10-04T12:34:56.000",
"unitilInclusive": "2024-10-05T12:34:56.000",
"packageTemplateId": "30003", "packageTemplateId": "30003",
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
"ovPayTokenId": 13, "ovPayTokenId": 13,
"createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedOn": "2024-10-04T12:34:56.000",
"createdBy": "someuser",
"lastUpdatedBy": null,
}, },
{ {
"purchasedGboProductId": 431e481f-4330-4ad4-be47-393db38cfe38, "purchasedGboProductId": 431e481f-4330-4ad4-be47-393db38cfe38,
"purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3", "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
"salesTimestamp": "2024-10-05T12:34:56.000", "salesTimestamp": "2024-10-05T12:34:56.000",
"refundTimestamp": "2024-10-06T12:34:56.000", "refundTimestamp": "2024-10-06T12:34:56.000",
"fromInclusive": "2024-10-05T12:34:56.000",
"unitilInclusive": "2024-10-06T12:34:56.000",
"packageTemplateId": "30003", "packageTemplateId": "30003",
"xBot": "f8f13d64-fd07-44e8-9c85-968857da5d68", "xBot": "f8f13d64-fd07-44e8-9c85-968857da5d68",
"xTat": "01a82ebe-5d07-45d8-a897-66152e8954dd", "xTat": "01a82ebe-5d07-45d8-a897-66152e8954dd",
"xSpit": "c3868858-b250-4480-9cb4-725d2e9198f3", "xSpit": "c3868858-b250-4480-9cb4-725d2e9198f3",
"customerTokenId": "6c7a6d4b-7e6c-4f6a-9b1e-0a9b1e6c7a6d", "customerTokenId": "6c7a6d4b-7e6c-4f6a-9b1e-0a9b1e6c7a6d",
"ovPayTokenId": 14, "ovPayTokenId": 14,
"createdOn": "2024-10-05T12:34:56.000",
"lastUpdatedOn": "2024-10-05T12:34:56.000",
"createdBy": "someuser",
"lastUpdatedBy": null,
}, },
] ]
/purchasedgboproducts/{purchasedGboProductId}: /purchasedgboproducts/{purchasedGboProductId}:
@@ -463,7 +567,12 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: { "refundTimestamp": "2024-10-05T12:34:56.000" } example:
{
"refundTimestamp": "2024-10-05T12:34:56.000",
"lastUpdatedOn": "2024-10-05T12:34:56.000",
"lastUpdatedBy": "someuser",
}
responses: responses:
"201": "201":
description: Created description: Created
@@ -472,7 +581,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd" } {
"purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
}
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken:
-26
View File
@@ -86,20 +86,6 @@ paths:
example: 65ad5520-4e62-41b7-89dd-a01be6cb78bf example: 65ad5520-4e62-41b7-89dd-a01be6cb78bf
required: false required: false
description: Pointer to executor of this action (e.g. the batch job). description: Pointer to executor of this action (e.g. the batch job).
- in: query
name: role
schema:
type: string
example: customer
required: false
description: Role of the user or process that initiated the action.
- in: query
name: user
schema:
type: string
example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
required: false
description: User that initiated the action. In case of a customer this is the customer id.
- in: query - in: query
name: resourceName name: resourceName
schema: schema:
@@ -137,8 +123,6 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399", "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
"role": "customer",
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
"scheduledActionResources": "scheduledActionResources":
[ [
{ {
@@ -173,8 +157,6 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399", "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
"role": "customer",
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
"scheduledActionResources": "scheduledActionResources":
[ [
{ {
@@ -235,8 +217,6 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399", "correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
"role": "customer",
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
"scheduledActionResources": "scheduledActionResources":
[ [
{ {
@@ -410,12 +390,6 @@ components:
type: string type: string
format: uuid format: uuid
example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f
role:
type: string
example: customer
user:
type: string
example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
ScheduledActionType: ScheduledActionType:
type: object type: object
properties: properties: