-
Notifications
You must be signed in to change notification settings - Fork 0
/
v1-credit-transfers.yaml
3508 lines (3436 loc) · 154 KB
/
v1-credit-transfers.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.1
info:
title: Origix Credit Transfer V1 REST API
description: '**** GENERATED BY Origix APPLICATION ****'
termsOfService: http://sentenial.com
contact:
name: sentenial
url: http://sentenial.com
email: [email protected]
license:
name: For internal use only
url: https://sentenial.com
version: 1.0.0
x-logo:
backgroundColor: '#FFFFFF'
url: https://www.nuapay.com/wp-content/uploads/2018/04/nuapay.svg
servers:
- url: http://api.nuapay.com/
tags:
- name: Introduction
description: |2-
Welcome to the Nuapay Credit Transfer (V1) REST API. Processing Credit Transfers (CTs) via API is a simple way to integrate this payment method into your systems. This API reference provides information on available endpoints and how to interact with them.
For Credit Transfers, add the Beneficiary then add the Credit Transfer and your payment is sent out. If you're new to Credit Transfers refer to this <a href= 'https://sentenial.github.io/developer-docs/np_ctoverview.html' target='_blank' >Credit Transfer Payments Overview</a>.
- name: Getting Started
description: |2-
To register for the service and get your API key, visit <a href=' https://www.nuapay.com/request-api-sandbox/' target='_blank' >https://www.nuapay.com/request-api-sandbox/</a> or e-mail: [[email protected]](mailto:[email protected])
If you prefer to talk to someone, call 00353 (0)1 901 2398.
We'll have you up and running in no time.
- name: API Endpoints
description: |-
Once you have your API key, you can send requests to the following endpoints:
`Live: https://api.nuapay.com`
`UAT: https://sandbox.nuapay.com/`
Our APIs are RESTful and we use JSON format for submitting and retrieving data.
<!-- A note on IDs: All IDs used in URIs are encoded. IDs used in request bodies are unencoded. -->
To view all available Nuapay REST endpoints, see the [Resources](#tag/Returned-Resources) sections below.
<aside class='notice'>
If you choose to use Java to integrate with our API, then you can make use of the <a href='https://github.com/sentenial/nuapay-rest-client' target='_blank'>Nuapay Java Rest Client</a> library.
</aside>
- name: Authentication
description: |-
Access to the API is controlled by HTTP Basic authentication.
Provide your API key as the basic authentication username, encoded in Base64. No password needs to be provided, however the request must be made from an allowed IP address configured in Nuapay.
API authentication header format:
`Authorization: Basic Base64(<API_Key>:)`
All API requests must be made over HTTPS, calls made over plain HTTP will fail. All API requests must be authenticated.
<br>
> To authorize, use this code:
```bash
# With curl, you can just pass BASIC auth header
# (-u option) with each request
$ curl 'https://api.nuapay.com/beneficiaries/46pkx7o9n5/'
-u bb09c2b6a9478720765c757a8bcadf1aa1fb31554566a21118c9c75e26c29686:
```
```java
// With java client library use following code to set up your ApiKey
ServiceConfiguration serviceConfig = new ServiceConfiguration();
serviceConfig.setApiKey('bb09c2b6a9478720765c757a8bcadf1aa1fb31554566a21118c9c75e26c29686');
RetrieveMandateResponse retrieveMandateResponse =
new MandateServiceDefault(serviceConfig)
.retrieveMandate('46pkx7o9n5', '46pkx7o9n5');
```
> Make sure to replace `bb09c2b6a...` with your API key.
<br>
- name: Output Encoding Rules
description: |2-
The code converts untrusted input into a safe form where the input is displayed as data to the user without executing as code in the browser.
The implementation is based off the <a href='https://www.owasp.org/index.php/XSS_(Cross_Site_Scripting)_Prevention_Cheat_Sheet#Output_Encoding_Rules_Summary' target='_blank' >OWASP recommendations</a>.
- name: JWS-Signature Header
description: |2-
The JWS-signature header is used to verify requests made to certain endpoints, it is generated based on the request body to be sent,
a customer private key and X.509 certificate issued by Nuapay.
For details on how to generate a private key and obtaining an X.509 certificate see the security section of the <a href = 'https://sentenial.github.io/developer-docs/np_secjwsgenerator.html' target='_blank'>Developer Resource</a> pages.
The JWS-signature is required when using the following POST / PUT endpoints,
* Create Beneficiary
* Create Credit Transfer
The JWS-signature is not required for GET endpoints.
<br>
> Example JWS-Signature Header
``` json
JWS-Signature: eyJiNjQiOmZhbHNlLCJjcml0IjpbImI2NCIsImlhdCIsImlzcyJdLCJraWQiOiIxNzk2NDU1MDI1IiwiaXNzIjoiT1VcdTAwM2ROdWFwYXkgQVBJLExcdTAwM2RMb25kb24sT1x1MDAzZE51YXBheSxDXHUwMDNkR0IsQ05cdTAwM2RvbWdkMzZkcG1rIiwiYWxnIjoiUlMyNTYiLCJpYXQiOjB9..wE6Cal9Hh62YKjjD4BbQpdPc1IwtteZ-ys3aiOWJDVLFdVxnJ0pEvcsK1nfRnfiiqCOB9PbapNrpG1e3jdWA3y-bm0KphLE52PEwhWZkD-x3WeFyxAeZT_Ma7Fem08k31ifMLMPYkXAyUDUfCao4DHJQHmOWQuDawYC4lH4qtiI
```
- name: Returned Resources
description: |-
All resources returned by endpoints are contained within a resource envelope.
For single entities, the JSON envelope has the following structure:
JSON Path | Type | Description
---- | ---- | -----------
uri | String | Resource URI
data.id | String | Resource ID
data.uri | String | Resource URI
data.* | | Resource content
For collections, the JSON envelope contains the following structure:
JSON Path | Type | Description
---- | ---- | -----------
uri | String | Collection resource URI
data | Collection | Collection of resources
data[].id | String | Resource ID
data[].uri | String | Resource URI
data[].* | | Resource content
data.page | Pagination object | Meta-data related to pagination
data.sort | Sort object | Meta-data related to sorting (currently empty)
<aside class='warning'>
NOTE: <strong>data.id</strong> is a Resource ID that is used as an URI parameter. When building the URI to view or update resource the id is to be used. <strong>data.uri</strong> contains ready to use URI of the resource returned.
</aside>
<br>
> Example response with single entity
``` json
{
'uri' : '/files/23qzxn1f7m',
'data' : {
'id' : '23qzxn1f7m',
'uri' : '/files/23qzxn1f7m',
'originalFileName': 'originalFileName.xml',
'newFileName': 'newFileName.xml.QUEUED'
}
}
```
> Example response with collection
``` json
{
'uri' : '/schemes/8g3o2yyk2w/mandates',
'data' : [ {
'id' : '46pkxn8e9n',
'uri' : '/schemes/8g3o2yyk2w/mandates/46pkxn8e9n',
'mandateId' : 'b8b7ee91-b403-4ecb-9d98-059746dd8149',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
}
],
'page' : {
'pageNumber' : 1,
'pageSize' : 1,
'totalElements' : 1,
'totalPages' : 1
},
'sort' : [ ]
}
```
- name: Resource IDs
description: |-
The ID is part of resource URI and in this documentation is marked as such by placing it between curly brackets. Sample scheme resource URI is `/beneficiaries/{beneficiaryId}/credittransfers/{credittransferId}` where `beneficiaryId` and `credittransferId` are the Beneficiary and Credit Transfer Resource IDs accordingly.
<aside class='warning'>
NOTE: Resource ID is not a business identifier, it is a technical ID assigned during the POST of a new resource and is available in the response ID property. This ID can then be used to query the resource.
</aside>
<aside class='notice'>
NOTE: <strong>data.uri</strong> is a Resource URI that contains related Resource IDs as well. For complex URIs, where the Resource belongs to another Resource, the <strong>data.uri</strong> element returns ready to use URI containing all related Resource IDs
</aside>
[Returned Resources](#tag/Returned-Resources) `data[].id` element contains the Resource ID. In above example [Credit Transfer Resource](#operation/listCreditTransfersBeneficiaryUsingGET) needs to be retrieved to get the `creditTransferId` and [Beneficiaries Resource](#operation/listBeneficiariesUsingGET) needs to be retrieved to get `beneficiaryId`.
- name: Links
- name: Credit Transfers
description: |-
Credit tranfers are the financial transactions associated to the beneficiary.
To access credit transfers use the following URL:
`https://api.nuapay.com/beneficiaries/{beneficiaryId}/credittransfers/{creditTransferId}`
where
* `beneficiaryId`, is the Beneficiary resource ID returned by a variety of beneficiary services including: [Create Beneficiary](#operation/addBeneficiaryUsingPOST), [List Beneficiaries](#operation/listBeneficiariesUsingGET), [Retrieve Beneficiary](#operation/viewBeneficiaryUsingGET)
* `creditTransferId`, is the Credit Transfer resource ID returned by a variety of credit transfers services including: [Create Credit Transfer](#operation/addCreditTransferUsingPOST), [Retrieve Credit Transfer](#operation/viewCreditTransferUsingGET)
- name: Beneficiaries
description: |-
Beneficiaries are the Credit Transfer receivers, also known as the payees or creditors. They enable the funds transfer from the debtor's (Originator/Merchant) account to a creditor's account via Credit Transfer.
To access a beneficiary use the following URL:
`https://api.nuapay.com/beneficiaries/{beneficiaryId}`
where
`beneficiaryId`, is the resource ID returned by [List Beneficiaries](#operation/listBeneficiariesUsingGET)
- name: About Responses
description: |-
Every API Request will generate a HTTP Response. This will contain a HTTP Response Code to indicate the status of the Request. In addition certain HTTP Responses (400, 422) may generate an Error Response with an Error Code.
- name: HTTP Status Codes
description: |2-
You may encounter the following response codes. Selected response codes will contain more information to help identify problems.
<nobr>Status Code</nobr> | Usage
---------- | -------
200 | OK -- The request completed successfully.
201 | Created -- A new resource has been created successfully. The resource is appended to the response.
400 | Bad Request -- The request was malformed. The response body will include an error providing further information.
401 | Unauthorized -- Your API key is wrong.
403 | Forbidden -- The client has provided a valid Authentication header, but it does not have permission to access this resource.
404 | Not Found -- The requested resource did not exist.
405 | Method Not Allowed -- When a HTTP method is being requested that isn't allowed.
410 | Gone -- The API requested has been removed from our servers.
412 | Precondition Failed -- Certain unmet conditions must be fulfilled before the request to be processed e.g. timestamp is too old.
415 | Unsupported Media Type -- If incorrect content type was provided as part of the request (e.g. other than 'application/json').
422 | Unprocessable Entity -- Used for validation errors. More details will be provided in response body.
429 | Too Many Requests -- Status code indicates the user has sent too many requests in a given amount of time.
500 | Internal Server Error -- We had a problem with our server. Try again later and if the problem persists contact the Nuapay application support team.
501 | Not Implemented -- When the endpoint is not implemented yet.
503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later.
- name: Errors
description: |-
Whenever an error response with status `400` or `422` is returned, the body will contain a JSON object that describes the problem. The error object has the following structure:
Path | Type | Description
---- | --------- | -----------
returnCode | String | Error Code
returnDescription | String | Error description
details | Array | The object holds collection of validation errors. It is returned only for `returnCode` equal to `8888`,`9999`.
details[].code | String | Error Code
details[].field | String | JSON path to request object property the error is related to
details[].description | Error description |
details[].resourceUri | String | This property holds existing resource URI in case the validation error states the resource already exist and can't be created. It is returned only for `returnCode` equal to `9999`.
See [Error Codes](#tag/Error-Codes) section for details.
<br>
> For example, a request that attempts to create a payment schedule with invalid start date will produce a
`400 Bad Request` response:
``` http
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
'returnCode' : '7043',
'returnDescription' : 'Start date is invalid'
}
```
- name: Error Codes
description: |-
Following is the list of error codes with description as a possible return when request failed:
Code | Description
---- | -----------
5001 | Invalid Beneficiary Account Details <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5002 | Duplicate Beneficiary Account Details Provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5004 | Beneficiary Country Required if any other Address element is provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5005 | Invalid Beneficiary e-mail address provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5006 | Payment Amount Invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5007 | Originator Account provided does not exist <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5008 | Invalid Payment Reference <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5009 | Invalid Date for Payment <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5014 | Transfer Failed. Please try again later <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5015 | Transfer Failed. Please contact support <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5016 | Insufficient Funds <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5017 | Originator account currency does not match payment currency <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7001 | Date format invalid <em>[List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7002 | 'From Date ' must be earlier or equal to 'To Date' <em>[List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7011 | Address Line1 is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7012 | Address Line2 is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7013 | Address Town is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7014 | Address Postal Code is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7015 | Address State is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7016 | Address ISO Country Code is invalid <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7019 | Phone Number is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7020 | Mobile Number is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7052 | Page size is invalid <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET), [List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7063 | Payment Status is invalid <em>[List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7081 | Beneficiary IBAN is invalid <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7082 | Beneficiary Bank BIC is invalid <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7083 | Beneficiary Account IBAN is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7084 | Beneficiary object is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7085 | Beneficiary Account object is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7086 | Beneficiary Name is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7087 | Beneficiary Bank BIC is required if External Account Validation is OFF <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7088 | Beneficiary Language is invalid <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7089 | Beneficiary Email is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7090 | Requested Execution Date is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7091 | Originator IBAN is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7092 | Payment Currency is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7093 | Payment Currency is invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7094 | Beneficiary account is not reachable for GBP currency <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7096 | Description of Purpose is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7100 | Beneficiary Name is invalid or max length is exceeded <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [Create beneficiary](#operation/addBeneficiaryUsingPOST), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7111 | Originator IBAN is invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7112 | Insufficient Funds <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7113 | Transfer Failed. Please try again later <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7114 | Transfer Failed. Please contact support <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7125 | Requested execution date is in the past <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7126 | Requested execution date is not a working day <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7127 | Requested execution date is today and Cut-off time has passed <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7130 | Beneficiary Bank BIC is required as Beneficiary Bank is located in a NON-EEA Country <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7131 | Field is invalid or max length is exceeded <em>[Create account](#operation/addAccountUsingPOST), [List accounts](#operation/listAccountsUsingPOST), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7146 | Transfer not allowed for current Originator configuration. <em>[Create transfer](#operation/transferUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7148 | The Execution Date must be set to today's date. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7152 | Payment amount exceeds max allowed scheme limit. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7153 | Requested payment type is not supported by Originator. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7154 | Originator Bank BIC is required for EXPRESS payments. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7155 | Beneficiary Bank BIC is required for EXPRESS payments <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7156 | Beneficiary account is not reachable for requested payment type <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7157 | Original transaction has not been found
7158 | Either originatorIban or originatorAccount object is allowed. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7159 | Either Iban or Domestic Account is allowed. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7160 | Domestic Bank Code is required for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7161 | Domestic Bank Code is not allowed for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7162 | Domestic Branch Code is required for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7163 | Domestic Branch Code is not allowed for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7164 | Domestic Checksum is required for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7165 | Domestic Checksum is not allowed for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7167 | Credit transfer not available from this account. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7168 | Credit transfer not allowed at the moment due to account settlement. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7169 | Requested Execution Date is not far enough in the future <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7170 | End to End ID invalid, for GBP Standard payments must follow [A-Z0-9-/.& ]{0,18} <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7200 | JWS-Signature header is required. <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7201 | JWS-Signature is invalid. <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7203 | Field is invalid or max length is exeeded <em>Multiple endpoints. <em>Response details.field indicates the request property the error is related to</em>
5001 | Invalid Beneficiary Account Details <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5002 | Duplicate Beneficiary Account Details Provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5004 | Beneficiary Country Required if any other Address element is provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5005 | Invalid Beneficiary e-mail address provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
5006 | Payment Amount Invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5007 | Originator Account provided does not exist <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5008 | Invalid Payment Reference <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5009 | Invalid Date for Payment <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5014 | Transfer Failed. Please try again later <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5015 | Transfer Failed. Please contact support <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5016 | Insufficient Funds <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
5017 | Originator account currency does not match payment currency <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7001 | Date format invalid <em>[List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7002 | 'From Date ' must be earlier or equal to 'To Date' <em>[List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7011 | Address Line1 is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7012 | Address Line2 is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7013 | Address Town is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7014 | Address Postal Code is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7015 | Address State is invalid or max length is exceeded <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7016 | Address ISO Country Code is invalid <em> [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7019 | Phone Number is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7020 | Mobile Number is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7050 | Page Number is invalid <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET), [List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7051 | Max page size is exceeded <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET), [List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7052 | Page size is invalid <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET), [List Transactions](#operation/listTransactionsUsingPOSTs)</em>
7063 | Payment Status is invalid <em>[List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7081 | Beneficiary IBAN is invalid <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7082 | Beneficiary Bank BIC is invalid <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7083 | Beneficiary Account IBAN is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7084 | Beneficiary object is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7085 | Beneficiary Account object is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7086 | Beneficiary Name is required <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7087 | Beneficiary Bank BIC is required if External Account Validation is OFF <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7088 | Beneficiary Language is invalid <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7089 | Beneficiary Email is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7090 | Requested Execution Date is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7091 | Originator IBAN is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7092 | Payment Currency is required <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7093 | Payment Currency is invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7094 | Beneficiary account is not reachable for GBP currency <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7096 | Description of Purpose is invalid or max length is exceeded <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7100 | Beneficiary Name is invalid or max length is exceeded <em>[List beneficiaries](#operation/listBeneficiariesUsingGET), [Create beneficiary](#operation/addBeneficiaryUsingPOST), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7111 | Originator IBAN is invalid <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7112 | Insufficient Funds <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7113 | Transfer Failed. Please try again later <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7114 | Transfer Failed. Please contact support <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7125 | Requested execution date is in the past <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7126 | Requested execution date is not a working day <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7127 | Requested execution date is today and Cut-off time has passed <em>[Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7130 | Beneficiary Bank BIC is required as Beneficiary Bank is located in a NON-EEA Country <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST)</em>
7131 | Field is invalid or max length is exceeded <em>[Create account](#operation/addAccountUsingPOST), [List accounts](#operation/listAccountsUsingPOST), [List credit transfers](#operation/listCreditTransfersBeneficiaryUsingGET)</em>
7146 | Transfer not allowed for current Originator configuration. <em>[Create transfer](#operation/transferUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7148 | The Execution Date must be set to today's date. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7152 | Payment amount exceeds max allowed scheme limit. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7153 | Requested payment type is not supported by Originator. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7154 | Originator Bank BIC is required for EXPRESS payments. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7155 | Beneficiary Bank BIC is required for EXPRESS payments <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7156 | Beneficiary account is not reachable for requested payment type <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7157 | Original transaction has not been found
7158 | Either originatorIban or originatorAccount object is allowed. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7159 | Either Iban or Domestic Account is allowed. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7160 | Domestic Bank Code is required for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7161 | Domestic Bank Code is not allowed for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7162 | Domestic Branch Code is required for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7163 | Domestic Branch Code is not allowed for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7164 | Domestic Checksum is required for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7165 | Domestic Checksum is not allowed for provided Account Country. <em>Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7167 | Credit transfer not available from this account. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7168 | Credit transfer not allowed at the moment due to account settlement. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7169 | Requested Execution Date is not far enough in the future <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7170 | End to End ID invalid, for GBP Standard payments must follow [A-Z0-9-/.& ]{0,18} <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7173 | Address Street Name is invalid or max length is exceeded
7174 | Address Building Number is invalid or max length is exceeded
7175 | Type is invalid, must be one of the allowed values from the ENUM
7200 | JWS-Signature header is required. <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7201 | JWS-Signature is invalid. <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create credit transfer](#operation/addCreditTransferUsingPOST)</em>
7203 | Field is invalid or max length is exeeded <em>Multiple endpoints. <em>Response details.field indicates the request property the error is related to</em>
7300 | UltimateParty Name' is invalid or max length is exceeded. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7301 | UltimateParty Other SchemeName Code' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7302 | UltimateParty Other SchemeName Proprietary' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7303 | UltimateParty Other ID' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7304 | UltimateParty Other Issuer' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7305 | UltimateParty OrganisationId BicorBei' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7306 | UltimateParty PrivateId BirthDate' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7307 | UltimateParty PrivateId BirthDate' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7308 | UltimateParty PrivateId CityOfBirth' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7309 | UltimateParty PrivateId CountryOfBirth' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7310 | UltimateParty PrivateId CountryOfBirth' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7330 | UltimateCreditor either 'organisationId' or 'privateId' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7331 | UltimateCreditor OrganisationId either 'bicOrBei' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7332 | UltimateCreditor OrganisationId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7333 | UltimateCreditor PrivateId either 'dateAndPlaceOfBirth' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7334 | UltimateCreditor PrivateId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7335 | UltimateDebtor either 'organisationId' or 'privateId' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7336 | UltimateDebtor OrganisationId either 'bicOrBei' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7337 | UltimateDebtor OrganisationId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7338 | UltimateDebtor PrivateId either 'dateAndPlaceOfBirth' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7339 | UltimateDebtor PrivateId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7340 | UltimateParty Other ID' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7341 | UltimateParty PrivateId CityOfBirth' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7300 | UltimateParty Name' is invalid or max length is exceeded. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7301 | UltimateParty Other SchemeName Code' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7302 | UltimateParty Other SchemeName Proprietary' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7303 | UltimateParty Other ID' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7304 | UltimateParty Other Issuer' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7305 | UltimateParty OrganisationId BicorBei' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7306 | UltimateParty PrivateId BirthDate' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7307 | UltimateParty PrivateId BirthDate' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7308 | UltimateParty PrivateId CityOfBirth' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7309 | UltimateParty PrivateId CountryOfBirth' is Invalid. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7310 | UltimateParty PrivateId CountryOfBirth' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7330 | UltimateCreditor either 'organisationId' or 'privateId' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7331 | UltimateCreditor OrganisationId either 'bicOrBei' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7332 | UltimateCreditor OrganisationId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7333 | UltimateCreditor PrivateId either 'dateAndPlaceOfBirth' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7334 | UltimateCreditor PrivateId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7335 | UltimateDebtor either 'organisationId' or 'privateId' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7336 | UltimateDebtor OrganisationId either 'bicOrBei' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7337 | UltimateDebtor OrganisationId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7338 | UltimateDebtor PrivateId either 'dateAndPlaceOfBirth' or 'other' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7339 | UltimateDebtor PrivateId Other SchemeName either 'code' or 'proprietary' is allowed. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7340 | UltimateParty Other ID' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7341 | UltimateParty PrivateId CityOfBirth' is required. <em>[Create credit transfer](#operation/addCreditTransferUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7359 | Provided Account Verification is not in a valid status, status is Pending <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7360 | Provided Account Verification is not in a valid status, status is Failed <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7361 | Failed to retrieve Account Verification, please try again later <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7362 | Account from the Account Verification does not match Beneficiary account Provided <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
7363 | Verification method must be 'ACCOUNT_HOLDER_VERIFICATION' when linking a verification to a beneficiary <em>[Create beneficiary](#operation/addBeneficiaryUsingPOST), [Create Credit Transfer and Beneficiary](#operation/addCreditTransferUsingPOST-and-beneficiary)</em>
- name: Pagination
description: |-
Nuapay API utilizes offset-based pagination for endpoints returning a collection of resources.
Pagination parameters can be passed in URI for GET requests and in Body in POST requests.
To control pagination, simply include either of 'Page Number' and 'Page Size' parameters in a request. In the supported responses there will always be a page section added, describing the pagination settings used.
<aside class='notice'>
NOTE: the default value for Page Size is 20 and the maximum value you can set is 100.
</aside>
<br>
# In URI
There are two parameters that control pagination: `pagenumber`, which specifies the page number to retrieve, and `pagesize`, which indicates how many records each page should contain.
<br>
# In Body
Path | Type | Description
---- | ---- | -----------
page.pageNumber<em>required</em>| Number | Holds page number to be returned. Default: 1
page.pageSize<em>required</em>| Number | Holds page size to be returned. Default: 20
<br>
> e.g. show the 1st page with a maximum of 10 entries per page from all of the available mandates:
```bash
$ curl 'https://api.nuapay.com/schemes/46pkx7o9n5/mandates/?pagesize=10&pagenumber=1' \
-u bb09c2b6a9478720765c757a8bcadf1aa1fb31554566a21118c9c75e26c29686: \
```
``` java
ListMandatesRequestParameters listMandatesRequestParameters =
new ListMandatesRequestParameters();
listMandatesRequestParameters.setPageSize(10);
listMandatesRequestParameters.setPageNumber(1);
ListMandatesResponse listMandatesResponse =
mandateService.listMandates('46pkx7o9n5', listMandatesRequestParameters);
```
> the response will be:
``` http
HTTP/1.1 200 OK
Content-Type: application/json
{
'uri' : '/schemes/46pkx7o9n5/mandates',
'data' : [ {
'id' : '46pkxn8e9n',
'uri' : '/schemes/8g3o2yyk2w/mandates/46pkxn8e9n',
'mandateId' : 'b8b7ee91-b403-4ecb-9d98-059746dd8149',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
}, {
'id' : 'nx9kndaejm',
'uri' : '/schemes/8g3o2yyk2w/mandates/nx9kndaejm',
'mandateId' : 'a04ee152-505d-4125-b671-5c5318b53842',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
}, {
'id' : 'vw7kj9gey5',
'uri' : '/schemes/8g3o2yyk2w/mandates/vw7kj9gey5',
'mandateId' : '79839287-54d8-4fab-99cc-cf1808b7a766',
'debtorName' : 'Debtor Name',
'debtorIBAN' : 'GB94SELN00999976543215',
'debtorMobileNumber' : '0360321312312',
'mandateStatus' : 'ACTIVE',
'creationDate' : '2015-07-21'
} ],
'page' : {
'pageNumber' : 1,
'pageSize' : 3,
'totalElements' : 3,
'totalPages' : 1
},
'sort' : [ ]
}
```
- name: Current Version
description: |-
The current version of the Nuapay API is version 1.0. Changes may occur to this version of the API without a change in version number if such a change follows our backwards compatibility guidelines. Different versions will be managed via a HTTP header indicating the version of the API which the client is using.
Requests with no version number or an unmatched version number will be treated as version 1.0 requests.
- name: Backwards Compatibility
description: |-
The following changes are considered backwards compatible:
* Adding new API endpoints, new endpoints are independent,
* Adding new optional request parameters to existing API calls,
* Adding new response properties to existing API calls. You should pay particular attention to this point if you are mapping your JSON responses to another programming language construct,
* Changing of the property order in existing API responses,
* Changing the length of object IDs (object IDs will never exceed 255 characters),
* Changing the messages returned by validation or other error messages,
* Output Encoding Rules are applied to some services and will be applied to all services in the future.
- name: Changelog
description: |-
## 2023-12-04
* API Initial Version
paths:
/accounts/{accountId}/credittransfers/list:
post:
tags:
- Credit Transfers
summary: List Credit Transfers for Account
description: |-
A POST request used to retrieve a list of credit transfers for a given account in secured way. Request parameters to be passed in the JSON body object.
A request must contain the application/json content type.
Important Note: Since this is a POST endpoint with only optional parameters when not providing any parameters user must supply an empty JSON body using {}.
operationId: listCreditTransfersForAccountUsingPOST
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: false
schema:
type: string
- name: Idempotency-Key
in: header
x-sentenial:
enriched: "true"
description: Every request will be processed only once per Idempotency-Key. The Idempotency Key will be valid for 24 hours.
required: false
schema:
type: string
maxLength: 50
- name: accountId
in: path
description: Encoded Account Id of the account to list credit transfers from.
required: true
schema:
type: string
requestBody:
description: listCreditTransfersAccountRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ListCreditTransferPostRequestEntity'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RestPaginatedCollectionResponseEnvelopeOfCreditTransferResponseEntity"
example:
uri: /accounts/w24y3dya2p/credittransfers/list
data:
- id: j29pjrvdbx
uri: /beneficiaries/j29pjqknbx/credittransfers/j29pjrvdbx
originatorIban: GB25SELN00999988796624
originatorAccount:
iban: GB25SELN00999988796624
bic: SELNGB21
domesticAccountNumber: "88796624"
domesticBankCode: null
domesticBranchCode: "009999"
domesticCheckSum: null
domesticAccountCountry: GB
requestedExecutionDate: "2018-10-27"
paymentAmount: 5000.01
paymentCurrency: EUR
endToEndId: "563456456"
remittanceInformation: Remittance info
paymentStatus: ACCEPTED
type: STANDARD
paymentScheme: SCT
ultimateCreditor: null
ultimateDebtor: null
beneficiaryName: Beneficiary Name
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: "12345678"
domesticBankCode: null
domesticBranchCode: "009999"
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
rejectDetails:
rejectReason: null,
rejectDescription: null,
rejectType: null,
rejectDate: null
originalBeneficiaryAccount:
iban: null,
domesticAccountNumber: null,
domesticBankCode: null,
domesticBranchCode: null,
domesticCheckSum: null,
domesticAccountCountry: null,
bic: null
links: []
page:
pageNumber: 1
pageSize: 1
totalElements: 1
totalPages: 1
sort: []
400:
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
returnCode: "8888"
returnDescription: Input validation errors occurred. Please check details.
details:
- code: "7001"
field: "filter.executionDateFrom"
description: Date format invalid
resourceUri: null
401:
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
application/json:
returnCode: null
returnDescription: null
details: null
403:
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
application/json:
returnCode: "10091"
returnDescription: Access denied
details: null
404:
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
application/json:
returnCode: "10093"
returnDescription: Requested resource is not available
details: null
405:
description: Method Not Allowed
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
application/json:
returnCode: null
returnDescription: null
details: null
415:
description: Unsupported Media Type
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
application/json:
returnCode: null
returnDescription: null
details: null
422:
description: Unprocessable Entity
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
application/json:
returnCode: "9999"
returnDescription: "Input validation errors occurred. Please check details."
details:
- code: "7002"
description: "'From Date' must be earlier or equal to 'To Date'"
resourceUri: null
429:
description: Too Many Requests
x-sentenial:
enriched: "true"
headers:
X-Rate-Limit-Reset:
description: Number in seconds to wait before retrying request.
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
application/json:
returnCode: null
returnDescription: null
details: null
security:
- MerchantOAuth2:
- credittransfers_read
- MerchantApiKey: []
/beneficiaries:
get:
tags:
- Beneficiaries
summary: List Beneficiaries
description: A GET request used to retrieve a collection of beneficiaries. It can return beneficiaries associated to an organization.
operationId: listBeneficiariesUsingGET
parameters:
- name: beneficiaryiban
in: query
description: Beneficiary IBAN.
schema:
pattern: "[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
type: string
- name: beneficiaryname
in: query
description: "Name of Beneficiary. Used to filter credit transfers with provided beneficiary name, full and partial names are supported."
schema:
maxLength: 70
type: string
- name: orderby
in: query
schema:
type: string
- name: pagenumber
in: query
description: "Holds page number to be returned. Default: 1"
schema:
type: integer
format: int32
default: 1
- name: pagesize
in: query
description: "Holds page size to be returned. Default: 20"
schema:
type: integer
format: int32
default: 20
- name: usercreatedbeneficiary
in: query
schema:
type: boolean
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestPaginatedCollectionResponseEnvelopeOfListBeneficiaryResponseEntity'
example:
uri: /beneficiaries
data:
- id: w24y3olz2p
uri: /beneficiaries/w24y3olz2p
beneficiary:
name: Beneficiary Name
address:
line1: Beneficiary Address Line1
line2: Beneficiary Address Line2
town: Beneficiary Town
postCode: "123123"
state: Beneficiary State
country: IE
language: en
email: [email protected]
mobileNumber: "0360321321321"
phoneNumber: "0360123123123"
descriptionOfPurpose: Description of Purpose
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: "12345678"
domesticBankCode: null
domesticBranchCode: "009999"
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
- id: abxq9jak2l
uri: /beneficiaries/abxq9jak2l
beneficiary:
name: Beneficiary Name
address:
line1: Beneficiary Address Line1
line2: Beneficiary Address Line2
town: Beneficiary Town
postCode: "123123"
state: Beneficiary State
country: IE
language: en
email: [email protected]
mobileNumber: "0360321321321"
phoneNumber: "0360123123123"
descriptionOfPurpose: Description of Purpose
beneficiaryAccount:
iban: GB47SELN00999912345678
domesticAccountNumber: "12345678"
domesticBankCode: null
domesticBranchCode: "009999"
domesticCheckSum: null
domesticAccountCountry: GB
bic: SELNGB21
page:
pageNumber: 1
pageSize: 20
totalElements: 2
totalPages: 1
sort: []
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
returnCode: "7100"
returnDescription: Beneficiary Name is invalid or max length is exceeded
details: null
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
returnCode: null
returnDescription: null
details: null
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
returnCode: "10091"
returnDescription: Access denied
details: null
"404":
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
returnCode: "10093"
returnDescription: Requested resource is not available
details: null
"405":
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
returnCode: null
returnDescription: null
details: null
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
returnCode: "7051"
returnDescription: Max page size is exceeded
details: null
"429":
description: Too Many Requests
headers:
X-Rate-Limit-Reset:
description: Number in seconds to wait before retrying request.
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
returnCode: null
returnDescription: null
details: null
x-sentenial:
enriched: "true"
security:
- MerchantOAuth2:
- beneficiaries_read
- MerchantApiKey: []
post:
tags:
- Beneficiaries
summary: Create Beneficiary
description: A POST request used to create beneficiaries. The request must contain the application/json content type. In the request body you must provide a JSON structure describing the Beneficiary.
operationId: addBeneficiaryUsingPOST
parameters:
- name: JWS-Signature
in: header
description: JWS-Signature
required: true
schema:
type: string
- name: Idempotency-Key
in: header
description: Every request will be processed only once per Idempotency-Key. The Idempotency Key will be valid for 24 hours.
schema:
maxLength: 50
type: string
requestBody:
description: "Note: For the beneficiary account information use either IBAN & BIC or Domestic Account details, not both."
content: