mtn_open_api 0.0.1

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 (15) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +0 -0
  3. data/README.md +244 -0
  4. data/Rakefile +4 -0
  5. data/generate_readme.rb +108 -0
  6. data/lib/mtn_open_api/version.rb +6 -0
  7. data/lib/mtn_open_api.rb +164 -0
  8. data/mtn_open_api.gemspec +42 -0
  9. data/readme-template +35 -0
  10. data/schemas/collection.yaml +2370 -0
  11. data/schemas/disbursement.yaml +1907 -0
  12. data/schemas/remittance.yaml +1452 -0
  13. data/schemas/sandbox-provisioning-api.yaml +187 -0
  14. data/sig/mtn_open_api.rbs +4 -0
  15. metadata +128 -0
data/schemas/remittance.yaml ADDED
@@ -0,0 +1,1452 @@
1
+ openapi: 3.0.1
2
+ info:
3
+ title: Remittance
4
+ description: Remit funds to local recipients from the diaspora with ease
5
+ version: '1.0'
6
+ servers:
7
+ - url: https://sandbox.momodeveloper.mtn.com/remittance
8
+ paths:
9
+ /v1_0/account/balance:
10
+ get:
11
+ summary: GetAccountBalance
12
+ description: Get the balance of own account.
13
+ operationId: GetAccountBalance
14
+ parameters:
15
+ - name: Authorization
16
+ in: header
17
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
18
+ required: true
19
+ schema:
20
+ type: string
21
+ - name: X-Target-Environment
22
+ in: header
23
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
24
+ required: true
25
+ schema:
26
+ type: string
27
+ responses:
28
+ '200':
29
+ description: Ok
30
+ content:
31
+ application/json:
32
+ schema:
33
+ $ref: '#/components/schemas/Balance'
34
+ example:
35
+ availableBalance: string
36
+ currency: string
37
+ Incorrect target environment:
38
+ schema:
39
+ $ref: '#/components/schemas/Balance'
40
+ examples:
41
+ default:
42
+ value:
43
+ '400':
44
+ description: 'Bad request, e.g. invalid data was sent in the request.'
45
+ content:
46
+ application/json: { }
47
+ Incorrect target environment: { }
48
+ '500':
49
+ description: Internal error. The returned response contains details.
50
+ content:
51
+ Incorrect target environment:
52
+ schema:
53
+ $ref: '#/components/schemas/ErrorReason'
54
+ example:
55
+ code: NOT_ALLOWED_TARGET_ENVIRONMENT
56
+ message: Access to target environment is forbidden.
57
+ application/json:
58
+ schema:
59
+ $ref: '#/components/schemas/ErrorReason'
60
+ example:
61
+ code: PAYEE_NOT_FOUND
62
+ message: string
63
+ '/v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/active':
64
+ get:
65
+ summary: ValidateAccountHolderStatus
66
+ description: Operation is used to check if an account holder is registered and active in the system.
67
+ operationId: ValidateAccountHolderStatus
68
+ parameters:
69
+ - name: accountHolderId
70
+ in: path
71
+ description: The AccountHolder number that's Validated according to the AccountHolder ID type (case Sensitive)<br> msisdn - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN <br>email - Validated to be a valid e-mail format. Validated with IsEmail
72
+ required: true
73
+ schema:
74
+ type: string
75
+ - name: accountHolderIdType
76
+ in: path
77
+ description: 'Specifies the type of the party id. Allowed values [msisdn, email, party_code].'
78
+ required: true
79
+ schema:
80
+ type: string
81
+ - name: Authorization
82
+ in: header
83
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
84
+ required: true
85
+ schema:
86
+ type: string
87
+ - name: X-Target-Environment
88
+ in: header
89
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
90
+ required: true
91
+ schema:
92
+ type: string
93
+ responses:
94
+ '200':
95
+ description: 'Ok. True if account holder is registered and active, false if the account holder is not active or not found found'
96
+ content:
97
+ Incorrect target environment: { }
98
+ '400':
99
+ description: 'Bad request, e.g. invalid data was sent in the request.'
100
+ content:
101
+ Incorrect target environment: { }
102
+ '500':
103
+ description: Internal error. The returned response contains details.
104
+ content:
105
+ Incorrect target environment:
106
+ schema:
107
+ $ref: '#/components/schemas/ErrorReason'
108
+ example:
109
+ code: NOT_ALLOWED_TARGET_ENVIRONMENT
110
+ message: Access to target environment is forbidden.
111
+ /v1_0/transfer:
112
+ post:
113
+ summary: Transfer
114
+ description: 'Transfer operation is used to transfer an amount from the own account to a payee account.<br> Status of the transaction can validated by using the GET /transfer/\{referenceId\}'
115
+ operationId: Transfer
116
+ parameters:
117
+ - name: Authorization
118
+ in: header
119
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
120
+ required: true
121
+ schema:
122
+ type: string
123
+ - name: X-Callback-Url
124
+ in: header
125
+ description: URL to the server where the callback should be sent.
126
+ schema:
127
+ type: string
128
+ - name: X-Reference-Id
129
+ in: header
130
+ description: 'Format - UUID. Recource ID of the created request to pay transaction. This ID is used, for example validating the status of the request. ‘Universal Unique ID’ for the transaction generated using UUID version 4.'
131
+ required: true
132
+ schema:
133
+ type: string
134
+ - name: X-Target-Environment
135
+ in: header
136
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
137
+ required: true
138
+ schema:
139
+ type: string
140
+ requestBody:
141
+ content:
142
+ application/json:
143
+ schema:
144
+ $ref: '#/components/schemas/Transfer'
145
+ example:
146
+ amount: string
147
+ currency: string
148
+ externalId: string
149
+ payee:
150
+ partyIdType: MSISDN
151
+ partyId: string
152
+ payerMessage: string
153
+ payeeNote: string
154
+ responses:
155
+ '202':
156
+ description: Accepted
157
+ content:
158
+ application/json: { }
159
+ ReferenceId already in use: { }
160
+ Incorrect currency for target environment: { }
161
+ '400':
162
+ description: 'Bad request, e.g. invalid data was sent in the request.'
163
+ content:
164
+ application/json: { }
165
+ ReferenceId already in use: { }
166
+ Incorrect currency for target environment: { }
167
+ '409':
168
+ description: 'Conflict, duplicated reference id'
169
+ content:
170
+ ReferenceId already in use:
171
+ schema:
172
+ $ref: '#/components/schemas/ErrorReason'
173
+ example:
174
+ code: RESOURCE_ALREADY_EXIST
175
+ message: Duplicated reference id. Creation of resource failed.
176
+ application/json:
177
+ schema:
178
+ $ref: '#/components/schemas/ErrorReason'
179
+ example:
180
+ code: PAYEE_NOT_FOUND
181
+ message: string
182
+ Incorrect currency for target environment:
183
+ schema:
184
+ $ref: '#/components/schemas/ErrorReason'
185
+ examples:
186
+ default:
187
+ value:
188
+ '500':
189
+ description: Internal Error.
190
+ content:
191
+ Incorrect currency for target environment:
192
+ schema:
193
+ $ref: '#/components/schemas/ErrorReason'
194
+ example:
195
+ code: INVALID_CURRENCY
196
+ message: Currency not supported.
197
+ application/json:
198
+ schema:
199
+ $ref: '#/components/schemas/ErrorReason'
200
+ example:
201
+ code: PAYEE_NOT_FOUND
202
+ message: string
203
+ ReferenceId already in use:
204
+ schema:
205
+ $ref: '#/components/schemas/ErrorReason'
206
+ examples:
207
+ default:
208
+ value:
209
+ '/v1_0/transfer/{referenceId}':
210
+ get:
211
+ summary: GetTransferStatus
212
+ description: This operation is used to get the status of a transfer. X-Reference-Id that was passed in the post is used as reference to the request.
213
+ operationId: GetTransferStatus
214
+ parameters:
215
+ - name: referenceId
216
+ in: path
217
+ description: UUID of transaction to get result. Reference id used when creating the Transfer.
218
+ required: true
219
+ schema:
220
+ type: string
221
+ - name: Authorization
222
+ in: header
223
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
224
+ required: true
225
+ schema:
226
+ type: string
227
+ - name: X-Target-Environment
228
+ in: header
229
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
230
+ required: true
231
+ schema:
232
+ type: string
233
+ responses:
234
+ '200':
235
+ description: OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
236
+ content:
237
+ Successful transfer:
238
+ schema:
239
+ $ref: '#/components/schemas/TransferResult'
240
+ example:
241
+ amount: 100
242
+ currency: UGX
243
+ financialTransactionId: 363440463
244
+ externalId: 83453
245
+ payee:
246
+ partyIdType: MSISDN
247
+ partyId: 4609274685
248
+ status: SUCCESSFUL
249
+ Payer limit breached:
250
+ schema:
251
+ $ref: '#/components/schemas/TransferResult'
252
+ example:
253
+ amount: 100
254
+ currency: UGX
255
+ externalId: 83453
256
+ payee:
257
+ partyIdType: MSISDN
258
+ partyId: 4609274685
259
+ status: FAILED
260
+ reason:
261
+ code: PAYER_LIMIT_REACHED
262
+ message: The payer's limit has been breached.
263
+ API user insufficient balance:
264
+ schema:
265
+ $ref: '#/components/schemas/TransferResult'
266
+ example:
267
+ amount: 100
268
+ currency: UGX
269
+ externalId: 83453
270
+ payee:
271
+ partyIdType: MSISDN
272
+ partyId: 4609274685
273
+ status: FAILED
274
+ reason:
275
+ code: NOT_ENOUGH_FUNDS
276
+ message: The payer does not have enough funds.
277
+ application/json:
278
+ schema:
279
+ $ref: '#/components/schemas/TransferResult'
280
+ example:
281
+ amount: string
282
+ currency: string
283
+ financialTransactionId: string
284
+ externalId: string
285
+ payee:
286
+ partyIdType: MSISDN
287
+ partyId: string
288
+ payerMessage: string
289
+ payeeNote: string
290
+ status: PENDING
291
+ reason:
292
+ code: PAYEE_NOT_FOUND
293
+ message: string
294
+ Transfer not found:
295
+ schema:
296
+ $ref: '#/components/schemas/TransferResult'
297
+ examples:
298
+ default:
299
+ value:
300
+ Unspecified internal error:
301
+ schema:
302
+ $ref: '#/components/schemas/TransferResult'
303
+ examples:
304
+ default:
305
+ value:
306
+ '400':
307
+ description: 'Bad request, e.g. an incorrectly formatted reference id was provided.'
308
+ content:
309
+ Successful transfer: { }
310
+ Payer limit breached: { }
311
+ API user insufficient balance: { }
312
+ application/json: { }
313
+ Transfer not found: { }
314
+ Unspecified internal error: { }
315
+ '404':
316
+ description: Resource not found.
317
+ content:
318
+ Transfer not found:
319
+ schema:
320
+ $ref: '#/components/schemas/ErrorReason'
321
+ example:
322
+ code: RESOURCE_NOT_FOUND
323
+ message: Requested resource was not found.
324
+ Successful transfer:
325
+ schema:
326
+ $ref: '#/components/schemas/ErrorReason'
327
+ examples:
328
+ default:
329
+ value:
330
+ Payer limit breached:
331
+ schema:
332
+ $ref: '#/components/schemas/ErrorReason'
333
+ examples:
334
+ default:
335
+ value:
336
+ API user insufficient balance:
337
+ schema:
338
+ $ref: '#/components/schemas/ErrorReason'
339
+ examples:
340
+ default:
341
+ value:
342
+ application/json:
343
+ schema:
344
+ $ref: '#/components/schemas/ErrorReason'
345
+ example:
346
+ code: PAYEE_NOT_FOUND
347
+ message: string
348
+ Unspecified internal error:
349
+ schema:
350
+ $ref: '#/components/schemas/ErrorReason'
351
+ examples:
352
+ default:
353
+ value:
354
+ '500':
355
+ description: 'Internal Error. Note that if the retreieved transfer has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.'
356
+ content:
357
+ Unspecified internal error:
358
+ schema:
359
+ $ref: '#/components/schemas/ErrorReason'
360
+ example:
361
+ code: INTERNAL_PROCESSING_ERROR
362
+ message: An internal error occurred while processing.
363
+ Successful transfer:
364
+ schema:
365
+ $ref: '#/components/schemas/ErrorReason'
366
+ examples:
367
+ default:
368
+ value:
369
+ Payer limit breached:
370
+ schema:
371
+ $ref: '#/components/schemas/ErrorReason'
372
+ examples:
373
+ default:
374
+ value:
375
+ API user insufficient balance:
376
+ schema:
377
+ $ref: '#/components/schemas/ErrorReason'
378
+ examples:
379
+ default:
380
+ value:
381
+ application/json:
382
+ schema:
383
+ $ref: '#/components/schemas/ErrorReason'
384
+ example:
385
+ code: PAYEE_NOT_FOUND
386
+ message: string
387
+ Transfer not found:
388
+ schema:
389
+ $ref: '#/components/schemas/ErrorReason'
390
+ examples:
391
+ default:
392
+ value:
393
+ '/v1_0/accountholder/msisdn/{accountHolderMSISDN}/basicuserinfo':
394
+ get:
395
+ summary: GetBasicUserinfo
396
+ description: This operation returns personal information of the account holder. The operation does not need any consent by the account holder.
397
+ operationId: GetBasicUserinfo
398
+ parameters:
399
+ - name: accountHolderMSISDN
400
+ in: path
401
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
402
+ required: true
403
+ schema:
404
+ type: string
405
+ - name: Authorization
406
+ in: header
407
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
408
+ required: true
409
+ schema:
410
+ type: string
411
+ - name: X-Target-Environment
412
+ in: header
413
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
414
+ required: true
415
+ schema:
416
+ type: string
417
+ responses:
418
+ '200':
419
+ description: OK
420
+ content:
421
+ application/json:
422
+ schema:
423
+ $ref: '#/components/schemas/BasicUserInfoJsonResponse'
424
+ example:
425
+ given_name: string
426
+ family_name: string
427
+ birthdate: string
428
+ locale: string
429
+ gender: string
430
+ status: string
431
+ '401':
432
+ description: Unauthorized
433
+ content:
434
+ application/json:
435
+ schema:
436
+ $ref: '#/components/schemas/TokenPost401ApplicationJsonResponse'
437
+ example:
438
+ error: string
439
+ '500':
440
+ description: Error
441
+ content:
442
+ application/json: { }
443
+ /v1_0/bc-authorize:
444
+ post:
445
+ summary: bc-authorize
446
+ description: This operation is used to claim a consent by the account holder for the requested scopes.
447
+ operationId: bc-authorize
448
+ parameters:
449
+ - name: Authorization
450
+ in: header
451
+ description: Basic authentication header containing API user ID and API key. Should be sent in as B64 encoded.
452
+ required: true
453
+ schema:
454
+ type: string
455
+ - name: X-Target-Environment
456
+ in: header
457
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
458
+ required: true
459
+ schema:
460
+ type: string
461
+ - name: X-Callback-Url
462
+ in: header
463
+ description: URL to the server where the callback should be sent.
464
+ schema:
465
+ type: string
466
+ requestBody:
467
+ content:
468
+ application/x-www-form-urlencoded:
469
+ schema:
470
+ properties:
471
+ scope:
472
+ type: string
473
+ login_hint:
474
+ type: string
475
+ access_type:
476
+ enum:
477
+ - online
478
+ - offline
479
+ type: string
480
+ consent_valid_in:
481
+ type: integer
482
+ client_notification_token:
483
+ type: string
484
+ scope_instruction:
485
+ type: string
486
+ example: 'login_hint=ID:{msisdn}/MSISDN&scope={scope}&access_type={online/offline}'
487
+ responses:
488
+ '200':
489
+ description: OK
490
+ content:
491
+ application/json:
492
+ schema:
493
+ $ref: '#/components/schemas/bcauthorizeResponse'
494
+ example:
495
+ auth_req_id: string
496
+ interval: 0
497
+ expires_in: 0
498
+ '/v1_0/account/balance/{currency}':
499
+ get:
500
+ summary: GetAccountBalanceInSpecificCurrency
501
+ description: Get the balance of own account. Currency parameter passed in GET
502
+ operationId: GetAccountBalanceInSpecificCurrency
503
+ parameters:
504
+ - name: currency
505
+ in: path
506
+ description: Should be in ISO4217 Currency
507
+ required: true
508
+ schema:
509
+ type: string
510
+ - name: Authorization
511
+ in: header
512
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
513
+ required: true
514
+ schema:
515
+ type: string
516
+ - name: X-Target-Environment
517
+ in: header
518
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
519
+ required: true
520
+ schema:
521
+ type: string
522
+ responses:
523
+ '200':
524
+ description: Ok
525
+ content:
526
+ application/json:
527
+ schema:
528
+ $ref: '#/components/schemas/Balance'
529
+ example:
530
+ availableBalance: string
531
+ currency: string
532
+ Incorrect target environment:
533
+ schema:
534
+ $ref: '#/components/schemas/Balance'
535
+ examples:
536
+ default:
537
+ value:
538
+ '400':
539
+ description: 'Bad request, e.g. invalid data was sent in the request.'
540
+ content:
541
+ application/json: { }
542
+ Incorrect target environment: { }
543
+ '500':
544
+ description: Internal error. The returned response contains details.
545
+ content:
546
+ Incorrect target environment:
547
+ schema:
548
+ $ref: '#/components/schemas/ErrorReason'
549
+ example:
550
+ code: NOT_ALLOWED_TARGET_ENVIRONMENT
551
+ message: Access to target environment is forbidden.
552
+ application/json:
553
+ schema:
554
+ $ref: '#/components/schemas/ErrorReason'
555
+ example:
556
+ code: PAYEE_NOT_FOUND
557
+ message: string
558
+ /oauth2/token/:
559
+ post:
560
+ summary: CreateOauth2Token
561
+ description: This operation is used to claim a consent by the account holder for the requested scopes.
562
+ operationId: CreateOauth2Token
563
+ parameters:
564
+ - name: Authorization
565
+ in: header
566
+ description: Basic authentication header containing API user ID and API key. Should be sent in as B64 encoded.
567
+ required: true
568
+ schema:
569
+ type: string
570
+ - name: X-Target-Environment
571
+ in: header
572
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
573
+ required: true
574
+ schema:
575
+ type: string
576
+ requestBody:
577
+ content:
578
+ application/x-www-form-urlencoded:
579
+ schema:
580
+ properties:
581
+ grant_type:
582
+ type: string
583
+ auth_req_id:
584
+ type: string
585
+ refresh_token:
586
+ type: string
587
+ example: 'grant_type=urn:openid:params:grant-type:ciba&auth_req_id={auth_req_id}'
588
+ responses:
589
+ '200':
590
+ description: OK
591
+ content:
592
+ application/json:
593
+ schema:
594
+ $ref: '#/components/schemas/oauth2TokenResponse'
595
+ example:
596
+ access_token: string
597
+ token_type: string
598
+ expires_in: 0
599
+ scope: string
600
+ refresh_token: string
601
+ refresh_token_expired_in: 0
602
+ /oauth2/v1_0/userinfo:
603
+ get:
604
+ summary: GetUserInfoWithConsent
605
+ description: This operation is used to claim a consent by the account holder for the requested scopes.
606
+ operationId: GetUserInfoWithConsent
607
+ parameters:
608
+ - name: Authorization
609
+ in: header
610
+ description: Bearer Token. Replace with a valid oauth2 token received from oauth2 token endpoint in Wallet Platform.
611
+ required: true
612
+ schema:
613
+ type: string
614
+ - name: X-Target-Environment
615
+ in: header
616
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
617
+ required: true
618
+ schema:
619
+ type: string
620
+ responses:
621
+ '200':
622
+ description: OK
623
+ content:
624
+ application/json:
625
+ schema:
626
+ $ref: '#/components/schemas/consentkycResponse'
627
+ example:
628
+ sub: string
629
+ name: string
630
+ given_name: string
631
+ family_name: string
632
+ middle_name: string
633
+ email: string
634
+ email_verified: true
635
+ gender: string
636
+ locale: string
637
+ phone_number: string
638
+ phone_number_verified: true
639
+ address: string
640
+ updated_at: 0
641
+ status: string
642
+ birthdate: string
643
+ credit_score: string
644
+ active: true
645
+ country_of_birth: string
646
+ region_of_birth: string
647
+ city_of_birth: string
648
+ occupation: string
649
+ employer_name: string
650
+ identification_type: string
651
+ identification_value: string
652
+ /token/:
653
+ post:
654
+ summary: CreateAccessToken
655
+ description: This operation is used to create an access token which can then be used to authorize and authenticate towards the other end-points of the API.
656
+ operationId: CreateAccessToken
657
+ parameters:
658
+ - name: Authorization
659
+ in: header
660
+ description: Basic authentication header containing API user ID and API key. Should be sent in as B64 encoded.
661
+ required: true
662
+ schema:
663
+ type: string
664
+ responses:
665
+ '200':
666
+ description: OK
667
+ content:
668
+ application/json:
669
+ schema:
670
+ $ref: '#/components/schemas/TokenPost200ApplicationJsonResponse'
671
+ example:
672
+ access_token: string
673
+ token_type: string
674
+ expires_in: 0
675
+ '401':
676
+ description: Unauthorized
677
+ content:
678
+ application/json:
679
+ schema:
680
+ $ref: '#/components/schemas/TokenPost401ApplicationJsonResponse'
681
+ example:
682
+ error: string
683
+ '500':
684
+ description: Error
685
+ content:
686
+ application/json: { }
687
+ /v2_0/cashtransfer:
688
+ post:
689
+ summary: CashTransfer
690
+ description: 'Cash transfer operation is used to transfer an amount from the owner’s account to a payee account. Status of the transaction can be validated by using GET /cashtransfer/{referenceId}'
691
+ operationId: CashTransfer
692
+ parameters:
693
+ - name: Authorization
694
+ in: header
695
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
696
+ schema:
697
+ type: string
698
+ - name: X-Callback-Url
699
+ in: header
700
+ description: 'URL to the server where the callback should be sent, Uses PORT method.'
701
+ schema:
702
+ type: string
703
+ - name: X-Reference-Id
704
+ in: header
705
+ description: Format - UUID. Recource ID of the created ‘request-to-pay’ transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
706
+ required: true
707
+ schema:
708
+ type: string
709
+ - name: X-Target-Environment
710
+ in: header
711
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
712
+ required: true
713
+ schema:
714
+ type: string
715
+ requestBody:
716
+ content:
717
+ application/json:
718
+ schema:
719
+ $ref: '#/components/schemas/CashTransfer'
720
+ example:
721
+ amount: string
722
+ currency: string
723
+ payee:
724
+ partyId: string
725
+ partyIdType: MSISDN/EMAIL/PARTY_CODE
726
+ externalId: string
727
+ orginatingCountry: string
728
+ originalAmount: string
729
+ originalCurrency: string
730
+ payerMessage: string
731
+ payeeNote: string
732
+ payerIdentificationType: PersonIdentificationType1Code
733
+ payerIdentificationNumber: string
734
+ payerIdentity: string
735
+ payerFirstName: string
736
+ payerSurName: string
737
+ payerLanguageCode: string
738
+ payerEmail: string (Email)
739
+ payerMsisdn: string (Msisdn)
740
+ payerGender: string
741
+ responses:
742
+ '202':
743
+ description: Accepted
744
+ content:
745
+ application/json: { }
746
+ ReferenceId already in use: { }
747
+ Incorrect currency for target environment: { }
748
+ '400':
749
+ description: 'Bad request, e.g. invalid data was sent in the request.'
750
+ content:
751
+ application/json: { }
752
+ ReferenceId already in use: { }
753
+ Incorrect currency for target environment: { }
754
+ '409':
755
+ description: 'Conflict, duplicated reference id'
756
+ content:
757
+ ReferenceId already in use:
758
+ schema:
759
+ $ref: '#/components/schemas/ErrorReason'
760
+ example:
761
+ code: RESOURCE_ALREADY_EXIST
762
+ message: Duplicated reference id. Creation of resource failed.
763
+ application/json:
764
+ schema:
765
+ $ref: '#/components/schemas/ErrorReason'
766
+ example:
767
+ code: PAYEE_NOT_FOUND
768
+ message: string
769
+ Incorrect currency for target environment:
770
+ schema:
771
+ $ref: '#/components/schemas/ErrorReason'
772
+ examples:
773
+ default:
774
+ value:
775
+ '500':
776
+ description: Internal Error.
777
+ content:
778
+ Incorrect currency for target environment:
779
+ schema:
780
+ $ref: '#/components/schemas/ErrorReason'
781
+ example:
782
+ code: INVALID_CURRENCY
783
+ message: Currency not supported.
784
+ application/json:
785
+ schema:
786
+ $ref: '#/components/schemas/ErrorReason'
787
+ example:
788
+ code: PAYEE_NOT_FOUND
789
+ message: string
790
+ ReferenceId already in use:
791
+ schema:
792
+ $ref: '#/components/schemas/ErrorReason'
793
+ examples:
794
+ default:
795
+ value:
796
+ '/v2_0/cashtransfer/{referenceId}':
797
+ get:
798
+ summary: GetCashTransferStatus
799
+ description: This operation is used to get the status of a transfer. X-Reference-Id that was passed in the post is used as reference to the request.
800
+ operationId: GetCashTransferStatus
801
+ parameters:
802
+ - name: referenceId
803
+ in: path
804
+ description: UUID of transaction to get result. Reference id used when creating the CashTransfer.
805
+ required: true
806
+ schema:
807
+ type: string
808
+ - name: Authorization
809
+ in: header
810
+ description: Bearer Authentication Token generated using CreateAccessToken API Call
811
+ required: true
812
+ schema:
813
+ type: string
814
+ - name: X-Target-Environment
815
+ in: header
816
+ description: The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
817
+ required: true
818
+ schema:
819
+ type: string
820
+ responses:
821
+ '200':
822
+ description: OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
823
+ content:
824
+ Successful transfer:
825
+ schema:
826
+ $ref: '#/components/schemas/CashTransferResult'
827
+ example:
828
+ amount: 100
829
+ currency: UGX
830
+ financialTransactionId: 363440463
831
+ externalId: 83453
832
+ payee:
833
+ partyIdType: MSISDN
834
+ partyId: 4609274685
835
+ status: SUCCESSFUL
836
+ Payer limit breached:
837
+ schema:
838
+ $ref: '#/components/schemas/CashTransferResult'
839
+ example:
840
+ amount: 100
841
+ currency: UGX
842
+ externalId: 83453
843
+ payee:
844
+ partyIdType: MSISDN
845
+ partyId: 4609274685
846
+ status: FAILED
847
+ reason:
848
+ code: PAYER_LIMIT_REACHED
849
+ message: The payer's limit has been breached.
850
+ API user insufficient balance:
851
+ schema:
852
+ $ref: '#/components/schemas/CashTransferResult'
853
+ example:
854
+ amount: 100
855
+ currency: UGX
856
+ externalId: 83453
857
+ payee:
858
+ partyIdType: MSISDN
859
+ partyId: 4609274685
860
+ status: FAILED
861
+ reason:
862
+ code: NOT_ENOUGH_FUNDS
863
+ message: The payer does not have enough funds.
864
+ application/json:
865
+ schema:
866
+ $ref: '#/components/schemas/CashTransferResult'
867
+ example:
868
+ amount: string
869
+ currency: string
870
+ financialTransactionId: string
871
+ externalId: string
872
+ payee:
873
+ partyIdType: MSISDN
874
+ partyId: string
875
+ payerMessage: string
876
+ payeeNote: string
877
+ status: PENDING
878
+ reason:
879
+ code: PAYEE_NOT_FOUND
880
+ message: string
881
+ Transfer not found:
882
+ schema:
883
+ $ref: '#/components/schemas/CashTransferResult'
884
+ examples:
885
+ default:
886
+ value:
887
+ Unspecified internal error:
888
+ schema:
889
+ $ref: '#/components/schemas/CashTransferResult'
890
+ examples:
891
+ default:
892
+ value:
893
+ '400':
894
+ description: 'Bad request, e.g. an incorrectly formatted reference id was provided.'
895
+ content:
896
+ Successful transfer: { }
897
+ Payer limit breached: { }
898
+ API user insufficient balance: { }
899
+ application/json: { }
900
+ Transfer not found: { }
901
+ Unspecified internal error: { }
902
+ '404':
903
+ description: Resource not found.
904
+ content:
905
+ Transfer not found:
906
+ schema:
907
+ $ref: '#/components/schemas/ErrorReason'
908
+ example:
909
+ code: RESOURCE_NOT_FOUND
910
+ message: Requested resource was not found.
911
+ Successful transfer:
912
+ schema:
913
+ $ref: '#/components/schemas/ErrorReason'
914
+ examples:
915
+ default:
916
+ value:
917
+ Payer limit breached:
918
+ schema:
919
+ $ref: '#/components/schemas/ErrorReason'
920
+ examples:
921
+ default:
922
+ value:
923
+ API user insufficient balance:
924
+ schema:
925
+ $ref: '#/components/schemas/ErrorReason'
926
+ examples:
927
+ default:
928
+ value:
929
+ application/json:
930
+ schema:
931
+ $ref: '#/components/schemas/ErrorReason'
932
+ example:
933
+ code: PAYEE_NOT_FOUND
934
+ message: string
935
+ Unspecified internal error:
936
+ schema:
937
+ $ref: '#/components/schemas/ErrorReason'
938
+ examples:
939
+ default:
940
+ value:
941
+ '500':
942
+ description: 'Internal Error. Note that if the retreieved transfer has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.'
943
+ content:
944
+ Unspecified internal error:
945
+ schema:
946
+ $ref: '#/components/schemas/ErrorReason'
947
+ example:
948
+ code: INTERNAL_PROCESSING_ERROR
949
+ message: An internal error occurred while processing.
950
+ Successful transfer:
951
+ schema:
952
+ $ref: '#/components/schemas/ErrorReason'
953
+ examples:
954
+ default:
955
+ value:
956
+ Payer limit breached:
957
+ schema:
958
+ $ref: '#/components/schemas/ErrorReason'
959
+ examples:
960
+ default:
961
+ value:
962
+ API user insufficient balance:
963
+ schema:
964
+ $ref: '#/components/schemas/ErrorReason'
965
+ examples:
966
+ default:
967
+ value:
968
+ application/json:
969
+ schema:
970
+ $ref: '#/components/schemas/ErrorReason'
971
+ example:
972
+ code: PAYEE_NOT_FOUND
973
+ message: string
974
+ Transfer not found:
975
+ schema:
976
+ $ref: '#/components/schemas/ErrorReason'
977
+ examples:
978
+ default:
979
+ value:
980
+ components:
981
+ schemas:
982
+ bcauthorize:
983
+ type: object
984
+ properties:
985
+ scope:
986
+ type: string
987
+ description: Space separated list of scopes.
988
+ login_hint:
989
+ type: string
990
+ description: The identity of the account holder.
991
+ access_type:
992
+ enum:
993
+ - online
994
+ - offline
995
+ type: string
996
+ description: 'Value either online, or offline.'
997
+ consent_valid_in:
998
+ type: integer
999
+ description: The validity time of the consent in secondsThis parameter can only be used together with access type offline.
1000
+ client_notification_token:
1001
+ type: string
1002
+ description: This token is required when the client is using Ping or Push mode.
1003
+ scope_instruction:
1004
+ type: string
1005
+ description: Base64 encoded Instrcution of the financial transaction.
1006
+ bcauthorizeResponse:
1007
+ type: object
1008
+ properties:
1009
+ auth_req_id:
1010
+ type: string
1011
+ description: Authentication request ID as an UUID.
1012
+ interval:
1013
+ type: number
1014
+ description: Indicates how long time the client should wait between retries towards the endpoint /oauth2/token.
1015
+ expires_in:
1016
+ type: number
1017
+ description: 'Shows when the authentication request ID expires, in seconds.'
1018
+ BasicUserInfoJsonResponse:
1019
+ type: object
1020
+ properties:
1021
+ given_name:
1022
+ type: string
1023
+ description: 'Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.'
1024
+ family_name:
1025
+ type: string
1026
+ description: 'Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.'
1027
+ birthdate:
1028
+ type: string
1029
+ description: Account holder birth date.
1030
+ locale:
1031
+ type: string
1032
+ description: 'End-User''s locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639�|�1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166�|�1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties may choose to accept this locale syntax as well.'
1033
+ gender:
1034
+ type: string
1035
+ description: End-User's gender. Values defined by this specification are female and male. Other values may be used when neither of the defined values are applicable.
1036
+ status:
1037
+ type: string
1038
+ description: Accountholder status.
1039
+ TokenPost200ApplicationJsonResponse:
1040
+ type: object
1041
+ properties:
1042
+ access_token:
1043
+ type: string
1044
+ description: A JWT token which can be used to authrize against the other API end-points. The format of the token follows the JWT standard format (see jwt.io for an example). This is the token that should be sent in in the Authorization header when calling the other API end-points.
1045
+ token_type:
1046
+ type: string
1047
+ description: The token type.
1048
+ expires_in:
1049
+ type: integer
1050
+ description: The validity time in seconds of the token.
1051
+ oauth2TokenRequest:
1052
+ type: object
1053
+ properties:
1054
+ grant_type:
1055
+ type: string
1056
+ description: Value ca be either "urn:openid:params:grant-type:ciba" or refresh_token
1057
+ auth_req_id:
1058
+ type: string
1059
+ description: Authentication request ID.Value is only mandatory if grant_type is "urn:openid:params:grant-type:ciba"
1060
+ refresh_token:
1061
+ type: string
1062
+ description: UUID.Refresh token retrieved from oauth2 token endpoint for consents with grant_type offline. This parameter is only valid if grant_type is refresh_token.
1063
+ oauth2TokenResponse:
1064
+ type: object
1065
+ properties:
1066
+ access_token:
1067
+ type: string
1068
+ description: Oauth2 JWT access token.The generated token is valid 3600 seconds as default.
1069
+ token_type:
1070
+ type: string
1071
+ description: Value is Bearer
1072
+ expires_in:
1073
+ type: number
1074
+ description: 'Shows when the authentication request ID expires, in seconds.'
1075
+ scope:
1076
+ type: string
1077
+ description: List of scopes that belongs to the authentication request ID.
1078
+ refresh_token:
1079
+ type: string
1080
+ description: UUID of the refresh_token
1081
+ refresh_token_expired_in:
1082
+ type: integer
1083
+ description: 'The time in seconds until the consent can no longer be refreshed. Based on the default value for consent validity, or the value set to parameter consent_valid_in sent in the bc-authorize request.'
1084
+ consentkycResponse:
1085
+ type: object
1086
+ properties:
1087
+ sub:
1088
+ type: string
1089
+ description: Subject - Identifier for the End-User at the Issuer.
1090
+ name:
1091
+ type: string
1092
+ description: End-User's full name in displayable form including all name parts.
1093
+ given_name:
1094
+ type: string
1095
+ description: Given name(s) or first name(s) of the End-User.
1096
+ family_name:
1097
+ type: string
1098
+ description: Surname(s) or last name(s) of the End-User.
1099
+ middle_name:
1100
+ type: string
1101
+ description: Middle name(s) of the End-User.
1102
+ email:
1103
+ type: string
1104
+ description: 'End-User''s preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] address specification syntax.'
1105
+ email_verified:
1106
+ type: boolean
1107
+ description: The response value is True if the End-User's e-mail address has been verified;otherwise false.
1108
+ gender:
1109
+ type: string
1110
+ description: End-User's gender.
1111
+ locale:
1112
+ type: string
1113
+ description: Preffered language.
1114
+ phone_number:
1115
+ type: string
1116
+ description: End-User's preferred telephone number
1117
+ phone_number_verified:
1118
+ type: boolean
1119
+ description: The response value is True if the End-User's phone number has been verified; otherwise false.
1120
+ address:
1121
+ type: string
1122
+ description: User Address
1123
+ updated_at:
1124
+ type: number
1125
+ description: The time the End-User's information was last updated.
1126
+ status:
1127
+ type: string
1128
+ description: Account holder status.
1129
+ birthdate:
1130
+ type: string
1131
+ description: The birth date of the account holder.
1132
+ credit_score:
1133
+ type: string
1134
+ description: The credit score of the account holder.
1135
+ active:
1136
+ type: boolean
1137
+ description: The status of the account holder.
1138
+ country_of_birth:
1139
+ type: string
1140
+ description: Account holder country of birth.
1141
+ region_of_birth:
1142
+ type: string
1143
+ description: The birth region of the account holder.
1144
+ city_of_birth:
1145
+ type: string
1146
+ description: The city of birth for the account holder.
1147
+ occupation:
1148
+ type: string
1149
+ description: Occupation of the account holder.
1150
+ employer_name:
1151
+ type: string
1152
+ description: The name of the employer.
1153
+ identification_type:
1154
+ type: string
1155
+ description: Type of identification.The first non-expired identification is always chosen.
1156
+ identification_value:
1157
+ type: string
1158
+ description: The value of the identification.
1159
+ address:
1160
+ type: object
1161
+ properties:
1162
+ formatted:
1163
+ type: string
1164
+ description: 'Full mailing address, formatted for display or use on a mailing label. This field may contain multiple lines, separated by newlines.'
1165
+ street_address:
1166
+ type: string
1167
+ description: 'Full street address component, which may include house number, street name, Post Office Box, and multi-line extended street address information.'
1168
+ locality:
1169
+ type: string
1170
+ description: City or locality component.
1171
+ region:
1172
+ type: string
1173
+ description: 'State, province, prefecture, or region component.'
1174
+ postal_code:
1175
+ type: string
1176
+ description: Zip code or postal code component.
1177
+ country:
1178
+ type: string
1179
+ description: Country name component.
1180
+ TokenPost401ApplicationJsonResponse:
1181
+ type: object
1182
+ properties:
1183
+ error:
1184
+ type: string
1185
+ description: An error code.
1186
+ Balance:
1187
+ type: object
1188
+ properties:
1189
+ availableBalance:
1190
+ type: string
1191
+ description: The available balance of the account
1192
+ currency:
1193
+ type: string
1194
+ description: ISO4217 Currency
1195
+ description: The available balance of the account
1196
+ Party:
1197
+ type: object
1198
+ properties:
1199
+ partyIdType:
1200
+ enum:
1201
+ - MSISDN
1202
+ - EMAIL
1203
+ - PARTY_CODE
1204
+ type: string
1205
+ partyId:
1206
+ type: string
1207
+ description: 'Party identifies a account holder in the wallet platform. Party consists of two parameters, type and partyId. Each type have its own validation of the partyId<br> MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN<br> EMAIL - Validated to be a valid e-mail format. Validated with IsEmail<br> PARTY_CODE - UUID of the party. Validated with IsUuid'
1208
+ Transfer:
1209
+ type: object
1210
+ properties:
1211
+ amount:
1212
+ type: string
1213
+ description: Amount that will be debited from the payer account.
1214
+ currency:
1215
+ type: string
1216
+ description: ISO4217 Currency
1217
+ externalId:
1218
+ type: string
1219
+ description: External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.
1220
+ payee:
1221
+ $ref: '#/components/schemas/Party'
1222
+ payerMessage:
1223
+ type: string
1224
+ description: Message that will be written in the payer transaction history message field.
1225
+ payeeNote:
1226
+ type: string
1227
+ description: Message that will be written in the payee transaction history note field.
1228
+ TransferResult:
1229
+ type: object
1230
+ properties:
1231
+ amount:
1232
+ type: string
1233
+ description: Amount that will be debited from the payer account.
1234
+ currency:
1235
+ type: string
1236
+ description: ISO4217 Currency
1237
+ financialTransactionId:
1238
+ type: string
1239
+ description: Financial transactionIdd from mobile money manager.<br> Used to connect to the specific financial transaction made in the account
1240
+ externalId:
1241
+ type: string
1242
+ description: External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.
1243
+ payee:
1244
+ $ref: '#/components/schemas/Party'
1245
+ payerMessage:
1246
+ type: string
1247
+ description: Message that will be written in the payer transaction history message field.
1248
+ payeeNote:
1249
+ type: string
1250
+ description: Message that will be written in the payee transaction history note field.
1251
+ status:
1252
+ enum:
1253
+ - PENDING
1254
+ - SUCCESSFUL
1255
+ - FAILED
1256
+ type: string
1257
+ reason:
1258
+ $ref: '#/components/schemas/ErrorReason'
1259
+ CashTransfer:
1260
+ type: object
1261
+ properties:
1262
+ amount:
1263
+ type: string
1264
+ description: Amount that will be debited from the payer account.
1265
+ currency:
1266
+ type: string
1267
+ description: ISO4217 Currency
1268
+ payee:
1269
+ $ref: '#/components/schemas/Party'
1270
+ externalId:
1271
+ type: string
1272
+ description: External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.
1273
+ orginatingCountry:
1274
+ type: string
1275
+ description: Country where the request came from
1276
+ originalAmount:
1277
+ type: string
1278
+ description: Amount that was sent before any foreign exchange
1279
+ originalCurrency:
1280
+ type: string
1281
+ description: ISO4217 Currency of the originalAmoun
1282
+ payerMessage:
1283
+ type: string
1284
+ description: Message that will be written in the payer transaction history message field.
1285
+ payeeNote:
1286
+ type: string
1287
+ description: Message that will be written in the payee transaction history note field.
1288
+ payerIdentificationType:
1289
+ enum:
1290
+ - PASS
1291
+ - CPFA
1292
+ - SRSSA
1293
+ - NRIN
1294
+ - OTHR
1295
+ - DRLC
1296
+ - SOCS
1297
+ - AREG
1298
+ - IDCD
1299
+ - EMID
1300
+ type: string
1301
+ description: Identification type of the payer
1302
+ payerIdentificationNumber:
1303
+ type: string
1304
+ description: Identification number of the payer
1305
+ payerIdentity:
1306
+ type: string
1307
+ description: Identification of the payer
1308
+ payerFirstName:
1309
+ type: string
1310
+ description: FirstName
1311
+ payerSurName:
1312
+ type: string
1313
+ description: Surname
1314
+ payerLanguageCode:
1315
+ type: string
1316
+ description: LanguageCode
1317
+ payerEmail:
1318
+ type: string
1319
+ description: Email
1320
+ payerMsisdn:
1321
+ type: string
1322
+ description: Msisdn
1323
+ payerGender:
1324
+ type: string
1325
+ description: GenderCode according to ISO 20022
1326
+ CashTransferResult:
1327
+ type: object
1328
+ properties:
1329
+ financialTransactionId:
1330
+ type: string
1331
+ description: transaction id of the cash transfer.
1332
+ status:
1333
+ type: string
1334
+ description: status of the cash transfer
1335
+ reason:
1336
+ type: string
1337
+ description: contains error if one occurred
1338
+ amount:
1339
+ type: string
1340
+ description: Amount that will be debited from the payer account.
1341
+ currency:
1342
+ type: string
1343
+ description: ISO4217 Currency
1344
+ payee:
1345
+ $ref: '#/components/schemas/Party'
1346
+ externalId:
1347
+ type: string
1348
+ description: External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.
1349
+ orginatingCountry:
1350
+ type: string
1351
+ description: Country where the request came from
1352
+ originalAmount:
1353
+ type: string
1354
+ description: Amount that was sent before any foreign exchange
1355
+ originalCurrency:
1356
+ type: string
1357
+ description: ISO4217 Currency of the originalAmoun
1358
+ payerMessage:
1359
+ type: string
1360
+ description: Message that will be written in the payer transaction history message field.
1361
+ payeeNote:
1362
+ type: string
1363
+ description: Message that will be written in the payee transaction history note field.
1364
+ payerIdentificationType:
1365
+ enum:
1366
+ - PASS
1367
+ - CPFA
1368
+ - SRSSA
1369
+ - NRIN
1370
+ - OTHR
1371
+ - DRLC
1372
+ - SOCS
1373
+ - AREG
1374
+ - IDCD
1375
+ - EMID
1376
+ type: string
1377
+ description: Identification type of the payer
1378
+ payerIdentificationNumber:
1379
+ type: string
1380
+ description: Identification number of the payer
1381
+ payerIdentity:
1382
+ type: string
1383
+ description: payerIdentity number of the payer
1384
+ payerFirstName:
1385
+ type: string
1386
+ description: FirstName
1387
+ payerSurName:
1388
+ type: string
1389
+ description: Surname
1390
+ payerLanguageCode:
1391
+ type: string
1392
+ description: LanguageCode
1393
+ payerEmail:
1394
+ type: string
1395
+ description: Email
1396
+ payerMsisdn:
1397
+ type: string
1398
+ description: Msisdn
1399
+ payerGender:
1400
+ type: string
1401
+ description: GenderCode
1402
+ ErrorReason:
1403
+ type: object
1404
+ properties:
1405
+ code:
1406
+ enum:
1407
+ - PAYEE_NOT_FOUND
1408
+ - PAYER_NOT_FOUND
1409
+ - NOT_ALLOWED
1410
+ - NOT_ALLOWED_TARGET_ENVIRONMENT
1411
+ - INVALID_CALLBACK_URL_HOST
1412
+ - INVALID_CURRENCY
1413
+ - SERVICE_UNAVAILABLE
1414
+ - INTERNAL_PROCESSING_ERROR
1415
+ - NOT_ENOUGH_FUNDS
1416
+ - PAYER_LIMIT_REACHED
1417
+ - PAYEE_NOT_ALLOWED_TO_RECEIVE
1418
+ - PAYMENT_NOT_APPROVED
1419
+ - RESOURCE_NOT_FOUND
1420
+ - APPROVAL_REJECTED
1421
+ - EXPIRED
1422
+ - TRANSACTION_CANCELED.
1423
+ - RESOURCE_ALREADY_EXIST
1424
+ - TRANSACTION_NOT_COMPLETED
1425
+ - TRANSACTION_NOT_FOUND
1426
+ - INFORMATIONAL_SCOPE_INSTRUCTION
1427
+ - MISSING_SCOPE_INSTRUCTION
1428
+ - MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED
1429
+ - UNSUPPORTED_SCOPE_COMBINATION
1430
+ - CONSENT_MISMATCH
1431
+ - UNSUPPORTED_SCOPE
1432
+ - NOT_FOUND
1433
+ type: string
1434
+ message:
1435
+ type: string
1436
+ BooleanResult:
1437
+ type: object
1438
+ properties:
1439
+ result:
1440
+ type: boolean
1441
+ securitySchemes:
1442
+ apiKeyHeader:
1443
+ type: apiKey
1444
+ name: Ocp-Apim-Subscription-Key
1445
+ in: header
1446
+ apiKeyQuery:
1447
+ type: apiKey
1448
+ name: subscription-key
1449
+ in: query
1450
+ security:
1451
+ - apiKeyHeader: [ ]
1452
+ - apiKeyQuery: [ ]