OVPAY-1742 - Added examples for unhappy flow.

src/openapi/customers/SE-customers.yaml

@@ -345,6 +345,11 @@ paths:
                                     "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/tokenPersonalizations?ovpaytokenId=1",
                                     "method": "POST",
                                   },
+                                "compare_token":
+                                  {
+                                    "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens/1/compare",
+                                    "method": "POST",
+                                  },
                               },
                           },
                         ],
@@ -1035,6 +1040,11 @@ paths:
                                   "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/pad?ovpaytokenid=1",
                                   "method": "POST",
                                 },
+                              "compare_token":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens/1/compare",
+                                  "method": "POST",
+                                },
                             },
                         },
                       "_links":
@@ -1258,6 +1268,11 @@ paths:
                                   "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/pad?ovpaytokenId=5",
                                   "method": "POST",
                                 },
+                              "compare_token":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens/1/compare",
+                                  "method": "POST",
+                                },
                             },
                         },
                     }
@@ -1394,6 +1409,11 @@ paths:
                                   "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/pad?ovpaytokenid=10",
                                   "method": "POST",
                                 },
+                              "compare_token":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens/1/compare",
+                                  "method": "POST",
+                                },
                             },
                         },
                     }
@@ -1517,6 +1537,11 @@ paths:
                                   "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/pad?ovpaytokenId=5",
                                   "method": "POST",
                                 },
+                              "compare_token":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens/1/compare",
+                                  "method": "POST",
+                                },
                             },
                         },
                     }
@@ -1578,6 +1603,11 @@ paths:
                                   "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/pad?ovpaytokenId=5",
                                   "method": "POST",
                                 },
+                              "compare_token":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens/1/compare",
+                                  "method": "POST",
+                                },
                             },
                         },
                     }
@@ -1639,6 +1669,11 @@ paths:
                                   "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/pad?ovpaytokenId=5",
                                   "method": "POST",
                                 },
+                              "compare_token":
+                                {
+                                  "href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens/1/compare",
+                                  "method": "POST",
+                                },
                             },
                         },
                     }
@@ -1927,6 +1962,77 @@ paths:
                         },
                       "_links": {},
                     }
+        "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",
+                          },
+                        ],
+                    }
   /customers/tokens/{ovPayTokenId}/transfer:
     parameters:
       - name: ovPayTokenId