- Created by user-5c3b0 on Jul 18, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
An Account is an atomic unit of asset or liability maintained by IFI for their Account Holders. It corresponds to one ledger in the accounting system, and thus represents an integral value of balance in a specified currency. Simply put, Account is the entity that holds the Account Holder's funds or money.
{
"openapi": "3.0.1",
"security": [
{
"zetaTokenBasedAuth": []
}
],
"tags": [
{
"name": "Account"
},
{
"name": "Account Vector"
},
{
"name": "Account Accessor"
},
{
"name": "Account Relation"
},
{
"name": "Account transactions"
},
{
"name": "Account group"
},
{
"name": "AccountHolder group"
},
{
"name": "Bundles"
}
],
"paths": {
"/api/v1/ifi/{ifiID}/productFamilies/{productFamilyID}/products/{productID}/accounts": {
"post": {
"tags": [
"Account"
],
"summary": "Create Account",
"description": "_Account_ can only by created by the _Account Provider_ registered by the issuer and whitelisted for that particular _Product_ or _Product Family_. Returns account object on successful creation of the object. This request is non-idempotent.",
"operationId": "createAccount",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productFamilyID",
"description": "ID of the _Product Family_ for which the _Account_ is being created.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productID",
"description": "ID of the _Product_ for which the _Account_ is being created.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountRequest"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountHolder"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accounts/{accountID}": {
"get": {
"tags": [
"Account"
],
"summary": "Get Account",
"description": "Returns account object given an `accountID`. `accountID` should be a UUID.",
"operationId": "getAccountByID",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"post": {
"tags": [
"Account"
],
"summary": "Update account ",
"description": "Use this endpoint to update the _Account_. Only the _Account Provider_ who created the _Account_ will be authorized to do so.",
"operationId": "updateAccount",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ being updated.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountRequest"
}
}
}
},
"responses": {
"default": {
"description": "Update Account ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accounts/{accountID}/owner": {
"put": {
"tags": [
"Account"
],
"summary": "Update owner for an account",
"description": "Returns the updated _Account_ object. An _Account Owner_ can be updated in case of merge case scenario.",
"operationId": "updateOwnerForAccount",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the IFI.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ for which an owner is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountOwnerRequest"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accounts/{accountID}/status": {
"put": {
"tags": [
"Account"
],
"summary": "Update Account Status",
"description": "Use this endpoint to update _Account_ status by providing the `status` in the request payload.",
"operationId": "updateAccountStatus",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the IFI.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ for which the status is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountStatusRequest"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accounts/{accountID}/product": {
"put": {
"tags": [
"Account"
],
"summary": "Update Account Product",
"description": "Update account product",
"operationId": "updateProductForAccount",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ for which the product is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductForAccountRequest"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accounts/{accountID}/balance": {
"get": {
"tags": [
"Account"
],
"summary": "Get balance for account",
"description": "Use this endpoint to retrieve the balance of an _Account_.",
"operationId": "getLedgerInfoForAnAccount",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the IFI.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ for which balance is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Balance",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerInfo"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/product/{productID}/accounts": {
"get": {
"tags": [
"Account"
],
"summary": "Get Account List given a product id",
"description": "Use this endpoint to retrieve a list of accounts for a _Product_ by providing the `productID`, along with other filters. ",
"operationId": "getAccountListForProduct",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productID",
"description": "ID of the _Product_ under which list of _Accounts_ is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "programID",
"description": "ID of the _Program_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountProviderID",
"description": "ID of the _Account Provider_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountHolderID",
"description": "ID of the _Account Holder_ for which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the _Account_ being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"description": "The specific page being requested.",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "pageSize",
"description": "Defines the number of items to be displayed on one page.",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/productFamily/{productFamilyID}/accounts": {
"get": {
"tags": [
"Account"
],
"summary": "Get Account List given a product family id",
"description": "Use this endpoint to retrieve a list of _Accounts_ for a _Product Family_ by providing the `productFamilyID`, along with other filters.",
"operationId": "getAccountListForProductFamily",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productFamilyID",
"description": "ID of the _Product Family_ under which list of _Accounts_ is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "programID",
"description": "ID of the _Program_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountProviderID",
"description": "ID of the _Account Provider_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountHolderID",
"description": "ID of the _Account Holder_ for which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the _Account_ being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"description": "The specific page being requested.",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "pageSize",
"description": "Defines the number of items to be displayed on one page.",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/program/{programID}/accounts": {
"get": {
"tags": [
"Account"
],
"summary": "Get Account List given a program id",
"description": "Use this endpoint to retrieve a list of _Accounts_ for a _Programy_ by providing the `programID`, along with other filters.",
"operationId": "getAccountListForPrograms",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "programID",
"description": "ID of the _Program_ under which list of _Accounts_ is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "productID",
"description": "ID of the _Product_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "accountProviderID",
"description": "ID of the _Account Provider_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountHolderID",
"description": "ID of the _Account Holder_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the _Account_ being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"description": "The specific page being requested.",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "pageSize",
"description": "Defines the number of items to be displayed on one page.",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accountHolder/{accountHolderID}/accounts": {
"get": {
"tags": [
"Account"
],
"summary": "Get Account List",
"description": "Use this endpoint to retrieve a list of _Accounts_ depending upon various filters.",
"operationId": "getAccountListForAccountHolder",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "accountHolderID",
"description": "ID of the _Account Holder_ under which list of _Accounts_ is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "programID",
"description": "ID of the _Program_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "productID",
"description": "ID of the _Product_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "productFamilyID",
"description": "ID of the _Product Family_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountProviderID",
"description": "ID of the _Account Provider_ under which list of _Accounts_ is being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the _Account_ being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"description": "The specific page being requested.",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "pageSize",
"description": "Defines the number of items to be displayed on one page.",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/vectors": {
"get": {
"tags": [
"Account Vector"
],
"summary": "Get Vectors",
"description": "Use this endpoint to get _Vectors_ of an _Account_.",
"operationId": "getAccountVectors",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ for which _Vectors_ are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Get Vectors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountVectorListResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"post": {
"tags": [
"Account Vector"
],
"summary": "Add vector",
"description": "Use this endpoint to add a _Vector_ to an _Account_.",
"operationId": "addAccountVector",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ to which the _Vector_ is being added.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddAccountVectorRequest"
}
}
}
},
"responses": {
"default": {
"description": "Add vector",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVector"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/vectors/{vectorID}": {
"get": {
"tags": [
"Account Vector"
],
"summary": "Get Vector by ID",
"description": "Use this endpoint to retrieve the _Vector_ of an _Account_ by `vectorID`.",
"operationId": "getAccountVectorByID",
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the _IFI_.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "accountID",
"description": "ID of the _Account_ for which _Vector_ is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vectorID",
"description": "ID of the _Vector_ for which details are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Get Vector by ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVector"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"put": {
"tags": [
"Account Vector"
],
"summary": "Update account vector",
"description": "Account alias maps various reference vectors to an account. Eg. Account numbers, email addresses.\nWe should also have various account number generators, // across product , product family and programs. Just like address allocation and address resolution works. // We should be able to map any account to an alias which are unique across the issuer system. For V1, this can just be an empty set.",
"operationId": "updateAccountVector",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which account vector is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Vector is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountVectorRequest"
}
}
}
},
"responses": {
"default": {
"description": "Add vector",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"delete": {
"tags": [
"Account Vector"
],
"summary": "Delete Vector by ID",
"description": "Delete vector by ID",
"operationId": "deleteAccountVectorByID",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Vectors is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Vector is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vectorID",
"description": "ID of the Vector for which details is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Delete Vector by ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVector"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/accessors": {
"get": {
"tags": [
"Account Accessor"
],
"summary": "Get Accessors",
"description": "Get accessors",
"operationId": "getAccountAccessors",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Accessors are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Accessors are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Get Accessors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountAccessorListResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"post": {
"tags": [
"Account Accessor"
],
"summary": "Add accessor",
"description": "Add accessor",
"operationId": "addAccountAccessor",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which account Accessor is being added.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Accessors are being added.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddAccountAccessorRequest"
}
}
}
},
"responses": {
"default": {
"description": "Add accessor",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accessor"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/accessors/{accessorID}": {
"get": {
"tags": [
"Account Accessor"
],
"summary": "Get Accessor by ID",
"description": "Get accessor by ID",
"operationId": "getAccountAccessorByID",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Accessor is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Accessor is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accessorID",
"description": "ID of the Accessor for which details is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Get Accessor by ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accessor"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"put": {
"tags": [
"Account Accessor"
],
"summary": "Update account accessor",
"description": "Update account accessor",
"operationId": "updateAccountAccessor",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Accessor is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Accessor is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountAccessorRequest"
}
}
}
},
"responses": {
"default": {
"description": "Add accessor",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accessor"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"delete": {
"tags": [
"Account Accessor"
],
"summary": "Delete Accessor by ID",
"description": "Delete accessor by ID",
"operationId": "deleteAccountAccessorByID",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Accessor is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Accessor is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accessorID",
"description": "ID of the accessor being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Delete Accessor by ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accessor"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/accessors/{accessorID}/transactionPolicy/{transactionPolicyID}": {
"post": {
"tags": [
"Account Accessor"
],
"summary": "Add account accessor transaction policy",
"description": "Add account accessor transaction policy",
"operationId": "addTransactionPolicyInAccessor",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Accessor transaction policy is being added.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Accessor transaction policy is being added.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transactionPolicyiD",
"description": "ID of the Transaction policy being added under Account Accessor.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Add transaction policy for given accessor",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accessor"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"delete": {
"tags": [
"Account Accessor"
],
"summary": "Delete account accessor transaction policy",
"description": "Delete account accessor transaction policy",
"operationId": "deleteTransactionPolicyInAccessor",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Accessor transaction policy is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Accessor transaction policy is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transactionPolicyiD",
"description": "ID of the Transaction policy under account accessor to be deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Delete transaction policy for given accessor",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accessor"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/relations/{relationID}": {
"get": {
"tags": [
"Account Relation"
],
"summary": "Get Relation by ID",
"description": "Get relation by ID",
"operationId": "getAccountRelationByID",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which Account Relation is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Relation is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "relationID",
"description": "ID of the Relation being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Get Relation by ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountRelation"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"put": {
"tags": [
"Account Relation"
],
"summary": "Update account relation",
"description": "Update account relation",
"operationId": "updateAccountRelation",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Account Relation is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which relation is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountRelationRequest"
}
}
}
},
"responses": {
"default": {
"description": "Add relation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"delete": {
"tags": [
"Account Relation"
],
"summary": "Delete Relation by ID",
"description": "Delete relation by ID",
"operationId": "deleteAccountRelationByID",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Account Relation is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Relation is being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "relationID",
"description": "ID of the Relation being deleted.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Delete Relation by ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountRelation"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/relations": {
"get": {
"tags": [
"Account Relation"
],
"summary": "Get Relations",
"description": "Get relations",
"operationId": "getAccountRelations",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Account Relations is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Relations are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Get Relations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountRelationListResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
},
"post": {
"tags": [
"Account Relation"
],
"summary": "Add relation",
"description": "Add relation",
"operationId": "addAccountRelation",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Account Relation is being added.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which Relation is being added.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddAccountRelationRequest"
}
}
}
},
"responses": {
"default": {
"description": "Add relation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountRelation"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/transactions": {
"get": {
"tags": [
"Account transactions"
],
"summary": "Get transactions for an account",
"description": "Get transactions for an account",
"operationId": "getAccountTransactions",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Account Transactions is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which transactions are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "startingAfter",
"description": "Starting date from which transactions are being retrieved.",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endingBefore",
"description": "Ending date for which transactions are being retrieved.",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "limit",
"description": "Maximum number of transactions being retrieved.",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "recordType",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "remarks",
"description": "State of the transaction being retrieved.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "voucherCode",
"description": "Alphanumeric code of the voucher to be registered.",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "searchKeys",
"in": "query",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account transactions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTransactionsResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/account/{accountID}/transactions/{transactionID}": {
"get": {
"tags": [
"Account transactions"
],
"summary": "Get transaction details for an account given a transactionID",
"description": "Get transaction details for an account given a transactionID",
"operationId": "getAccountTransactionByID",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Account Transaction details is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountID",
"description": "ID of the Account for which transaction details is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transactionID",
"description": "ID of the Transaction for which details is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account transaction",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountTransaction"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/account",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accountGroups": {
"get": {
"tags": [
"Account group"
],
"summary": "Get account groups",
"description": "Returns list of account groups with the given filters.",
"operationId": "getAccountGroup",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which the Account groups are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAccountGroupResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
},
"post": {
"tags": [
"Account group"
],
"summary": "Create account group",
"description": "Returns Created account group.",
"operationId": "createAccountGroup",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which an Account group is being created.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountGroupRequest"
}
}
}
},
"responses": {
"default": {
"description": "Account Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accountHolderGroups": {
"get": {
"tags": [
"AccountHolder group"
],
"summary": "Get accountHolder groups",
"description": "Returns list of accountHolder groups with the given filters.",
"operationId": "getAccountHolderGroup_1",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which the Account Holder groups are being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "AccountHolder Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAccountHolderGroupResponse"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
},
"post": {
"tags": [
"AccountHolder group"
],
"summary": "Create accountHolder group",
"description": "Returns Created accountHolder group.",
"operationId": "createAccountHolderGroup",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which an Account Holder group is being created.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountHolderGroupRequest"
}
}
}
},
"responses": {
"default": {
"description": "AccountHolder Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountHolderGroup"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accountHolderGroups/{accountHolderGroupID}": {
"get": {
"tags": [
"AccountHolder group"
],
"summary": "Get accountHolder group",
"description": "Returns accountHolder group.",
"operationId": "getAccountHolderGroup",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which the Account Holder Group is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountHolderGroupID",
"description" : "ID of the Account Holder Group for which the details is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "AccountHolder Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountHolderGroup"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
},
"post": {
"tags": [
"AccountHolder group"
],
"summary": "Update accountHolder group",
"description": "Returns Update accountHolder group.",
"operationId": "updateAccountHolderGroup",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which the Account Holder Group is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountHolderGroupID",
"description" : "ID of the Account Holder Group for which details is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountHolderGroupRequest"
}
}
}
},
"responses": {
"default": {
"description": "AccountHolder Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountHolderGroup"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/accountGroups/{accountGroupID}": {
"get": {
"tags": [
"Account group"
],
"summary": "Get account group",
"description": "Returns account group.",
"operationId": "getAccountGroup_1",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which the Account Group is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountGroupID",
"description" : "ID of the Account Group for which details is being retrieved.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"default": {
"description": "Account Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
},
"put": {
"tags": [
"Account group"
],
"summary": "Update account group",
"description": "Returns Updated account group.",
"operationId": "updateAccountGroup",
"parameters": [
{
"name": "ifiID",
"description" : "ID of the IFI (on-boarded organization) under which the Account Group is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountGroupID",
"description" : "ID of the Account Group for which is being updated.",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountGroupRequest"
}
}
}
},
"responses": {
"default": {
"description": "Account Group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
}
}
}
}
},
"servers": [
{
"url": "http://api.stage.zeta.in/athena-manager",
"variables": {}
}
]
}
},
"/api/v1/ifi/{ifiID}/bundles": {
"get": {
"tags": [
"Bundles"
],
"summary": "getAllBundles",
"description": "Use this endpoint to retrieve all _Bundles_ for an _IFI_.",
"operationId": "getAllBundlesUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the _IFI_.",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BundleResponse"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/ifi/{ifiID}/bundles/{bundleID}": {
"get": {
"tags": [
"Bundles"
],
"summary": "getBundleByID",
"description": "Use this endpoint to retrieve _Bundle_ by `bundleID` for an _IFI_.",
"operationId": "getBundleByIDUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the _IFI_.",
"required": false,
"type": "integer"
},
{
"name": "bundleID",
"in": "path",
"description": "ID of the _Bundle_ whose details are being retrieved.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BundleResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueAccount": {
"post": {
"tags": [
"Bundles"
],
"summary": "issueAccountProduct",
"description": "Use this endpoint to issue an _Account Product_ to an _Account Holder_.",
"operationId": "issueAccountProductUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the _IFI_.",
"required": true,
"type": "integer"
},
{
"name": "bundleID",
"in": "path",
"description": "ID of the _Bundle_ whose _Account Product_ is being issued.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "issueAccountArtifactRequest",
"description": "Click Model below to learn about request body constructs.",
"required": true,
"schema": {
"$ref": "#/definitions/IssueAccountArtifactRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CompletionStage«IssueAccountArtifactResponse»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueBundle": {
"post": {
"tags": [
"Bundles"
],
"summary": "issueBundle",
"description": "Use this endpoint to issue a _Bundle_ to an _Account Holder_.",
"operationId": "issueBundleUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the _IFI_.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "bundleID",
"in": "path",
"description": "ID of the _Bundle_ which is being issued.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "issueBundleRequest",
"description": "issueBundleRequest",
"required": true,
"schema": {
"$ref": "#/definitions/IssueBundleRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CompletionStage«IssueBundleResponse»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueFormFactor": {
"post": {
"tags": [
"Bundles"
],
"summary": "issueFormFactor",
"description": "Use this endpoint to issue a _Form factor_ to an _Account Holder_.",
"operationId": "issueFormFactorUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the _IFI_.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "bundleID",
"in": "path",
"description": "ID of the _Bundle_ whose _Form Factor_/_Card_ is being issued.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "issueFormFactorRequest",
"description": "Click Model below to learn about request body constructs.",
"required": true,
"schema": {
"$ref": "#/definitions/IssueFormFactorRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CompletionStage«IssueFormFactorResponse»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueResource": {
"post": {
"tags": [
"Bundles"
],
"summary": "issueResource",
"description": "Use this endpoint to issue a _Resource_ to an _Account Holder_.",
"operationId": "issueResourceUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the _IFI_.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "bundleID",
"in": "path",
"description": "ID of the _Bundle_ whose _Resource_ is being issued.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "issueResourceRequest",
"description": "Click Model below to learn about request body constructs.",
"required": true,
"schema": {
"$ref": "#/definitions/IssueResourceRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CompletionStage«IssueResourceResponse»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueAccountProducts": {
"post": {
"tags": [
"Bundles"
],
"summary": "Issue multiple Account Products",
"description": "A list of _Account Products_ are taken as input by providing `accountProductID`. The _Account Products_ are issued to the _Account Holders_, identified by `accountHolderID`. Depending on the issuance state, the `status` returned in the response can be `enabled` or `disabled`.",
"operationId": "issueAccountProductUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the _IFI_.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "bundleID",
"in": "path",
"description": "ID of the _Bundle_ being issued.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "issueAccountArtifactRequests",
"description": "Click model below to know about request body constructs.",
"required": true,
"schema": {
"$ref": "#/definitions/IssueAccountProductsRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IssueAccountArtifactResponse"
}
}
}
}
},
"/api/v1/ifi/{ifiID}/bundles/{bundleID}/issuePaymentProducts": {
"post": {
"tags": [
"Bundles"
],
"summary": "Issue multiple Payment Products",
"description": "A list of _Payment Products_ are taken as input by providing `paymentProductID`. The _Products Products_ are issued to the _Account Holders_, identified by `accountHolderID`. Depending on the issuance state, the `status` returned in the response can be `active`, `inactive` or `deleted`.",
"operationId": "issueMultiplePaymentProductsUsingPOST_1",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the IFI.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "bundleID",
"in": "path",
"description": "ID of the _Bundle_ being issued.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "issuePaymentProductsRequest",
"description": "Click model below to know about request body constructs.",
"required": true,
"schema": {
"$ref": "#/definitions/IssuePaymentProductsRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IssueAccountArtifactResponse"
}
}
}
}
},
},
"definitions": {
"IssueAccountProductsRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "ID of the _Account Holder_ to whom the _Bundle_ is being issued.",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "`requestID` as an idempotent key",
"allowEmptyValue": false
},
"issueAccountArtifactRequests": {
"type": "array",
"items": {
"$ref": "#/definitions/IssueAccountArtifactRequest"
}
}
},
"title": "IssueAccountProductsRequest"
},
"IssuePaymentProductsRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "ID of the _Account Holder_ to whom the _Bundle_ is being issued.",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "`requestID` as an idempotent key.",
"allowEmptyValue": false
},
"issuePaymentProductRequests": {
"type": "array",
"items": {
"$ref": "#/definitions/IssuePaymentProductRequest"
}
}
},
"title": "IssuePaymentProductsRequest"
},
"IssuePaymentProductRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paymentProductID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Product_ which is part of the issuing _Bundle_.",
"allowEmptyValue": false
},
"phoneNumber": {
"type": "string",
"example": "+919876543210",
"description": "The phone number to be assosciated with the _Account_ and the _card_.",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "`requestID` as an idempotent key.",
"allowEmptyValue": false
},
"targetAccountID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the individual's account which is to be linked to the resource/card.",
"allowEmptyValue": false
},
"attributes": {
"type": "object"
}
},
"title": "IssuePaymentProductRequest"
},
"Accessor": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "Accessor"
},
"AccountRelation": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relatedAccountID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "AccountRelation"
},
"AccountVector": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
}
},
"title": "AccountVector"
},
"IssueAccountArtifactRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_ being issued with the _Account_.",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Victor",
"description": "Preferred name in the _Account_.",
"allowEmptyValue": false
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
},
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelation"
}
},
"accountProductID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Product_ which is part of the issuing _Bundle_.",
"allowEmptyValue": false
}
},
"title": "IssueAccountArtifactRequest"
},
"IssueAccountArtifactResponse": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"bundleID": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"accountID": {
"type": "string"
}
},
"title": "IssueAccountArtifactResponse"
},
"IssueBundleRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_ to whom the _Bundle_ is being issued.",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Victor",
"description": "Preferred name in the _Account_.",
"allowEmptyValue": false
},
"phoneNumber": {
"type": "string",
"example": "+919876543210",
"description": "The phone number associated with the _Account_ and the _Card_.",
"allowEmptyValue": false
}
},
"title": "IssueBundleRequest"
},
"IssueBundleResponse": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/IssueAccountArtifactResponse"
}
},
"bundleID": {
"type": "string"
},
"paymentInstruments": {
"type": "array",
"items": {
"$ref": "#/definitions/IssuePaymentProductResponse"
}
}
},
"title": "IssueBundleResponse"
},
"IssueFormFactorRequest": {
"type": "object",
"properties": {
"formFactorProductID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the _Form Factor_/_Card_ which is being issued.",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"targetAccountID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_'s _Account_ which is to be linked to the _Resource_/_Card_.",
"allowEmptyValue": false
},
"attributes": {
"type": "object"
},
"resourceID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the _Resource_ which is being issued and is part of the _Bundle_.",
"allowEmptyValue": false
},
"orderDetails": {
"type": "object"
}
},
"title": "IssueFormFactorRequest"
},
"IssueFormFactorResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"status": {
"type": "string"
},
"targetUri": {
"type": "string"
}
},
"title": "IssueFormFactorResponse"
},
"IssueResourceResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"targetUri": {
"type": "string"
},
"resourceID": {
"type": "string"
}
},
"title": "IssueResourceResponse"
},
"ModelAndView": {
"type": "object",
"properties": {
"empty": {
"type": "boolean"
},
"model": {
"type": "object"
},
"modelMap": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"reference": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"view": {
"$ref": "#/definitions/View"
},
"viewName": {
"type": "string"
}
},
"title": "ModelAndView"
},
"ProductInfoRequest": {
"type": "object",
"properties": {
"productID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "The UUID of the account product which will be a part of the bundle",
"allowEmptyValue": false
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
},
"description": "The UUIDs of the programs which will be associated to the account product at the time of issuance",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"description": "Any additional information which is specific to the product info",
"allowEmptyValue": false
},
"productFamilyID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "The UUID of the product's family which will be a part of the bundle",
"allowEmptyValue": false
}
},
"title": "ProductInfoRequest"
},
"Timestamp": {
"type": "object",
"properties": {
"date": {
"type": "integer",
"format": "int32"
},
"day": {
"type": "integer",
"format": "int32"
},
"hours": {
"type": "integer",
"format": "int32"
},
"minutes": {
"type": "integer",
"format": "int32"
},
"month": {
"type": "integer",
"format": "int32"
},
"nanos": {
"type": "integer",
"format": "int32"
},
"seconds": {
"type": "integer",
"format": "int32"
},
"time": {
"type": "integer",
"format": "int64"
},
"timezoneOffset": {
"type": "integer",
"format": "int32"
},
"year": {
"type": "integer",
"format": "int32"
}
},
"title": "Timestamp"
},
"View": {
"type": "object",
"properties": {
"contentType": {
"type": "string"
}
},
"title": "View"
},
"Account": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"accountProviderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cardID": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"ledgerID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"ownerAccountHolderID": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"productID": {
"type": "integer",
"format": "int64"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelation"
}
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
}
},
"title": "Account"
},
"AccountHolder": {
"type": "object",
"properties": {
"accountHolderProviderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"dob": {
"type": "string",
"format": "date"
},
"firstName": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"kycstatus": {
"$ref": "#/definitions/KYCStatus"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"name": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"requestID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"userId": {
"type": "integer",
"format": "int64"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "AccountHolder"
},
"AccountHolderRelation": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relatedAccountHolderID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "AccountHolderRelation"
},
"AccountHolderVector": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
}
},
"title": "AccountHolderVector"
},
"AccountTransaction": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"currency": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ledgerID": {
"type": "integer",
"format": "int64"
},
"newBalance": {
"type": "integer",
"format": "int64"
},
"previousBalance": {
"type": "integer",
"format": "int64"
},
"recordType": {
"type": "string"
},
"remarks": {
"type": "string"
},
"reversalTransactionIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"reversedTransactionID": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int64"
},
"transactionID": {
"type": "string"
}
},
"title": "AccountTransaction"
},
"AddAccountAccessorRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "AddAccountAccessorRequest"
},
"AddAccountHolderPOPRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"label": {
"type": "string"
},
"address": {
"$ref": "#/definitions/Address"
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "AddAccountHolderPOPRequest"
},
"AddAccountHolderRelationshipRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"relatedAccountHolderID": {
"type": "string"
},
"relationshipType": {
"type": "string"
}
},
"title": "AddAccountHolderRelationshipRequest"
},
"AddAccountHolderVectorRequest": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"verified": {
"type": "boolean"
}
},
"title": "AddAccountHolderVectorRequest"
},
"AddAccountProductInBundleRequest": {
"type": "object",
"properties": {
"accountProduct": {
"description": "The account product which will be a part of the bundle",
"allowEmptyValue": false,
"$ref": "#/definitions/ProductInfoRequest"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "AddAccountProductInBundleRequest"
},
"AddAccountRelationRequest": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relatedAccountID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
}
},
"title": "AddAccountRelationRequest"
},
"AddAccountVectorRequest": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"title": "AddAccountVectorRequest"
},
"AddBeneficiaryAccountForBeneficiaryRequest": {
"type": "object",
"properties": {
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"default": {
"type": "boolean"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"nickname": {
"type": "string"
},
"parentAccountHolderID": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"title": "AddBeneficiaryAccountForBeneficiaryRequest"
},
"AddBundleRequest": {
"type": "object",
"properties": {
"accountProducts": {
"type": "array",
"description": "The list of account products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"attributes": {
"type": "object",
"description": "Any additional information which is specific to the bundle",
"allowEmptyValue": false
},
"description": {
"type": "string",
"example": "Bundle related to savings accounts. Consists of a savings account product and a related debit card",
"description": "The detailed description of the bundle",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Savings Bundle",
"description": "The name which would be assigned to the bundle",
"allowEmptyValue": false
},
"paymentProducts": {
"type": "array",
"description": "The list of payment products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"picURL": {
"type": "string",
"description": "The URL to get the bundle's display pic",
"allowEmptyValue": false
},
"shortCode": {
"type": "string",
"example": "SVNG",
"description": "The short code to identify the bundle",
"allowEmptyValue": false
}
},
"title": "AddBundleRequest"
},
"AddPaymentProductInBundleRequest": {
"type": "object",
"properties": {
"paymentProduct": {
"description": "The payment product which will be a part of the bundle",
"allowEmptyValue": false,
"$ref": "#/definitions/ProductInfoRequest"
}
},
"title": "AddPaymentProductInBundleRequest"
},
"Address": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"addressLine4": {
"type": "string"
},
"city": {
"type": "string"
},
"contactNumber": {
"type": "string"
},
"country": {
"type": "string"
},
"name": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
}
},
"title": "Address"
},
"Beneficiary": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryAccount"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"dob": {
"type": "string",
"format": "date"
},
"firstName": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"relationship": {
"type": "string"
},
"requestID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryVector"
}
}
},
"title": "Beneficiary"
},
"BeneficiaryAccount": {
"type": "object",
"properties": {
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"default": {
"type": "boolean"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"nickname": {
"type": "string"
},
"parentAccountHolderID": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"verified": {
"type": "boolean"
}
},
"title": "BeneficiaryAccount"
},
"BeneficiaryAccountInfo": {
"type": "object",
"properties": {
"accountNumber": {
"type": "string"
},
"accountProvider": {
"type": "string"
},
"accountType": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"nameAtAccountProvider": {
"type": "string"
},
"routingCode": {
"type": "string"
}
},
"title": "BeneficiaryAccountInfo"
},
"BeneficiaryAccountListResponse": {
"type": "object",
"properties": {
"beneficiaryAccountList": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryAccount"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "BeneficiaryAccountListResponse"
},
"BeneficiaryAccountTransactionRequest": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryAccountID": {
"type": "string"
},
"beneficiaryID": {
"type": "string"
},
"currency": {
"type": "string"
},
"debitAccountHolderID": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"requestID": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryAccountTransactionRequest"
},
"BeneficiaryListResponse": {
"type": "object",
"properties": {
"beneficiaryList": {
"type": "array",
"items": {
"$ref": "#/definitions/Beneficiary"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "BeneficiaryListResponse"
},
"BeneficiaryTransaction": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryAccountID": {
"type": "string"
},
"beneficiaryID": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"currency": {
"type": "string"
},
"debitAccountHolderID": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionID": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryTransaction"
},
"BeneficiaryTransactionRequest": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"currency": {
"type": "string"
},
"debitAccountHolderID": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"requestID": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryTransactionRequest"
},
"BeneficiaryTransactionResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transactionID": {
"type": "string"
}
},
"title": "BeneficiaryTransactionResponse"
},
"BeneficiaryVector": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
}
},
"title": "BeneficiaryVector"
},
"Builder": {
"type": "object",
"properties": {
"object": {
"$ref": "#/definitions/JID"
},
"tenantID": {
"type": "integer",
"format": "int64"
}
},
"title": "Builder"
},
"BundleResponse": {
"type": "object",
"properties": {
"accountProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductInfoResponse"
}
},
"attributes": {
"type": "object"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"paymentProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductInfoResponse"
}
},
"picURL": {
"type": "string"
},
"shortCode": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"vboID": {
"type": "string"
}
},
"title": "BundleResponse"
},
"CardBinRange": {
"type": "object",
"properties": {
"bin": {
"type": "string"
},
"range": {
"type": "string"
}
},
"title": "CardBinRange"
},
"CardOrder": {
"type": "object",
"properties": {
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cardSkuID": {
"type": "string"
},
"deliveryAddress": {
"$ref": "#/definitions/Address"
},
"expiry": {
"$ref": "#/definitions/Expiry"
},
"fourthLineEmbossing": {
"type": "string"
},
"orderID": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "CardOrder"
},
"CardView": {
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/Account"
},
"associatedAt": {
"type": "string",
"format": "date-time"
},
"binRange": {
"$ref": "#/definitions/CardBinRange"
},
"cardID": {
"type": "string"
},
"cardStatus": {
"type": "string"
},
"cardType": {
"type": "string"
},
"crn": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"maskedPan": {
"type": "string"
},
"orderDetails": {
"$ref": "#/definitions/OrderDetails"
},
"sensitiveView": {
"$ref": "#/definitions/SensitiveCardView"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "CardView"
},
"Channel": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"paymentCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "Channel"
},
"CompletionStage«Accessor»": {
"type": "object",
"title": "CompletionStage«Accessor»"
},
"CompletionStage«AccountHolderRelation»": {
"type": "object",
"title": "CompletionStage«AccountHolderRelation»"
},
"CompletionStage«AccountHolderVector»": {
"type": "object",
"title": "CompletionStage«AccountHolderVector»"
},
"CompletionStage«AccountHolder»": {
"type": "object",
"title": "CompletionStage«AccountHolder»"
},
"CompletionStage«AccountRelation»": {
"type": "object",
"title": "CompletionStage«AccountRelation»"
},
"CompletionStage«AccountTransaction»": {
"type": "object",
"title": "CompletionStage«AccountTransaction»"
},
"CompletionStage«AccountVector»": {
"type": "object",
"title": "CompletionStage«AccountVector»"
},
"CompletionStage«Account»": {
"type": "object",
"title": "CompletionStage«Account»"
},
"CompletionStage«BeneficiaryAccountListResponse»": {
"type": "object",
"title": "CompletionStage«BeneficiaryAccountListResponse»"
},
"CompletionStage«BeneficiaryAccount»": {
"type": "object",
"title": "CompletionStage«BeneficiaryAccount»"
},
"CompletionStage«BeneficiaryListResponse»": {
"type": "object",
"title": "CompletionStage«BeneficiaryListResponse»"
},
"CompletionStage«BeneficiaryTransactionResponse»": {
"type": "object",
"title": "CompletionStage«BeneficiaryTransactionResponse»"
},
"CompletionStage«BeneficiaryTransaction»": {
"type": "object",
"title": "CompletionStage«BeneficiaryTransaction»"
},
"CompletionStage«Beneficiary»": {
"type": "object",
"title": "CompletionStage«Beneficiary»"
},
"CompletionStage«CardOrder»": {
"type": "object",
"title": "CompletionStage«CardOrder»"
},
"CompletionStage«CardView»": {
"type": "object",
"title": "CompletionStage«CardView»"
},
"CompletionStage«CreateAndLinkFormFactorResponse»": {
"type": "object",
"title": "CompletionStage«CreateAndLinkFormFactorResponse»"
},
"CompletionStage«FormFactorProduct»": {
"type": "object",
"title": "CompletionStage«FormFactorProduct»"
},
"CompletionStage«FormFactor»": {
"type": "object",
"title": "CompletionStage«FormFactor»"
},
"CompletionStage«GetAccountAccessorListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountAccessorListResponse»"
},
"CompletionStage«GetAccountBalanceResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountBalanceResponse»"
},
"CompletionStage«GetAccountHolderRelationListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountHolderRelationListResponse»"
},
"CompletionStage«GetAccountListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountListResponse»"
},
"CompletionStage«GetAccountRelationListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountRelationListResponse»"
},
"CompletionStage«GetAccountTransactionListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountTransactionListResponse»"
},
"CompletionStage«GetAccountVectorListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountVectorListResponse»"
},
"CompletionStage«GetAllAccountHoldersResponse»": {
"type": "object",
"title": "CompletionStage«GetAllAccountHoldersResponse»"
},
"CompletionStage«GetBeneficiaryTransactionListResponse»": {
"type": "object",
"title": "CompletionStage«GetBeneficiaryTransactionListResponse»"
},
"CompletionStage«GetPOPListResponse»": {
"type": "object",
"title": "CompletionStage«GetPOPListResponse»"
},
"CompletionStage«InsertFormFactorProductResponse»": {
"type": "object",
"title": "CompletionStage«InsertFormFactorProductResponse»"
},
"CompletionStage«InsertFormFactorResponse»": {
"type": "object",
"title": "CompletionStage«InsertFormFactorResponse»"
},
"CompletionStage«InsertPaymentProductResponse»": {
"type": "object",
"title": "CompletionStage«InsertPaymentProductResponse»"
},
"CompletionStage«InsertResourceProductResponse»": {
"type": "object",
"title": "CompletionStage«InsertResourceProductResponse»"
},
"CompletionStage«InsertResourceResponse»": {
"type": "object",
"title": "CompletionStage«InsertResourceResponse»"
},
"CompletionStage«IssueAccountArtifactResponse»": {
"type": "object",
"title": "CompletionStage«IssueAccountArtifactResponse»"
},
"CompletionStage«IssueBundleResponse»": {
"type": "object",
"title": "CompletionStage«IssueBundleResponse»"
},
"CompletionStage«IssueFormFactorResponse»": {
"type": "object",
"title": "CompletionStage«IssueFormFactorResponse»"
},
"CompletionStage«IssueResourceResponse»": {
"type": "object",
"title": "CompletionStage«IssueResourceResponse»"
},
"CompletionStage«ListResourceResponse»": {
"type": "object",
"title": "CompletionStage«ListResourceResponse»"
},
"CompletionStage«List«CardView»»": {
"type": "object",
"title": "CompletionStage«List«CardView»»"
},
"CompletionStage«OrderSummary»": {
"type": "object",
"title": "CompletionStage«OrderSummary»"
},
"CompletionStage«POP»": {
"type": "object",
"title": "CompletionStage«POP»"
},
"CompletionStage«PaymentProduct»": {
"type": "object",
"title": "CompletionStage«PaymentProduct»"
},
"CompletionStage«ResourceProduct»": {
"type": "object",
"title": "CompletionStage«ResourceProduct»"
},
"CompletionStage«Resource»": {
"type": "object",
"title": "CompletionStage«Resource»"
},
"CompletionStage«TransferResponse»": {
"type": "object",
"title": "CompletionStage«TransferResponse»"
},
"CompletionStage«Void»": {
"type": "object",
"title": "CompletionStage«Void»"
},
"Contact": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "Contact"
},
"CreateAccountHolderRequest": {
"type": "object",
"properties": {
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"salutation": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"gender": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
}
},
"title": "CreateAccountHolderRequest"
},
"CreateAndLinkFormFactorResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"provisionFormFactorResponse": {
"type": "object"
},
"resource": {
"$ref": "#/definitions/Resource"
}
},
"title": "CreateAndLinkFormFactorResponse"
},
"CreateBeneficiaryRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"gender": {
"type": "string"
},
"salutation": {
"type": "string"
},
"relationship": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryVector"
}
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "CreateBeneficiaryRequest"
},
"ECDHEncryptedCardPayload": {
"type": "object",
"properties": {
"encryptedData": {
"type": "string"
},
"iv": {
"type": "string"
},
"serverPublicKey": {
"type": "string"
}
},
"title": "ECDHEncryptedCardPayload"
},
"Expiry": {
"type": "object",
"properties": {
"month": {
"type": "integer",
"format": "int32"
},
"year": {
"type": "integer",
"format": "int32"
}
},
"title": "Expiry"
},
"FormFactor": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactorID": {
"type": "string"
},
"formFactorProductID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "FormFactor"
},
"FormFactorProduct": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"issuanceStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"paymentStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"policies": {
"$ref": "#/definitions/Policies"
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"type": {
"type": "string"
}
},
"title": "FormFactorProduct"
},
"GetAccountAccessorListResponse": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountAccessorListResponse"
},
"GetAccountBalanceResponse": {
"type": "object",
"properties": {
"accountingType": {
"type": "string",
"enum": [
"ASSET",
"LIABILITY",
"INCOME",
"EXPENSE",
"EQUITY"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"balance": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"lastTransactionID": {
"type": "string"
}
},
"title": "GetAccountBalanceResponse"
},
"GetAccountHolderRelationListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderRelation"
}
}
},
"title": "GetAccountHolderRelationListResponse"
},
"GetAccountListResponse": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/Account"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountListResponse"
},
"GetAccountRelationListResponse": {
"type": "object",
"properties": {
"accountRelations": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelation"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountRelationListResponse"
},
"GetAccountTransactionListResponse": {
"type": "object",
"properties": {
"accountTransactionList": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountTransaction"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"totalRecord": {
"type": "integer",
"format": "int64"
}
},
"title": "GetAccountTransactionListResponse"
},
"GetAccountVectorListResponse": {
"type": "object",
"properties": {
"accountVectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountVectorListResponse"
},
"GetAllAccountHoldersResponse": {
"type": "object",
"properties": {
"accountHolder": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolder"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAllAccountHoldersResponse"
},
"GetBeneficiaryTransactionListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryTransaction"
}
}
},
"title": "GetBeneficiaryTransactionListResponse"
},
"GetPOPListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"popList": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
}
},
"title": "GetPOPListResponse"
},
"InsertFormFactorProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"issuanceStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"paymentStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"policies": {
"$ref": "#/definitions/Policies"
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"type": {
"type": "string"
}
},
"title": "InsertFormFactorProductResponse"
},
"InsertFormFactorResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactorID": {
"type": "string"
},
"formFactorProductID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "InsertFormFactorResponse"
},
"InsertPaymentProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/definitions/Channel"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"resourceProduct": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "InsertPaymentProductResponse"
},
"InsertResourceProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactorProduct"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "InsertResourceProductResponse"
},
"InsertResourceResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactors": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactor"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"resourceProduct": {
"$ref": "#/definitions/ResourceProduct"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "InsertResourceResponse"
},
"IssuePaymentProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"status": {
"type": "string"
},
"targetAccount": {
"type": "string"
}
},
"title": "IssuePaymentProductResponse"
},
"IssueResourceRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"phoneNumber": {
"type": "string",
"example": "+919876543210",
"description": "The phone number to be assosciated with the _Account_ and the _Card_.",
"allowEmptyValue": false
},
"resourceProductID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the _Resource Product_ which is being issued and is part of the _Bundle_.",
"allowEmptyValue": false
},
"targetAccountID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_'s _Account_ which is to be linked to the _Resource_/_Card_.",
"allowEmptyValue": false
},
"attributes": {
"type": "object"
}
},
"title": "IssueResourceRequest"
},
"JID": {
"type": "object",
"properties": {
"appDomain": {
"type": "string"
},
"bareJID": {
"$ref": "#/definitions/JID"
},
"defaultServiceNode": {
"type": "boolean"
},
"jidOfAGroup": {
"type": "boolean"
},
"nodeId": {
"type": "string"
},
"primaryServiceName": {
"type": "string"
},
"proxyServiceJID": {
"type": "boolean"
},
"resource": {
"type": "string"
},
"serviceInstanceJID": {
"type": "boolean"
},
"serviceName": {
"type": "string"
},
"serviceViewJID": {
"type": "boolean"
},
"serviceViewName": {
"type": "string"
}
},
"title": "JID"
},
"KYCStatus": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"expiryTime": {
"type": "string",
"format": "date-time"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"kycStatus": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
},
"title": "KYCStatus"
},
"ListCardsFilter": {
"type": "object",
"properties": {
"cardID": {
"type": "string"
},
"cguid": {
"type": "string"
},
"account": {
"$ref": "#/definitions/Account"
},
"crn": {
"type": "string"
},
"orderID": {
"type": "string"
},
"productCode": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"cardSkuID": {
"type": "string"
}
},
"title": "ListCardsFilter"
},
"ListCardsRequest": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"example": 123123,
"allowEmptyValue": false
},
"offset": {
"type": "integer",
"format": "int32",
"example": 123123,
"allowEmptyValue": false
},
"view": {
"type": "string",
"enum": [
"BASIC",
"EXPANDED",
"EXPANDED_SENSITIVE"
]
},
"filters": {
"$ref": "#/definitions/ListCardsFilter"
}
},
"title": "ListCardsRequest"
},
"ListResourceResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"resources": {
"type": "array",
"items": {
"$ref": "#/definitions/Resource"
}
}
},
"title": "ListResourceResponse"
},
"Money": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "string"
}
},
"title": "Money"
},
"OrderDetails": {
"type": "object",
"properties": {
"cardSkuID": {
"type": "string"
},
"deliveryAddress": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"embossedAt": {
"type": "string",
"format": "date-time"
},
"expiry": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fourthLineEmbossing": {
"type": "string"
},
"orderID": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"orderedAt": {
"type": "string",
"format": "date-time"
},
"plasticCode": {
"type": "string"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "OrderDetails"
},
"OrderSummary": {
"type": "object",
"properties": {
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cardSkuID": {
"type": "string"
},
"deliveryAddress": {
"$ref": "#/definitions/Address"
},
"expiry": {
"$ref": "#/definitions/Expiry"
},
"fourthLineEmbossing": {
"type": "string"
},
"orderID": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"orderedAt": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "OrderSummary"
},
"POP": {
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"default": {
"type": "boolean"
},
"entityID": {
"type": "string"
},
"entityType": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"label": {
"type": "string"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
}
},
"title": "POP"
},
"PaymentProduct": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/definitions/Channel"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"resourceProduct": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "PaymentProduct"
},
"Policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {
"type": "string"
}
},
"paymentPolicies": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "Policies"
},
"ProductInfoResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"productID": {
"type": "string"
},
"programIDs": {
"type": "string"
},
"shortCode": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"ACCOUNT",
"PAYMENT"
]
}
},
"title": "ProductInfoResponse"
},
"Resource": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactors": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactor"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"resourceProduct": {
"$ref": "#/definitions/ResourceProduct"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "Resource"
},
"ResourceProduct": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactorProduct"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "ResourceProduct"
},
"SensitiveCardView": {
"type": "object",
"properties": {
"algo": {
"type": "string",
"enum": [
"ECDH"
]
},
"value": {
"$ref": "#/definitions/ECDHEncryptedCardPayload"
}
},
"title": "SensitiveCardView"
},
"SetPinRequest": {
"type": "object",
"properties": {
"newPin": {
"type": "string"
},
"nonce": {
"type": "integer",
"format": "int64"
}
},
"title": "SetPinRequest"
},
"TransferRequest": {
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"amount": {
"$ref": "#/definitions/Money"
},
"transferCode": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"creditAccountID": {
"type": "string"
},
"transferTime": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "TransferRequest"
},
"TransferResponse": {
"type": "object",
"properties": {
"isRetriableFailure": {
"type": "string"
},
"message": {
"type": "string"
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transferID": {
"type": "string"
}
},
"title": "TransferResponse"
},
"UpdateBundleRequest": {
"type": "object",
"properties": {
"accountProducts": {
"type": "array",
"description": "The list of account products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"attributes": {
"type": "object",
"description": "Any additional information which is specific to the bundle",
"allowEmptyValue": false
},
"description": {
"type": "string",
"example": "Bundle related to savings accounts. Consists of a savings account product and a related debit card",
"description": "The detailed description of the bundle",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Savings Bundle",
"description": "The name which would be assigned to the bundle",
"allowEmptyValue": false
},
"paymentProducts": {
"type": "array",
"description": "The list of payment products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"picURL": {
"type": "string",
"description": "The URL to get the bundle's display pic",
"allowEmptyValue": false
},
"shortCode": {
"type": "string",
"example": "SVNG",
"description": "The short code to identify the bundle",
"allowEmptyValue": false
},
"status": {
"type": "string"
}
},
"title": "UpdateBundleRequest"
}
},
"components": {
"schemas": {
"Address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postCode": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "integer",
"format": "int64"
},
"longitude": {
"type": "integer",
"format": "int64"
}
}
},
"Contact": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vector"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"POP": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"label": {
"type": "string"
},
"accountHolderID": {
"type": "string"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"default": {
"type": "boolean"
}
}
},
"Vector": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"verified": {
"type": "boolean"
}
}
},
"AccountHolder": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"AccountHolderRelation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"relatedAccountHolderID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"EffectiveKYCStatus": {
"type": "object",
"properties": {
"kycStatus": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"expiryTime": {
"type": "string",
"format": "date-time"
},
"kycStatusPostExpiry": {
"type": "string"
},
"kycAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"CreateAccountHolderRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"accountHolderStatus": {
"type": "string"
},
"salutation": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date-time"
},
"gender": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vector"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POP"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountHolderRelation"
}
},
"effectiveKYCStatus": {
"$ref": "#/components/schemas/EffectiveKYCStatus"
},
"providerID": {
"type": "string"
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateAccountHolderRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"accountHolderStatus": {
"type": "string"
},
"salutation": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date-time"
},
"gender": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vector"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POP"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountHolderRelation"
}
},
"effectiveKYCStatus": {
"$ref": "#/components/schemas/EffectiveKYCStatus"
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"GetAllAccountHoldersResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountHolder"
}
}
}
},
"AddAccountHolderRelationRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"GetAccountHolderRelationshipListResponse": {
"type": "object"
},
"AddPOPRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"label": {
"type": "string"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"default": {
"type": "boolean"
}
}
},
"UpdateAddressRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"default": {
"type": "boolean"
}
}
},
"GetPOPListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"popList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POP"
}
}
}
},
"AddVectorRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"vector": {
"$ref": "#/components/schemas/Vector"
}
}
},
"DeleteVectorRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountHolderProviderID": {
"type": "string"
},
"vector": {
"$ref": "#/components/schemas/Vector"
}
}
},
"UpdateVectorRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"currentVector": {
"$ref": "#/components/schemas/Vector"
},
"updatedVector": {
"$ref": "#/components/schemas/Vector"
}
}
},
"Accessor": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"AccountRelation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"accountID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"AccountVector": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountID": {
"type": "integer",
"format": "int64"
},
"value": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"CreateAccountRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"description": "",
"type": "string"
},
"ifiID": {
"description": "Unique identifier of the _IFI_.",
"type": "integer"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountVector"
}
},
"accessors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Accessor"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountRelation"
}
},
"accountHolderID": {
"description": "ID of the _Account Holder_.",
"type": "string"
},
"externalAccountHolderID": {
"description": "",
"type": "string"
},
"externalIDType": {
"description": "",
"type": "string",
"enum": [
"ZetaUserID",
"CompanyID",
"BusinessID"
]
},
"name": {
"description": "Preferred name in the _Account_.",
"type": "string"
},
"productFamilyID": {
"description": "ID of the _Product Family_ for which the _Account_ is being created.",
"type": "integer"
},
"productID": {
"description": "ID of the _Product_ for which the _Account_ is being created.",
"type": "integer"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"accountProviderID": {
"description": "ID of the _Account Provider_ who is creating the _Account_.",
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"AccountResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountVector"
}
},
"accessors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Accessor"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountRelation"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"ownerAccountHolderID": {
"type": "string"
},
"accountProviderID": {
"type": "string"
},
"name": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"productID": {
"type": "integer",
"format": "int64"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"ledgerID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"transactionPolicies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionPolicy"
}
}
}
},
"ProgramInfo": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"UpdateAccountRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"description": "",
"type": "string"
},
"ifiID": {
"description": "Unique identifier of the _IFI_.",
"type": "integer"
},
"name": {
"description": "Preferred name in the _Account_.",
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"UpdateAccountOwnerRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"description": "",
"type": "string"
},
"ifiID": {
"description": "Unique identifier of the _IFI_.",
"type": "integer"
},
"accountHolderID": {
"description": "ID of the _Account Holder_.",
"type": "string"
},
"externalAccountHolderID": {
"description": "",
"type": "string"
},
"externalIDType": {
"description": "",
"type": "string",
"enum": [
"ZetaUserID",
"CompanyID",
"BusinessID"
]
}
}
},
"UpdateAccountStatusRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"description": "",
"type": "string"
},
"ifiID": {
"description": "Unique identifier of the _IFI_.",
"type": "integer"
},
"status": {
"description": "",
"type": "string"
}
}
},
"UpdateProductForAccountRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"description": "Unique identifier of the _IFI_.",
"type": "integer"
},
"productID": {
"description": "ID of the _Product_ being updated.",
"type": "integer"
},
"accountProviderID": {
"description": "ID of the _Account Provider_ who created the _Account_.",
"type": "string"
}
}
},
"LedgerInfo": {
"type": "object",
"properties": {
"balance": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "string"
},
"lastDebitTransactionID": {
"type": "string"
},
"lastCreditTransactionID": {
"type": "string"
},
"lastDebitReversalTransactionID": {
"type": "string"
},
"lastCreditReversalTransactionID": {
"type": "string"
},
"accountingType": {
"type": "string",
"enum": [
"ASSET",
"LIABILITY",
"INCOME",
"EXPENSE",
"EQUITY"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"Account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountVector"
}
},
"accessors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Accessor"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountRelation"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"ownerAccountHolderID": {
"type": "string"
},
"accountProviderID": {
"type": "string"
},
"cardID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"productID": {
"type": "integer",
"format": "int64"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"ledgerID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"AddAccountVectorRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"description": "Unique identifier of the _IFI_.",
"type": "integer"
},
"accountID": {
"description": "ID of the _Account_ to which the _Vector_ is being added.",
"type": "integer"
},
"value": {
"description": "",
"type": "string"
},
"type": {
"description": "",
"type": "string"
},
"status": {
"description": "",
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateAccountVectorRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountID": {
"type": "integer",
"format": "int64"
},
"value": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"GetAccountVectorListResponse": {
"type": "object",
"properties": {
"accountVectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountVector"
}
}
}
},
"AetherTag": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"AddTagRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"value": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateTagRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"value": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateAccountRelationRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountID": {
"type": "integer",
"format": "int64"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"GetAccountRelationListResponse": {
"type": "object",
"properties": {
"accountVectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountVector"
}
}
}
},
"Beneficiary": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"parentAccountHolderID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"gender": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"relationship": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BeneficiaryVector"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POP"
}
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BeneficiaryAccount"
}
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"BeneficiaryAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"parentAccountHolderID": {
"type": "string"
},
"beneficiaryID": {
"type": "string"
},
"nickname": {
"type": "string"
},
"type": {
"type": "string"
},
"accountInfo": {
"$ref": "#/components/schemas/BeneficiaryAccountInfo"
},
"default": {
"type": "boolean"
},
"verified": {
"type": "boolean"
}
}
},
"BeneficiaryAccountInfo": {
"type": "object",
"properties": {
"accountNumber": {
"type": "string"
},
"accountProvider": {
"type": "string"
},
"nameAtAccountProvider": {
"type": "string"
},
"routingCode": {
"type": "string"
},
"accountType": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"BeneficiaryVector": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"AddBeneficiaryAccountForBeneficiaryRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"nickname": {
"type": "string"
},
"type": {
"type": "string"
},
"accountInfo": {
"$ref": "#/components/schemas/BeneficiaryAccountInfo"
}
}
},
"AddBeneficiaryRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountHolderID": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"gender": {
"type": "string"
},
"salutation": {
"type": "string"
},
"relationship": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BeneficiaryVector"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POP"
}
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"accountInfo": {
"$ref": "#/components/schemas/AddBeneficiaryAccountForBeneficiaryRequest"
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"defaultBeneficiaryAccountID": {
"type": "string"
}
}
},
"UpdateBeneficiaryRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountHolderID": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"gender": {
"type": "string"
},
"salutation": {
"type": "string"
},
"relationship": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BeneficiaryVector"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POP"
}
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"accountInfo": {
"$ref": "#/components/schemas/AddBeneficiaryAccountForBeneficiaryRequest"
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"defaultBeneficiaryAccountID": {
"type": "string"
}
}
},
"UpdateBeneficiaryAccountRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"beneficiaryID": {
"type": "string"
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"alias": {
"type": "string"
},
"type": {
"type": "string"
},
"accountInfo": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED",
"DELETED"
]
}
}
},
"EmptyPayload": {
"type": "object"
},
"BeneficiaryTransferRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"amount": {
"$ref": "#/components/schemas/Money"
},
"transferCode": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"beneficiaryID": {
"type": "string"
},
"transferTime": {
"type": "string",
"format": "date-time"
},
"remarks": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"Money": {
"type": "object",
"properties": {
"currency": {
"type": "string"
},
"amount": {
"type": "integer",
"format": "int64"
}
}
},
"Bundle": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"accountProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductInfo"
}
},
"paymentProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductInfo"
}
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"ProductInfo": {
"type": "object",
"properties": {
"productID": {
"type": "integer",
"format": "int64"
},
"programID": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AddBundleRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"accountProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductInfo"
}
},
"paymentProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductInfo"
}
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateBundleRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"accountProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductInfo"
}
},
"paymentProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductInfo"
}
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"AddAccountProductInBundleRequest": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountProduct": {
"$ref": "#/components/schemas/ProductInfo"
}
}
},
"AddPaymentProductInBundleRequest": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"paymentProduct": {
"$ref": "#/components/schemas/ProductInfo"
}
}
},
"BundleAccountInfo": {
"type": "object"
},
"IssueBundleResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BundleAccountInfo"
}
},
"paymentInstruments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BundleAccountInfo"
}
}
}
},
"IssueAccountArtifactRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"accountHolderID": {
"type": "string"
},
"bundleID": {
"type": "string"
},
"productID": {
"type": "integer",
"format": "int64"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountVector"
}
},
"accessors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Accessor"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountRelation"
}
}
}
},
"GetAccountListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
},
"PolicyAggregateRule": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
},
"action": {
"type": "string",
"enum": [
"DEBIT",
"CREDIT",
"DEBIT_REVERSAL",
"CREDIT_REVERSAL"
]
},
"categoryCode": {
"type": "string"
},
"aggExpressionID": {
"type": "integer",
"format": "int64"
},
"dailyLimit": {
"type": "integer",
"format": "int64"
},
"weeklyLimit": {
"type": "integer",
"format": "int64"
},
"monthlyLimit": {
"type": "integer",
"format": "int64"
},
"quarterlyLimit": {
"type": "integer",
"format": "int64"
},
"yearlyLimit": {
"type": "integer",
"format": "int64"
},
"errorCode": {
"type": "string"
}
}
},
"PolicyBalanceRule": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
},
"action": {
"type": "string",
"enum": [
"DEBIT",
"CREDIT",
"DEBIT_REVERSAL",
"CREDIT_REVERSAL"
]
},
"minRequiredBalance": {
"type": "integer",
"format": "int64"
},
"maxAllowedBalance": {
"type": "integer",
"format": "int64"
},
"errorCode": {
"type": "string"
}
}
},
"PolicyTxnRule": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
},
"action": {
"type": "string",
"enum": [
"DEBIT",
"CREDIT",
"DEBIT_REVERSAL",
"CREDIT_REVERSAL"
]
},
"categoryCode": {
"type": "string"
},
"minRequiredAmount": {
"type": "integer",
"format": "int64"
},
"maxAllowedAmount": {
"type": "integer",
"format": "int64"
},
"errorCode": {
"type": "string"
}
}
},
"TransactionPolicy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validUntil": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"accountingPolicyID": {
"type": "integer",
"format": "int64"
},
"policyTxnRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyTxnRule"
}
},
"policyBalanceRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyBalanceRule"
}
},
"policyAggregateRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyAggregateRule"
}
}
}
},
"CreateTransactionPolicyMappingRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"policyID": {
"type": "string"
}
}
},
"UpdateTransactionPolicyMappingRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"newPolicyID": {
"type": "string"
},
"oldPolicyID": {
"type": "string"
}
}
},
"DeleteTransactionPolicyMappingRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"policyID": {
"type": "string"
}
}
},
"AccountTransaction": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountID": {
"type": "integer",
"format": "int64"
},
"ledgerID": {
"type": "integer",
"format": "int64"
},
"transactionID": {
"type": "string"
},
"reversedTransactionID": {
"type": "string"
},
"reversalTxnIDs": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"previousBalance": {
"type": "integer",
"format": "int64"
},
"newBalance": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"type": "integer",
"format": "int64"
},
"amount": {
"type": "integer",
"format": "int64"
},
"recordType": {
"type": "string"
},
"remarks": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"GetTransactionsResponse": {
"type": "object",
"properties": {
"accountTransactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountTransaction"
}
}
}
},
"AddCustomFieldRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"UpdateCustomFieldRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolderID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"oldKey": {
"type": "string"
},
"newKey": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"CustomFieldResponse": {
"type": "object",
"properties": {
"customFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"BundleListResponse": {
"type": "object",
"properties": {
"bundles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundle"
}
}
}
},
"GetTagListResponse": {
"type": "object",
"properties": {
"accountVectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AetherTag"
}
}
}
},
"GetAccountHoldersResponsePayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accountHolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountHolder"
}
}
}
},
"AddAccountAccessorRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountID": {
"type": "integer",
"format": "int64"
},
"accountHolderID": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateAccountAccessorRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountID": {
"type": "integer",
"format": "int64"
},
"accountHolderID": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"GetAccountAccessorListResponse": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Accessor"
}
}
}
},
"AddAccountRelationRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"accountID": {
"type": "integer",
"format": "int64"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
{
"swagger": "2.0",
"info": {
},
"definitions": {
"IssueAccountProductsRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "ID of the _Account Holder_ to whom the _Bundle_ is being issued.",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "`requestID` as an idempotent key",
"allowEmptyValue": false
},
"issueAccountArtifactRequests": {
"type": "array",
"items": {
"$ref": "#/definitions/IssueAccountArtifactRequest"
}
}
},
"title": "IssueAccountProductsRequest"
},
"IssuePaymentProductsRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "ID of the _Account Holder_ to whom the _Bundle_ is being issued.",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "`requestID` as an idempotent key.",
"allowEmptyValue": false
},
"issuePaymentProductRequests": {
"type": "array",
"items": {
"$ref": "#/definitions/IssuePaymentProductRequest"
}
}
},
"title": "IssuePaymentProductsRequest"
},
"IssuePaymentProductRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paymentProductID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Product_ which is part of the issuing _Bundle_.",
"allowEmptyValue": false
},
"phoneNumber": {
"type": "string",
"example": "+919876543210",
"description": "The phone number to be assosciated with the _Account_ and the _card_.",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "`requestID` as an idempotent key.",
"allowEmptyValue": false
},
"targetAccountID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the individual's account which is to be linked to the resource/card.",
"allowEmptyValue": false
},
"attributes": {
"type": "object"
}
},
"title": "IssuePaymentProductRequest"
},
"Accessor": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "Accessor"
},
"AccountRelation": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relatedAccountID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "AccountRelation"
},
"AccountVector": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
}
},
"title": "AccountVector"
},
"IssueAccountArtifactRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_ being issued with the _Account_.",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Victor",
"description": "Preferred name in the _Account_.",
"allowEmptyValue": false
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
},
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelation"
}
},
"accountProductID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Product_ which is part of the issuing _Bundle_.",
"allowEmptyValue": false
}
},
"title": "IssueAccountArtifactRequest"
},
"IssueAccountArtifactResponse": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"bundleID": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"accountID": {
"type": "string"
}
},
"title": "IssueAccountArtifactResponse"
},
"IssueBundleRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_ to whom the _Bundle_ is being issued.",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Victor",
"description": "Preferred name in the _Account_.",
"allowEmptyValue": false
},
"phoneNumber": {
"type": "string",
"example": "+919876543210",
"description": "The phone number associated with the _Account_ and the _Card_.",
"allowEmptyValue": false
}
},
"title": "IssueBundleRequest"
},
"IssueBundleResponse": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/IssueAccountArtifactResponse"
}
},
"bundleID": {
"type": "string"
},
"paymentInstruments": {
"type": "array",
"items": {
"$ref": "#/definitions/IssuePaymentProductResponse"
}
}
},
"title": "IssueBundleResponse"
},
"IssueFormFactorRequest": {
"type": "object",
"properties": {
"formFactorProductID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the _Form Factor_/_Card_ which is being issued.",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"targetAccountID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_'s _Account_ which is to be linked to the _Resource_/_Card_.",
"allowEmptyValue": false
},
"attributes": {
"type": "object"
},
"resourceID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the _Resource_ which is being issued and is part of the _Bundle_.",
"allowEmptyValue": false
},
"orderDetails": {
"type": "object"
}
},
"title": "IssueFormFactorRequest"
},
"IssueFormFactorResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"status": {
"type": "string"
},
"targetUri": {
"type": "string"
}
},
"title": "IssueFormFactorResponse"
},
"IssueResourceResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"targetUri": {
"type": "string"
},
"resourceID": {
"type": "string"
}
},
"title": "IssueResourceResponse"
},
"ModelAndView": {
"type": "object",
"properties": {
"empty": {
"type": "boolean"
},
"model": {
"type": "object"
},
"modelMap": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"reference": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"view": {
"$ref": "#/definitions/View"
},
"viewName": {
"type": "string"
}
},
"title": "ModelAndView"
},
"ProductInfoRequest": {
"type": "object",
"properties": {
"productID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "The UUID of the account product which will be a part of the bundle",
"allowEmptyValue": false
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
},
"description": "The UUIDs of the programs which will be associated to the account product at the time of issuance",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"description": "Any additional information which is specific to the product info",
"allowEmptyValue": false
},
"productFamilyID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "The UUID of the product's family which will be a part of the bundle",
"allowEmptyValue": false
}
},
"title": "ProductInfoRequest"
},
"Timestamp": {
"type": "object",
"properties": {
"date": {
"type": "integer",
"format": "int32"
},
"day": {
"type": "integer",
"format": "int32"
},
"hours": {
"type": "integer",
"format": "int32"
},
"minutes": {
"type": "integer",
"format": "int32"
},
"month": {
"type": "integer",
"format": "int32"
},
"nanos": {
"type": "integer",
"format": "int32"
},
"seconds": {
"type": "integer",
"format": "int32"
},
"time": {
"type": "integer",
"format": "int64"
},
"timezoneOffset": {
"type": "integer",
"format": "int32"
},
"year": {
"type": "integer",
"format": "int32"
}
},
"title": "Timestamp"
},
"View": {
"type": "object",
"properties": {
"contentType": {
"type": "string"
}
},
"title": "View"
},
"Account": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"accountProviderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cardID": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"ledgerID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"ownerAccountHolderID": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"productID": {
"type": "integer",
"format": "int64"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelation"
}
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
}
},
"title": "Account"
},
"AccountHolder": {
"type": "object",
"properties": {
"accountHolderProviderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"dob": {
"type": "string",
"format": "date"
},
"firstName": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"kycstatus": {
"$ref": "#/definitions/KYCStatus"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"name": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"requestID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"userId": {
"type": "integer",
"format": "int64"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "AccountHolder"
},
"AccountHolderRelation": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relatedAccountHolderID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "AccountHolderRelation"
},
"AccountHolderVector": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
}
},
"title": "AccountHolderVector"
},
"AccountTransaction": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"currency": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ledgerID": {
"type": "integer",
"format": "int64"
},
"newBalance": {
"type": "integer",
"format": "int64"
},
"previousBalance": {
"type": "integer",
"format": "int64"
},
"recordType": {
"type": "string"
},
"remarks": {
"type": "string"
},
"reversalTransactionIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"reversedTransactionID": {
"type": "string"
},
"timestamp": {
"type": "integer",
"format": "int64"
},
"transactionID": {
"type": "string"
}
},
"title": "AccountTransaction"
},
"AddAccountAccessorRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "AddAccountAccessorRequest"
},
"AddAccountHolderPOPRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"label": {
"type": "string"
},
"address": {
"$ref": "#/definitions/Address"
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "AddAccountHolderPOPRequest"
},
"AddAccountHolderRelationshipRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"relatedAccountHolderID": {
"type": "string"
},
"relationshipType": {
"type": "string"
}
},
"title": "AddAccountHolderRelationshipRequest"
},
"AddAccountHolderVectorRequest": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"verified": {
"type": "boolean"
}
},
"title": "AddAccountHolderVectorRequest"
},
"AddAccountProductInBundleRequest": {
"type": "object",
"properties": {
"accountProduct": {
"description": "The account product which will be a part of the bundle",
"allowEmptyValue": false,
"$ref": "#/definitions/ProductInfoRequest"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "AddAccountProductInBundleRequest"
},
"AddAccountRelationRequest": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relatedAccountID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
}
},
"title": "AddAccountRelationRequest"
},
"AddAccountVectorRequest": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"title": "AddAccountVectorRequest"
},
"AddBeneficiaryAccountForBeneficiaryRequest": {
"type": "object",
"properties": {
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"default": {
"type": "boolean"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"nickname": {
"type": "string"
},
"parentAccountHolderID": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"title": "AddBeneficiaryAccountForBeneficiaryRequest"
},
"AddBundleRequest": {
"type": "object",
"properties": {
"accountProducts": {
"type": "array",
"description": "The list of account products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"attributes": {
"type": "object",
"description": "Any additional information which is specific to the bundle",
"allowEmptyValue": false
},
"description": {
"type": "string",
"example": "Bundle related to savings accounts. Consists of a savings account product and a related debit card",
"description": "The detailed description of the bundle",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Savings Bundle",
"description": "The name which would be assigned to the bundle",
"allowEmptyValue": false
},
"paymentProducts": {
"type": "array",
"description": "The list of payment products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"picURL": {
"type": "string",
"description": "The URL to get the bundle's display pic",
"allowEmptyValue": false
},
"shortCode": {
"type": "string",
"example": "SVNG",
"description": "The short code to identify the bundle",
"allowEmptyValue": false
}
},
"title": "AddBundleRequest"
},
"AddPaymentProductInBundleRequest": {
"type": "object",
"properties": {
"paymentProduct": {
"description": "The payment product which will be a part of the bundle",
"allowEmptyValue": false,
"$ref": "#/definitions/ProductInfoRequest"
}
},
"title": "AddPaymentProductInBundleRequest"
},
"Address": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"addressLine4": {
"type": "string"
},
"city": {
"type": "string"
},
"contactNumber": {
"type": "string"
},
"country": {
"type": "string"
},
"name": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"state": {
"type": "string"
}
},
"title": "Address"
},
"Beneficiary": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryAccount"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"dob": {
"type": "string",
"format": "date"
},
"firstName": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"relationship": {
"type": "string"
},
"requestID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryVector"
}
}
},
"title": "Beneficiary"
},
"BeneficiaryAccount": {
"type": "object",
"properties": {
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"default": {
"type": "boolean"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"nickname": {
"type": "string"
},
"parentAccountHolderID": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"verified": {
"type": "boolean"
}
},
"title": "BeneficiaryAccount"
},
"BeneficiaryAccountInfo": {
"type": "object",
"properties": {
"accountNumber": {
"type": "string"
},
"accountProvider": {
"type": "string"
},
"accountType": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"nameAtAccountProvider": {
"type": "string"
},
"routingCode": {
"type": "string"
}
},
"title": "BeneficiaryAccountInfo"
},
"BeneficiaryAccountListResponse": {
"type": "object",
"properties": {
"beneficiaryAccountList": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryAccount"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "BeneficiaryAccountListResponse"
},
"BeneficiaryAccountTransactionRequest": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryAccountID": {
"type": "string"
},
"beneficiaryID": {
"type": "string"
},
"currency": {
"type": "string"
},
"debitAccountHolderID": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"requestID": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryAccountTransactionRequest"
},
"BeneficiaryListResponse": {
"type": "object",
"properties": {
"beneficiaryList": {
"type": "array",
"items": {
"$ref": "#/definitions/Beneficiary"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "BeneficiaryListResponse"
},
"BeneficiaryTransaction": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryAccountID": {
"type": "string"
},
"beneficiaryID": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"currency": {
"type": "string"
},
"debitAccountHolderID": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionID": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryTransaction"
},
"BeneficiaryTransactionRequest": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"currency": {
"type": "string"
},
"debitAccountHolderID": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"requestID": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryTransactionRequest"
},
"BeneficiaryTransactionResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transactionID": {
"type": "string"
}
},
"title": "BeneficiaryTransactionResponse"
},
"BeneficiaryVector": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
}
},
"title": "BeneficiaryVector"
},
"Builder": {
"type": "object",
"properties": {
"object": {
"$ref": "#/definitions/JID"
},
"tenantID": {
"type": "integer",
"format": "int64"
}
},
"title": "Builder"
},
"BundleResponse": {
"type": "object",
"properties": {
"accountProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductInfoResponse"
}
},
"attributes": {
"type": "object"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"paymentProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductInfoResponse"
}
},
"picURL": {
"type": "string"
},
"shortCode": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"vboID": {
"type": "string"
}
},
"title": "BundleResponse"
},
"CardBinRange": {
"type": "object",
"properties": {
"bin": {
"type": "string"
},
"range": {
"type": "string"
}
},
"title": "CardBinRange"
},
"CardOrder": {
"type": "object",
"properties": {
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cardSkuID": {
"type": "string"
},
"deliveryAddress": {
"$ref": "#/definitions/Address"
},
"expiry": {
"$ref": "#/definitions/Expiry"
},
"fourthLineEmbossing": {
"type": "string"
},
"orderID": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "CardOrder"
},
"CardView": {
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/Account"
},
"associatedAt": {
"type": "string",
"format": "date-time"
},
"binRange": {
"$ref": "#/definitions/CardBinRange"
},
"cardID": {
"type": "string"
},
"cardStatus": {
"type": "string"
},
"cardType": {
"type": "string"
},
"crn": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"maskedPan": {
"type": "string"
},
"orderDetails": {
"$ref": "#/definitions/OrderDetails"
},
"sensitiveView": {
"$ref": "#/definitions/SensitiveCardView"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "CardView"
},
"Channel": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"paymentCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "Channel"
},
"CompletionStage«Accessor»": {
"type": "object",
"title": "CompletionStage«Accessor»"
},
"CompletionStage«AccountHolderRelation»": {
"type": "object",
"title": "CompletionStage«AccountHolderRelation»"
},
"CompletionStage«AccountHolderVector»": {
"type": "object",
"title": "CompletionStage«AccountHolderVector»"
},
"CompletionStage«AccountHolder»": {
"type": "object",
"title": "CompletionStage«AccountHolder»"
},
"CompletionStage«AccountRelation»": {
"type": "object",
"title": "CompletionStage«AccountRelation»"
},
"CompletionStage«AccountTransaction»": {
"type": "object",
"title": "CompletionStage«AccountTransaction»"
},
"CompletionStage«AccountVector»": {
"type": "object",
"title": "CompletionStage«AccountVector»"
},
"CompletionStage«Account»": {
"type": "object",
"title": "CompletionStage«Account»"
},
"CompletionStage«BeneficiaryAccountListResponse»": {
"type": "object",
"title": "CompletionStage«BeneficiaryAccountListResponse»"
},
"CompletionStage«BeneficiaryAccount»": {
"type": "object",
"title": "CompletionStage«BeneficiaryAccount»"
},
"CompletionStage«BeneficiaryListResponse»": {
"type": "object",
"title": "CompletionStage«BeneficiaryListResponse»"
},
"CompletionStage«BeneficiaryTransactionResponse»": {
"type": "object",
"title": "CompletionStage«BeneficiaryTransactionResponse»"
},
"CompletionStage«BeneficiaryTransaction»": {
"type": "object",
"title": "CompletionStage«BeneficiaryTransaction»"
},
"CompletionStage«Beneficiary»": {
"type": "object",
"title": "CompletionStage«Beneficiary»"
},
"CompletionStage«CardOrder»": {
"type": "object",
"title": "CompletionStage«CardOrder»"
},
"CompletionStage«CardView»": {
"type": "object",
"title": "CompletionStage«CardView»"
},
"CompletionStage«CreateAndLinkFormFactorResponse»": {
"type": "object",
"title": "CompletionStage«CreateAndLinkFormFactorResponse»"
},
"CompletionStage«FormFactorProduct»": {
"type": "object",
"title": "CompletionStage«FormFactorProduct»"
},
"CompletionStage«FormFactor»": {
"type": "object",
"title": "CompletionStage«FormFactor»"
},
"CompletionStage«GetAccountAccessorListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountAccessorListResponse»"
},
"CompletionStage«GetAccountBalanceResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountBalanceResponse»"
},
"CompletionStage«GetAccountHolderRelationListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountHolderRelationListResponse»"
},
"CompletionStage«GetAccountListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountListResponse»"
},
"CompletionStage«GetAccountRelationListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountRelationListResponse»"
},
"CompletionStage«GetAccountTransactionListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountTransactionListResponse»"
},
"CompletionStage«GetAccountVectorListResponse»": {
"type": "object",
"title": "CompletionStage«GetAccountVectorListResponse»"
},
"CompletionStage«GetAllAccountHoldersResponse»": {
"type": "object",
"title": "CompletionStage«GetAllAccountHoldersResponse»"
},
"CompletionStage«GetBeneficiaryTransactionListResponse»": {
"type": "object",
"title": "CompletionStage«GetBeneficiaryTransactionListResponse»"
},
"CompletionStage«GetPOPListResponse»": {
"type": "object",
"title": "CompletionStage«GetPOPListResponse»"
},
"CompletionStage«InsertFormFactorProductResponse»": {
"type": "object",
"title": "CompletionStage«InsertFormFactorProductResponse»"
},
"CompletionStage«InsertFormFactorResponse»": {
"type": "object",
"title": "CompletionStage«InsertFormFactorResponse»"
},
"CompletionStage«InsertPaymentProductResponse»": {
"type": "object",
"title": "CompletionStage«InsertPaymentProductResponse»"
},
"CompletionStage«InsertResourceProductResponse»": {
"type": "object",
"title": "CompletionStage«InsertResourceProductResponse»"
},
"CompletionStage«InsertResourceResponse»": {
"type": "object",
"title": "CompletionStage«InsertResourceResponse»"
},
"CompletionStage«IssueAccountArtifactResponse»": {
"type": "object",
"title": "CompletionStage«IssueAccountArtifactResponse»"
},
"CompletionStage«IssueBundleResponse»": {
"type": "object",
"title": "CompletionStage«IssueBundleResponse»"
},
"CompletionStage«IssueFormFactorResponse»": {
"type": "object",
"title": "CompletionStage«IssueFormFactorResponse»"
},
"CompletionStage«IssueResourceResponse»": {
"type": "object",
"title": "CompletionStage«IssueResourceResponse»"
},
"CompletionStage«ListResourceResponse»": {
"type": "object",
"title": "CompletionStage«ListResourceResponse»"
},
"CompletionStage«List«CardView»»": {
"type": "object",
"title": "CompletionStage«List«CardView»»"
},
"CompletionStage«OrderSummary»": {
"type": "object",
"title": "CompletionStage«OrderSummary»"
},
"CompletionStage«POP»": {
"type": "object",
"title": "CompletionStage«POP»"
},
"CompletionStage«PaymentProduct»": {
"type": "object",
"title": "CompletionStage«PaymentProduct»"
},
"CompletionStage«ResourceProduct»": {
"type": "object",
"title": "CompletionStage«ResourceProduct»"
},
"CompletionStage«Resource»": {
"type": "object",
"title": "CompletionStage«Resource»"
},
"CompletionStage«TransferResponse»": {
"type": "object",
"title": "CompletionStage«TransferResponse»"
},
"CompletionStage«Void»": {
"type": "object",
"title": "CompletionStage«Void»"
},
"Contact": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "Contact"
},
"CreateAccountHolderRequest": {
"type": "object",
"properties": {
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"salutation": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"gender": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
}
},
"title": "CreateAccountHolderRequest"
},
"CreateAndLinkFormFactorResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"provisionFormFactorResponse": {
"type": "object"
},
"resource": {
"$ref": "#/definitions/Resource"
}
},
"title": "CreateAndLinkFormFactorResponse"
},
"CreateBeneficiaryRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"gender": {
"type": "string"
},
"salutation": {
"type": "string"
},
"relationship": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryVector"
}
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "CreateBeneficiaryRequest"
},
"ECDHEncryptedCardPayload": {
"type": "object",
"properties": {
"encryptedData": {
"type": "string"
},
"iv": {
"type": "string"
},
"serverPublicKey": {
"type": "string"
}
},
"title": "ECDHEncryptedCardPayload"
},
"Expiry": {
"type": "object",
"properties": {
"month": {
"type": "integer",
"format": "int32"
},
"year": {
"type": "integer",
"format": "int32"
}
},
"title": "Expiry"
},
"FormFactor": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactorID": {
"type": "string"
},
"formFactorProductID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "FormFactor"
},
"FormFactorProduct": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"issuanceStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"paymentStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"policies": {
"$ref": "#/definitions/Policies"
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"type": {
"type": "string"
}
},
"title": "FormFactorProduct"
},
"GetAccountAccessorListResponse": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountAccessorListResponse"
},
"GetAccountBalanceResponse": {
"type": "object",
"properties": {
"accountingType": {
"type": "string",
"enum": [
"ASSET",
"LIABILITY",
"INCOME",
"EXPENSE",
"EQUITY"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"balance": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"lastTransactionID": {
"type": "string"
}
},
"title": "GetAccountBalanceResponse"
},
"GetAccountHolderRelationListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderRelation"
}
}
},
"title": "GetAccountHolderRelationListResponse"
},
"GetAccountListResponse": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/Account"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountListResponse"
},
"GetAccountRelationListResponse": {
"type": "object",
"properties": {
"accountRelations": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelation"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountRelationListResponse"
},
"GetAccountTransactionListResponse": {
"type": "object",
"properties": {
"accountTransactionList": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountTransaction"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"totalRecord": {
"type": "integer",
"format": "int64"
}
},
"title": "GetAccountTransactionListResponse"
},
"GetAccountVectorListResponse": {
"type": "object",
"properties": {
"accountVectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAccountVectorListResponse"
},
"GetAllAccountHoldersResponse": {
"type": "object",
"properties": {
"accountHolder": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolder"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAllAccountHoldersResponse"
},
"GetBeneficiaryTransactionListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryTransaction"
}
}
},
"title": "GetBeneficiaryTransactionListResponse"
},
"GetPOPListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"popList": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
}
},
"title": "GetPOPListResponse"
},
"InsertFormFactorProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"issuanceStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"paymentStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"policies": {
"$ref": "#/definitions/Policies"
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"type": {
"type": "string"
}
},
"title": "InsertFormFactorProductResponse"
},
"InsertFormFactorResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactorID": {
"type": "string"
},
"formFactorProductID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "InsertFormFactorResponse"
},
"InsertPaymentProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/definitions/Channel"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"resourceProduct": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "InsertPaymentProductResponse"
},
"InsertResourceProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactorProduct"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "InsertResourceProductResponse"
},
"InsertResourceResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactors": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactor"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"resourceProduct": {
"$ref": "#/definitions/ResourceProduct"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "InsertResourceResponse"
},
"IssuePaymentProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"status": {
"type": "string"
},
"targetAccount": {
"type": "string"
}
},
"title": "IssuePaymentProductResponse"
},
"IssueResourceRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"phoneNumber": {
"type": "string",
"example": "+919876543210",
"description": "The phone number to be assosciated with the _Account_ and the _Card_.",
"allowEmptyValue": false
},
"resourceProductID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the _Resource Product_ which is being issued and is part of the _Bundle_.",
"allowEmptyValue": false
},
"targetAccountID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the _Account Holder_'s _Account_ which is to be linked to the _Resource_/_Card_.",
"allowEmptyValue": false
},
"attributes": {
"type": "object"
}
},
"title": "IssueResourceRequest"
},
"JID": {
"type": "object",
"properties": {
"appDomain": {
"type": "string"
},
"bareJID": {
"$ref": "#/definitions/JID"
},
"defaultServiceNode": {
"type": "boolean"
},
"jidOfAGroup": {
"type": "boolean"
},
"nodeId": {
"type": "string"
},
"primaryServiceName": {
"type": "string"
},
"proxyServiceJID": {
"type": "boolean"
},
"resource": {
"type": "string"
},
"serviceInstanceJID": {
"type": "boolean"
},
"serviceName": {
"type": "string"
},
"serviceViewJID": {
"type": "boolean"
},
"serviceViewName": {
"type": "string"
}
},
"title": "JID"
},
"KYCStatus": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"expiryTime": {
"type": "string",
"format": "date-time"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"kycStatus": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
},
"title": "KYCStatus"
},
"ListCardsFilter": {
"type": "object",
"properties": {
"cardID": {
"type": "string"
},
"cguid": {
"type": "string"
},
"account": {
"$ref": "#/definitions/Account"
},
"crn": {
"type": "string"
},
"orderID": {
"type": "string"
},
"productCode": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"cardSkuID": {
"type": "string"
}
},
"title": "ListCardsFilter"
},
"ListCardsRequest": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"example": 123123,
"allowEmptyValue": false
},
"offset": {
"type": "integer",
"format": "int32",
"example": 123123,
"allowEmptyValue": false
},
"view": {
"type": "string",
"enum": [
"BASIC",
"EXPANDED",
"EXPANDED_SENSITIVE"
]
},
"filters": {
"$ref": "#/definitions/ListCardsFilter"
}
},
"title": "ListCardsRequest"
},
"ListResourceResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"resources": {
"type": "array",
"items": {
"$ref": "#/definitions/Resource"
}
}
},
"title": "ListResourceResponse"
},
"Money": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "string"
}
},
"title": "Money"
},
"OrderDetails": {
"type": "object",
"properties": {
"cardSkuID": {
"type": "string"
},
"deliveryAddress": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"embossedAt": {
"type": "string",
"format": "date-time"
},
"expiry": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fourthLineEmbossing": {
"type": "string"
},
"orderID": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"orderedAt": {
"type": "string",
"format": "date-time"
},
"plasticCode": {
"type": "string"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "OrderDetails"
},
"OrderSummary": {
"type": "object",
"properties": {
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cardSkuID": {
"type": "string"
},
"deliveryAddress": {
"$ref": "#/definitions/Address"
},
"expiry": {
"$ref": "#/definitions/Expiry"
},
"fourthLineEmbossing": {
"type": "string"
},
"orderID": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"orderedAt": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "OrderSummary"
},
"POP": {
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"default": {
"type": "boolean"
},
"entityID": {
"type": "string"
},
"entityType": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"label": {
"type": "string"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
}
},
"title": "POP"
},
"PaymentProduct": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/definitions/Channel"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"resourceProduct": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "PaymentProduct"
},
"Policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {
"type": "string"
}
},
"paymentPolicies": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "Policies"
},
"ProductInfoResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"productID": {
"type": "string"
},
"programIDs": {
"type": "string"
},
"shortCode": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"ACCOUNT",
"PAYMENT"
]
}
},
"title": "ProductInfoResponse"
},
"Resource": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"formFactors": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactor"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"resourceProduct": {
"$ref": "#/definitions/ResourceProduct"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"targetURI": {
"type": "string"
}
},
"title": "Resource"
},
"ResourceProduct": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/FormFactorProduct"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
}
},
"title": "ResourceProduct"
},
"SensitiveCardView": {
"type": "object",
"properties": {
"algo": {
"type": "string",
"enum": [
"ECDH"
]
},
"value": {
"$ref": "#/definitions/ECDHEncryptedCardPayload"
}
},
"title": "SensitiveCardView"
},
"SetPinRequest": {
"type": "object",
"properties": {
"newPin": {
"type": "string"
},
"nonce": {
"type": "integer",
"format": "int64"
}
},
"title": "SetPinRequest"
},
"TransferRequest": {
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"amount": {
"$ref": "#/definitions/Money"
},
"transferCode": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"creditAccountID": {
"type": "string"
},
"transferTime": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "TransferRequest"
},
"TransferResponse": {
"type": "object",
"properties": {
"isRetriableFailure": {
"type": "string"
},
"message": {
"type": "string"
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transferID": {
"type": "string"
}
},
"title": "TransferResponse"
},
"UpdateBundleRequest": {
"type": "object",
"properties": {
"accountProducts": {
"type": "array",
"description": "The list of account products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"attributes": {
"type": "object",
"description": "Any additional information which is specific to the bundle",
"allowEmptyValue": false
},
"description": {
"type": "string",
"example": "Bundle related to savings accounts. Consists of a savings account product and a related debit card",
"description": "The detailed description of the bundle",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Savings Bundle",
"description": "The name which would be assigned to the bundle",
"allowEmptyValue": false
},
"paymentProducts": {
"type": "array",
"description": "The list of payment products which will be a part of the bundle",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
},
"picURL": {
"type": "string",
"description": "The URL to get the bundle's display pic",
"allowEmptyValue": false
},
"shortCode": {
"type": "string",
"example": "SVNG",
"description": "The short code to identify the bundle",
"allowEmptyValue": false
},
"status": {
"type": "string"
}
},
"title": "UpdateBundleRequest"
}
}
}
- No labels