@ogcio/building-blocks-sdk 0.2.70 → 0.2.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/.gitleaksignore +10 -1
  2. package/.release-please-manifest.json +1 -1
  3. package/CHANGELOG.md +14 -0
  4. package/dist/client/clients/audit/index.d.ts +132 -0
  5. package/dist/client/clients/audit/index.d.ts.map +1 -0
  6. package/dist/client/clients/audit/index.js +14 -0
  7. package/dist/client/clients/audit/index.js.map +1 -0
  8. package/dist/client/clients/audit/schema.d.ts +246 -0
  9. package/dist/client/clients/audit/schema.d.ts.map +1 -0
  10. package/dist/client/clients/audit/schema.js +2 -0
  11. package/dist/client/clients/audit/schema.js.map +1 -0
  12. package/dist/client/clients/payments/index.d.ts +138 -2
  13. package/dist/client/clients/payments/index.d.ts.map +1 -1
  14. package/dist/client/clients/payments/index.js +9 -0
  15. package/dist/client/clients/payments/index.js.map +1 -1
  16. package/dist/client/clients/payments/schema.d.ts +206 -4
  17. package/dist/client/clients/payments/schema.d.ts.map +1 -1
  18. package/dist/clients-configurations/clients-configuration.json +10 -2
  19. package/dist/types/index.d.ts +9 -3
  20. package/dist/types/index.d.ts.map +1 -1
  21. package/dist/types/index.js +2 -1
  22. package/dist/types/index.js.map +1 -1
  23. package/package.json +1 -1
  24. package/src/client/clients/audit/index.ts +25 -0
  25. package/src/client/clients/audit/open-api-definition.json +433 -0
  26. package/src/client/clients/audit/schema.ts +245 -0
  27. package/src/client/clients/payments/index.ts +15 -0
  28. package/src/client/clients/payments/open-api-definition.json +966 -38
  29. package/src/client/clients/payments/schema.ts +206 -4
  30. package/src/clients-configurations/clients-configuration.json +10 -2
  31. package/src/types/index.ts +10 -2
@@ -228,6 +228,18 @@
228
228
  "accountHolderName": "Government Services"
229
229
  }
230
230
  }
231
+ },
232
+ "example5": {
233
+ "value": {
234
+ "name": "Worldpay Production",
235
+ "type": "worldpay",
236
+ "data": {
237
+ "merchantCode": "merchant_1234567890",
238
+ "installationId": "installation_1234567890",
239
+ "username": "worldpay_api_username",
240
+ "password": "worldpay_xml_secret"
241
+ }
242
+ }
231
243
  }
232
244
  }
233
245
  }
@@ -991,11 +1003,19 @@
991
1003
  },
992
1004
  "installationId": {
993
1005
  "type": "string"
1006
+ },
1007
+ "username": {
1008
+ "type": "string"
1009
+ },
1010
+ "password": {
1011
+ "type": "string"
994
1012
  }
995
1013
  },
996
1014
  "required": [
997
1015
  "merchantCode",
998
- "installationId"
1016
+ "installationId",
1017
+ "username",
1018
+ "password"
999
1019
  ]
1000
1020
  },
1001
1021
  {
@@ -7275,14 +7295,35 @@
7275
7295
  }
7276
7296
  }
7277
7297
  },
7278
- "/api/v1/transactions/schema": {
7279
- "get": {
7280
- "operationId": "getTransactionSchema",
7281
- "summary": "Get Transaction Schema",
7298
+ "/api/v1/transactions/search": {
7299
+ "post": {
7300
+ "operationId": "searchTransactions",
7301
+ "summary": "Search Transactions",
7282
7302
  "tags": [
7283
7303
  "Transactions"
7284
7304
  ],
7285
- "description": "Retrieve the JSON schema for transaction data structure.",
7305
+ "description": "Retrieve a list of transactions based on a given list of transaction ids.",
7306
+ "requestBody": {
7307
+ "content": {
7308
+ "application/json": {
7309
+ "schema": {
7310
+ "type": "object",
7311
+ "properties": {
7312
+ "transactionIds": {
7313
+ "type": "array",
7314
+ "items": {
7315
+ "type": "string"
7316
+ }
7317
+ }
7318
+ },
7319
+ "required": [
7320
+ "transactionIds"
7321
+ ]
7322
+ }
7323
+ }
7324
+ },
7325
+ "required": true
7326
+ },
7286
7327
  "responses": {
7287
7328
  "200": {
7288
7329
  "description": "Default Response",
@@ -7291,21 +7332,88 @@
7291
7332
  "schema": {
7292
7333
  "type": "object",
7293
7334
  "properties": {
7294
- "examples": {
7335
+ "data": {
7295
7336
  "type": "array",
7296
7337
  "items": {
7297
7338
  "type": "object",
7298
7339
  "properties": {
7299
- "userId": {
7340
+ "transactionId": {
7300
7341
  "type": "string"
7301
7342
  },
7302
- "transactionId": {
7343
+ "status": {
7344
+ "anyOf": [
7345
+ {
7346
+ "type": "string",
7347
+ "enum": [
7348
+ "initiated"
7349
+ ]
7350
+ },
7351
+ {
7352
+ "type": "string",
7353
+ "enum": [
7354
+ "pending"
7355
+ ]
7356
+ },
7357
+ {
7358
+ "type": "string",
7359
+ "enum": [
7360
+ "succeeded"
7361
+ ]
7362
+ },
7363
+ {
7364
+ "type": "string",
7365
+ "enum": [
7366
+ "cancelled"
7367
+ ]
7368
+ },
7369
+ {
7370
+ "type": "string",
7371
+ "enum": [
7372
+ "cancellation_requested"
7373
+ ]
7374
+ },
7375
+ {
7376
+ "type": "string",
7377
+ "enum": [
7378
+ "failed"
7379
+ ]
7380
+ },
7381
+ {
7382
+ "type": "string",
7383
+ "enum": [
7384
+ "refunded"
7385
+ ]
7386
+ },
7387
+ {
7388
+ "type": "string",
7389
+ "enum": [
7390
+ "refund_failed"
7391
+ ]
7392
+ }
7393
+ ]
7394
+ },
7395
+ "amount": {
7396
+ "minimum": 1,
7397
+ "maximum": 1000000,
7398
+ "type": "number"
7399
+ },
7400
+ "extPaymentId": {
7401
+ "allOf": [
7402
+ {
7403
+ "type": "string"
7404
+ },
7405
+ {
7406
+ "type": "string"
7407
+ }
7408
+ ]
7409
+ },
7410
+ "paymentProviderId": {
7303
7411
  "type": "string"
7304
7412
  },
7305
- "paymentRequestId": {
7413
+ "updatedAt": {
7306
7414
  "type": "string"
7307
7415
  },
7308
- "paymentRequestTitle": {
7416
+ "title": {
7309
7417
  "type": "object",
7310
7418
  "properties": {
7311
7419
  "en": {
@@ -7314,41 +7422,551 @@
7314
7422
  "ga": {
7315
7423
  "type": "string"
7316
7424
  }
7317
- }
7318
- },
7319
- "amount": {
7320
- "type": "integer"
7425
+ },
7426
+ "required": [
7427
+ "en"
7428
+ ]
7321
7429
  },
7322
- "extReferenceCode": {
7430
+ "userId": {
7323
7431
  "type": "string"
7324
7432
  },
7325
- "paymentMethod": {
7433
+ "metadata": {
7434
+ "type": "object",
7435
+ "properties": {
7436
+ "runId": {
7437
+ "type": "string"
7438
+ },
7439
+ "journeyId": {
7440
+ "type": "string"
7441
+ },
7442
+ "journeyTitle": {
7443
+ "type": "object",
7444
+ "properties": {
7445
+ "en": {
7446
+ "type": "string"
7447
+ },
7448
+ "ga": {
7449
+ "type": "string"
7450
+ }
7451
+ },
7452
+ "required": [
7453
+ "en"
7454
+ ]
7455
+ },
7456
+ "redirectUrls": {
7457
+ "type": "object",
7458
+ "properties": {
7459
+ "en": {
7460
+ "type": "string"
7461
+ },
7462
+ "ga": {
7463
+ "type": "string"
7464
+ }
7465
+ },
7466
+ "required": [
7467
+ "en",
7468
+ "ga"
7469
+ ]
7470
+ },
7471
+ "amount": {
7472
+ "type": "string"
7473
+ },
7474
+ "providerData": {
7475
+ "type": "object",
7476
+ "properties": {
7477
+ "chargeId": {
7478
+ "type": "string"
7479
+ }
7480
+ },
7481
+ "required": [
7482
+ "chargeId"
7483
+ ]
7484
+ }
7485
+ }
7486
+ },
7487
+ "description": {
7488
+ "type": "object",
7489
+ "properties": {
7490
+ "en": {
7491
+ "type": "string"
7492
+ },
7493
+ "ga": {
7494
+ "type": "string"
7495
+ }
7496
+ },
7497
+ "required": [
7498
+ "en"
7499
+ ]
7500
+ },
7501
+ "providerName": {
7326
7502
  "type": "string"
7327
7503
  },
7328
- "paymentProviderName": {
7504
+ "providerType": {
7329
7505
  "type": "string"
7330
7506
  },
7331
- "status": {
7507
+ "paymentRequestId": {
7332
7508
  "type": "string"
7509
+ }
7510
+ },
7511
+ "required": [
7512
+ "transactionId",
7513
+ "status",
7514
+ "amount",
7515
+ "extPaymentId",
7516
+ "paymentProviderId",
7517
+ "updatedAt",
7518
+ "title",
7519
+ "userId",
7520
+ "metadata",
7521
+ "description",
7522
+ "providerName",
7523
+ "providerType",
7524
+ "paymentRequestId"
7525
+ ],
7526
+ "example": {
7527
+ "transactionId": "tx_1234567890abcdef",
7528
+ "status": "succeeded",
7529
+ "amount": 25,
7530
+ "extPaymentId": "pi_stripe_1234567890",
7531
+ "paymentProviderId": "prov_stripe_001",
7532
+ "updatedAt": "2024-01-15T14:30:00Z",
7533
+ "title": {
7534
+ "en": "Driver License Renewal Fee",
7535
+ "ga": "Táille Athnuachana Ceadúnais Tiomána"
7333
7536
  },
7334
- "createdAt": {
7335
- "type": "string",
7336
- "format": "date-time"
7537
+ "description": {
7538
+ "en": "Payment for renewing your driver license",
7539
+ "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
7337
7540
  },
7338
- "updatedAt": {
7339
- "type": "string",
7340
- "format": "date-time"
7541
+ "providerName": "Stripe Production",
7542
+ "providerType": "stripe",
7543
+ "paymentRequestId": "pr_1234567890abcdef",
7544
+ "userId": "user_1234567890",
7545
+ "metadata": {
7546
+ "runId": "run_1234567890",
7547
+ "journeyId": "journey_1234567890",
7548
+ "journeyTitle": {
7549
+ "en": "Driver License Application",
7550
+ "ga": "Iarratas ar Cheadúnas Tiomána"
7551
+ },
7552
+ "redirectUrls": {
7553
+ "en": "https://example.com/success",
7554
+ "ga": "https://example.com/success-ga"
7555
+ },
7556
+ "amount": "25.00",
7557
+ "providerData": {
7558
+ "chargeId": "ch_stripe_1234567890"
7559
+ }
7341
7560
  }
7342
7561
  }
7343
7562
  }
7344
7563
  },
7345
- "type": {
7346
- "type": "string"
7347
- },
7348
- "properties": {
7564
+ "metadata": {
7349
7565
  "type": "object",
7350
7566
  "properties": {
7351
- "userId": {
7567
+ "links": {
7568
+ "description": "Object containing the links to the related endpoints",
7569
+ "type": "object",
7570
+ "properties": {
7571
+ "self": {
7572
+ "type": "object",
7573
+ "properties": {
7574
+ "href": {
7575
+ "description": "URL pointing to the request itself",
7576
+ "type": "string"
7577
+ }
7578
+ }
7579
+ },
7580
+ "next": {
7581
+ "type": "object",
7582
+ "properties": {
7583
+ "href": {
7584
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
7585
+ "type": "string"
7586
+ }
7587
+ }
7588
+ },
7589
+ "prev": {
7590
+ "type": "object",
7591
+ "properties": {
7592
+ "href": {
7593
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
7594
+ "type": "string"
7595
+ }
7596
+ }
7597
+ },
7598
+ "first": {
7599
+ "type": "object",
7600
+ "properties": {
7601
+ "href": {
7602
+ "description": "URL pointing to the first page of results in a paginated response",
7603
+ "type": "string"
7604
+ }
7605
+ }
7606
+ },
7607
+ "last": {
7608
+ "type": "object",
7609
+ "properties": {
7610
+ "href": {
7611
+ "description": "URL pointing to the first page of results in a paginated response",
7612
+ "type": "string"
7613
+ }
7614
+ }
7615
+ },
7616
+ "pages": {
7617
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
7618
+ "type": "object",
7619
+ "additionalProperties": {
7620
+ "type": "object",
7621
+ "properties": {
7622
+ "href": {
7623
+ "type": "string"
7624
+ }
7625
+ }
7626
+ }
7627
+ }
7628
+ },
7629
+ "required": [
7630
+ "self",
7631
+ "first",
7632
+ "last",
7633
+ "pages"
7634
+ ]
7635
+ },
7636
+ "totalCount": {
7637
+ "description": "Number representing the total number of available items",
7638
+ "type": "number"
7639
+ }
7640
+ }
7641
+ }
7642
+ },
7643
+ "required": [
7644
+ "data"
7645
+ ]
7646
+ }
7647
+ }
7648
+ }
7649
+ },
7650
+ "401": {
7651
+ "description": "Default Response",
7652
+ "content": {
7653
+ "application/json": {
7654
+ "schema": {
7655
+ "type": "object",
7656
+ "properties": {
7657
+ "code": {
7658
+ "type": "string"
7659
+ },
7660
+ "detail": {
7661
+ "type": "string"
7662
+ },
7663
+ "requestId": {
7664
+ "type": "string"
7665
+ },
7666
+ "name": {
7667
+ "type": "string"
7668
+ },
7669
+ "validation": {},
7670
+ "validationContext": {
7671
+ "type": "string"
7672
+ }
7673
+ },
7674
+ "required": [
7675
+ "code",
7676
+ "detail",
7677
+ "requestId",
7678
+ "name"
7679
+ ]
7680
+ },
7681
+ "examples": {
7682
+ "example1": {
7683
+ "value": {
7684
+ "code": "400",
7685
+ "detail": "Bad Request - Invalid input data",
7686
+ "requestId": "req_1234567890abcdef",
7687
+ "name": "BadRequestError"
7688
+ }
7689
+ },
7690
+ "example2": {
7691
+ "value": {
7692
+ "code": "401",
7693
+ "detail": "Unauthorized - Missing or invalid JWT token",
7694
+ "requestId": "req_0987654321fedcba",
7695
+ "name": "UnauthorizedError"
7696
+ }
7697
+ },
7698
+ "example3": {
7699
+ "value": {
7700
+ "code": "404",
7701
+ "detail": "Not Found - Resource not found",
7702
+ "requestId": "req_fedcba0987654321",
7703
+ "name": "NotFoundError"
7704
+ }
7705
+ },
7706
+ "example4": {
7707
+ "value": {
7708
+ "code": "422",
7709
+ "detail": "Unprocessable Entity - Validation failed",
7710
+ "requestId": "req_abcdef1234567890",
7711
+ "name": "ValidationError",
7712
+ "validation": {
7713
+ "field": "title.en",
7714
+ "message": "Title in English is required"
7715
+ },
7716
+ "validationContext": "body"
7717
+ }
7718
+ },
7719
+ "example5": {
7720
+ "value": {
7721
+ "code": "500",
7722
+ "detail": "Internal Server Error - An unexpected error occurred",
7723
+ "requestId": "req_1234567890fedcba",
7724
+ "name": "InternalServerError"
7725
+ }
7726
+ }
7727
+ }
7728
+ }
7729
+ }
7730
+ },
7731
+ "404": {
7732
+ "description": "Default Response",
7733
+ "content": {
7734
+ "application/json": {
7735
+ "schema": {
7736
+ "type": "object",
7737
+ "properties": {
7738
+ "code": {
7739
+ "type": "string"
7740
+ },
7741
+ "detail": {
7742
+ "type": "string"
7743
+ },
7744
+ "requestId": {
7745
+ "type": "string"
7746
+ },
7747
+ "name": {
7748
+ "type": "string"
7749
+ },
7750
+ "validation": {},
7751
+ "validationContext": {
7752
+ "type": "string"
7753
+ }
7754
+ },
7755
+ "required": [
7756
+ "code",
7757
+ "detail",
7758
+ "requestId",
7759
+ "name"
7760
+ ]
7761
+ },
7762
+ "examples": {
7763
+ "example1": {
7764
+ "value": {
7765
+ "code": "400",
7766
+ "detail": "Bad Request - Invalid input data",
7767
+ "requestId": "req_1234567890abcdef",
7768
+ "name": "BadRequestError"
7769
+ }
7770
+ },
7771
+ "example2": {
7772
+ "value": {
7773
+ "code": "401",
7774
+ "detail": "Unauthorized - Missing or invalid JWT token",
7775
+ "requestId": "req_0987654321fedcba",
7776
+ "name": "UnauthorizedError"
7777
+ }
7778
+ },
7779
+ "example3": {
7780
+ "value": {
7781
+ "code": "404",
7782
+ "detail": "Not Found - Resource not found",
7783
+ "requestId": "req_fedcba0987654321",
7784
+ "name": "NotFoundError"
7785
+ }
7786
+ },
7787
+ "example4": {
7788
+ "value": {
7789
+ "code": "422",
7790
+ "detail": "Unprocessable Entity - Validation failed",
7791
+ "requestId": "req_abcdef1234567890",
7792
+ "name": "ValidationError",
7793
+ "validation": {
7794
+ "field": "title.en",
7795
+ "message": "Title in English is required"
7796
+ },
7797
+ "validationContext": "body"
7798
+ }
7799
+ },
7800
+ "example5": {
7801
+ "value": {
7802
+ "code": "500",
7803
+ "detail": "Internal Server Error - An unexpected error occurred",
7804
+ "requestId": "req_1234567890fedcba",
7805
+ "name": "InternalServerError"
7806
+ }
7807
+ }
7808
+ }
7809
+ }
7810
+ }
7811
+ },
7812
+ "500": {
7813
+ "description": "Default Response",
7814
+ "content": {
7815
+ "application/json": {
7816
+ "schema": {
7817
+ "type": "object",
7818
+ "properties": {
7819
+ "code": {
7820
+ "type": "string"
7821
+ },
7822
+ "detail": {
7823
+ "type": "string"
7824
+ },
7825
+ "requestId": {
7826
+ "type": "string"
7827
+ },
7828
+ "name": {
7829
+ "type": "string"
7830
+ },
7831
+ "validation": {},
7832
+ "validationContext": {
7833
+ "type": "string"
7834
+ }
7835
+ },
7836
+ "required": [
7837
+ "code",
7838
+ "detail",
7839
+ "requestId",
7840
+ "name"
7841
+ ]
7842
+ },
7843
+ "examples": {
7844
+ "example1": {
7845
+ "value": {
7846
+ "code": "400",
7847
+ "detail": "Bad Request - Invalid input data",
7848
+ "requestId": "req_1234567890abcdef",
7849
+ "name": "BadRequestError"
7850
+ }
7851
+ },
7852
+ "example2": {
7853
+ "value": {
7854
+ "code": "401",
7855
+ "detail": "Unauthorized - Missing or invalid JWT token",
7856
+ "requestId": "req_0987654321fedcba",
7857
+ "name": "UnauthorizedError"
7858
+ }
7859
+ },
7860
+ "example3": {
7861
+ "value": {
7862
+ "code": "404",
7863
+ "detail": "Not Found - Resource not found",
7864
+ "requestId": "req_fedcba0987654321",
7865
+ "name": "NotFoundError"
7866
+ }
7867
+ },
7868
+ "example4": {
7869
+ "value": {
7870
+ "code": "422",
7871
+ "detail": "Unprocessable Entity - Validation failed",
7872
+ "requestId": "req_abcdef1234567890",
7873
+ "name": "ValidationError",
7874
+ "validation": {
7875
+ "field": "title.en",
7876
+ "message": "Title in English is required"
7877
+ },
7878
+ "validationContext": "body"
7879
+ }
7880
+ },
7881
+ "example5": {
7882
+ "value": {
7883
+ "code": "500",
7884
+ "detail": "Internal Server Error - An unexpected error occurred",
7885
+ "requestId": "req_1234567890fedcba",
7886
+ "name": "InternalServerError"
7887
+ }
7888
+ }
7889
+ }
7890
+ }
7891
+ }
7892
+ }
7893
+ }
7894
+ }
7895
+ },
7896
+ "/api/v1/transactions/schema": {
7897
+ "get": {
7898
+ "operationId": "getTransactionSchema",
7899
+ "summary": "Get Transaction Schema",
7900
+ "tags": [
7901
+ "Transactions"
7902
+ ],
7903
+ "description": "Retrieve the JSON schema for transaction data structure.",
7904
+ "responses": {
7905
+ "200": {
7906
+ "description": "Default Response",
7907
+ "content": {
7908
+ "application/json": {
7909
+ "schema": {
7910
+ "type": "object",
7911
+ "properties": {
7912
+ "examples": {
7913
+ "type": "array",
7914
+ "items": {
7915
+ "type": "object",
7916
+ "properties": {
7917
+ "userId": {
7918
+ "type": "string"
7919
+ },
7920
+ "transactionId": {
7921
+ "type": "string"
7922
+ },
7923
+ "paymentRequestId": {
7924
+ "type": "string"
7925
+ },
7926
+ "paymentRequestTitle": {
7927
+ "type": "object",
7928
+ "properties": {
7929
+ "en": {
7930
+ "type": "string"
7931
+ },
7932
+ "ga": {
7933
+ "type": "string"
7934
+ }
7935
+ }
7936
+ },
7937
+ "amount": {
7938
+ "type": "integer"
7939
+ },
7940
+ "extReferenceCode": {
7941
+ "type": "string"
7942
+ },
7943
+ "paymentMethod": {
7944
+ "type": "string"
7945
+ },
7946
+ "paymentProviderName": {
7947
+ "type": "string"
7948
+ },
7949
+ "status": {
7950
+ "type": "string"
7951
+ },
7952
+ "createdAt": {
7953
+ "type": "string",
7954
+ "format": "date-time"
7955
+ },
7956
+ "updatedAt": {
7957
+ "type": "string",
7958
+ "format": "date-time"
7959
+ }
7960
+ }
7961
+ }
7962
+ },
7963
+ "type": {
7964
+ "type": "string"
7965
+ },
7966
+ "properties": {
7967
+ "type": "object",
7968
+ "properties": {
7969
+ "userId": {
7352
7970
  "type": "object",
7353
7971
  "properties": {
7354
7972
  "type": {
@@ -12670,11 +13288,11 @@
12670
13288
  "/api/v1/worldpay/paymentRequest": {
12671
13289
  "post": {
12672
13290
  "operationId": "createWorldpayPaymentRequest",
12673
- "summary": "Get Worldpay Payment Object",
13291
+ "summary": "Initiate a Worldpay payment",
12674
13292
  "tags": [
12675
13293
  "Worldpay"
12676
13294
  ],
12677
- "description": "Generate a Worldpay payment object for processing payments through the Worldpay payment provider.",
13295
+ "description": "Generate a Worldpay payment request to initiate a payment and obtain the payment page URL.",
12678
13296
  "requestBody": {
12679
13297
  "content": {
12680
13298
  "application/json": {
@@ -12687,9 +13305,6 @@
12687
13305
  "amount": {
12688
13306
  "type": "string"
12689
13307
  },
12690
- "providerId": {
12691
- "type": "string"
12692
- },
12693
13308
  "paymentRequestId": {
12694
13309
  "type": "string"
12695
13310
  },
@@ -12700,7 +13315,6 @@
12700
13315
  "required": [
12701
13316
  "intentId",
12702
13317
  "amount",
12703
- "providerId",
12704
13318
  "paymentRequestId"
12705
13319
  ]
12706
13320
  },
@@ -12709,7 +13323,6 @@
12709
13323
  "value": {
12710
13324
  "intentId": "pi_worldpay_1234567890",
12711
13325
  "amount": "25.00",
12712
- "providerId": "prov_realex_001",
12713
13326
  "paymentRequestId": "pr_1234567890abcdef",
12714
13327
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleGFtcGxlIjoiZXhhbXBsZV90b2tlbl9kYXRhIn0uZXhhbXBsZV9zaWduYXR1cmU"
12715
13328
  }
@@ -12718,7 +13331,6 @@
12718
13331
  "value": {
12719
13332
  "intentId": "pi_worldpay_0987654321",
12720
13333
  "amount": "80.00",
12721
- "providerId": "prov_realex_001",
12722
13334
  "paymentRequestId": "pr_0987654321fedcba"
12723
13335
  }
12724
13336
  }
@@ -13008,8 +13620,324 @@
13008
13620
  "Worldpay"
13009
13621
  ],
13010
13622
  "description": "Handle webhook events from Worldpay payment provider. This endpoint processes payment status updates, failed payments, and other Worldpay events to keep transaction status in sync.",
13623
+ "requestBody": {
13624
+ "content": {
13625
+ "application/json": {
13626
+ "schema": {
13627
+ "type": "object",
13628
+ "properties": {
13629
+ "eventId": {
13630
+ "type": "string"
13631
+ },
13632
+ "eventTimestamp": {
13633
+ "type": "string"
13634
+ },
13635
+ "eventDetails": {
13636
+ "type": "object",
13637
+ "properties": {
13638
+ "classification": {
13639
+ "type": "string"
13640
+ },
13641
+ "downstreamReference": {
13642
+ "type": "string"
13643
+ },
13644
+ "transactionReference": {
13645
+ "type": "string"
13646
+ },
13647
+ "type": {
13648
+ "type": "string"
13649
+ },
13650
+ "date": {
13651
+ "type": "string"
13652
+ }
13653
+ },
13654
+ "required": [
13655
+ "classification",
13656
+ "type",
13657
+ "date"
13658
+ ]
13659
+ },
13660
+ "reference": {
13661
+ "type": "string"
13662
+ },
13663
+ "refund": {
13664
+ "type": "object",
13665
+ "properties": {
13666
+ "onlineRefundAuthorization": {
13667
+ "type": "string"
13668
+ },
13669
+ "refusal": {
13670
+ "type": "object",
13671
+ "properties": {
13672
+ "code": {
13673
+ "type": "string"
13674
+ },
13675
+ "description": {
13676
+ "type": "string"
13677
+ }
13678
+ },
13679
+ "required": [
13680
+ "code",
13681
+ "description"
13682
+ ]
13683
+ }
13684
+ },
13685
+ "required": [
13686
+ "onlineRefundAuthorization"
13687
+ ]
13688
+ },
13689
+ "amount": {
13690
+ "type": "object",
13691
+ "properties": {
13692
+ "value": {
13693
+ "type": "number"
13694
+ },
13695
+ "currencyCode": {
13696
+ "type": "string"
13697
+ }
13698
+ },
13699
+ "required": [
13700
+ "value",
13701
+ "currencyCode"
13702
+ ]
13703
+ },
13704
+ "value": {
13705
+ "type": "number"
13706
+ },
13707
+ "_links": {
13708
+ "type": "object",
13709
+ "properties": {}
13710
+ }
13711
+ },
13712
+ "required": [
13713
+ "eventId",
13714
+ "eventTimestamp",
13715
+ "eventDetails"
13716
+ ]
13717
+ },
13718
+ "examples": {
13719
+ "example1": {
13720
+ "value": {
13721
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13722
+ "eventTimestamp": "2018-06-13T14:18:13.407",
13723
+ "eventDetails": {
13724
+ "classification": "payment",
13725
+ "downstreamReference": "3378792436",
13726
+ "transactionReference": "AuthOrder001",
13727
+ "type": "sentForAuthorization",
13728
+ "date": "2017-11-03",
13729
+ "amount": {
13730
+ "value": 100,
13731
+ "currencyCode": "EUR"
13732
+ },
13733
+ "_links": {
13734
+ "payment": {
13735
+ "href": ""
13736
+ }
13737
+ }
13738
+ }
13739
+ }
13740
+ },
13741
+ "example2": {
13742
+ "value": {
13743
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13744
+ "eventTimestamp": "2018-06-13T14:18:13.407",
13745
+ "eventDetails": {
13746
+ "classification": "payment",
13747
+ "downstreamReference": "3378792436",
13748
+ "transactionReference": "AuthOrder001",
13749
+ "type": "authorized",
13750
+ "date": "2017-11-03",
13751
+ "amount": {
13752
+ "value": 100,
13753
+ "currencyCode": "EUR"
13754
+ },
13755
+ "_links": {
13756
+ "payment": {
13757
+ "href": ""
13758
+ }
13759
+ }
13760
+ }
13761
+ }
13762
+ },
13763
+ "example3": {
13764
+ "value": {
13765
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13766
+ "eventTimestamp": "2018-06-13T14:18:13.407",
13767
+ "eventDetails": {
13768
+ "classification": "payment",
13769
+ "downstreamReference": "3378792436",
13770
+ "transactionReference": "AuthOrder001",
13771
+ "type": "sentForSettlement",
13772
+ "date": "2017-11-03",
13773
+ "reference": null,
13774
+ "amount": {
13775
+ "value": 100,
13776
+ "currencyCode": "EUR"
13777
+ },
13778
+ "_links": {
13779
+ "payment": {
13780
+ "href": ""
13781
+ }
13782
+ }
13783
+ }
13784
+ }
13785
+ },
13786
+ "example4": {
13787
+ "value": {
13788
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13789
+ "eventTimestamp": "2018-06-13T14:18:13.407",
13790
+ "eventDetails": {
13791
+ "classification": "payment",
13792
+ "downstreamReference": "3378792436",
13793
+ "transactionReference": "AuthOrder001",
13794
+ "type": "cancelled",
13795
+ "date": "2017-11-03",
13796
+ "amount": {
13797
+ "value": 100,
13798
+ "currencyCode": "EUR"
13799
+ },
13800
+ "_links": {
13801
+ "payment": {
13802
+ "href": ""
13803
+ }
13804
+ }
13805
+ }
13806
+ }
13807
+ },
13808
+ "example5": {
13809
+ "value": {
13810
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13811
+ "eventTimestamp": "2018-06-13T14:18:13.407",
13812
+ "eventDetails": {
13813
+ "classification": "payment",
13814
+ "downstreamReference": "3378792436",
13815
+ "transactionReference": "AuthOrder001",
13816
+ "type": "error",
13817
+ "date": "2017-11-03",
13818
+ "_links": {
13819
+ "payment": {
13820
+ "href": ""
13821
+ }
13822
+ }
13823
+ }
13824
+ }
13825
+ },
13826
+ "example6": {
13827
+ "value": {
13828
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13829
+ "eventTimestamp": "2018-06-13T14:18:13.407",
13830
+ "eventDetails": {
13831
+ "classification": "payment",
13832
+ "downstreamReference": "3378792436",
13833
+ "transactionReference": "AuthOrder001",
13834
+ "type": "expired",
13835
+ "date": "2017-11-03",
13836
+ "amount": {
13837
+ "value": 100,
13838
+ "currencyCode": "EUR"
13839
+ },
13840
+ "_links": {
13841
+ "payment": {
13842
+ "href": ""
13843
+ }
13844
+ }
13845
+ }
13846
+ }
13847
+ },
13848
+ "example7": {
13849
+ "value": {
13850
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13851
+ "eventTimestamp": "2018-01-01T10:30:06.123",
13852
+ "eventDetails": {
13853
+ "classification": "payment",
13854
+ "downstreamReference": "3378792436",
13855
+ "transactionReference": "AuthOrder001",
13856
+ "type": "refused",
13857
+ "date": "2017-11-13",
13858
+ "octReference": "123456",
13859
+ "_links": {
13860
+ "payment": {
13861
+ "href": ""
13862
+ }
13863
+ }
13864
+ }
13865
+ }
13866
+ },
13867
+ "example8": {
13868
+ "value": {
13869
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13870
+ "eventTimestamp": "2020-10-29T14:40:05.171",
13871
+ "eventDetails": {
13872
+ "classification": "payment",
13873
+ "downstreamReference": "3378792436",
13874
+ "transactionReference": "AuthOrder001",
13875
+ "type": "sentForRefund",
13876
+ "date": "2020-10-29",
13877
+ "reference": null,
13878
+ "refund": {
13879
+ "onlineRefundAuthorization": "987654"
13880
+ },
13881
+ "octReference": "123456",
13882
+ "amount": {
13883
+ "value": 100,
13884
+ "currencyCode": "EUR"
13885
+ },
13886
+ "_links": {
13887
+ "payment": {
13888
+ "href": ""
13889
+ }
13890
+ }
13891
+ }
13892
+ }
13893
+ },
13894
+ "example9": {
13895
+ "value": {
13896
+ "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
13897
+ "eventTimestamp": "2020-10-29T11:06:07.636",
13898
+ "eventDetails": {
13899
+ "classification": "payment",
13900
+ "downstreamReference": "3378792436",
13901
+ "transactionReference": "AuthOrder001",
13902
+ "type": "refundFailed",
13903
+ "date": "2020-10-29",
13904
+ "reference": null,
13905
+ "refund": {
13906
+ "refusal": {
13907
+ "code": 5,
13908
+ "description": "Do not honor"
13909
+ }
13910
+ },
13911
+ "amount": {
13912
+ "value": 100,
13913
+ "currencyCode": "EUR"
13914
+ },
13915
+ "_links": {
13916
+ "payment": {
13917
+ "href": ""
13918
+ }
13919
+ }
13920
+ }
13921
+ }
13922
+ }
13923
+ }
13924
+ }
13925
+ },
13926
+ "required": true
13927
+ },
13011
13928
  "security": [],
13012
13929
  "responses": {
13930
+ "200": {
13931
+ "description": "Default Response",
13932
+ "content": {
13933
+ "application/json": {
13934
+ "schema": {
13935
+ "type": "object",
13936
+ "properties": {}
13937
+ }
13938
+ }
13939
+ }
13940
+ },
13013
13941
  "404": {
13014
13942
  "description": "Default Response",
13015
13943
  "content": {