@mojaloop/api-snippets 17.2.0 → 17.2.4

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.
@@ -4,65 +4,103 @@
4
4
  */
5
5
  export interface paths {
6
6
  "/": {
7
+ /** Health check endpoint. */
7
8
  get: operations["BackendHealthCheck"];
8
9
  };
9
10
  "/bulkQuotes": {
11
+ /** Requests a bulk quote. */
10
12
  post: operations["BackendBulkQuotesPost"];
11
13
  };
12
14
  "/bulkQuotes/{idValue}": {
15
+ /** Requests information relating to a bulk quote identified by the specified identifier value. */
13
16
  get: operations["BackendBulkQuotesGet"];
14
17
  };
15
18
  "/bulkTransactions/{bulkTransactionId}": {
16
- /** The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer. */
19
+ /**
20
+ * Callbacks for the bulk transaction request.
21
+ * @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
22
+ */
17
23
  put: operations["BackendBulkTransactionsPut"];
18
24
  };
19
25
  "/requestToPay/{transactionRequestId}": {
20
- /** It is used to notify the DFSP backend about the status of the requestToPayTransfer. */
26
+ /**
27
+ * Callback for the requestToPay request.
28
+ * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer.
29
+ */
21
30
  put: operations["RequestToPayPut"];
22
31
  };
23
32
  "/bulkTransfers": {
33
+ /** Execute bulk transfer of funds from an external account to internal accounts. */
24
34
  post: operations["BackendBulkTransfersPost"];
25
35
  };
26
36
  "/bulkTransfers/{idValue}": {
37
+ /** Requests information relating to a bulk transfer identified by the specified identifier value. */
27
38
  get: operations["BackendBulkTransfersGet"];
28
39
  };
29
40
  "/otp/{transactionRequestId}": {
41
+ /** Requests OTP. */
30
42
  get: operations["BackendOtpGet"];
31
43
  };
32
44
  "/participants/{idType}/{idValue}": {
33
- /** The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. */
45
+ /**
46
+ * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
47
+ * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
48
+ */
34
49
  get: operations["BackendParticipantsGetByTypeAndID"];
35
50
  };
36
51
  "/participants/{idType}/{idValue}/{idSubValue}": {
37
- /** The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. */
52
+ /**
53
+ * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
54
+ * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
55
+ */
38
56
  get: operations["BackendParticipantsGetByTypeIDAndSubId"];
39
57
  };
40
58
  "/parties/{idType}/{idValue}": {
41
- /** The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. */
59
+ /**
60
+ * Requests information relating to a transfer party identified by the specified identifier type and value.
61
+ * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
62
+ */
42
63
  get: operations["BackendPartiesGetByTypeAndID"];
43
64
  };
44
65
  "/parties/{idType}/{idValue}/{idSubValue}": {
45
- /** The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. */
66
+ /**
67
+ * Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
68
+ * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
69
+ */
46
70
  get: operations["BackendPartiesGetByTypeIdAndSubId"];
47
71
  };
48
72
  "/quoterequests": {
49
- /** The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. */
73
+ /**
74
+ * Requests a quote for the specified transfer.
75
+ * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
76
+ */
50
77
  post: operations["BackendQuoteRequest"];
51
78
  };
52
79
  "/transactionrequests": {
80
+ /** Transaction request that supports pull based transfers. */
53
81
  post: operations["BackendTransactionRequest"];
54
82
  };
55
83
  "/transfers": {
56
- /** The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. */
84
+ /**
85
+ * Transfers funds from an external account to an internal account.
86
+ * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
87
+ */
57
88
  post: operations["BackendTransfersPost"];
58
89
  };
59
90
  "/transfers/{transferId}": {
60
- /** The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer. */
91
+ /**
92
+ * Retrieves information for a specific transfer.
93
+ * @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
94
+ */
61
95
  get: operations["BackendTransfersGet"];
62
- /** The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. */
96
+ /**
97
+ * Receive notification for a specific transfer.
98
+ * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
99
+ */
63
100
  put: operations["BackendTransfersPut"];
64
101
  };
65
102
  }
103
+ export type webhooks = Record<string, never>;
66
104
  export interface components {
67
105
  schemas: {
68
106
  /**
@@ -251,60 +289,34 @@ export interface components {
251
289
  transferState: components["schemas"]["transferState"];
252
290
  };
253
291
  fulfil?: {
254
- body?: {
255
- [key: string]: unknown;
256
- };
257
- headers?: {
258
- [key: string]: unknown;
259
- };
292
+ body?: Record<string, never>;
293
+ headers?: Record<string, never>;
260
294
  };
261
295
  initiatedTimestamp?: components["schemas"]["timestamp"];
262
296
  lastError?: components["schemas"]["transferError"];
263
297
  prepare?: {
264
- body?: {
265
- [key: string]: unknown;
266
- };
267
- headers?: {
268
- [key: string]: unknown;
269
- };
298
+ body?: Record<string, never>;
299
+ headers?: Record<string, never>;
270
300
  };
271
301
  quote?: {
272
302
  fulfilment?: string;
273
- internalRequest?: {
274
- [key: string]: unknown;
275
- };
276
- mojaloopResponse?: {
277
- [key: string]: unknown;
278
- };
279
- request?: {
280
- [key: string]: unknown;
281
- };
282
- response?: {
283
- [key: string]: unknown;
284
- };
303
+ internalRequest?: Record<string, never>;
304
+ mojaloopResponse?: Record<string, never>;
305
+ request?: Record<string, never>;
306
+ response?: Record<string, never>;
285
307
  };
286
308
  quoteRequest?: {
287
- body?: {
288
- [key: string]: unknown;
289
- };
290
- headers?: {
291
- [key: string]: unknown;
292
- };
309
+ body?: Record<string, never>;
310
+ headers?: Record<string, never>;
293
311
  };
294
312
  quoteResponse?: {
295
- body?: {
296
- [key: string]: unknown;
297
- };
298
- headers?: {
299
- [key: string]: unknown;
300
- };
313
+ body?: Record<string, never>;
314
+ headers?: Record<string, never>;
301
315
  };
302
316
  transferId?: components["schemas"]["transferId"];
303
317
  };
304
318
  /** @description This object may represent a number of different error object types and so its properties may vary significantly. */
305
- generalError: {
306
- [key: string]: unknown;
307
- };
319
+ generalError: Record<string, never>;
308
320
  /** @description Indicates the geographic location from where the transaction was initiated. */
309
321
  geoCode: {
310
322
  latitude: components["schemas"]["latitude"];
@@ -829,15 +841,17 @@ export interface components {
829
841
  AuthenticationType: "OTP" | "QRCODE" | "U2F";
830
842
  };
831
843
  responses: {
832
- /** Malformed or missing required headers or parameters. */
844
+ /** @description Malformed or missing required headers or parameters. */
833
845
  400: {
834
846
  content: {
835
847
  "application/json": components["schemas"]["errorResponse"];
836
848
  };
837
849
  };
838
- /** The party specified by the provided identifier type and value is not known to the server. */
839
- 404: unknown;
840
- /** An error occurred processing the request. */
850
+ /** @description The party specified by the provided identifier type and value is not known to the server. */
851
+ 404: {
852
+ content: never;
853
+ };
854
+ /** @description An error occurred processing the request. */
841
855
  500: {
842
856
  content: {
843
857
  "application/json": components["schemas"]["errorResponse"];
@@ -856,17 +870,32 @@ export interface components {
856
870
  /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
857
871
  bulkTransactionId: components["schemas"]["CorrelationId"];
858
872
  };
873
+ requestBodies: never;
874
+ headers: never;
875
+ pathItems: never;
859
876
  }
877
+ export type $defs = Record<string, never>;
878
+ export type external = Record<string, never>;
860
879
  export interface operations {
880
+ /** Health check endpoint. */
861
881
  BackendHealthCheck: {
862
882
  responses: {
863
- /** Returns empty body if the service is running. */
864
- 200: unknown;
883
+ /** @description Returns empty body if the service is running. */
884
+ 200: {
885
+ content: never;
886
+ };
865
887
  };
866
888
  };
889
+ /** Requests a bulk quote. */
867
890
  BackendBulkQuotesPost: {
891
+ /** @description Incoming request for a bulk quotation. */
892
+ requestBody?: {
893
+ content: {
894
+ "application/json": components["schemas"]["bulkQuoteRequest"];
895
+ };
896
+ };
868
897
  responses: {
869
- /** A response to the bulk quote request. */
898
+ /** @description A response to the bulk quote request. */
870
899
  200: {
871
900
  content: {
872
901
  "application/json": components["schemas"]["bulkQuoteResponse"];
@@ -875,22 +904,16 @@ export interface operations {
875
904
  400: components["responses"]["400"];
876
905
  500: components["responses"]["500"];
877
906
  };
878
- /** Incoming request for a bulk quotation. */
879
- requestBody: {
880
- content: {
881
- "application/json": components["schemas"]["bulkQuoteRequest"];
882
- };
883
- };
884
907
  };
908
+ /** Requests information relating to a bulk quote identified by the specified identifier value. */
885
909
  BackendBulkQuotesGet: {
886
910
  parameters: {
887
911
  path: {
888
- /** The identifier value. */
889
912
  idValue: components["parameters"]["idValue"];
890
913
  };
891
914
  };
892
915
  responses: {
893
- /** Response containing details of the requested bulk quote. */
916
+ /** @description Response containing details of the requested bulk quote. */
894
917
  200: {
895
918
  content: {
896
919
  "application/json": components["schemas"]["bulkQuoteResponse"];
@@ -901,48 +924,64 @@ export interface operations {
901
924
  500: components["responses"]["500"];
902
925
  };
903
926
  };
904
- /** The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer. */
927
+ /**
928
+ * Callbacks for the bulk transaction request.
929
+ * @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
930
+ */
905
931
  BackendBulkTransactionsPut: {
906
932
  parameters: {
907
933
  path: {
908
- /** Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
909
934
  bulkTransactionId: components["parameters"]["bulkTransactionId"];
910
935
  };
911
936
  };
912
- responses: {
913
- /** Bulk transaction information successfully amended. */
914
- 202: unknown;
915
- 400: components["responses"]["400"];
916
- 500: components["responses"]["500"];
917
- };
918
- requestBody: {
937
+ requestBody?: {
919
938
  content: {
920
939
  "application/json": components["schemas"]["bulkTransactionResponse"];
921
940
  };
922
941
  };
942
+ responses: {
943
+ /** @description Bulk transaction information successfully amended. */
944
+ 202: {
945
+ content: never;
946
+ };
947
+ 400: components["responses"]["400"];
948
+ 500: components["responses"]["500"];
949
+ };
923
950
  };
924
- /** It is used to notify the DFSP backend about the status of the requestToPayTransfer. */
951
+ /**
952
+ * Callback for the requestToPay request.
953
+ * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer.
954
+ */
925
955
  RequestToPayPut: {
926
956
  parameters: {
927
957
  path: {
928
958
  transactionRequestId: components["parameters"]["transactionRequestId"];
929
959
  };
930
960
  };
961
+ requestBody?: {
962
+ content: {
963
+ "application/json": components["schemas"]["requestToPayCallback"];
964
+ };
965
+ };
931
966
  responses: {
932
- /** OK */
933
- 200: unknown;
967
+ /** @description OK */
968
+ 200: {
969
+ content: never;
970
+ };
934
971
  400: components["responses"]["400"];
935
972
  500: components["responses"]["500"];
936
973
  };
937
- requestBody: {
974
+ };
975
+ /** Execute bulk transfer of funds from an external account to internal accounts. */
976
+ BackendBulkTransfersPost: {
977
+ /** @description An incoming bulk transfer request. */
978
+ requestBody?: {
938
979
  content: {
939
- "application/json": components["schemas"]["requestToPayCallback"];
980
+ "application/json": components["schemas"]["bulkTransferRequest"];
940
981
  };
941
982
  };
942
- };
943
- BackendBulkTransfersPost: {
944
983
  responses: {
945
- /** The bulk transfer was accepted. */
984
+ /** @description The bulk transfer was accepted. */
946
985
  200: {
947
986
  content: {
948
987
  "application/json": components["schemas"]["bulkTransferResponse"];
@@ -951,22 +990,16 @@ export interface operations {
951
990
  400: components["responses"]["400"];
952
991
  500: components["responses"]["500"];
953
992
  };
954
- /** An incoming bulk transfer request. */
955
- requestBody: {
956
- content: {
957
- "application/json": components["schemas"]["bulkTransferRequest"];
958
- };
959
- };
960
993
  };
994
+ /** Requests information relating to a bulk transfer identified by the specified identifier value. */
961
995
  BackendBulkTransfersGet: {
962
996
  parameters: {
963
997
  path: {
964
- /** The identifier value. */
965
998
  idValue: components["parameters"]["idValue"];
966
999
  };
967
1000
  };
968
1001
  responses: {
969
- /** Response containing details of the requested bulk transfer. */
1002
+ /** @description Response containing details of the requested bulk transfer. */
970
1003
  200: {
971
1004
  content: {
972
1005
  "application/json": components["schemas"]["bulkTransferResponse"];
@@ -977,6 +1010,7 @@ export interface operations {
977
1010
  500: components["responses"]["500"];
978
1011
  };
979
1012
  };
1013
+ /** Requests OTP. */
980
1014
  BackendOtpGet: {
981
1015
  parameters: {
982
1016
  path: {
@@ -984,7 +1018,7 @@ export interface operations {
984
1018
  };
985
1019
  };
986
1020
  responses: {
987
- /** Response containing details of the OTP. */
1021
+ /** @description Response containing details of the OTP. */
988
1022
  200: {
989
1023
  content: {
990
1024
  "application/json": components["schemas"]["otpDetails"];
@@ -995,18 +1029,19 @@ export interface operations {
995
1029
  500: components["responses"]["500"];
996
1030
  };
997
1031
  };
998
- /** The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. */
1032
+ /**
1033
+ * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
1034
+ * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
1035
+ */
999
1036
  BackendParticipantsGetByTypeAndID: {
1000
1037
  parameters: {
1001
1038
  path: {
1002
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1003
1039
  idType: components["parameters"]["idType"];
1004
- /** The identifier value. */
1005
1040
  idValue: components["parameters"]["idValue"];
1006
1041
  };
1007
1042
  };
1008
1043
  responses: {
1009
- /** Response containing details of the requested party. */
1044
+ /** @description Response containing details of the requested party. */
1010
1045
  200: {
1011
1046
  content: {
1012
1047
  "application/json": components["schemas"]["participantsResponse"];
@@ -1017,20 +1052,20 @@ export interface operations {
1017
1052
  500: components["responses"]["500"];
1018
1053
  };
1019
1054
  };
1020
- /** The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. */
1055
+ /**
1056
+ * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
1057
+ * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
1058
+ */
1021
1059
  BackendParticipantsGetByTypeIDAndSubId: {
1022
1060
  parameters: {
1023
1061
  path: {
1024
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1025
1062
  idType: components["parameters"]["idType"];
1026
- /** The identifier value. */
1027
1063
  idValue: components["parameters"]["idValue"];
1028
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
1029
1064
  idSubValue: components["parameters"]["idSubValue"];
1030
1065
  };
1031
1066
  };
1032
1067
  responses: {
1033
- /** Response containing details of the requested party. */
1068
+ /** @description Response containing details of the requested party. */
1034
1069
  200: {
1035
1070
  content: {
1036
1071
  "application/json": components["schemas"]["participantsResponse"];
@@ -1041,18 +1076,19 @@ export interface operations {
1041
1076
  500: components["responses"]["500"];
1042
1077
  };
1043
1078
  };
1044
- /** The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. */
1079
+ /**
1080
+ * Requests information relating to a transfer party identified by the specified identifier type and value.
1081
+ * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
1082
+ */
1045
1083
  BackendPartiesGetByTypeAndID: {
1046
1084
  parameters: {
1047
1085
  path: {
1048
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1049
1086
  idType: components["parameters"]["idType"];
1050
- /** The identifier value. */
1051
1087
  idValue: components["parameters"]["idValue"];
1052
1088
  };
1053
1089
  };
1054
1090
  responses: {
1055
- /** Response containing details of the requested party. */
1091
+ /** @description Response containing details of the requested party. */
1056
1092
  200: {
1057
1093
  content: {
1058
1094
  "application/json": components["schemas"]["transferParty"];
@@ -1063,20 +1099,20 @@ export interface operations {
1063
1099
  500: components["responses"]["500"];
1064
1100
  };
1065
1101
  };
1066
- /** The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. */
1102
+ /**
1103
+ * Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
1104
+ * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
1105
+ */
1067
1106
  BackendPartiesGetByTypeIdAndSubId: {
1068
1107
  parameters: {
1069
1108
  path: {
1070
- /** The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1071
1109
  idType: components["parameters"]["idType"];
1072
- /** The identifier value. */
1073
1110
  idValue: components["parameters"]["idValue"];
1074
- /** A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
1075
1111
  idSubValue: components["parameters"]["idSubValue"];
1076
1112
  };
1077
1113
  };
1078
1114
  responses: {
1079
- /** Response containing details of the requested party. */
1115
+ /** @description Response containing details of the requested party. */
1080
1116
  200: {
1081
1117
  content: {
1082
1118
  "application/json": components["schemas"]["transferParty"];
@@ -1087,10 +1123,19 @@ export interface operations {
1087
1123
  500: components["responses"]["500"];
1088
1124
  };
1089
1125
  };
1090
- /** The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. */
1126
+ /**
1127
+ * Requests a quote for the specified transfer.
1128
+ * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
1129
+ */
1091
1130
  BackendQuoteRequest: {
1131
+ /** @description Request for a transfer quotation. */
1132
+ requestBody?: {
1133
+ content: {
1134
+ "application/json": components["schemas"]["quoteRequest"];
1135
+ };
1136
+ };
1092
1137
  responses: {
1093
- /** A response to the transfer quotation request. */
1138
+ /** @description A response to the transfer quotation request. */
1094
1139
  200: {
1095
1140
  content: {
1096
1141
  "application/json": components["schemas"]["quoteResponse"];
@@ -1099,16 +1144,17 @@ export interface operations {
1099
1144
  400: components["responses"]["400"];
1100
1145
  500: components["responses"]["500"];
1101
1146
  };
1102
- /** Request for a transfer quotation. */
1103
- requestBody: {
1147
+ };
1148
+ /** Transaction request that supports pull based transfers. */
1149
+ BackendTransactionRequest: {
1150
+ /** @description Request for Transaction Request. */
1151
+ requestBody?: {
1104
1152
  content: {
1105
- "application/json": components["schemas"]["quoteRequest"];
1153
+ "application/json": components["schemas"]["transactionRequest"];
1106
1154
  };
1107
1155
  };
1108
- };
1109
- BackendTransactionRequest: {
1110
1156
  responses: {
1111
- /** A response to the transfer transaction request. */
1157
+ /** @description A response to the transfer transaction request. */
1112
1158
  200: {
1113
1159
  content: {
1114
1160
  "application/json": components["schemas"]["transactionRequestResponse"];
@@ -1117,17 +1163,20 @@ export interface operations {
1117
1163
  400: components["responses"]["400"];
1118
1164
  500: components["responses"]["500"];
1119
1165
  };
1120
- /** Request for Transaction Request. */
1121
- requestBody: {
1166
+ };
1167
+ /**
1168
+ * Transfers funds from an external account to an internal account.
1169
+ * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
1170
+ */
1171
+ BackendTransfersPost: {
1172
+ /** @description An incoming transfer request. */
1173
+ requestBody?: {
1122
1174
  content: {
1123
- "application/json": components["schemas"]["transactionRequest"];
1175
+ "application/json": components["schemas"]["transferRequest"];
1124
1176
  };
1125
1177
  };
1126
- };
1127
- /** The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. */
1128
- BackendTransfersPost: {
1129
1178
  responses: {
1130
- /** The transfer was accepted. */
1179
+ /** @description The transfer was accepted. */
1131
1180
  200: {
1132
1181
  content: {
1133
1182
  "application/json": components["schemas"]["transferResponse"];
@@ -1136,14 +1185,11 @@ export interface operations {
1136
1185
  400: components["responses"]["400"];
1137
1186
  500: components["responses"]["500"];
1138
1187
  };
1139
- /** An incoming transfer request. */
1140
- requestBody: {
1141
- content: {
1142
- "application/json": components["schemas"]["transferRequest"];
1143
- };
1144
- };
1145
1188
  };
1146
- /** The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer. */
1189
+ /**
1190
+ * Retrieves information for a specific transfer.
1191
+ * @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
1192
+ */
1147
1193
  BackendTransfersGet: {
1148
1194
  parameters: {
1149
1195
  path: {
@@ -1151,7 +1197,7 @@ export interface operations {
1151
1197
  };
1152
1198
  };
1153
1199
  responses: {
1154
- /** The transfer was accepted. */
1200
+ /** @description The transfer was accepted. */
1155
1201
  200: {
1156
1202
  content: {
1157
1203
  "application/json": components["schemas"]["transferDetailsResponse"];
@@ -1160,25 +1206,28 @@ export interface operations {
1160
1206
  500: components["responses"]["500"];
1161
1207
  };
1162
1208
  };
1163
- /** The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. */
1209
+ /**
1210
+ * Receive notification for a specific transfer.
1211
+ * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
1212
+ */
1164
1213
  BackendTransfersPut: {
1165
1214
  parameters: {
1166
1215
  path: {
1167
1216
  transferId: components["parameters"]["transferId"];
1168
1217
  };
1169
1218
  };
1170
- responses: {
1171
- /** The notification was accepted. */
1172
- 200: unknown;
1173
- 500: components["responses"]["500"];
1174
- };
1175
- /** An incoming notification for fulfiled transfer. */
1176
- requestBody: {
1219
+ /** @description An incoming notification for fulfiled transfer. */
1220
+ requestBody?: {
1177
1221
  content: {
1178
1222
  "application/json": components["schemas"]["fulfilNotification"];
1179
1223
  };
1180
1224
  };
1225
+ responses: {
1226
+ /** @description The notification was accepted. */
1227
+ 200: {
1228
+ content: never;
1229
+ };
1230
+ 500: components["responses"]["500"];
1231
+ };
1181
1232
  };
1182
1233
  }
1183
- export interface external {
1184
- }
@@ -115,5 +115,5 @@ var Schemas;
115
115
  Schemas.bulkTransactionIndividualTransferResult = json_schemas_json_1.default.bulkTransactionIndividualTransferResult;
116
116
  Schemas.bulkTransactionResponse = json_schemas_json_1.default.bulkTransactionResponse;
117
117
  Schemas.AuthenticationType = json_schemas_json_1.default.AuthenticationType;
118
- })(Schemas = exports.Schemas || (exports.Schemas = {}));
118
+ })(Schemas || (exports.Schemas = Schemas = {}));
119
119
  //# sourceMappingURL=schemas.js.map