@mojaloop/api-snippets 17.8.0 → 17.9.0
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.
- package/CHANGELOG.md +7 -0
- package/audit-ci.jsonc +0 -1
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +125 -27
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +216 -7
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +136 -11
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +184 -7
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js +4 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.d.ts +4 -1
- package/package.json +12 -12
- package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionCompleted.yaml +5 -0
- package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionError.yaml +5 -0
- package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionTimeout.yaml +5 -0
- package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionResponse.yaml +26 -0
- package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionState.yaml +4 -0
- package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionStatus.yaml +10 -0
- package/sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml +4 -0
- package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID.yaml +19 -0
- package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID_SubId.yaml +20 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,11 @@
|
|
|
1
1
|
# Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
|
|
2
|
+
## [17.9.0](https://github.com/mojaloop/api-snippets/compare/v17.8.0...v17.9.0) (2025-03-19)
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
### Features
|
|
6
|
+
|
|
7
|
+
* **csi-1244:** add sdk outbound DELETE /accounts/{Type}/{ID}/{SubId} endpoint ([#195](https://github.com/mojaloop/api-snippets/issues/195)) ([a8204f7](https://github.com/mojaloop/api-snippets/commit/a8204f7032d2421e61cf1a8b68b02b218b26f465))
|
|
8
|
+
|
|
2
9
|
## [17.8.0](https://github.com/mojaloop/api-snippets/compare/v17.7.13...v17.8.0) (2025-02-20)
|
|
3
10
|
|
|
4
11
|
|
package/audit-ci.jsonc
CHANGED
|
@@ -48,6 +48,43 @@ paths:
|
|
|
48
48
|
$ref: '#/components/responses/accountsCreationError'
|
|
49
49
|
'504':
|
|
50
50
|
$ref: '#/components/responses/accountsCreationTimeout'
|
|
51
|
+
/accounts/{Type}/{ID}:
|
|
52
|
+
delete:
|
|
53
|
+
summary: Delete account on the Account Lookup Service
|
|
54
|
+
description: The HTTP request `DELETE /accounts/{Type}/{ID}` is used to account account information on the Account Lookup Service (ALS) by Type and ID.
|
|
55
|
+
tags:
|
|
56
|
+
- Accounts
|
|
57
|
+
parameters:
|
|
58
|
+
- $ref: '#/components/parameters/Type'
|
|
59
|
+
- $ref: '#/components/parameters/ID'
|
|
60
|
+
responses:
|
|
61
|
+
'200':
|
|
62
|
+
$ref: '#/components/responses/accountDeletionCompleted'
|
|
63
|
+
'400':
|
|
64
|
+
$ref: '#/components/responses/accountDeletionError'
|
|
65
|
+
'500':
|
|
66
|
+
$ref: '#/components/responses/accountDeletionError'
|
|
67
|
+
'504':
|
|
68
|
+
$ref: '#/components/responses/accountDeletionTimeout'
|
|
69
|
+
/accounts/{Type}/{ID}/{SubId}:
|
|
70
|
+
delete:
|
|
71
|
+
summary: Delete account on the Account Lookup Service
|
|
72
|
+
description: The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type, ID, and SubId.
|
|
73
|
+
tags:
|
|
74
|
+
- Accounts
|
|
75
|
+
parameters:
|
|
76
|
+
- $ref: '#/components/parameters/Type'
|
|
77
|
+
- $ref: '#/components/parameters/ID'
|
|
78
|
+
- $ref: '#/components/parameters/SubId'
|
|
79
|
+
responses:
|
|
80
|
+
'200':
|
|
81
|
+
$ref: '#/components/responses/accountDeletionCompleted'
|
|
82
|
+
'400':
|
|
83
|
+
$ref: '#/components/responses/accountDeletionError'
|
|
84
|
+
'500':
|
|
85
|
+
$ref: '#/components/responses/accountDeletionError'
|
|
86
|
+
'504':
|
|
87
|
+
$ref: '#/components/responses/accountDeletionTimeout'
|
|
51
88
|
/bulkQuotes:
|
|
52
89
|
post:
|
|
53
90
|
summary: Request bulk quotes for the provided financial transactions
|
|
@@ -908,6 +945,55 @@ components:
|
|
|
908
945
|
properties:
|
|
909
946
|
executionState:
|
|
910
947
|
$ref: '#/components/schemas/accountsResponse'
|
|
948
|
+
FspId:
|
|
949
|
+
title: FspId
|
|
950
|
+
type: string
|
|
951
|
+
minLength: 1
|
|
952
|
+
maxLength: 32
|
|
953
|
+
description: FSP identifier.
|
|
954
|
+
accountDeletionStatus:
|
|
955
|
+
type: array
|
|
956
|
+
items:
|
|
957
|
+
type: object
|
|
958
|
+
required:
|
|
959
|
+
- fspId
|
|
960
|
+
properties:
|
|
961
|
+
fspId:
|
|
962
|
+
$ref: '#/components/schemas/FspId'
|
|
963
|
+
error:
|
|
964
|
+
$ref: '#/components/schemas/errorResponse'
|
|
965
|
+
accountDeletionState:
|
|
966
|
+
type: string
|
|
967
|
+
enum:
|
|
968
|
+
- ERROR_OCCURRED
|
|
969
|
+
- COMPLETED
|
|
970
|
+
accountDeletionResponse:
|
|
971
|
+
type: object
|
|
972
|
+
required:
|
|
973
|
+
- idType
|
|
974
|
+
- idValue
|
|
975
|
+
properties:
|
|
976
|
+
idType:
|
|
977
|
+
$ref: '#/components/schemas/PartyIdType'
|
|
978
|
+
idValue:
|
|
979
|
+
$ref: '#/components/schemas/PartyIdentifier'
|
|
980
|
+
subIdOrType:
|
|
981
|
+
$ref: '#/components/schemas/PartySubIdOrType'
|
|
982
|
+
response:
|
|
983
|
+
$ref: '#/components/schemas/accountDeletionStatus'
|
|
984
|
+
currentState:
|
|
985
|
+
$ref: '#/components/schemas/accountDeletionState'
|
|
986
|
+
lastError:
|
|
987
|
+
$ref: '#/components/schemas/transferError'
|
|
988
|
+
deleteAccountResponse:
|
|
989
|
+
type: object
|
|
990
|
+
required:
|
|
991
|
+
- body
|
|
992
|
+
properties:
|
|
993
|
+
body:
|
|
994
|
+
type: object
|
|
995
|
+
headers:
|
|
996
|
+
type: object
|
|
911
997
|
TransactionInitiatorType:
|
|
912
998
|
title: TransactionInitiatorType
|
|
913
999
|
type: string
|
|
@@ -968,12 +1054,6 @@ components:
|
|
|
968
1054
|
type: string
|
|
969
1055
|
pattern: ^[\d]{1,4}$
|
|
970
1056
|
description: A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
|
|
971
|
-
FspId:
|
|
972
|
-
title: FspId
|
|
973
|
-
type: string
|
|
974
|
-
minLength: 1
|
|
975
|
-
maxLength: 32
|
|
976
|
-
description: FSP identifier.
|
|
977
1057
|
KYCInformation:
|
|
978
1058
|
title: KYCInformation
|
|
979
1059
|
type: string
|
|
@@ -2834,6 +2914,24 @@ components:
|
|
|
2834
2914
|
application/json:
|
|
2835
2915
|
schema:
|
|
2836
2916
|
$ref: '#/components/schemas/errorAccountsResponse'
|
|
2917
|
+
accountDeletionCompleted:
|
|
2918
|
+
description: Account deletion completed
|
|
2919
|
+
content:
|
|
2920
|
+
application/json:
|
|
2921
|
+
schema:
|
|
2922
|
+
$ref: '#/components/schemas/accountDeletionResponse'
|
|
2923
|
+
accountDeletionError:
|
|
2924
|
+
description: An error occurred while deleting an account
|
|
2925
|
+
content:
|
|
2926
|
+
application/json:
|
|
2927
|
+
schema:
|
|
2928
|
+
$ref: '#/components/schemas/errorAccountsResponse'
|
|
2929
|
+
accountDeletionTimeout:
|
|
2930
|
+
description: Timeout occurred while deleting an account
|
|
2931
|
+
content:
|
|
2932
|
+
application/json:
|
|
2933
|
+
schema:
|
|
2934
|
+
$ref: '#/components/schemas/errorAccountsResponse'
|
|
2837
2935
|
bulkQuoteSuccess:
|
|
2838
2936
|
description: Bulk quote completed successfully
|
|
2839
2937
|
content:
|
|
@@ -2974,27 +3072,6 @@ components:
|
|
|
2974
3072
|
schema:
|
|
2975
3073
|
$ref: '#/components/schemas/ServicesFXPPutResponse'
|
|
2976
3074
|
parameters:
|
|
2977
|
-
bulkQuoteId:
|
|
2978
|
-
name: bulkQuoteId
|
|
2979
|
-
in: path
|
|
2980
|
-
required: true
|
|
2981
|
-
schema:
|
|
2982
|
-
$ref: '#/components/schemas/CorrelationId'
|
|
2983
|
-
description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
|
|
2984
|
-
bulkTransactionId:
|
|
2985
|
-
name: bulkTransactionId
|
|
2986
|
-
in: path
|
|
2987
|
-
required: true
|
|
2988
|
-
schema:
|
|
2989
|
-
$ref: '#/components/schemas/CorrelationId'
|
|
2990
|
-
description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
|
|
2991
|
-
bulkTransferId:
|
|
2992
|
-
name: bulkTransferId
|
|
2993
|
-
in: path
|
|
2994
|
-
required: true
|
|
2995
|
-
schema:
|
|
2996
|
-
$ref: '#/components/schemas/CorrelationId'
|
|
2997
|
-
description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
|
|
2998
3075
|
Type:
|
|
2999
3076
|
name: Type
|
|
3000
3077
|
in: path
|
|
@@ -3016,6 +3093,27 @@ components:
|
|
|
3016
3093
|
schema:
|
|
3017
3094
|
type: string
|
|
3018
3095
|
description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
|
|
3096
|
+
bulkQuoteId:
|
|
3097
|
+
name: bulkQuoteId
|
|
3098
|
+
in: path
|
|
3099
|
+
required: true
|
|
3100
|
+
schema:
|
|
3101
|
+
$ref: '#/components/schemas/CorrelationId'
|
|
3102
|
+
description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
|
|
3103
|
+
bulkTransactionId:
|
|
3104
|
+
name: bulkTransactionId
|
|
3105
|
+
in: path
|
|
3106
|
+
required: true
|
|
3107
|
+
schema:
|
|
3108
|
+
$ref: '#/components/schemas/CorrelationId'
|
|
3109
|
+
description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
|
|
3110
|
+
bulkTransferId:
|
|
3111
|
+
name: bulkTransferId
|
|
3112
|
+
in: path
|
|
3113
|
+
required: true
|
|
3114
|
+
schema:
|
|
3115
|
+
$ref: '#/components/schemas/CorrelationId'
|
|
3116
|
+
description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
|
|
3019
3117
|
transactionRequestId:
|
|
3020
3118
|
name: transactionRequestId
|
|
3021
3119
|
in: path
|
|
@@ -1605,6 +1605,222 @@
|
|
|
1605
1605
|
}
|
|
1606
1606
|
]
|
|
1607
1607
|
},
|
|
1608
|
+
"FspId": {
|
|
1609
|
+
"title": "FspId",
|
|
1610
|
+
"type": "string",
|
|
1611
|
+
"minLength": 1,
|
|
1612
|
+
"maxLength": 32,
|
|
1613
|
+
"description": "FSP identifier."
|
|
1614
|
+
},
|
|
1615
|
+
"accountDeletionStatus": {
|
|
1616
|
+
"type": "array",
|
|
1617
|
+
"items": {
|
|
1618
|
+
"type": "object",
|
|
1619
|
+
"required": [
|
|
1620
|
+
"fspId"
|
|
1621
|
+
],
|
|
1622
|
+
"properties": {
|
|
1623
|
+
"fspId": {
|
|
1624
|
+
"title": "FspId",
|
|
1625
|
+
"type": "string",
|
|
1626
|
+
"minLength": 1,
|
|
1627
|
+
"maxLength": 32,
|
|
1628
|
+
"description": "FSP identifier."
|
|
1629
|
+
},
|
|
1630
|
+
"error": {
|
|
1631
|
+
"type": "object",
|
|
1632
|
+
"properties": {
|
|
1633
|
+
"statusCode": {
|
|
1634
|
+
"type": "string",
|
|
1635
|
+
"description": "Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.\nOtherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.\n"
|
|
1636
|
+
},
|
|
1637
|
+
"message": {
|
|
1638
|
+
"type": "string",
|
|
1639
|
+
"description": "Error message text."
|
|
1640
|
+
}
|
|
1641
|
+
}
|
|
1642
|
+
}
|
|
1643
|
+
}
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"accountDeletionState": {
|
|
1647
|
+
"type": "string",
|
|
1648
|
+
"enum": [
|
|
1649
|
+
"ERROR_OCCURRED",
|
|
1650
|
+
"COMPLETED"
|
|
1651
|
+
]
|
|
1652
|
+
},
|
|
1653
|
+
"accountDeletionResponse": {
|
|
1654
|
+
"type": "object",
|
|
1655
|
+
"required": [
|
|
1656
|
+
"idType",
|
|
1657
|
+
"idValue"
|
|
1658
|
+
],
|
|
1659
|
+
"properties": {
|
|
1660
|
+
"idType": {
|
|
1661
|
+
"title": "PartyIdType",
|
|
1662
|
+
"type": "string",
|
|
1663
|
+
"enum": [
|
|
1664
|
+
"MSISDN",
|
|
1665
|
+
"EMAIL",
|
|
1666
|
+
"PERSONAL_ID",
|
|
1667
|
+
"BUSINESS",
|
|
1668
|
+
"DEVICE",
|
|
1669
|
+
"ACCOUNT_ID",
|
|
1670
|
+
"IBAN",
|
|
1671
|
+
"ALIAS"
|
|
1672
|
+
],
|
|
1673
|
+
"description": "Below are the allowed values for the enumeration.\n- MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.\n- EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).\n- PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.\n- BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.\n- DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.\n- ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.\n- IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.\n- ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier."
|
|
1674
|
+
},
|
|
1675
|
+
"idValue": {
|
|
1676
|
+
"title": "PartyIdentifier",
|
|
1677
|
+
"type": "string",
|
|
1678
|
+
"minLength": 1,
|
|
1679
|
+
"maxLength": 128,
|
|
1680
|
+
"description": "Identifier of the Party.",
|
|
1681
|
+
"example": "16135551212"
|
|
1682
|
+
},
|
|
1683
|
+
"subIdOrType": {
|
|
1684
|
+
"title": "PartySubIdOrType",
|
|
1685
|
+
"type": "string",
|
|
1686
|
+
"minLength": 1,
|
|
1687
|
+
"maxLength": 128,
|
|
1688
|
+
"description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
|
|
1689
|
+
},
|
|
1690
|
+
"response": {
|
|
1691
|
+
"type": "array",
|
|
1692
|
+
"items": {
|
|
1693
|
+
"type": "object",
|
|
1694
|
+
"required": [
|
|
1695
|
+
"fspId"
|
|
1696
|
+
],
|
|
1697
|
+
"properties": {
|
|
1698
|
+
"fspId": {
|
|
1699
|
+
"title": "FspId",
|
|
1700
|
+
"type": "string",
|
|
1701
|
+
"minLength": 1,
|
|
1702
|
+
"maxLength": 32,
|
|
1703
|
+
"description": "FSP identifier."
|
|
1704
|
+
},
|
|
1705
|
+
"error": {
|
|
1706
|
+
"type": "object",
|
|
1707
|
+
"properties": {
|
|
1708
|
+
"statusCode": {
|
|
1709
|
+
"type": "string",
|
|
1710
|
+
"description": "Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.\nOtherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.\n"
|
|
1711
|
+
},
|
|
1712
|
+
"message": {
|
|
1713
|
+
"type": "string",
|
|
1714
|
+
"description": "Error message text."
|
|
1715
|
+
}
|
|
1716
|
+
}
|
|
1717
|
+
}
|
|
1718
|
+
}
|
|
1719
|
+
}
|
|
1720
|
+
},
|
|
1721
|
+
"currentState": {
|
|
1722
|
+
"type": "string",
|
|
1723
|
+
"enum": [
|
|
1724
|
+
"ERROR_OCCURRED",
|
|
1725
|
+
"COMPLETED"
|
|
1726
|
+
]
|
|
1727
|
+
},
|
|
1728
|
+
"lastError": {
|
|
1729
|
+
"type": "object",
|
|
1730
|
+
"description": "This object represents a Mojaloop API error received at any time during the transfer process",
|
|
1731
|
+
"properties": {
|
|
1732
|
+
"httpStatusCode": {
|
|
1733
|
+
"type": "integer",
|
|
1734
|
+
"description": "The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response."
|
|
1735
|
+
},
|
|
1736
|
+
"mojaloopError": {
|
|
1737
|
+
"type": "object",
|
|
1738
|
+
"properties": {
|
|
1739
|
+
"errorInformation": {
|
|
1740
|
+
"title": "ErrorInformation",
|
|
1741
|
+
"type": "object",
|
|
1742
|
+
"description": "Data model for the complex type ErrorInformation.",
|
|
1743
|
+
"properties": {
|
|
1744
|
+
"errorCode": {
|
|
1745
|
+
"title": "ErrorCode",
|
|
1746
|
+
"type": "string",
|
|
1747
|
+
"pattern": "^[1-9]\\d{3}$",
|
|
1748
|
+
"description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.",
|
|
1749
|
+
"example": "5100"
|
|
1750
|
+
},
|
|
1751
|
+
"errorDescription": {
|
|
1752
|
+
"title": "ErrorDescription",
|
|
1753
|
+
"type": "string",
|
|
1754
|
+
"minLength": 1,
|
|
1755
|
+
"maxLength": 128,
|
|
1756
|
+
"description": "Error description string."
|
|
1757
|
+
},
|
|
1758
|
+
"extensionList": {
|
|
1759
|
+
"title": "ExtensionList",
|
|
1760
|
+
"type": "object",
|
|
1761
|
+
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
1762
|
+
"properties": {
|
|
1763
|
+
"extension": {
|
|
1764
|
+
"type": "array",
|
|
1765
|
+
"items": {
|
|
1766
|
+
"title": "Extension_v2_1_0",
|
|
1767
|
+
"type": "object",
|
|
1768
|
+
"description": "Data model for the complex type Extension.",
|
|
1769
|
+
"properties": {
|
|
1770
|
+
"key": {
|
|
1771
|
+
"title": "ExtensionKey_v2_1_0",
|
|
1772
|
+
"type": "string",
|
|
1773
|
+
"minLength": 1,
|
|
1774
|
+
"description": "Extension key."
|
|
1775
|
+
},
|
|
1776
|
+
"value": {
|
|
1777
|
+
"title": "ExtensionValue",
|
|
1778
|
+
"type": "string",
|
|
1779
|
+
"minLength": 1,
|
|
1780
|
+
"maxLength": 128,
|
|
1781
|
+
"description": "Extension value."
|
|
1782
|
+
}
|
|
1783
|
+
},
|
|
1784
|
+
"required": [
|
|
1785
|
+
"key",
|
|
1786
|
+
"value"
|
|
1787
|
+
]
|
|
1788
|
+
},
|
|
1789
|
+
"minItems": 1,
|
|
1790
|
+
"maxItems": 16,
|
|
1791
|
+
"description": "Number of Extension elements."
|
|
1792
|
+
}
|
|
1793
|
+
},
|
|
1794
|
+
"required": [
|
|
1795
|
+
"extension"
|
|
1796
|
+
]
|
|
1797
|
+
}
|
|
1798
|
+
},
|
|
1799
|
+
"required": [
|
|
1800
|
+
"errorCode",
|
|
1801
|
+
"errorDescription"
|
|
1802
|
+
]
|
|
1803
|
+
}
|
|
1804
|
+
}
|
|
1805
|
+
}
|
|
1806
|
+
}
|
|
1807
|
+
},
|
|
1808
|
+
"deleteAccountResponse": {
|
|
1809
|
+
"type": "object",
|
|
1810
|
+
"required": [
|
|
1811
|
+
"body"
|
|
1812
|
+
],
|
|
1813
|
+
"properties": {
|
|
1814
|
+
"body": {
|
|
1815
|
+
"type": "object"
|
|
1816
|
+
},
|
|
1817
|
+
"headers": {
|
|
1818
|
+
"type": "object"
|
|
1819
|
+
}
|
|
1820
|
+
}
|
|
1821
|
+
}
|
|
1822
|
+
}
|
|
1823
|
+
},
|
|
1608
1824
|
"TransactionInitiatorType": {
|
|
1609
1825
|
"title": "TransactionInitiatorType",
|
|
1610
1826
|
"type": "string",
|
|
@@ -1663,13 +1879,6 @@
|
|
|
1663
1879
|
"pattern": "^[\\d]{1,4}$",
|
|
1664
1880
|
"description": "A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc."
|
|
1665
1881
|
},
|
|
1666
|
-
"FspId": {
|
|
1667
|
-
"title": "FspId",
|
|
1668
|
-
"type": "string",
|
|
1669
|
-
"minLength": 1,
|
|
1670
|
-
"maxLength": 32,
|
|
1671
|
-
"description": "FSP identifier."
|
|
1672
|
-
},
|
|
1673
1882
|
"KYCInformation": {
|
|
1674
1883
|
"title": "KYCInformation",
|
|
1675
1884
|
"type": "string",
|
|
@@ -81,6 +81,86 @@ export interface paths {
|
|
|
81
81
|
patch?: never;
|
|
82
82
|
trace?: never;
|
|
83
83
|
};
|
|
84
|
+
"/accounts/{Type}/{ID}": {
|
|
85
|
+
parameters: {
|
|
86
|
+
query?: never;
|
|
87
|
+
header?: never;
|
|
88
|
+
path?: never;
|
|
89
|
+
cookie?: never;
|
|
90
|
+
};
|
|
91
|
+
get?: never;
|
|
92
|
+
put?: never;
|
|
93
|
+
post?: never;
|
|
94
|
+
/**
|
|
95
|
+
* Delete account on the Account Lookup Service
|
|
96
|
+
* @description The HTTP request `DELETE /accounts/{Type}/{ID}` is used to account account information on the Account Lookup Service (ALS) by Type and ID.
|
|
97
|
+
*/
|
|
98
|
+
delete: {
|
|
99
|
+
parameters: {
|
|
100
|
+
query?: never;
|
|
101
|
+
header?: never;
|
|
102
|
+
path: {
|
|
103
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
104
|
+
Type: components["parameters"]["Type"];
|
|
105
|
+
/** @description The identifier value. */
|
|
106
|
+
ID: components["parameters"]["ID"];
|
|
107
|
+
};
|
|
108
|
+
cookie?: never;
|
|
109
|
+
};
|
|
110
|
+
requestBody?: never;
|
|
111
|
+
responses: {
|
|
112
|
+
200: components["responses"]["accountDeletionCompleted"];
|
|
113
|
+
400: components["responses"]["accountDeletionError"];
|
|
114
|
+
500: components["responses"]["accountDeletionError"];
|
|
115
|
+
504: components["responses"]["accountDeletionTimeout"];
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
options?: never;
|
|
119
|
+
head?: never;
|
|
120
|
+
patch?: never;
|
|
121
|
+
trace?: never;
|
|
122
|
+
};
|
|
123
|
+
"/accounts/{Type}/{ID}/{SubId}": {
|
|
124
|
+
parameters: {
|
|
125
|
+
query?: never;
|
|
126
|
+
header?: never;
|
|
127
|
+
path?: never;
|
|
128
|
+
cookie?: never;
|
|
129
|
+
};
|
|
130
|
+
get?: never;
|
|
131
|
+
put?: never;
|
|
132
|
+
post?: never;
|
|
133
|
+
/**
|
|
134
|
+
* Delete account on the Account Lookup Service
|
|
135
|
+
* @description The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type, ID, and SubId.
|
|
136
|
+
*/
|
|
137
|
+
delete: {
|
|
138
|
+
parameters: {
|
|
139
|
+
query?: never;
|
|
140
|
+
header?: never;
|
|
141
|
+
path: {
|
|
142
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
143
|
+
Type: components["parameters"]["Type"];
|
|
144
|
+
/** @description The identifier value. */
|
|
145
|
+
ID: components["parameters"]["ID"];
|
|
146
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
147
|
+
SubId: components["parameters"]["SubId"];
|
|
148
|
+
};
|
|
149
|
+
cookie?: never;
|
|
150
|
+
};
|
|
151
|
+
requestBody?: never;
|
|
152
|
+
responses: {
|
|
153
|
+
200: components["responses"]["accountDeletionCompleted"];
|
|
154
|
+
400: components["responses"]["accountDeletionError"];
|
|
155
|
+
500: components["responses"]["accountDeletionError"];
|
|
156
|
+
504: components["responses"]["accountDeletionTimeout"];
|
|
157
|
+
};
|
|
158
|
+
};
|
|
159
|
+
options?: never;
|
|
160
|
+
head?: never;
|
|
161
|
+
patch?: never;
|
|
162
|
+
trace?: never;
|
|
163
|
+
};
|
|
84
164
|
"/bulkQuotes": {
|
|
85
165
|
parameters: {
|
|
86
166
|
query?: never;
|
|
@@ -985,6 +1065,29 @@ export interface components {
|
|
|
985
1065
|
errorAccountsResponse: components["schemas"]["errorResponse"] & {
|
|
986
1066
|
executionState: components["schemas"]["accountsResponse"];
|
|
987
1067
|
};
|
|
1068
|
+
/**
|
|
1069
|
+
* FspId
|
|
1070
|
+
* @description FSP identifier.
|
|
1071
|
+
*/
|
|
1072
|
+
FspId: string;
|
|
1073
|
+
accountDeletionStatus: {
|
|
1074
|
+
fspId: components["schemas"]["FspId"];
|
|
1075
|
+
error?: components["schemas"]["errorResponse"];
|
|
1076
|
+
}[];
|
|
1077
|
+
/** @enum {string} */
|
|
1078
|
+
accountDeletionState: "ERROR_OCCURRED" | "COMPLETED";
|
|
1079
|
+
accountDeletionResponse: {
|
|
1080
|
+
idType: components["schemas"]["PartyIdType"];
|
|
1081
|
+
idValue: components["schemas"]["PartyIdentifier"];
|
|
1082
|
+
subIdOrType?: components["schemas"]["PartySubIdOrType"];
|
|
1083
|
+
response?: components["schemas"]["accountDeletionStatus"];
|
|
1084
|
+
currentState?: components["schemas"]["accountDeletionState"];
|
|
1085
|
+
lastError?: components["schemas"]["transferError"];
|
|
1086
|
+
deleteAccountResponse?: {
|
|
1087
|
+
body: Record<string, never>;
|
|
1088
|
+
headers?: Record<string, never>;
|
|
1089
|
+
};
|
|
1090
|
+
};
|
|
988
1091
|
/**
|
|
989
1092
|
* TransactionInitiatorType
|
|
990
1093
|
* @description Below are the allowed values for the enumeration.
|
|
@@ -1034,11 +1137,6 @@ export interface components {
|
|
|
1034
1137
|
* @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
|
|
1035
1138
|
*/
|
|
1036
1139
|
MerchantClassificationCode: string;
|
|
1037
|
-
/**
|
|
1038
|
-
* FspId
|
|
1039
|
-
* @description FSP identifier.
|
|
1040
|
-
*/
|
|
1041
|
-
FspId: string;
|
|
1042
1140
|
/**
|
|
1043
1141
|
* KYCInformation
|
|
1044
1142
|
* @description KYC information for the party in a form mandated by an individual scheme.
|
|
@@ -2015,6 +2113,33 @@ export interface components {
|
|
|
2015
2113
|
"application/json": components["schemas"]["errorAccountsResponse"];
|
|
2016
2114
|
};
|
|
2017
2115
|
};
|
|
2116
|
+
/** @description Account deletion completed */
|
|
2117
|
+
accountDeletionCompleted: {
|
|
2118
|
+
headers: {
|
|
2119
|
+
[name: string]: unknown;
|
|
2120
|
+
};
|
|
2121
|
+
content: {
|
|
2122
|
+
"application/json": components["schemas"]["accountDeletionResponse"];
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
/** @description An error occurred while deleting an account */
|
|
2126
|
+
accountDeletionError: {
|
|
2127
|
+
headers: {
|
|
2128
|
+
[name: string]: unknown;
|
|
2129
|
+
};
|
|
2130
|
+
content: {
|
|
2131
|
+
"application/json": components["schemas"]["errorAccountsResponse"];
|
|
2132
|
+
};
|
|
2133
|
+
};
|
|
2134
|
+
/** @description Timeout occurred while deleting an account */
|
|
2135
|
+
accountDeletionTimeout: {
|
|
2136
|
+
headers: {
|
|
2137
|
+
[name: string]: unknown;
|
|
2138
|
+
};
|
|
2139
|
+
content: {
|
|
2140
|
+
"application/json": components["schemas"]["errorAccountsResponse"];
|
|
2141
|
+
};
|
|
2142
|
+
};
|
|
2018
2143
|
/** @description Bulk quote completed successfully */
|
|
2019
2144
|
bulkQuoteSuccess: {
|
|
2020
2145
|
headers: {
|
|
@@ -2224,18 +2349,18 @@ export interface components {
|
|
|
2224
2349
|
};
|
|
2225
2350
|
};
|
|
2226
2351
|
parameters: {
|
|
2227
|
-
/** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
|
2228
|
-
bulkQuoteId: components["schemas"]["CorrelationId"];
|
|
2229
|
-
/** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
|
|
2230
|
-
bulkTransactionId: components["schemas"]["CorrelationId"];
|
|
2231
|
-
/** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
|
2232
|
-
bulkTransferId: components["schemas"]["CorrelationId"];
|
|
2233
2352
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
|
2234
2353
|
Type: string;
|
|
2235
2354
|
/** @description The identifier value. */
|
|
2236
2355
|
ID: string;
|
|
2237
2356
|
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
|
2238
2357
|
SubId: string;
|
|
2358
|
+
/** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
|
2359
|
+
bulkQuoteId: components["schemas"]["CorrelationId"];
|
|
2360
|
+
/** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
|
|
2361
|
+
bulkTransactionId: components["schemas"]["CorrelationId"];
|
|
2362
|
+
/** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
|
2363
|
+
bulkTransferId: components["schemas"]["CorrelationId"];
|
|
2239
2364
|
/** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
|
|
2240
2365
|
transactionRequestId: components["schemas"]["CorrelationId"];
|
|
2241
2366
|
/** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */
|
|
@@ -795,6 +795,190 @@ export declare namespace Schemas {
|
|
|
795
795
|
};
|
|
796
796
|
})[];
|
|
797
797
|
};
|
|
798
|
+
const FspId: {
|
|
799
|
+
title: string;
|
|
800
|
+
type: string;
|
|
801
|
+
minLength: number;
|
|
802
|
+
maxLength: number;
|
|
803
|
+
description: string;
|
|
804
|
+
};
|
|
805
|
+
const accountDeletionStatus: {
|
|
806
|
+
type: string;
|
|
807
|
+
items: {
|
|
808
|
+
type: string;
|
|
809
|
+
required: string[];
|
|
810
|
+
properties: {
|
|
811
|
+
fspId: {
|
|
812
|
+
title: string;
|
|
813
|
+
type: string;
|
|
814
|
+
minLength: number;
|
|
815
|
+
maxLength: number;
|
|
816
|
+
description: string;
|
|
817
|
+
};
|
|
818
|
+
error: {
|
|
819
|
+
type: string;
|
|
820
|
+
properties: {
|
|
821
|
+
statusCode: {
|
|
822
|
+
type: string;
|
|
823
|
+
description: string;
|
|
824
|
+
};
|
|
825
|
+
message: {
|
|
826
|
+
type: string;
|
|
827
|
+
description: string;
|
|
828
|
+
};
|
|
829
|
+
};
|
|
830
|
+
};
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
const accountDeletionState: {
|
|
835
|
+
type: string;
|
|
836
|
+
enum: string[];
|
|
837
|
+
};
|
|
838
|
+
const accountDeletionResponse: {
|
|
839
|
+
type: string;
|
|
840
|
+
required: string[];
|
|
841
|
+
properties: {
|
|
842
|
+
idType: {
|
|
843
|
+
title: string;
|
|
844
|
+
type: string;
|
|
845
|
+
enum: string[];
|
|
846
|
+
description: string;
|
|
847
|
+
};
|
|
848
|
+
idValue: {
|
|
849
|
+
title: string;
|
|
850
|
+
type: string;
|
|
851
|
+
minLength: number;
|
|
852
|
+
maxLength: number;
|
|
853
|
+
description: string;
|
|
854
|
+
example: string;
|
|
855
|
+
};
|
|
856
|
+
subIdOrType: {
|
|
857
|
+
title: string;
|
|
858
|
+
type: string;
|
|
859
|
+
minLength: number;
|
|
860
|
+
maxLength: number;
|
|
861
|
+
description: string;
|
|
862
|
+
};
|
|
863
|
+
response: {
|
|
864
|
+
type: string;
|
|
865
|
+
items: {
|
|
866
|
+
type: string;
|
|
867
|
+
required: string[];
|
|
868
|
+
properties: {
|
|
869
|
+
fspId: {
|
|
870
|
+
title: string;
|
|
871
|
+
type: string;
|
|
872
|
+
minLength: number;
|
|
873
|
+
maxLength: number;
|
|
874
|
+
description: string;
|
|
875
|
+
};
|
|
876
|
+
error: {
|
|
877
|
+
type: string;
|
|
878
|
+
properties: {
|
|
879
|
+
statusCode: {
|
|
880
|
+
type: string;
|
|
881
|
+
description: string;
|
|
882
|
+
};
|
|
883
|
+
message: {
|
|
884
|
+
type: string;
|
|
885
|
+
description: string;
|
|
886
|
+
};
|
|
887
|
+
};
|
|
888
|
+
};
|
|
889
|
+
};
|
|
890
|
+
};
|
|
891
|
+
};
|
|
892
|
+
currentState: {
|
|
893
|
+
type: string;
|
|
894
|
+
enum: string[];
|
|
895
|
+
};
|
|
896
|
+
lastError: {
|
|
897
|
+
type: string;
|
|
898
|
+
description: string;
|
|
899
|
+
properties: {
|
|
900
|
+
httpStatusCode: {
|
|
901
|
+
type: string;
|
|
902
|
+
description: string;
|
|
903
|
+
};
|
|
904
|
+
mojaloopError: {
|
|
905
|
+
type: string;
|
|
906
|
+
properties: {
|
|
907
|
+
errorInformation: {
|
|
908
|
+
title: string;
|
|
909
|
+
type: string;
|
|
910
|
+
description: string;
|
|
911
|
+
properties: {
|
|
912
|
+
errorCode: {
|
|
913
|
+
title: string;
|
|
914
|
+
type: string;
|
|
915
|
+
pattern: string;
|
|
916
|
+
description: string;
|
|
917
|
+
example: string;
|
|
918
|
+
};
|
|
919
|
+
errorDescription: {
|
|
920
|
+
title: string;
|
|
921
|
+
type: string;
|
|
922
|
+
minLength: number;
|
|
923
|
+
maxLength: number;
|
|
924
|
+
description: string;
|
|
925
|
+
};
|
|
926
|
+
extensionList: {
|
|
927
|
+
title: string;
|
|
928
|
+
type: string;
|
|
929
|
+
description: string;
|
|
930
|
+
properties: {
|
|
931
|
+
extension: {
|
|
932
|
+
type: string;
|
|
933
|
+
items: {
|
|
934
|
+
title: string;
|
|
935
|
+
type: string;
|
|
936
|
+
description: string;
|
|
937
|
+
properties: {
|
|
938
|
+
key: {
|
|
939
|
+
title: string;
|
|
940
|
+
type: string;
|
|
941
|
+
minLength: number;
|
|
942
|
+
description: string;
|
|
943
|
+
};
|
|
944
|
+
value: {
|
|
945
|
+
title: string;
|
|
946
|
+
type: string;
|
|
947
|
+
minLength: number;
|
|
948
|
+
maxLength: number;
|
|
949
|
+
description: string;
|
|
950
|
+
};
|
|
951
|
+
};
|
|
952
|
+
required: string[];
|
|
953
|
+
};
|
|
954
|
+
minItems: number;
|
|
955
|
+
maxItems: number;
|
|
956
|
+
description: string;
|
|
957
|
+
};
|
|
958
|
+
};
|
|
959
|
+
required: string[];
|
|
960
|
+
};
|
|
961
|
+
};
|
|
962
|
+
required: string[];
|
|
963
|
+
};
|
|
964
|
+
};
|
|
965
|
+
};
|
|
966
|
+
};
|
|
967
|
+
};
|
|
968
|
+
deleteAccountResponse: {
|
|
969
|
+
type: string;
|
|
970
|
+
required: string[];
|
|
971
|
+
properties: {
|
|
972
|
+
body: {
|
|
973
|
+
type: string;
|
|
974
|
+
};
|
|
975
|
+
headers: {
|
|
976
|
+
type: string;
|
|
977
|
+
};
|
|
978
|
+
};
|
|
979
|
+
};
|
|
980
|
+
};
|
|
981
|
+
};
|
|
798
982
|
const TransactionInitiatorType: {
|
|
799
983
|
title: string;
|
|
800
984
|
type: string;
|
|
@@ -848,13 +1032,6 @@ export declare namespace Schemas {
|
|
|
848
1032
|
pattern: string;
|
|
849
1033
|
description: string;
|
|
850
1034
|
};
|
|
851
|
-
const FspId: {
|
|
852
|
-
title: string;
|
|
853
|
-
type: string;
|
|
854
|
-
minLength: number;
|
|
855
|
-
maxLength: number;
|
|
856
|
-
description: string;
|
|
857
|
-
};
|
|
858
1035
|
const KYCInformation: {
|
|
859
1036
|
title: string;
|
|
860
1037
|
type: string;
|
|
@@ -27,6 +27,10 @@ var Schemas;
|
|
|
27
27
|
Schemas.transferError = json_schemas_json_1.default["transferError"];
|
|
28
28
|
Schemas.accountsResponse = json_schemas_json_1.default["accountsResponse"];
|
|
29
29
|
Schemas.errorAccountsResponse = json_schemas_json_1.default["errorAccountsResponse"];
|
|
30
|
+
Schemas.FspId = json_schemas_json_1.default["FspId"];
|
|
31
|
+
Schemas.accountDeletionStatus = json_schemas_json_1.default["accountDeletionStatus"];
|
|
32
|
+
Schemas.accountDeletionState = json_schemas_json_1.default["accountDeletionState"];
|
|
33
|
+
Schemas.accountDeletionResponse = json_schemas_json_1.default["accountDeletionResponse"];
|
|
30
34
|
Schemas.TransactionInitiatorType = json_schemas_json_1.default["TransactionInitiatorType"];
|
|
31
35
|
Schemas.Name = json_schemas_json_1.default["Name"];
|
|
32
36
|
Schemas.FirstName = json_schemas_json_1.default["FirstName"];
|
|
@@ -34,7 +38,6 @@ var Schemas;
|
|
|
34
38
|
Schemas.LastName = json_schemas_json_1.default["LastName"];
|
|
35
39
|
Schemas.DateOfBirth = json_schemas_json_1.default["DateOfBirth"];
|
|
36
40
|
Schemas.MerchantClassificationCode = json_schemas_json_1.default["MerchantClassificationCode"];
|
|
37
|
-
Schemas.FspId = json_schemas_json_1.default["FspId"];
|
|
38
41
|
Schemas.KYCInformation = json_schemas_json_1.default["KYCInformation"];
|
|
39
42
|
Schemas.extensionListEmptiable = json_schemas_json_1.default["extensionListEmptiable"];
|
|
40
43
|
Schemas.transferParty = json_schemas_json_1.default["transferParty"];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/sdk-scheme-adapter/v2_1_0/outbound/schemas.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;AAEpD,kEAAkE;AAElE,oFAA6C;AAE7C,IAAiB,OAAO,
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/sdk-scheme-adapter/v2_1_0/outbound/schemas.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;AAEpD,kEAAkE;AAElE,oFAA6C;AAE7C,IAAiB,OAAO,CA+IvB;AA/ID,WAAiB,OAAO;IACT,mBAAW,GAAG,2BAAW,CAAC,aAAa,CAAC,CAAA;IACxC,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,gBAAQ,GAAG,2BAAW,CAAC,UAAU,CAAC,CAAA;IAClC,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,iBAAS,GAAG,2BAAW,CAAC,WAAW,CAAC,CAAA;IACpC,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,sBAAc,GAAG,2BAAW,CAAC,gBAAgB,CAAC,CAAA;IAC9C,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,4BAAoB,GAAG,2BAAW,CAAC,sBAAsB,CAAC,CAAA;IAC1D,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,aAAK,GAAG,2BAAW,CAAC,OAAO,CAAC,CAAA;IAC5B,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,4BAAoB,GAAG,2BAAW,CAAC,sBAAsB,CAAC,CAAA;IAC1D,+BAAuB,GAAG,2BAAW,CAAC,yBAAyB,CAAC,CAAA;IAChE,gCAAwB,GAAG,2BAAW,CAAC,0BAA0B,CAAC,CAAA;IAClE,YAAI,GAAG,2BAAW,CAAC,MAAM,CAAC,CAAA;IAC1B,iBAAS,GAAG,2BAAW,CAAC,WAAW,CAAC,CAAA;IACpC,kBAAU,GAAG,2BAAW,CAAC,YAAY,CAAC,CAAA;IACtC,gBAAQ,GAAG,2BAAW,CAAC,UAAU,CAAC,CAAA;IAClC,mBAAW,GAAG,2BAAW,CAAC,aAAa,CAAC,CAAA;IACxC,kCAA0B,GAAG,2BAAW,CAAC,4BAA4B,CAAC,CAAA;IACtE,sBAAc,GAAG,2BAAW,CAAC,gBAAgB,CAAC,CAAA;IAC9C,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,kBAAU,GAAG,2BAAW,CAAC,YAAY,CAAC,CAAA;IACtC,cAAM,GAAG,2BAAW,CAAC,QAAQ,CAAC,CAAA;IAC9B,+BAAuB,GAAG,2BAAW,CAAC,yBAAyB,CAAC,CAAA;IAChE,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,YAAI,GAAG,2BAAW,CAAC,MAAM,CAAC,CAAA;IAC1B,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,gBAAQ,GAAG,2BAAW,CAAC,UAAU,CAAC,CAAA;IAClC,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,aAAK,GAAG,2BAAW,CAAC,OAAO,CAAC,CAAA;IAC5B,gBAAQ,GAAG,2BAAW,CAAC,UAAU,CAAC,CAAA;IAClC,iBAAS,GAAG,2BAAW,CAAC,WAAW,CAAC,CAAA;IACpC,eAAO,GAAG,2BAAW,CAAC,SAAS,CAAC,CAAA;IAChC,iBAAS,GAAG,2BAAW,CAAC,WAAW,CAAC,CAAA;IACpC,oBAAY,GAAG,2BAAW,CAAC,cAAc,CAAC,CAAA;IAC1C,kBAAU,GAAG,2BAAW,CAAC,YAAY,CAAC,CAAA;IACtC,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,yBAAiB,GAAG,2BAAW,CAAC,mBAAmB,CAAC,CAAA;IACpD,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,+BAAuB,GAAG,2BAAW,CAAC,yBAAyB,CAAC,CAAA;IAChE,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,+BAAuB,GAAG,2BAAW,CAAC,yBAAyB,CAAC,CAAA;IAChE,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,mBAAW,GAAG,2BAAW,CAAC,aAAa,CAAC,CAAA;IACxC,iBAAS,GAAG,2BAAW,CAAC,WAAW,CAAC,CAAA;IACpC,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,yBAAiB,GAAG,2BAAW,CAAC,mBAAmB,CAAC,CAAA;IACpD,aAAK,GAAG,2BAAW,CAAC,OAAO,CAAC,CAAA;IAC5B,yCAAiC,GAAG,2BAAW,CAAC,mCAAmC,CAAC,CAAA;IACpF,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,gCAAwB,GAAG,2BAAW,CAAC,0BAA0B,CAAC,CAAA;IAClE,4BAAoB,GAAG,2BAAW,CAAC,sBAAsB,CAAC,CAAA;IAC1D,iCAAyB,GAAG,2BAAW,CAAC,2BAA2B,CAAC,CAAA;IACpE,+CAAuC,GAAG,2BAAW,CAAC,yCAAyC,CAAC,CAAA;IAChG,uCAA+B,GAAG,2BAAW,CAAC,iCAAiC,CAAC,CAAA;IAChF,8CAAsC,GAAG,2BAAW,CAAC,wCAAwC,CAAC,CAAA;IAC9F,uCAA+B,GAAG,2BAAW,CAAC,iCAAiC,CAAC,CAAA;IAChF,8CAAsC,GAAG,2BAAW,CAAC,wCAAwC,CAAC,CAAA;IAC9F,kBAAU,GAAG,2BAAW,CAAC,YAAY,CAAC,CAAA;IACtC,+CAAuC,GAAG,2BAAW,CAAC,yCAAyC,CAAC,CAAA;IAChG,+CAAuC,GAAG,2BAAW,CAAC,yCAAyC,CAAC,CAAA;IAChG,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,oCAA4B,GAAG,2BAAW,CAAC,8BAA8B,CAAC,CAAA;IAC1E,kCAA0B,GAAG,2BAAW,CAAC,4BAA4B,CAAC,CAAA;IACtE,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,4BAAoB,GAAG,2BAAW,CAAC,sBAAsB,CAAC,CAAA;IAC1D,oBAAY,GAAG,2BAAW,CAAC,cAAc,CAAC,CAAA;IAC1C,cAAM,GAAG,2BAAW,CAAC,QAAQ,CAAC,CAAA;IAC9B,yBAAiB,GAAG,2BAAW,CAAC,mBAAmB,CAAC,CAAA;IACpD,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,yBAAiB,GAAG,2BAAW,CAAC,mBAAmB,CAAC,CAAA;IACpD,cAAM,GAAG,2BAAW,CAAC,QAAQ,CAAC,CAAA;IAC9B,yBAAiB,GAAG,2BAAW,CAAC,mBAAmB,CAAC,CAAA;IACpD,+BAAuB,GAAG,2BAAW,CAAC,yBAAyB,CAAC,CAAA;IAChE,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,+BAAuB,GAAG,2BAAW,CAAC,yBAAyB,CAAC,CAAA;IAChE,kCAA0B,GAAG,2BAAW,CAAC,4BAA4B,CAAC,CAAA;IACtE,4BAAoB,GAAG,2BAAW,CAAC,sBAAsB,CAAC,CAAA;IAC1D,sBAAc,GAAG,2BAAW,CAAC,gBAAgB,CAAC,CAAA;IAC9C,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,eAAO,GAAG,2BAAW,CAAC,SAAS,CAAC,CAAA;IAChC,gBAAQ,GAAG,2BAAW,CAAC,UAAU,CAAC,CAAA;IAClC,oBAAY,GAAG,2BAAW,CAAC,cAAc,CAAC,CAAA;IAC1C,oCAA4B,GAAG,2BAAW,CAAC,8BAA8B,CAAC,CAAA;IAC1E,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,wBAAgB,GAAG,2BAAW,CAAC,kBAAkB,CAAC,CAAA;IAClD,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,mCAA2B,GAAG,2BAAW,CAAC,6BAA6B,CAAC,CAAA;IACxE,2BAAmB,GAAG,2BAAW,CAAC,qBAAqB,CAAC,CAAA;IACxD,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,iCAAyB,GAAG,2BAAW,CAAC,2BAA2B,CAAC,CAAA;IACpE,kCAA0B,GAAG,2BAAW,CAAC,4BAA4B,CAAC,CAAA;IACtE,oCAA4B,GAAG,2BAAW,CAAC,8BAA8B,CAAC,CAAA;IAC1E,qCAA6B,GAAG,2BAAW,CAAC,+BAA+B,CAAC,CAAA;IAC5E,4BAAoB,GAAG,2BAAW,CAAC,sBAAsB,CAAC,CAAA;IAC1D,kCAA0B,GAAG,2BAAW,CAAC,4BAA4B,CAAC,CAAA;IACtE,mCAA2B,GAAG,2BAAW,CAAC,6BAA6B,CAAC,CAAA;IACxE,oCAA4B,GAAG,2BAAW,CAAC,8BAA8B,CAAC,CAAA;IAC1E,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,4CAAoC,GAAG,2BAAW,CAAC,sCAAsC,CAAC,CAAA;IAC1F,mDAA2C,GAAG,2BAAW,CAAC,6CAA6C,CAAC,CAAA;IACxG,8BAAsB,GAAG,2BAAW,CAAC,wBAAwB,CAAC,CAAA;IAC9D,mCAA2B,GAAG,2BAAW,CAAC,6BAA6B,CAAC,CAAA;IACxE,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,6BAAqB,GAAG,2BAAW,CAAC,uBAAuB,CAAC,CAAA;IAC5D,qBAAa,GAAG,2BAAW,CAAC,eAAe,CAAC,CAAA;IAC5C,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,oBAAY,GAAG,2BAAW,CAAC,cAAc,CAAC,CAAA;IAC1C,oBAAY,GAAG,2BAAW,CAAC,cAAc,CAAC,CAAA;IAC1C,iBAAS,GAAG,2BAAW,CAAC,WAAW,CAAC,CAAA;IACpC,sCAA8B,GAAG,2BAAW,CAAC,gCAAgC,CAAC,CAAA;IAC9E,kBAAU,GAAG,2BAAW,CAAC,YAAY,CAAC,CAAA;IACtC,0BAAkB,GAAG,2BAAW,CAAC,oBAAoB,CAAC,CAAA;IACtD,uBAAe,GAAG,2BAAW,CAAC,iBAAiB,CAAC,CAAA;IAChD,uCAA+B,GAAG,2BAAW,CAAC,iCAAiC,CAAC,CAAA;AAC/F,CAAC,EA/IgB,OAAO,uBAAP,OAAO,QA+IvB"}
|
|
@@ -21,6 +21,10 @@ export declare namespace Types {
|
|
|
21
21
|
type transferError = components['schemas']['transferError'];
|
|
22
22
|
type accountsResponse = components['schemas']['accountsResponse'];
|
|
23
23
|
type errorAccountsResponse = components['schemas']['errorAccountsResponse'];
|
|
24
|
+
type FspId = components['schemas']['FspId'];
|
|
25
|
+
type accountDeletionStatus = components['schemas']['accountDeletionStatus'];
|
|
26
|
+
type accountDeletionState = components['schemas']['accountDeletionState'];
|
|
27
|
+
type accountDeletionResponse = components['schemas']['accountDeletionResponse'];
|
|
24
28
|
type TransactionInitiatorType = components['schemas']['TransactionInitiatorType'];
|
|
25
29
|
type Name = components['schemas']['Name'];
|
|
26
30
|
type FirstName = components['schemas']['FirstName'];
|
|
@@ -28,7 +32,6 @@ export declare namespace Types {
|
|
|
28
32
|
type LastName = components['schemas']['LastName'];
|
|
29
33
|
type DateOfBirth = components['schemas']['DateOfBirth'];
|
|
30
34
|
type MerchantClassificationCode = components['schemas']['MerchantClassificationCode'];
|
|
31
|
-
type FspId = components['schemas']['FspId'];
|
|
32
35
|
type KYCInformation = components['schemas']['KYCInformation'];
|
|
33
36
|
type extensionListEmptiable = components['schemas']['extensionListEmptiable'];
|
|
34
37
|
type transferParty = components['schemas']['transferParty'];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mojaloop/api-snippets",
|
|
3
|
-
"version": "17.
|
|
3
|
+
"version": "17.9.0",
|
|
4
4
|
"description": "Mojaloop API specification reusable snippets",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -95,21 +95,21 @@
|
|
|
95
95
|
"dompurify": "3.2.4"
|
|
96
96
|
},
|
|
97
97
|
"devDependencies": {
|
|
98
|
-
"@commitlint/cli": "^19.
|
|
99
|
-
"@commitlint/config-conventional": "^19.
|
|
98
|
+
"@commitlint/cli": "^19.8.0",
|
|
99
|
+
"@commitlint/config-conventional": "^19.8.0",
|
|
100
100
|
"@redocly/openapi-cli": "^1.0.0-beta.95",
|
|
101
101
|
"@redocly/cli": "^1.5.0",
|
|
102
102
|
"@types/jest": "^29.5.14",
|
|
103
103
|
"@types/js-yaml": "^4.0.9",
|
|
104
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
105
|
-
"@typescript-eslint/parser": "^8.
|
|
104
|
+
"@typescript-eslint/eslint-plugin": "^8.26.1",
|
|
105
|
+
"@typescript-eslint/parser": "^8.26.1",
|
|
106
106
|
"audit-ci": "^7.1.0",
|
|
107
107
|
"browser-sync": "^3.0.3",
|
|
108
108
|
"diff": "^7.0.0",
|
|
109
109
|
"eslint": "^8.55.0",
|
|
110
|
-
"eslint-config-prettier": "^10.
|
|
110
|
+
"eslint-config-prettier": "^10.1.1",
|
|
111
111
|
"eslint-config-standard": "^17.1.0",
|
|
112
|
-
"eslint-import-resolver-typescript": "^
|
|
112
|
+
"eslint-import-resolver-typescript": "^4.2.2",
|
|
113
113
|
"eslint-plugin-cucumber": "^2.0.0",
|
|
114
114
|
"eslint-plugin-import": "^2.31.0",
|
|
115
115
|
"eslint-plugin-node": "^11.1.0",
|
|
@@ -119,16 +119,16 @@
|
|
|
119
119
|
"husky": "9.1.7",
|
|
120
120
|
"jest": "^29.7.0",
|
|
121
121
|
"jest-junit": "^16.0.0",
|
|
122
|
-
"lint-staged": "^15.
|
|
123
|
-
"npm-check-updates": "^17.1.
|
|
124
|
-
"prettier": "^3.5.
|
|
122
|
+
"lint-staged": "^15.5.0",
|
|
123
|
+
"npm-check-updates": "^17.1.15",
|
|
124
|
+
"prettier": "^3.5.3",
|
|
125
125
|
"standard-version": "^9.5.0",
|
|
126
126
|
"swagger-cli": "^4.0.4",
|
|
127
|
-
"ts-jest": "^29.2.
|
|
127
|
+
"ts-jest": "^29.2.6",
|
|
128
128
|
"ts-node": "^10.9.2",
|
|
129
129
|
"ts-patch": "^3.3.0",
|
|
130
130
|
"tslib": "^2.8.1",
|
|
131
|
-
"typescript": "^5.
|
|
131
|
+
"typescript": "^5.8.2"
|
|
132
132
|
},
|
|
133
133
|
"publishConfig": {
|
|
134
134
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
type: object
|
|
2
|
+
required:
|
|
3
|
+
- idType
|
|
4
|
+
- idValue
|
|
5
|
+
properties:
|
|
6
|
+
idType:
|
|
7
|
+
$ref: ./PartyIdType.yaml
|
|
8
|
+
idValue:
|
|
9
|
+
$ref: ./PartyIdentifier.yaml
|
|
10
|
+
subIdOrType:
|
|
11
|
+
$ref: ./PartySubIdOrType.yaml
|
|
12
|
+
response:
|
|
13
|
+
$ref: ./accountDeletionStatus.yaml
|
|
14
|
+
currentState:
|
|
15
|
+
$ref: ./accountDeletionState.yaml
|
|
16
|
+
lastError:
|
|
17
|
+
$ref: ./transferError.yaml
|
|
18
|
+
deleteAccountResponse:
|
|
19
|
+
type: object
|
|
20
|
+
required:
|
|
21
|
+
- body
|
|
22
|
+
properties:
|
|
23
|
+
body:
|
|
24
|
+
type: object
|
|
25
|
+
headers:
|
|
26
|
+
type: object
|
|
@@ -24,6 +24,10 @@ paths:
|
|
|
24
24
|
$ref: paths.yaml
|
|
25
25
|
/accounts:
|
|
26
26
|
$ref: paths/accounts.yaml
|
|
27
|
+
/accounts/{Type}/{ID}:
|
|
28
|
+
$ref: paths/accounts_Type_ID.yaml
|
|
29
|
+
/accounts/{Type}/{ID}/{SubId}:
|
|
30
|
+
$ref: paths/accounts_Type_ID_SubId.yaml
|
|
27
31
|
/bulkQuotes:
|
|
28
32
|
$ref: paths/bulkQuotes.yaml
|
|
29
33
|
/bulkQuotes/{bulkQuoteId}:
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
delete:
|
|
2
|
+
summary: Delete account on the Account Lookup Service
|
|
3
|
+
description: >-
|
|
4
|
+
The HTTP request `DELETE /accounts/{Type}/{ID}` is used to account account information on
|
|
5
|
+
the Account Lookup Service (ALS) by Type and ID.
|
|
6
|
+
tags:
|
|
7
|
+
- Accounts
|
|
8
|
+
parameters:
|
|
9
|
+
- $ref: ../../components/parameters/Type.yaml
|
|
10
|
+
- $ref: ../../components/parameters/ID.yaml
|
|
11
|
+
responses:
|
|
12
|
+
'200':
|
|
13
|
+
$ref: ../../components/responses/accountDeletionCompleted.yaml
|
|
14
|
+
'400':
|
|
15
|
+
$ref: ../../components/responses/accountDeletionError.yaml
|
|
16
|
+
'500':
|
|
17
|
+
$ref: ../../components/responses/accountDeletionError.yaml
|
|
18
|
+
'504':
|
|
19
|
+
$ref: ../../components/responses/accountDeletionTimeout.yaml
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
delete:
|
|
2
|
+
summary: Delete account on the Account Lookup Service
|
|
3
|
+
description: >-
|
|
4
|
+
The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on
|
|
5
|
+
the Account Lookup Service (ALS) by Type, ID, and SubId.
|
|
6
|
+
tags:
|
|
7
|
+
- Accounts
|
|
8
|
+
parameters:
|
|
9
|
+
- $ref: ../../components/parameters/Type.yaml
|
|
10
|
+
- $ref: ../../components/parameters/ID.yaml
|
|
11
|
+
- $ref: ../../components/parameters/SubId.yaml
|
|
12
|
+
responses:
|
|
13
|
+
'200':
|
|
14
|
+
$ref: ../../components/responses/accountDeletionCompleted.yaml
|
|
15
|
+
'400':
|
|
16
|
+
$ref: ../../components/responses/accountDeletionError.yaml
|
|
17
|
+
'500':
|
|
18
|
+
$ref: ../../components/responses/accountDeletionError.yaml
|
|
19
|
+
'504':
|
|
20
|
+
$ref: ../../components/responses/accountDeletionTimeout.yaml
|