-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathcarrier-billing-refund.yaml
1443 lines (1409 loc) · 60.3 KB
/
carrier-billing-refund.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
description: |-
Service Enabling Refunds against Operator Carrier Billing Systems
# Introduction
The Carrier Billing Refund API provides programmable interface for developers and other users (capabilities consumers) to perform a refund over a given payment.
The API provides management of a refund entity and its associated lifecycle.
# Relevant terms and definitions
- **Carrier Billing**:
An online payment process which allows users to make purchases by charging payments against Telco Operator Billing Systems, accordingly to the user's configuration in the Telco Operator. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line.
- **Payment**:
The process of paying for a (set of) good(s)/service(s).
- **Refund**:
The process of returning the amount involved in a given payment (totally or partially) back to the user.
# API Functionality
This API allows to third party clients to request the refund of a given payment, as well as to retrieve information about a specific refund or a list of refunds.
The API provides several endpoints/operations:
- An endpoint to request a refund, named `createRefund`.
- A set of endpoints to retrieve information about a list of refunds or a specific refund (identified by its specific `refundId`), named `retrieveRefunds` and `retrieveRefund` respectively.
- A callback endpoint where API Server can send notifications about a refund procedure, as defined within `createRefund` operation, towards the `sink` when provided by API client.
- An endpoint to retrieve remaining amount on a payment taken into consideration processed refund, named `retrievePaymentRemainingAmount`.
State transitions:
If `createRefund` is a **SYNC** process:
- Response contains `refundId` and refundStatus=`succeeded`.
- In case of any error scenario `refundId` is not created.
If `createRefund` is an **ASYNC** process:
- Response contains `refundId` and refundStatus=`processing`. After completion:
- When refund is successfully completed then refundStatus=`succeeded`.
- When refund is not successfully performed then refundStatus=`denied`.
- In case of any error scenario `refundId` is not created. That means a `denied` Refund is not considerated as an error for the ASYNC process, because a `denied` Refund is a refund that has been created (i.e. the refund resource exists) and after applying the internal business logic has been settled to `denied` refundStatus.
# Generic Clarification about optional parameters
Regarding optional parameters, they can be conditionally mandatory for a Telco Operator to implement them based on business scenarios or applicable regulations in a given market.
NOTE: Within a given market, in a multi Telco Operator ecosystem, the set of optional parameters to be implemented MUST be aligned among involved Telco Operators.
# Authorization and authentication
The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
# Further info and support
(FAQs will be added in a later version of the documentation)
version: 0.2.0
title: Carrier Billing Refunds
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
x-camara-commonalities: 0.5
externalDocs:
description: Product documentation at Camara
url: https://github.com/camaraproject/CarrierBillingCheckOut
servers:
- url: "{apiRoot}/carrier-billing-refund/v0.2"
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider
tags:
- name: Refund
description: Operations to manage Refund procedure
paths:
/payments/{paymentId}/refunds:
post:
security:
- openId:
- carrier-billing-refund:refunds:create
tags:
- Refund
summary: Create a new Refund
operationId: createRefund
description: Create a new refund for an existing payment. Refund can be `total` or `partial`. This procedure MUST be always limited to the API client which performed the related payment.
parameters:
- name: paymentId
in: path
description: The payment identifier for which the payment refund is requested.
required: true
schema:
type: string
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: Refund transaction
content:
application/json:
schema:
$ref: "#/components/schemas/CreateRefund"
required: true
callbacks:
notifications:
"{$request.body#/sink}":
post:
security:
- {}
- notificationsBearerAuth: []
tags:
- Refund Notifications
summary: Carrier Billing refund notifications
operationId: createRefundNotification
description: |
Important: This endpoint is exposed by the API client, accepting requests in the defined format.
The Carrier Billing server will call this endpoint whenever any carrier billing related event occurs.
parameters:
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: Creates a new carrier billing refund notification
content:
application/cloudevents+json:
schema:
$ref: "#/components/schemas/CloudEvent"
required: true
responses:
"204":
description: Successful notification
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"410":
$ref: "#/components/responses/Generic410"
"429":
$ref: "#/components/responses/Generic429"
responses:
"201":
description: Created
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/Refund"
"400":
$ref: "#/components/responses/RefundInvalid400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/RefundPermissionDenied403"
"404":
$ref: "#/components/responses/Generic404"
"422":
$ref: "#/components/responses/CreateRefundUnprocessableContent422"
"409":
$ref: "#/components/responses/Generic409"
"429":
$ref: "#/components/responses/Generic429"
get:
security:
- openId:
- carrier-billing-refund:refunds:read
tags:
- Refund
summary: Get a list of refunds
operationId: retrieveRefunds
description: |-
Retrieve a list of refunds and their details for a specific payment, identified by its `paymentId`, based on some filtering criteria.
Regardless the refund criteria provided, response MUST be always limited to refunds performed by the API client (i.e same oAuth credentials) triggering this request.
This is to guarantee no API client can check refunds performed by other, therefore avoiding any legal or privacy topic.
When Access Token is issued for a given user phone number, the list of refunds returned would be only the ones associated to that user phone number and API client. When Access Token is not associated to a user phone number, therefore only associated to API client the list of refunds returned would be all the ones managed by that API client.
Considerations regarding `refundCreationDate.gte`, `refundCreationDate.lte`:
- If both included, return refunds in that date range
- If no one included, no filtering by date range is applied
- If only settled `refundCreationDate.gte`, `refundCreationDate.lte` is considered current date-time
- If only settled `refundCreationDate.lte`, every refund existing in the Operator billing system until such date is returned
parameters:
- name: paymentId
in: path
description: Payment identifier for which their refunds are queried
required: true
schema:
type: string
- $ref: "#/components/parameters/x-correlator"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
- $ref: "#/components/parameters/StartRefundCreationDate"
- $ref: "#/components/parameters/EndRefundCreationDate"
- $ref: "#/components/parameters/Order"
- $ref: "#/components/parameters/RefundStatus"
- $ref: "#/components/parameters/MerchantIdentifier"
responses:
"200":
description: OK
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
Content-Last-Key:
$ref: "#/components/headers/Content-Last-Key"
X-Total-Count:
$ref: "#/components/headers/X-Total-Count"
content:
application/json:
schema:
$ref: "#/components/schemas/RefundArray"
"400":
$ref: "#/components/responses/GetRefundsInvalid400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/RefundReadPermissionDenied403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"
/payments/{paymentId}/refunds/{refundId}:
get:
security:
- openId:
- carrier-billing-refund:refunds:read
tags:
- Refund
summary: Get refund details
operationId: retrieveRefund
description: |-
Retrieve refund details for a given refund.
When Access Token is issued for a given user phone number, the refund details would be returned in case the `refundId` is associated to that user phone number and API client, otherwise `404 NOT_FOUND` will be returned. When Access Token is not associated to a user phone number, the refund details are returned in case the API client managed that refund.
parameters:
- name: paymentId
in: path
description: Payment identifier associated to the `refundId`
required: true
schema:
type: string
- name: refundId
in: path
description: Refund identifier that was obtained from the create refund operation
required: true
schema:
type: string
- $ref: "#/components/parameters/x-correlator"
responses:
"200":
description: OK
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/Refund"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/RefundReadPermissionDenied403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"
/payments/{paymentId}/refunds/remaining-amount:
get:
security:
- openId:
- carrier-billing-refund:refunds:read
tags:
- Refund
summary: Get remaining amount not refunded for a given payment
operationId: retrievePaymentRemainingAmount
description: |-
Retrieve remaining amount not yet refunded for a given payment. This amount refers to the pending amount never requested to be refunded (i.e. a refund not yet consolidated -processing- implies that such an amount is not part of the remaining amount until final status for that procedure is reached). Some cases below to illustrate the behaviour:
**Case_1:** Payment of 80 EUR, with 2 partial `succedeed` Refunds, each of them of 20 EUR
- remainingAmount: 40 EUR
**Case_2:** Payment of 80 EUR, with 2 partial Refunds, one `succeeded` of 20 EUR and other `processing` of 15 EUR
- remainingAmount: 45 EUR (API cannot return 60 EUR, because there is an ongoing refund process)
***SubCase_A***: Second partial Refund of 15 EUR is `succeeded`
- remainingAmount: 45 EUR
***SubCase_B***: Second partial Refund of 15 EUR is `denied`
- remainingAmount: 60 EUR
**Case_3:** Payment of 80 EUR, with 1 total `succeeded` Refund
- remainingAmount: 0 EUR
**Case_4:** Payment of 80 EUR, with 1 total `processing` Refund
- remainingAmount: 0 EUR (API cannot return 80 EUR, because there is an ongoing refund process)
***SubCase_A***: Total Refund is `succeeded`
- remainingAmount: 0 EUR
***SubCase_B***: Total Refund is `denied`
- remainingAmount: 80 EUR
When Access Token is issued for a given user phone number, information would be returned in case the `paymentId` is associated to that user phone number and API client, otherwise `404 NOT_FOUND` will be returned. When Access Token is not associated to a user phone number, the information is returned in case the API client managed that payment.
parameters:
- name: paymentId
in: path
description: Payment identifier associated to the `refundId`
required: true
schema:
type: string
- $ref: "#/components/parameters/x-correlator"
responses:
"200":
description: OK
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/PaymentRemainingAmount"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/RefundReadPermissionDenied403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"
components:
securitySchemes:
openId:
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
notificationsBearerAuth:
type: http
scheme: bearer
bearerFormat: "{$request.body#/sinkCredential.credentialType}"
schemas:
CreateRefund:
type: object
description: Information to create a Refund resource.
required:
- type
properties:
type:
type: string
description: |-
Type of refund.
- `total` stands for a final refund, where whole amount is refunded so as it is not indicated by API Consumer. No more refunds are allowed for that `paymentId`.
- `partial` stands for a partial refund, whose amount is indicated by API Consumer. More refunds are allowed for that `paymentId`.
enum:
- total
- partial
reason:
type: string
description: Reason provided to request the refund. Optionally provided by the user or the merchant.
sink:
type: string
format: uri
description: The address to which events shall be delivered, using the HTTP protocol.
example: "https://endpoint.example.com/sink"
sinkCredential:
allOf:
- description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
- $ref: "#/components/schemas/SinkCredential"
discriminator:
propertyName: type
mapping:
total: "#/components/schemas/CreateTotalRefund"
partial: "#/components/schemas/CreatePartialRefund"
CreateTotalRefund:
allOf:
- $ref: "#/components/schemas/CreateRefund"
- type: object
required:
- amountTransaction
properties:
amountTransaction:
$ref: "#/components/schemas/AmountTransactionTotalRefund"
CreatePartialRefund:
allOf:
- $ref: "#/components/schemas/CreateRefund"
- type: object
required:
- amountTransaction
properties:
amountTransaction:
$ref: "#/components/schemas/AmountTransactionPartialRefund"
Refund:
type: object
description: Information about a Refund resource.
required:
- refundId
- refundStatus
- refundCreationDate
- type
properties:
refundId:
type: string
description: Unique Identifier of the refund
example: "AK234rfweSBuWGFUEWFGWEVWRV"
refundStatus:
type: string
description: Specifies the refund status (`processing`, `denied`, `succeeded`).
example: "processing"
type:
type: string
description: |-
Type of refund.
- `total` stands for a final refund, where whole amount is refunded so as it is not indicated by API Consumer. No more refunds are allowed for that `paymentId`.
- `partial` stands for a partial refund, whose amount is indicated by API Consumer. More refunds are allowed for that `paymentId`.
enum:
- total
- partial
refundCreationDate:
type: string
format: date-time
description: Date time when the refund is created in server database. This is a technical information. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
refundDate:
type: string
format: date-time
description: Date time when the refund is effectively performed. This is a business information. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
reason:
type: string
description: Reason provided to request the refund. Optionally provided by the user or the merchant.
sink:
type: string
format: uri
description: The address to which events shall be delivered, using the HTTP protocol.
example: "https://endpoint.example.com/sink"
discriminator:
propertyName: type
mapping:
total: "#/components/schemas/TotalRefund"
partial: "#/components/schemas/PartialRefund"
TotalRefund:
allOf:
- $ref: "#/components/schemas/Refund"
- type: object
required:
- amountTransaction
properties:
amountTransaction:
$ref: "#/components/schemas/AmountTransactionTotalRefund"
PartialRefund:
allOf:
- $ref: "#/components/schemas/Refund"
- type: object
required:
- amountTransaction
properties:
amountTransaction:
$ref: "#/components/schemas/AmountTransactionPartialRefund"
AmountTransactionTotalRefund:
type: object
required:
- refundAmount
- referenceCode
properties:
clientCorrelator:
type: string
description:
Uniquely identifies this create refund request. If there is
a communication failure during the refund request, using the same clientCorrelator
when retrying the request allows the operator to avoid applying the same
charge twice. This field SHOULD be present.
example: "req-12f2pgh448gh2hvrfrv"
refundAmount:
$ref: "#/components/schemas/RefundAmountTotalRefund"
referenceCode:
type: string
description:
Merchant generated refund reference to uniquely identify the
request, for instance, in the case of disputes.
example: "ref-refund-834tfr2rA3v8r8vr3rv"
RefundAmountTotalRefund:
type: object
description: Information for a `total` refund. Whole amount is refunded so as it is not needed to be provided, then it can be an empty object unless `merchantIdentifier` is indicated.
properties:
chargingMetaData:
$ref: "#/components/schemas/ChargingMetaData"
AmountTransactionPartialRefund:
type: object
required:
- refundAmount
- referenceCode
properties:
clientCorrelator:
type: string
description:
Uniquely identifies this create refund request. If there is
a communication failure during the refund request, using the same clientCorrelator
when retrying the request allows the operator to avoid applying the same
charge twice. This field SHOULD be present.
example: "req-12f2pgh448gh2hvrfrv"
refundAmount:
$ref: "#/components/schemas/RefundAmountPartialRefund"
referenceCode:
type: string
description:
Merchant generated refund reference to uniquely identify the
request, for instance, in the case of disputes.
example: "ref-refund-834tfr2rA3v8r8vr3rv"
RefundAmountPartialRefund:
type: object
description: Information for a `partial` refund. Amount to be refunded is required.
required:
- chargingInformation
properties:
chargingInformation:
$ref: "#/components/schemas/ChargingInformation"
chargingMetaData:
$ref: "#/components/schemas/ChargingMetaData"
refundDetails:
$ref: "#/components/schemas/RefundDetails"
RefundArray:
description: A list of refund(s)
type: array
minItems: 0
items:
$ref: "#/components/schemas/Refund"
SinkCredential:
type: object
properties:
credentialType:
type: string
enum:
- PLAIN
- ACCESSTOKEN
- REFRESHTOKEN
description: "The type of the credential. Only `ACCESSTOKEN` is supported so far."
discriminator:
propertyName: credentialType
mapping:
PLAIN: "#/components/schemas/PlainCredential"
ACCESSTOKEN: "#/components/schemas/AccessTokenCredential"
REFRESHTOKEN: "#/components/schemas/RefreshTokenCredential"
required:
- credentialType
PlainCredential:
type: object
description: A plain credential as a combination of an identifier and a secret.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
required:
- identifier
- secret
properties:
identifier:
description: The identifier might be an account or username.
type: string
secret:
description: The secret might be a password or passphrase.
type: string
AccessTokenCredential:
type: object
description: An access token credential.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
properties:
accessToken:
description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
type: string
accessTokenExpiresUtc:
type: string
format: date-time
description: REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired. Token expiration should occur after the expiration of the requested payment refund, allowing the client to be notified of any changes during the payment refund's existence. If the token expires while the payment refund is still active, the client will stop receiving notifications.
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
enum:
- bearer
required:
- accessToken
- accessTokenExpiresUtc
- accessTokenType
RefreshTokenCredential:
type: object
description: An access token credential with a refresh token.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
properties:
accessToken:
description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
type: string
accessTokenExpiresUtc:
type: string
format: date-time
description: REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired. Token expiration should occur after the expiration of the requested payment refund, allowing the client to be notified of any changes during the payment refund's existence. If the token expires while the payment refund is still active, the client will stop receiving notifications.
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
enum:
- bearer
refreshToken:
description: REQUIRED. An refresh token credential used to acquire access tokens.
type: string
refreshTokenEndpoint:
type: string
format: uri
description: REQUIRED. A URL at which the refresh token can be traded for an access token.
required:
- accessToken
- accessTokenExpiresUtc
- accessTokenType
- refreshToken
- refreshTokenEndpoint
ChargingInformation:
type: object
required:
- amount
- currency
- description
properties:
amount:
type: number
format: float
multipleOf: 0.001
minimum: 0.001
description: Amount to be refunded.
example: 100
currency:
type: string
description: Currency code in which amount is expressed as defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
example: "EUR"
description:
type: string
description: Description text to be used for information and billing text
example: "FIFA EA Sports 24"
isTaxIncluded:
type: boolean
default: false
description: If true, the `amount` is tax included, if false the `amount` is provided without tax. In both cases, `taxAmount` could be indicated to provide tax amount.
taxAmount:
type: number
format: float
multipleOf: 0.001
minimum: 0
description: |
The tax amount refunded by the merchant. Indicated when the merchant is the one applying taxes. This field also provides an indicator to the downstream billing system.
example: 21
ChargingMetaData:
type: object
properties:
merchantIdentifier:
type: string
description: Indicates the merchant identifier. Allows aggregators/partners to specify the actual merchant identifier
example: "eas-12345"
RefundDetails:
type: array
description: Detailed description of the concepts/items considered within a specific refund procedure.
minItems: 1
items:
$ref: "#/components/schemas/RefundItem"
RefundItem:
type: object
required:
- paymentItemId
- amount
- currency
- description
properties:
paymentItemId:
type: string
description: |-
Unique payment item identifier to which this refund item is related to. Relevant when indicating `refundDetails` to correlate information for a refund regarding this `paymentItemId`.
example: "3goug3uvu32v3b"
amount:
type: number
format: float
multipleOf: 0.001
minimum: 0.001
description: Specific amount to be refunded referred to a specific item.
example: 100
currency:
type: string
description: Currency code in which amount is expressed as defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
example: "EUR"
description:
type: string
description: Description text to be used for information and billing text referred to a specific item.
example: "FIFA EA Sports 24"
isTaxIncluded:
type: boolean
default: false
description: If true, the `amount` is tax included, if false the `amount` is provided without tax. In both cases, `taxAmount` could be indicated to provide tax amount.
taxAmount:
type: number
format: float
multipleOf: 0.001
minimum: 0
description: |
The tax amount refunded by the merchant. Indicated when the merchant is the one applying taxes. This field also provides an indicator to the downstream billing system.
example: 21
PaymentRemainingAmount:
type: object
description: Remaining Amount of a given payment not refunded yet.
required:
- amount
- currency
properties:
amount:
type: number
format: float
multipleOf: 0.001
minimum: 0
description: Specific amount not yet refunded for the payment. When takes value `0` it means whole payment has been refunded.
example: 100
currency:
type: string
description: Currency code in which amount is expressed as defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
example: "EUR"
description:
type: string
description: Description text (human readable) to contextualize this amount. Optionally indicated by Telco Operator.
example: "Current Amount not refunded so far"
isTaxIncluded:
type: boolean
default: false
description: If true, the `amount` is tax included, if false the `amount` is provided without tax. In both cases, `taxAmount` could be indicated to provide tax amount.
taxAmount:
type: number
format: float
multipleOf: 0.001
minimum: 0
description: |
The tax amount refunded by the merchant. Indicated when the merchant is the one applying taxes. This field also provides an indicator to the downstream billing system.
example: 21
CloudEvent:
description: The notification format
required:
- id
- source
- specversion
- type
- time
properties:
id:
type: string
description: Identifier of this event, that must be unique in the source context.
minLength: 1
example: "sd5e-uy52-88t4-za66"
source:
$ref: "#/components/schemas/Source"
type:
type: string
description: Type of event as defined in each CAMARA API
minLength: 25
example: "org.camaraproject.carrier-billing.v0.payment-reserved"
specversion:
type: string
description: Version of the specification to which this event conforms (must be 1.0 if it conforms to cloudevents 1.0.2 version)
minLength: 3
example: "1.0"
datacontenttype:
type: string
description: 'media-type that describes the event payload encoding, must be "application/json" for CAMARA APIs'
example: "application/json"
data:
type: object
description: Event details payload described in each CAMARA API and referenced by its type
time:
$ref: "#/components/schemas/DateTime"
discriminator:
propertyName: "type"
mapping:
org.camaraproject.carrier-billing-refund.v0.refund-completed: "#/components/schemas/EventRefundCompleted"
org.camaraproject.carrier-billing-refund.v0.refund-denied: "#/components/schemas/EventRefundDenied"
org.camaraproject.carrier-billing-refund.v0.refund-in-bill: "#/components/schemas/EventRefundInBill"
Source:
type: string
format: uri-reference
minLength: 1
description: |-
Identifies the context in which an event happened - be a non-empty `URI-reference` like:
- URI with a DNS authority:
* https://github.com/cloudevents
* mailto:cncf-wg-serverless@lists.cncf.io
- Universally-unique URN with a UUID:
* urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66
- Application-specific identifier:
* /cloudevents/spec/pull/123
* 1-555-123-4567
example: "https://notificationSendServer12.supertelco.com"
DateTime:
type: string
format: date-time
description: Timestamp when the occurrence happened. Must adhere to RFC 3339.
example: "2023-11-03T12:27:10Z"
EventRefundCompleted:
description: Event structure for refund completed
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
$ref: "#/components/schemas/RefundCompleted"
EventRefundDenied:
description: Event structure for refund denied
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
$ref: "#/components/schemas/RefundDenied"
EventRefundInBill:
description: Event structure for refund in bill (i.e. confirmation about refund will be applied in next bill)
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
$ref: "#/components/schemas/RefundInBill"
RefundCompleted:
allOf:
- description: Event detail structure for org.camaraproject.carrier-billing-refund.v0.refund-completed event
- $ref: "#/components/schemas/BasicEvent"
- type: object
required:
- refundDate
properties:
refundDate:
type: string
description: Date when the refund is effectively performed. This is a business information. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
format: date-time
example: "2023-11-03T12:27:08.312Z"
RefundDenied:
allOf:
- description: Event detail structure for org.camaraproject.carrier-billing-refund.v0.refund-denied event
- $ref: "#/components/schemas/BasicEvent"
- type: object
properties:
denialReason:
type: string
description: Indicates the business reason for denying the refund.
example: "User is blocked due to pending debt"
RefundInBill:
allOf:
- description: Event detail structure for org.camaraproject.carrier-billing-refund.v0.refund-in-bill event
- $ref: "#/components/schemas/BasicEvent"
BasicEvent:
type: object
description: Data type to provide basic refund event information
required:
- paymentId
- refundId
- status
- description
properties:
paymentId:
type: string
description: Unique Identifier of the payment
example: "AK234rfweSBuWGFUEWFGWEVWRV"
refundId:
type: string
description: Unique Identifier of the refund
example: "AK234rfweSBuWGFUEWFGWEVWRV"
status:
type: string
enum:
- succeeded
- failed
description: |-
Status of the refund procedure. Possible status are:
* `succeeded`: procedure was accomplished
* `failed`: procedure failed.
description:
type: string
description: Description of the notification, both used when process was `succeeded` or `failed` indicating in the latter case human understable reason about why process failed.
example: "Payment Notification"
ErrorInfo:
type: object
required:
- code
- message
- status
properties:
code:
type: string
description: Code given to this error
status:
type: integer
description: HTTP response status code
message:
type: string
description: Detailed error description
responses:
Generic400:
description: Invalid input
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
examples:
GENERIC_400_INVALID_ARGUMENT:
summary: Generic Invalid Argument
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or query param.
GetRefundsInvalid400:
description: |-
Invalid input. In addition to regular INVALID_ARGUMENT scenario other scenarios may exist:
- Inconsistent refundCreationDate.gte and refundCreationDate.lte values ("code": "CARRIER_BILLING_REFUND.INVALID_DATE_RANGE","message": "Client specified an invalid date range.").
- Request out of range ("code": "OUT_OF_RANGE","message": "Client specified an invalid range.").
- Too many matching records found ("code": "CARRIER_BILLING_REFUND.TOO_MANY_MATCHING_RECORDS","message": "Too many matching records found. Specify additional/suitable criteria to limit the number of records.").
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
- OUT_OF_RANGE
- CARRIER_BILLING_REFUND.INVALID_DATE_RANGE
- CARRIER_BILLING_REFUND.TOO_MANY_MATCHING_RECORDS
examples:
GENERIC_400_INVALID_ARGUMENT:
summary: Generic Invalid Argument
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or query param.
GENERIC_400_INVALID_DATE_RANGE:
summary: Generic Invalid Date Range
description: Inconsistent refundCreationDate.gte and refundCreationDate.lte values
value:
status: 400
code: CARRIER_BILLING_REFUND.INVALID_DATE_RANGE
message: "Client specified an invalid date range."
GENERIC_400_OUT_OF_RANGE:
summary: Generic Out Of Range
description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested
value:
status: 400
code: OUT_OF_RANGE
message: Client specified an invalid range.
GENERIC_400_TOO_MANY_MATCHING_RECORDS:
summary: Generic Too Many Matching Records
description: Too many matching records found
value:
status: 400
code: CARRIER_BILLING_REFUND.TOO_MANY_MATCHING_RECORDS
message: "Too many matching records found. Specify additional/suitable criteria to limit the number of records."
RefundInvalid400:
description: |-
Invalid input.
Common INVALID_ARGUMENT scenarios usually are:
- Schema validation failed ("code": "INVALID_ARGUMENT","message": "Client specified an invalid argument, request body or query param.").
- Currency is unknown or not authorized ("code": "INVALID_ARGUMENT","message": "Currency is unknown or not authorized.").
- clientCorrelator still exist ("code": "INVALID_ARGUMENT","message": "clientCorrelator already exist on server.").
In addition to regular INVALID_ARGUMENT scenario other scenarios may exist:
- Invalid sink credential ("code": "INVALID_CREDENTIAL","message": "Only Access token is supported").
- Invalid sink credential access token ("code": "INVALID_TOKEN","message": "Only bearer token is supported").
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400