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

OVPAY-1742 - Added examples for unhappy transfer flow.

Browse Source
This commit is contained in:
Bas Boterman 2025-05-02 14:57:11 +02:00
parent 079c16763e
commit 946ba3f898
1 changed files with 159 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
src/openapi/customers/SE-customers.yaml
View File

@ -2044,8 +2044,9 @@ paths:
type: integer
example: 1
post:
summary: Transfer old OVpay token to new OVpay token.
summary: "**INTEGRATIELAAG** Transfer old OVpay token to new OVpay token."
description: |-
**Note that this is an integratielaag endpoint, not a service eninge endpoint!**
Transfers all products, e-purse and personal account data of an existing OVpay token
to a new OVpay token. The new token will also be persisted in the profile as a replacement
of the old token.
@ -2172,6 +2173,163 @@ paths:
},
},
}
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Old token not found in profile:
value:
{
"type": "https://htm.nl/api/v1/probs/notfound",
"title": "The item you requested was not found.",
"detail": "The old token was not found in the customer profile.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "The old token was not found in the customer profile.",
"pointer": "#/0/ovPayTokenId",
"ovPayTokenId": 123,
},
],
}
New token not found in profile:
value:
{
"type": "https://htm.nl/api/v1/probs/notfound",
"title": "The item you requested was not found.",
"detail": "The new token was not found in the customer profile.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "The new token was not found in the customer profile.",
"pointer": "#/0/ovPayTokenId",
"ovPayTokenId": 123,
},
],
}
XTAT for new token not found in GBO:
value:
{
"type": "https://htm.nl/api/v1/probs/notfound",
"title": "The item you requested was not found.",
"detail": "The new token was not found in GBO:.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "XTAT for the new token was not found in GBO.",
"pointer": "#/0/xtat",
"xtat": "e35977b2-52bb-48ef-aca8-297b2c1d5058",
},
],
}
SRID for new token not found in GBO:
value:
{
"type": "https://htm.nl/api/v1/probs/notfound",
"title": "The item you requested was not found.",
"detail": "The new token was not found in GBO:.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "Service Reference ID for the new token was not found in GBO.",
"pointer": "#/0/serviceReferenceId",
"serviceReferenceId": "NLOV1234567ABCDEFG",
},
],
}
"405":
description: Not allowed
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Old token is wrong token type:
value:
{
"type": "https://htm.nl/api/v1/probs/notallowed",
"title": "The transfer you requested was not allowed.",
"detail": "The old token has wrong token type.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "The old token has token type OV-pas physical.",
"pointer": "#/0/ovPayToken/tokenTypeId",
"tokenTypeId": 2,
},
],
}
Old token has wrong token status:
value:
{
"type": "https://htm.nl/api/v1/probs/notallowed",
"title": "The transfer you requested was not allowed.",
"detail": "The old token has wrong token status.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "The old token has token status replaced.",
"pointer": "#/0/ovPayToken/tokenStatusId",
"tokenStatusId": 4,
},
],
}
New token is expired:
value:
{
"type": "https://htm.nl/api/v1/probs/notallowed",
"title": "The transfer you requested was not allowed.",
"detail": "The new token is expired.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "The new token is expired.",
"pointer": "#/0/ovPayToken/expirationDate",
"experiationDate": 2022-01-01,
},
],
}
One or more GBO product instances not transferable:
value:
{
"type": "https://htm.nl/api/v1/probs/notallowed",
"title": "The transfer you requested was not allowed.",
"detail": "One or more GBO product instances are not transferable.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "One or more GBO product instances are not transferable",
"pointer": "#/0/ovPayToken/packageTemplateId",
"packageTemplateId": "33613",
},
],
}
One or more PAD attributes marked:
value:
{
"type": "https://htm.nl/api/v1/probs/notallowed",
"title": "The transfer you requested was not allowed.",
"detail": "One or more PAD attributes are not transferable.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors":
[
{
"detail": "PAD attribute birthdate is marked on the old token",
"pointer": "#/0/ovPayToken/padAttributes/birthdate",
},
],
}
components:
schemas:
unavailable: