{
"swagger": "2.0",
"info": {
"version": "",
"contact": {}
},
"tags": [
{
"name": "Payment Transfer"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/api/v1/ifi/{ifiID}/transfers": {
"post": {
"description": "Create fund transfer, which transfers fund from one account to another",
"summary": "Create fund transfer",
"tags": [
"Payment Transfer"
],
"operationId": "CreatefundTransfer",
"deprecated": false,
"produces": [
"application/json; charset=utf-8"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"required": true,
"type": "string",
"description": "Unique identifier of the IFI."
},
{
"name": "body",
"in": "body",
"required": false,
"description": "",
"schema": {
"$ref": "#/definitions/ApiV1IfiTransfersRequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ApiV1IfiTransfersResponse"
},
"headers": {}
},
"500": {
"description": "",
"schema": {
"$ref": "#/definitions/ApiV1IfiTransfers500Error"
}
}
}
}
},
"/api/v1/ifi/{ifiID}/transfers/{transferID}": {
"get": {
"description": "Retrieve fund transfer details using transferID",
"summary": "Get fund transfer using transferID",
"tags": [
"Payment Transfer"
],
"operationId": "GetfundTransferusingtransferID",
"deprecated": false,
"produces": [
"application/json; charset=utf-8"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"required": true,
"type": "string",
"description": "Unique identifier of the IFI."
},
{
"name": "transferID",
"in": "path",
"required": true,
"type": "string",
"description": "ID of the fund transfer."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ApiV1IfiTransfersResponse1"
},
"headers": {}
}
}
}
},
"/api/v1/ifi/{ifiID}/transactions/{transactionID}/reversal": {
"post": {
"tags": [
"Payment Transfer"
],
"summary": "Reverse fund transfer",
"description": "In case of disputes, reverse the fund transfer using `transactionID` On successful reversal, the API will return the `status` as `SUCCESS` else it will return `FAILED`. Note the `revertTransactionID` in the response for future references.",
"operationId": "reversalsUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "Unique identifier of the IFI.",
"required": false,
"type": "integer"
},
{
"name": "transactionID",
"in": "path",
"description": "ID of the _Transaction_ for which the reversal is being triggered.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "requestID",
"description": "Click Model below to learn about request body constructs",
"required": true,
"schema": {
"$ref": "#/definitions/ReversalRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/A2AReversalTransactionResponse"
}
}
}
}
},
"/api/v1/ifi/{ifiID}/payment_products/{paymentProductID}": {
"get": {
"tags": [
"Payment Product"
],
"parameters": [
{
"examples": {
"Payment Product ID": {
"value": "5291112c-4b42-4e92-a7db-c3fcf0f96b89"
}
},
"name": "paymentProductID",
"description": "Unique Payment Product identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"examples": {
"IFIID": {
"value": "140827"
}
},
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resource Product Details are being retrieved.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentProductDe"
}
}
},
"description": "Returns Payment Product details"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
},
"description": "Payment product does not exist\r\n\r\n"
}
},
"operationId": "getPaymentProduct",
"summary": "Get Payment Product details",
"description": "Get Payment Product details"
}
},
"/api/v1/ifi/{ifiID}/form_factor_products": {
"get": {
"tags": [
"Form Factor Product"
],
"parameters": [
{
"name": "limit",
"description": "Limit identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "offset",
"description": "Offset identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Form Factor Products are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFormFactorProducts"
}
}
},
"description": "Returns a paginated list of Form Factor Products"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "listFormFactorProducts",
"summary": "List Form Factor Products",
"description": "List Form Factor Products for a Resource"
}
},
"/api/v1/ifi/{ifiID}/form_factor_products/{formFactorProductID}": {
"get": {
"tags": [
"Form Factor Product"
],
"parameters": [
{
"name": "formFactorProductID",
"description": "Unique Form Factor Product",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Form Factor Products are being retrieved by ID.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchFormFactorProduct"
}
}
},
"description": "Returns Form Factor Product"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
},
"description": "Form Factor Product does not exist"
}
},
"operationId": "getFormFactorProduct",
"summary": "Get Form Factor Product",
"description": "Get Form Factor Product using formFactorProductID"
}
},
"/api/v1/ifi/{ifiID}/resource_products": {
"get": {
"tags": [
"Resource Product"
],
"parameters": [
{
"name": "limit",
"description": "Limit identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "offset",
"description": "Offset identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resource Products are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResourceProducts"
}
}
},
"description": "Returns paginated list of Resource Products"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "listResourceProduct",
"summary": "List Resource Products",
"description": "List Resource Products for an IFI"
}
},
"/api/v1/ifi/{ifiID}/resource_products/{resourceProductID}": {
"get": {
"tags": [
"Resource Product"
],
"parameters": [
{
"name": "resourceProductID",
"description": "Unique Resource Product identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resource Product Details are being retrieved.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceProduct"
}
}
},
"description": "Returns Resource Product details"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
},
"description": "Resource product does not exist"
}
},
"operationId": "getResourceProduct",
"summary": "Get Resource Product details",
"description": "Get Resource Product details"
}
},
"/api/v1/ifi/{ifiID}/resource_products/{resourceProductID}/resources/list": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResourceRequest"
}
}
}
},
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resources are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "limit",
"description": "Limit identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "offset",
"description": "Offset identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "resourceProductID",
"description": "Resource Product identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceProductList"
}
}
},
"description": "Returns a paginated list of Resources corresponding to a Resource Product ID"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "listResourcesPerResourceProduct",
"summary": "List Resources per Resource Product",
"description": "List Resources per Resource Product using resourceProductID"
}
},
"/api/v1/ifi/{ifiID}/resources": {
"get": {
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resources are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "limit",
"description": "Limit identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "offset",
"description": "Offset identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
}
}
}
},
"description": "Returns a paginated list of Resources"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "listResources",
"summary": "List Resources",
"description": "List Resources for an IFI"
}
},
"/api/v1/ifi/{ifiID}/resources/list": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResourceRequest"
}
}
}
},
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resources are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "limit",
"description": "Limit identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "offset",
"description": "Offset identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
}
}
}
},
"description": "Returns a paginated list of Resources"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "listResourcesWithFilters",
"summary": "List Resources with Filters",
"description": "List Resources with Filters"
}
},
"/api/v1/ifi/{ifiID}/resources/{resourceID}": {
"get": {
"tags": [
"Resource"
],
"parameters": [
{
"name": "resourceID",
"description": "Unique Resource Identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resource data is being retrieved.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Resource"
}
}
},
"description": "Returns Resource details"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
},
"description": "Resource does not exist"
}
},
"operationId": "getResource",
"summary": "Get Resource data",
"description": "Get Resource data using resourceID"
},
"patch": {
"requestBody": {
"description": "UpdateResourceRequest",
"content": {
"application/json": {}
},
"required": false
},
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Resource data is being retrieved.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "resourceID",
"description": "Unique Resource Identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Resource"
}
}
},
"description": "Returns the updated resource object."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
},
"description": "Resource does not exist"
}
},
"operationId": "updateResourceInformation",
"summary": "Update Resource Information",
"description": "Update Resource Information"
}
},
"/api/v1/ifi/{ifiID}/resources/{resourceID}/target": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkTargetRequest"
}
}
}
},
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Target is being linked with Resource.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "resourceID",
"description": "Resource Product ID",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Resource"
}
}
},
"description": "Target linked to Resource"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"badRequest": {
"summary": "Bad Request",
"value": {
"code": "BAD_REQUEST",
"message": "Bad Request"
}
}
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlreadyExists"
}
}
},
"description": "Target already linked to Resource"
}
},
"operationId": "linkTargetWithResource",
"summary": "List Target with Resource",
"description": "Link Target with Resource"
},
"delete": {
"tags": [
"Resource"
],
"parameters": [
{
"name": "resourceID",
"description": "Unique resource identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Target linked to Resource is marked as Deleted.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "Target linked to Resource marked as Deleted"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"summary": "Mark Target linked to Resource Deleted",
"description": "Mark Target linked to Resource Deleted"
},
"patch": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkTargetRequest"
}
}
}
},
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Target linked to Resource is being updated.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "resourceID",
"description": "Resource Product ID",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Resource"
}
}
},
"description": "Target updated for Resource"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"badRequest": {
"summary": "Bad Request",
"value": {
"code": "BAD_REQUEST",
"message": "Bad Request"
}
}
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlreadyExists"
}
}
},
"description": "Target already linked to Resource"
}
},
"operationId": "updateLinkTargetToResource",
"summary": "Update Target linked to Resource",
"description": "Update Target linked to Resource"
}
},
"/api/v1/ifi/{ifiID}/resources/{resourceID}/form_factors": {
"get": {
"tags": [
"Form Factor"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Form Factors are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "resourceID",
"description": "Resource ID",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "limit",
"description": "Limit identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "offset",
"description": "Offset identifier",
"schema": {
"type": "string"
},
"in": "query",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormFactor"
}
}
}
},
"description": "Returns a paginated list of Resources"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "listFormFactors",
"summary": "Get Form Factors Information for a specific resource ID",
"description": "List Form Factors"
},
"post": {
"requestBody": {
"description": "addFormFactorRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssociateFormFactor"
},
"examples": {
"addFormFactorRequest ": {
"value": {
"formFactorProductID": "a71a0b5a-b512-4457-9edb-a6f76f325fd9",
"formFactorID": "c7845612-c10d-4524-beb4-10b834655c47",
"targetURI": "account://71227305-whatMobile2",
"status": "ACTIVE"
}
}
}
}
},
"required": true
},
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Form Factors are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "resourceID",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {}
},
"description": "Returns the updated form factor data object for the resource."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "associateFormFactorResource",
"summary": "Associate form factor to a specific resource",
"description": "Associate form factor to a specific resource"
}
},
"/api/v1/ifi/{ifiID}/form_factors/list": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFormFactorRequest"
}
}
}
},
"tags": [
"Form Factor"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Form Factors are being retrieved.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormFactor"
}
}
}
},
"description": "Form Factor linked"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"badRequest": {
"summary": "Bad Request",
"value": {
"code": "BAD_REQUEST",
"message": "Bad Request"
}
}
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlreadyExists"
}
}
},
"description": "Form Factor already linked"
}
},
"operationId": "getFormFactors",
"summary": "Get Form Factors",
"description": "Get form factors"
}
},
"/api/v1/ifi/{ifiID}/resources/{resourceID}/form_factors/{formFactorID}": {
"get": {
"tags": [
"Form Factor"
],
"parameters": [
{
"name": "resourceID",
"description": "Unique Resource identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "formFactorID",
"description": "Unique Form Factor identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "ifiID",
"description": "Unique identifier of the IFI.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormFactor"
}
}
},
"description": "Returns Resource Form Factor details"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
},
"description": "Resource Form Factor does not exist"
}
},
"operationId": "getResourceFormFactor",
"summary": "Get Resource Form Factor details",
"description": "Get Resource Form Factor details"
},
"patch": {
"requestBody": {
"description": "Specify the following parameters in the request body to change the status of the Form Factor. Please note that if you are deleting the Form Factor, specifying the reason (code, description) is required.<ul><li>`status`: Required. Status of the Form Factor.<br/>Supported values — `ACTIVE` to activate the Form Factor; `INACTIVE` to deactivate the Form Factor; `DELETED` to delete the Form Factor.</li><li>`code`: Code of the reason for changing the status of the Form Factor. Optional for activating/deactivating the Form Factor. Required for deleting the Form Factor.<br/>Supported values: `LOST_OR_STOLEN`, `DAMAGED`, `HOTLISTED`, `OFAC_BLOCKED`, `OTHER` </li><li>`description`: Human-readable description of the reason for deleting the Form Factor. Length must be less than 200 characters. Optional for activating/deactivating the Form Factor. Required for deleting the Form Factor.</li></ul>",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/updateFormFactorRequest"
},
"examples": {
"Deactivate": {
"value": {
"status": "INACTIVE",
"reason": {
"code": "OTHER",
"description": "temporarily deactivated due to suspicious activity "
}
}
},
"Activate": {
"value": {
"status": "ACTIVE",
"reason": {
"code": "OTHER",
"description": "card activated"
}
}
},
"Delete": {
"value": {
"status": "DELETED",
"reason": {
"code": "DAMAGED",
"description": "Card is damaged and needs to be replaced"
}
}
}
}
}
}
},
"tags": [
"Form Factor"
],
"parameters": [
{
"name": "resourceID",
"description": "Unique identifier of the Resource with which the Form Factor is associated.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "formFactorID",
"description": "Unique identifier of the Form Factor.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "ifiID",
"description": "Unique identifier of the IFI.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormFactor"
}
}
},
"description": "Returns the updated form factor data object for the specific resource."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
},
"description": "Form Factor for the specific resource does not exist"
}
},
"operationId": "updateFormFactorInfo",
"summary": "Activate/Deactivate/Delete Form Factor by ID",
"description": "Use the endpoint to activate, deactivate or delete a Form Factor by changing its status. Examples of Form Factors include card and phone number. Please note that if you are deleting the Form Factor, specifying the reason (request body parameter) is required.</br></br>To get the Resource ID and Form Factor ID for card, call the `/orders/{orderID}/cards/list` endpoint. The response returns an array of all the cards in the order with each card's ID and Resource ID. `cardID` provides the value for Form Factor ID, and note the Resource ID from `uri:resource://{resourceID}` parameter."
}
},
"/api/v1/ifi/{ifiID}/form_factor_providers/{formFactorProvider}/form_factors/list": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFormFactorFromProviderRequest"
}
}
}
},
"tags": [
"Form Factor"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which a new Form Factor is being provisioned and linked to an existing Resource.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "formFactorProvider",
"description": "Form Factor Provider identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormFactor"
}
}
}
},
"description": "List Form Factors"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"badRequest": {
"summary": "Bad Request",
"value": {
"code": "BAD_REQUEST",
"message": "Bad Request"
}
}
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
}
},
"operationId": "ListFormFactorsForProvider",
"summary": "Provision new Form Factor and link it to an existing Resource",
"description": "Provision new Form Factor and link it to an existing Resource"
}
},
"/api/v1/ifi/{ifiID}/resourceByVector": {
"get": {
"operationId": "resourceInfoByVector",
"summary": "Get Resource by Vector",
"description": "Use the endpoint to get Resource details, including associated Form Factors, of an entity using its Vector details. Currently you can fetch details of an Account Holder.</br></br> You can filter the results using the `view` query parameter. The following views are supported: </br> <ul><li>BASIC: Default view. Returns details of all the active and inactive Form Factors associated with the Resource.</li><li>EXPANDED: Returns details of all the active, inactive and deleted Form Factors associated with the Resource.</li></ul> ",
"tags": [
"Resource"
],
"parameters": [
{
"name": "ifiID",
"description": "Unique identifier of the IFI",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "vectorType",
"description": "The type of Vector against which Resource details are fetched. Allowed value:`ACCOUNTHOLDER`",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "vectorValue",
"description": "Value of the Vector depending on the `vectorType` specified. Since, only Account Holder is currently supported, hence specify Account Holder ID here.",
"schema": {
"type": "string"
},
"in": "query",
"required": true
},
{
"name": "view",
"description": "Filter the results using this parameter. BASIC is the default view and returns details of all the active and inactive Form Factors associated with the Resource. EXPANDED view returns details of all the active, inactive and deleted Form Factors associated with the Resource. ",
"schema": {
"type": "string",
"enum":["BASIC","EXPANDED"]
},
"in": "query"
}
],
"responses": {
"200": {
"description": "Returns Resource details in BASIC view",
"content": {
"application/json": {
"schema": {
"allOf":[
"$ref": "#/components/schemas/VectorResource",
"example":{
"ifi": 140827,
"requestId": "b9382c61-c365-4f3d-988e-cffa7b3f886a_4fa18593-d2d9-4bf3-bea7-7f6deb9f2ca4",
"id": "d793ba95-e92d-472b-a44d-75cf7631277c",
"resourceProductId": "2ac114f3",
"resourceProduct": {
"ifi": 140827,
"id": "2ac114f3",
"code": "RPFAM001",
"name": "Prepaid Card Resource Product",
"description": "Prepaid RuPay card resource product for ABC",
"formFactorProducts": [
{
"ifi": 140827,
"id": "4f6ed594",
"code": "CMSFF100",
"name": "ABC Form Factor Pr100",
"description": "Mobile Form Factor Product for ABC",
"type": "phoneNumber",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "PMS",
"skuID": "ABC_FAMPAY_MS",
"tags": [],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Nov 15, 2019 5:28:13 PM",
"modifiedAt": "Nov 15, 2019 5:28:13 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
},
{
"ifi": 140827,
"id": "66abce21",
"code": "CMSFF001",
"name": "ABC Form Factor Product 001",
"description": "Card Form Factor Product for ABC",
"type": "card",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "CMS",
"skuID": "ABC_FAMPAY_MS",
"tags": [],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Nov 20, 2019 4:33:37 PM",
"modifiedAt": "Nov 20, 2019 4:33:37 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
}
],
"tags": [],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Nov 20, 2019 4:36:45 PM",
"modifiedAt": "Nov 28, 2019 7:20:03 PM",
"headers": {}
},
"targetURI": "account://8780dd20-8171-4849-90e6-8752b2e5b675",
"formFactors": [
{
"id": "b3121006-f2e1-4d8c-ad64-f7d8086aa0da",
"ifi": 140827,
"formFactorProductID": "66abce21",
"formFactorID": "40323ba2-f091-4d24-bddb-cc5663501bb2",
"targetURI": "account:account://8780dd20-8171-4849-90e6-8752b2e5b675",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "May 11, 2020 8:24:07 AM",
"modifiedAt": "May 11, 2020 8:24:07 AM",
"headers": {}
}
],
"tags": [],
"vectors": [
"vector://ACCOUNTHOLDER/c99824ec-5126-43cd-a6a1-fdd2878359f5"
],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"attributes": {},
"status": "ACTIVE",
"createdAt": "May 11, 2020 8:24:06 AM",
"modifiedAt": "May 11, 2020 8:24:06 AM",
"headers": {}
}
]
}
}
},
},
},
}
},
"/api/v1/ifi/{ifiID}/resources/{resourceID}/form_factors/create": {
"post": {
"requestBody": {
"description": "Data object to provision the form factor.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/provisionAndLinkFormFactorRequest"
}
}
},
"required": true
},
"tags": [
"Form Factor"
],
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI (on-boarded organization) under which the Form Factors are being listed.",
"schema": {
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "resourceID",
"description": "Resource Identifier",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/provisionAndLinkFormFactorResponse"
}
}
},
"description": "Returns the updated resource and form factor information."
}
}
}
}
},
"definitions": {
"A2AReversalTransactionResponse": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64",
"example": 1,
"description": "Amount for which reversal is required",
"allowEmptyValue": false
},
"currency": {
"type": "string",
"example": "INR",
"description": "Currency for which reversal is required",
"allowEmptyValue": false
},
"paymentType": {
"type": "string",
"example": "REVERSAL",
"description": "Denotes type of payment response",
"allowEmptyValue": false
},
"remark": {
"type": "string",
"example": "Reversal of vbo1",
"description": "Remark of the reversal",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "93480e72-b883-46fa-8f3f-abe326ab9df7",
"description": "Request id for A2A Reversal",
"allowEmptyValue": false
},
"revertTransactionID": {
"type": "string",
"example": "20200429121612790_14_revert_375231000459_reversal_dfdsrdkedddsdd",
"description": "Denotes reverted transaction id for corresponding transaction id",
"allowEmptyValue": false
},
"status": {
"type": "string",
"example": "SUCCESS/FAILED",
"description": "Status of the reversal",
"allowEmptyValue": false
},
"statusDetails": {
"example": "Transaction code is invalid",
"description": "Status details in case reversal fails",
"allowEmptyValue": false,
"$ref": "#/definitions/JsonObject"
},
"transactionID": {
"type": "string",
"example": "20181206084927090_687_375231000459",
"description": "Denotes transaction id for which reversal needs to be done",
"allowEmptyValue": false
},
"transferCode": {
"type": "string",
"example": "ATLAS_P2M_AUTH-REVERSAL",
"description": "Denotes reversal transfer code",
"allowEmptyValue": false
}
},
"title": "A2AReversalTransactionResponse"
},
"AbstractApplicationDataObject": {
"type": "object",
"properties": {
"applicationId": {
"type": "integer",
"format": "int32"
},
"moderatedApplicationType": {
"type": "string",
"enum": [
"SIGN_UP",
"EDIT_CORPORATE"
]
},
"sections": {
"type": "array",
"items": {
"$ref": "#/definitions/AbstractSectionDataObject"
}
},
"summary": {
"type": "object"
}
},
"title": "AbstractApplicationDataObject"
},
"AbstractSectionDataObject": {
"type": "object",
"properties": {
"entityId": {
"type": "string"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
}
},
"title": "AbstractSectionDataObject"
},
"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"
},
"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"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
}
},
"title": "Account"
},
"AccountAccessorResponse": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"updatedAt": {
"type": "string"
}
},
"title": "AccountAccessorResponse"
},
"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"
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"profilePicURL": {
"type": "string"
},
"requestID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "AccountHolder"
},
"AccountHolderApplicationListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"individualApplicationList": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderApplicationResponse"
}
},
"totalRows": {
"type": "integer",
"format": "int64"
}
},
"title": "AccountHolderApplicationListResponse"
},
"AccountHolderApplicationResponse": {
"type": "object",
"properties": {
"applicationID": {
"type": "string"
},
"applicationType": {
"type": "string"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"customFields": {
"type": "object"
},
"description": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"documentList": {
"type": "array",
"items": {
"$ref": "#/definitions/DocumentResponse"
}
},
"firstName": {
"type": "string"
},
"formID": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"kycDetails": {
"$ref": "#/definitions/KYCDetails"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"pops": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/POP"
}
},
"profilePicURL": {
"type": "string"
},
"salutation": {
"type": "string"
},
"source": {
"type": "string"
},
"spoolID": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"PENDING_ON_USER_ACTION",
"REJECTED",
"APPROVED",
"DELETED"
]
},
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Tag"
}
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"vectors": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Vector"
}
}
},
"title": "AccountHolderApplicationResponse"
},
"AccountHolderApplicationStandardResponse": {
"type": "object",
"properties": {
"applicationID": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"customFields": {
"type": "object"
},
"description": {
"type": "string"
},
"dob": {
"type": "string"
},
"documentList": {
"type": "array",
"items": {
"$ref": "#/definitions/DocumentResponse"
}
},
"firstName": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"kycDetails": {
"$ref": "#/definitions/KYCDetailsStandard"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"pops": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/POP"
}
},
"profilePicURL": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"PENDING_ON_USER_ACTION",
"REJECTED",
"APPROVED",
"DELETED"
]
},
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Tag"
}
},
"updatedAt": {
"type": "string"
},
"vectors": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Vector"
}
}
},
"title": "AccountHolderApplicationStandardResponse"
},
"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"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "AccountHolderRelation"
},
"AccountHolderRelationResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"relatedIndividualID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"title": "AccountHolderRelationResponse"
},
"AccountHolderResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"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"
},
"kycstatus": {
"$ref": "#/definitions/KYCStatus"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POPResponse"
}
},
"profilePicURL": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVectorResponse"
}
}
},
"title": "AccountHolderResponse"
},
"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"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"title": "AccountHolderVector"
},
"AccountHolderVectorResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"title": "AccountHolderVectorResponse"
},
"AccountInfo": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"accountProviderID": {
"type": "string"
},
"accountingType": {
"type": "string",
"enum": [
"ASSET",
"LIABILITY",
"INCOME",
"EXPENSE",
"EQUITY"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"balance": {
"type": "integer",
"format": "int64"
},
"cardID": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"currency": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"ownerAccountHolderID": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"productFamilyName": {
"type": "string"
},
"productID": {
"type": "integer",
"format": "int64"
},
"productName": {
"type": "string"
},
"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": "AccountInfo"
},
"AccountInfoResponse": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountAccessorResponse"
}
},
"accountingType": {
"type": "string",
"enum": [
"ASSET",
"LIABILITY",
"INCOME",
"EXPENSE",
"EQUITY"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"balance": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string"
},
"currency": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"ownerAccountHolderID": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"productFamilyName": {
"type": "string"
},
"productID": {
"type": "integer",
"format": "int64"
},
"productName": {
"type": "string"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelationResponse"
}
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVectorResponse"
}
}
},
"title": "AccountInfoResponse"
},
"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"
},
"AccountRelationResponse": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"relatedAccountID": {
"type": "string"
},
"relationshipType": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"title": "AccountRelationResponse"
},
"AccountResponse": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"productID": {
"type": "integer",
"format": "int64"
},
"programIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
}
},
"title": "AccountResponse"
},
"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"
},
"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"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
}
},
"title": "AccountVector"
},
"AccountVectorResponse": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"value": {
"type": "string"
}
},
"title": "AccountVectorResponse"
},
"ActionOnAddCompanySectionRequest": {
"type": "object",
"required": [
"opsActionOnSection",
"remarks",
"type"
],
"properties": {
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"documents": {
"$ref": "#/definitions/Documents"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"logoURL": {
"type": "string",
"example": "https://abc.com/logo.png",
"description": "URL for the logo of the company",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "Contract Change",
"description": "Name of the action being performed",
"allowEmptyValue": false
},
"opsActionOnSection": {
"type": "string",
"example": "SAVE",
"description": "Action to be performed on this specific section",
"allowEmptyValue": false,
"enum": [
"SAVE",
"MARK_AS_COMPLETE",
"REJECT",
"ACCEPT"
]
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "PRIVATE_LIMITED",
"description": "Identification for the type of company which is being created",
"allowEmptyValue": false,
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
}
},
"title": "ActionOnAddCompanySectionRequest"
},
"ActionOnAddCorporateSectionRequest": {
"type": "object",
"required": [
"opsActionOnSection",
"remarks"
],
"properties": {
"agreementEndDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date on which the validity of the agreement ends",
"allowEmptyValue": false
},
"agreementNumber": {
"type": "string",
"example": 123456,
"description": "Number of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"agreementStartDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date from which the validity of the agreement starts",
"allowEmptyValue": false
},
"agreementURL": {
"type": "string",
"example": "abc.com/agreement",
"description": "URL of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"corporateName": {
"type": "string",
"example": "My Company",
"description": "Name of the Corporate which needs to be added",
"allowEmptyValue": false
},
"opsActionOnSection": {
"type": "string",
"example": "SAVE",
"description": "Action to be performed on this specific section",
"allowEmptyValue": false,
"enum": [
"SAVE",
"MARK_AS_COMPLETE",
"REJECT",
"ACCEPT"
]
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
},
"signingAuthority": {
"$ref": "#/definitions/SigningAuthority"
}
},
"title": "ActionOnAddCorporateSectionRequest"
},
"ActionOnApplicationRequest": {
"type": "object",
"required": [
"moderatedApplicationType",
"remarks"
],
"properties": {
"moderatedApplicationType": {
"type": "string",
"example": "SIGN_UP",
"description": "Type of the application on which the action is to be performed",
"allowEmptyValue": false,
"enum": [
"SIGN_UP",
"EDIT_CORPORATE"
]
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
}
},
"title": "ActionOnApplicationRequest"
},
"ActionOnEditCompanySectionRequest": {
"type": "object",
"required": [
"companyId",
"opsActionOnSection",
"remarks",
"type"
],
"properties": {
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"companyId": {
"type": "string",
"example": "ee64c930-c06f-49cb-9443-84b132b9d4e2",
"description": "Identifier of the company which is being acted upon",
"allowEmptyValue": false
},
"documents": {
"$ref": "#/definitions/Documents"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"logoURL": {
"type": "string",
"example": "https://abc.com/logo.png",
"description": "URL for the logo of the company",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "Contract Change",
"description": "Name of the action being performed",
"allowEmptyValue": false
},
"opsActionOnSection": {
"type": "string",
"example": "SAVE",
"description": "Action to be performed on this specific section",
"allowEmptyValue": false,
"enum": [
"SAVE",
"MARK_AS_COMPLETE",
"REJECT",
"ACCEPT"
]
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
},
"shortCode": {
"type": "string",
"example": "ABCXYZ",
"description": "Short code to be used as identifier for the company",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "PRIVATE_LIMITED",
"description": "Identification for the type of company which is being created",
"allowEmptyValue": false,
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
}
},
"title": "ActionOnEditCompanySectionRequest"
},
"ActionOnEditCorporateSectionRequest": {
"type": "object",
"required": [
"opsActionOnSection",
"remarks"
],
"properties": {
"agreementEndDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date on which the validity of the agreement ends",
"allowEmptyValue": false
},
"agreementNumber": {
"type": "string",
"example": 123456,
"description": "Number of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"agreementStartDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date from which the validity of the agreement starts",
"allowEmptyValue": false
},
"agreementURL": {
"type": "string",
"example": "abc.com/agreement",
"description": "URL of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"corporateId": {
"type": "string",
"example": "4baf7564-f2c4-4300-b27b-cdee926146e6",
"description": "Identifier of the corporate which is being edited",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "Contract Change",
"description": "Name of the action being performed",
"allowEmptyValue": false
},
"opsActionOnSection": {
"type": "string",
"example": "SAVE",
"description": "Action to be performed on this specific section",
"allowEmptyValue": false,
"enum": [
"SAVE",
"MARK_AS_COMPLETE",
"REJECT",
"ACCEPT"
]
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
},
"signingAuthority": {
"$ref": "#/definitions/SigningAuthority"
}
},
"title": "ActionOnEditCorporateSectionRequest"
},
"ActionOnSectionResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "TEMP_SUBMITTED",
"description": "Current status of the section after action is perfromed",
"allowEmptyValue": false
}
},
"title": "ActionOnSectionResponse"
},
"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",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the account holder for whom the account belongs",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"label": {
"type": "string",
"example": "My-Home",
"description": "ID of the account holder for whom the account belongs",
"allowEmptyValue": false
},
"address": {
"$ref": "#/definitions/Address"
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
}
},
"title": "AddAccountHolderPOPRequest"
},
"AddAccountHolderRelationshipRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"relatedAccountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the account holder with whom the relationship is being established",
"allowEmptyValue": false
},
"relationshipType": {
"type": "string",
"example": "Brother",
"description": "Definition of the relationship type with the related Account Holder",
"allowEmptyValue": false
}
},
"title": "AddAccountHolderRelationshipRequest"
},
"AddAccountHolderVectorRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"type": {
"type": "string",
"example": "PhoneNumber",
"description": "Type of the vector being defined for the account holder",
"allowEmptyValue": false
},
"value": {
"type": "string",
"example": "+911234567890",
"description": "Value of the vector being defined for the account holder",
"allowEmptyValue": false
},
"verified": {
"type": "boolean"
}
},
"title": "AddAccountHolderVectorRequest"
},
"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"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"title": "AddAccountVectorRequest"
},
"AddBeneficiaryAccountForBeneficiaryFusionRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"default": {
"type": "boolean"
},
"isVerified": {
"type": "boolean"
},
"nickname": {
"type": "string",
"example": true,
"description": "Nickname of the Beneficiary Account",
"allowEmptyValue": false
},
"status": {
"type": "string",
"example": "ENABLED",
"description": "Status of the Beneficiary Account",
"allowEmptyValue": false
},
"verified": {
"type": "boolean"
},
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"isDefault": {
"type": "boolean"
}
},
"title": "AddBeneficiaryAccountForBeneficiaryFusionRequest"
},
"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": {
"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
},
"picURL": {
"type": "string",
"description": "The URL to get the bundle's display pic",
"allowEmptyValue": false
},
"productMappingRequest": {
"type": "array",
"description": "The mapping of account products to payment products",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/ProductMappingRequest"
}
},
"shortCode": {
"type": "string",
"example": "SVNG",
"description": "The short code to identify the bundle",
"allowEmptyValue": false
}
},
"title": "AddBundleRequest"
},
"AddCompanyDataObject": {
"type": "object",
"required": [
"remarks",
"sectionStatus",
"type"
],
"properties": {
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"createdOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Date on which this entity was created",
"allowEmptyValue": false
},
"entityId": {
"type": "string"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"logoURL": {
"type": "string",
"example": "https://abc.com/logo.png",
"description": "URL for the logo of the company",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "Contract Change",
"description": "Name of the action being performed",
"allowEmptyValue": false
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"example": "IN_REVIEW",
"description": "Current status of the section",
"allowEmptyValue": false,
"enum": [
"NEW",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"type": {
"type": "string",
"example": "PRIVATE_LIMITED",
"description": "Identification for the type of company which is being created",
"allowEmptyValue": false,
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
},
"updatedOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Latest date on which this entity was updated",
"allowEmptyValue": false
}
},
"title": "AddCompanyDataObject"
},
"AddCompanyDataObjectResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdOn": {
"type": "string"
},
"documents": {
"$ref": "#/definitions/Documents"
},
"entityId": {
"type": "string"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"logoURL": {
"type": "string"
},
"name": {
"type": "string"
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"remarks": {
"type": "string"
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"enum": [
"NEW",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"type": {
"type": "string",
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
},
"updatedOn": {
"type": "string"
}
},
"title": "AddCompanyDataObjectResponse"
},
"AddCorporateDataObject": {
"type": "object",
"required": [
"remarks",
"sectionStatus"
],
"properties": {
"agreementEndDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date on which the validity of the agreement ends",
"allowEmptyValue": false
},
"agreementNumber": {
"type": "string",
"example": 123456,
"description": "Number of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"agreementStartDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date from which the validity of the agreement starts",
"allowEmptyValue": false
},
"agreementURL": {
"type": "string",
"example": "abc.com/agreement",
"description": "URL of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"corporateName": {
"type": "string"
},
"createdOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Date on which this entity was created",
"allowEmptyValue": false
},
"entityId": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64",
"example": 123456,
"description": "ID of the IFI (on-boarded organization) under which the corporate exists",
"allowEmptyValue": false
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for adding the corporate data",
"allowEmptyValue": false
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"example": "IN_REVIEW",
"description": "Current status of the section",
"allowEmptyValue": false,
"enum": [
"NEW",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"signingAuthority": {
"$ref": "#/definitions/SigningAuthority"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Latest date on which this entity was updated",
"allowEmptyValue": false
}
},
"title": "AddCorporateDataObject"
},
"AddCorporateDataObjectResponse": {
"type": "object",
"properties": {
"agreementEndDate": {
"type": "string"
},
"agreementNumber": {
"type": "string"
},
"agreementStartDate": {
"type": "string"
},
"agreementURL": {
"type": "string"
},
"attributes": {
"type": "object"
},
"corporateName": {
"type": "string"
},
"createdOn": {
"type": "string"
},
"entityId": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"enum": [
"NEW",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"signingAuthority": {
"$ref": "#/definitions/SigningAuthority"
},
"updatedOn": {
"type": "string"
}
},
"title": "AddCorporateDataObjectResponse"
},
"AddFusionConfigRequest": {
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "Description of the key",
"description": "The description for the key-value config",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"key": {
"type": "string",
"example": 123123,
"description": "The key of the key-value pair",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "SANDBOX_VBO_MAPPING",
"description": "The type for the key-value config",
"allowEmptyValue": false
},
"value": {
"type": "string",
"example": "test",
"description": "The value of the key-value pair",
"allowEmptyValue": false
}
},
"title": "AddFusionConfigRequest"
},
"AddTransactionCategoryRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"transactionCategoryAttributes": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionCategoryStructure"
}
}
},
"title": "AddTransactionCategoryRequest"
},
"Address": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accountHolderVectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"default": {
"type": "boolean"
},
"firstName": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"lastName": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"postCode": {
"type": "string"
},
"state": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ENABLED",
"DELETED"
]
},
"tag": {
"type": "string"
}
},
"title": "Address"
},
"AggregateExpression": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"createdAt": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"expression": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"updatedAt": {
"type": "integer",
"format": "int64"
}
},
"title": "AggregateExpression"
},
"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"
}
},
"totalElements": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryAccountListResponse"
},
"BeneficiaryAccountResponse": {
"type": "object",
"properties": {
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"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"
},
"updatedAt": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"title": "BeneficiaryAccountResponse"
},
"BeneficiaryAccountTransactionFusionRequest": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64",
"example": 500,
"description": "Amount that need to be transferred",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"beneficiaryAccountID": {
"type": "string",
"description": "ID of the beneficiary's account in which money is being transferred",
"allowEmptyValue": false
},
"currency": {
"type": "string",
"example": "INR",
"description": "Currency in which money need to be transacted ",
"allowEmptyValue": false
},
"debitAccountID": {
"type": "string",
"description": "ID of the account from which money has to be deducted",
"allowEmptyValue": false
},
"transactionCode": {
"type": "string",
"description": "TransactionCode regarding the transaction",
"allowEmptyValue": false
},
"transactionTime": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
}
},
"title": "BeneficiaryAccountTransactionFusionRequest"
},
"BeneficiaryAccountTransferRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"transferAmount": {
"$ref": "#/definitions/Money"
},
"currency": {
"type": "string"
},
"amount": {
"type": "integer",
"format": "int64"
},
"transactionCode": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "BeneficiaryAccountTransferRequest"
},
"BeneficiaryListResponse": {
"type": "object",
"properties": {
"beneficiaryList": {
"type": "array",
"items": {
"$ref": "#/definitions/Beneficiary"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"totalElements": {
"type": "integer",
"format": "int64"
}
},
"title": "BeneficiaryListResponse"
},
"BeneficiaryResponse": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryAccount"
}
},
"createdAt": {
"type": "string"
},
"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"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryVector"
}
}
},
"title": "BeneficiaryResponse"
},
"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"
},
"receiptID": {
"type": "string"
},
"remarks": {
"type": "string"
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionID": {
"type": "string"
},
"transactionTime": {
"type": "integer",
"format": "int64"
},
"transferType": {
"type": "string"
}
},
"title": "BeneficiaryTransaction"
},
"BeneficiaryTransactionFusionResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"transactionID": {
"type": "string"
}
},
"title": "BeneficiaryTransactionFusionResponse"
},
"BeneficiaryTransactionResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"debits": {
"type": "array",
"items": {
"$ref": "#/definitions/Posting"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"payeeInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"payerInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paymentID": {
"type": "string"
},
"receiptID": {
"type": "integer",
"format": "int64"
},
"requestID": {
"type": "string"
},
"reversedReceiptID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
},
"statusDetails": {
"$ref": "#/definitions/JsonObject"
},
"time": {
"type": "integer",
"format": "int64"
},
"towards": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionID": {
"type": "string"
},
"transferAmount": {
"$ref": "#/definitions/Money"
},
"transferType": {
"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": {
"deliveryChannel": {
"type": "string",
"enum": [
"PHONE",
"EMAIL"
]
},
"object": {
"$ref": "#/definitions/JID"
},
"tenantID": {
"type": "integer",
"format": "int64"
}
},
"title": "Builder"
},
"BulkOrderRequest": {
"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": "BulkOrderRequest"
},
"CalendarInfo": {
"type": "object",
"properties": {
"calendarId": {
"type": "integer",
"format": "int64"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"timeZone": {
"type": "string"
},
"weekStartOffset": {
"type": "integer",
"format": "int32"
},
"yearStartDay": {
"type": "integer",
"format": "int32"
},
"yearStartMonth": {
"type": "integer",
"format": "int32"
}
},
"title": "CalendarInfo"
},
"CardBinRange": {
"type": "object",
"properties": {
"bin": {
"type": "string"
},
"range": {
"type": "string"
}
},
"title": "CardBinRange"
},
"CardSku": {
"type": "object",
"properties": {
"bin": {
"type": "string"
},
"binRange": {
"type": "string"
},
"cardSkuId": {
"type": "string"
},
"ifi": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"productID": {
"type": "string"
},
"range": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"vendorID": {
"type": "string"
}
},
"title": "CardSku"
},
"CardViewResponse": {
"type": "object",
"properties": {
"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"
},
"resource": {
"$ref": "#/definitions/Resource"
},
"sensitiveView": {
"$ref": "#/definitions/SensitiveCardView"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "CardViewResponse"
},
"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"
},
"CoAConfig": {
"type": "object",
"properties": {
"calendarId": {
"type": "integer",
"format": "int64"
},
"coaDepth": {
"type": "integer",
"format": "int32"
},
"coaDescription": {
"type": "string"
},
"coaId": {
"type": "integer",
"format": "int64"
},
"coaName": {
"type": "string"
},
"currency": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
}
},
"title": "CoAConfig"
},
"Coa": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "Coa"
},
"CoaGraphNode": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/CoaGraphNode"
}
},
"nodeAggregate": {
"type": "integer",
"format": "int64"
},
"nodeId": {
"type": "integer",
"format": "int64"
},
"nodeType": {
"type": "string",
"enum": [
"ROOT",
"INTERMEDIATE",
"LEAF"
]
},
"nodeValue": {
"type": "string"
}
},
"title": "CoaGraphNode"
},
"CoaNode": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "CoaNode"
},
"Company": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"companyLogoURL": {
"type": "string"
},
"companyType": {
"type": "string",
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
},
"corporateId": {
"type": "integer",
"format": "int32"
},
"createdOn": {
"$ref": "#/definitions/Timestamp"
},
"id": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"name": {
"type": "string"
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"status": {
"type": "string"
},
"updatedOn": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "Company"
},
"CompanyResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"companyLogoURL": {
"type": "string"
},
"companyType": {
"type": "string",
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
},
"corporateId": {
"type": "integer",
"format": "int32"
},
"createdOn": {
"type": "string"
},
"documents": {
"$ref": "#/definitions/Documents"
},
"id": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"name": {
"type": "string"
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"status": {
"type": "string"
},
"updatedOn": {
"type": "string"
}
},
"title": "CompanyResponse"
},
"ConnectionConfig": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "ConnectionConfig"
},
"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"
},
"CorporateBeneficiaryAccountResponse": {
"type": "object",
"properties": {
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string",
"example": "93480e72-b883-46fa-8f3f-abe326ab9df7",
"description": "ID of the Beneficiary of the company whose account is being created",
"allowEmptyValue": false
},
"companyID": {
"type": "string",
"example": "93480e72-b883-46fa-8f3f-abe326ab9df7",
"description": "ID of the company creating beneficiary account",
"allowEmptyValue": false
},
"createdAt": {
"type": "string"
},
"default": {
"type": "boolean"
},
"id": {
"type": "string",
"example": "93480e72-b883-46fa-8f3f-abe326ab9df7",
"description": "ID of the Beneficiary account being created by the company",
"allowEmptyValue": false
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"nickname": {
"type": "string",
"example": true,
"description": "Nickname of the Beneficiary Account",
"allowEmptyValue": false
},
"status": {
"type": "string",
"example": "ENABLED",
"description": "Status of the Beneficiary Account",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "ZETA",
"description": "Type of beneficiary ie NEFT or IMPS or ZETA",
"allowEmptyValue": false
},
"updatedAt": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"title": "CorporateBeneficiaryAccountResponse"
},
"CorporateBeneficiaryResponse": {
"type": "object",
"properties": {
"companyID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the company for whom the beneficiary is being created",
"allowEmptyValue": false
},
"createdAt": {
"type": "string",
"example": "2020-02-18T06:24:14.000+00:00",
"description": "Date/Time of the Beneficiary when created",
"allowEmptyValue": false
},
"customFields": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"firstName": {
"type": "string",
"example": "Chandler",
"description": "First name of the beneficiary being created",
"allowEmptyValue": false
},
"gender": {
"type": "string",
"example": "Male",
"description": "Gender of the beneficiary being created",
"allowEmptyValue": false
},
"id": {
"type": "string",
"example": "93480e72-b883-46fa-8f3f-abe326ab9df7",
"description": "ID of the Beneficiary being created by the company",
"allowEmptyValue": false
},
"ifiID": {
"type": "integer",
"format": "int64",
"example": 123123,
"description": "ID of the IFI (on-boarded organization) under which the beneficiary is being created",
"allowEmptyValue": false
},
"lastName": {
"type": "string",
"example": "Bing",
"description": "Last name of the beneficiary being created",
"allowEmptyValue": false
},
"middleName": {
"type": "string",
"example": "Muriel",
"description": "Middle name of the beneficiary being created",
"allowEmptyValue": false
},
"profilePicURL": {
"type": "string",
"example": "http://abc.com",
"description": "Profile pic URL of the beneficiary being created",
"allowEmptyValue": false
},
"relationship": {
"type": "string",
"example": "Brother",
"description": "Relation of the beneficiary being created with the individual",
"allowEmptyValue": false
},
"status": {
"type": "string"
},
"type": {
"type": "string",
"example": "LEGAL",
"description": "Type of the Account Holder for whom the beneficiary being created",
"allowEmptyValue": false,
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string",
"example": "2020-02-18T06:24:14.000+00:00",
"description": "Date/Time of the Beneficiary when updated",
"allowEmptyValue": false
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryVector"
}
}
},
"title": "CorporateBeneficiaryResponse"
},
"CorporateBeneficiaryTransactionResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"debits": {
"type": "array",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/Posting"
}
},
"payeeInfo": {
"type": "object",
"description": "payee Information",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"payerInfo": {
"type": "object",
"description": "payer Information",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"paymentID": {
"type": "string",
"description": "ID of the payment",
"allowEmptyValue": false
},
"receiptID": {
"type": "integer",
"format": "int64",
"description": "receipt ID",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"description": "ID of the request",
"allowEmptyValue": false
},
"reversedReceiptID": {
"type": "integer",
"format": "int64",
"description": "ID of transfer reversal in case of failure ",
"allowEmptyValue": false
},
"status": {
"type": "string",
"description": "status of the transfer",
"allowEmptyValue": false
},
"statusDetails": {
"$ref": "#/definitions/JsonObject"
},
"time": {
"type": "integer",
"format": "int64",
"description": "Time of transaction",
"allowEmptyValue": false
},
"towards": {
"type": "string"
},
"transactionCode": {
"type": "string",
"description": "Transaction Code",
"allowEmptyValue": false
},
"transactionID": {
"type": "string",
"description": "ID of the transaction",
"allowEmptyValue": false
},
"transferAmount": {
"description": "Amount of transaction being transferred and currency",
"allowEmptyValue": false,
"$ref": "#/definitions/Money"
},
"transferType": {
"type": "string",
"description": "type of transfer",
"allowEmptyValue": false
}
},
"title": "CorporateBeneficiaryTransactionResponse"
},
"CorporateResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdOn": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int32"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"updatedOn": {
"type": "string"
}
},
"title": "CorporateResponse"
},
"CreateAccountHolderApplicationRequest": {
"type": "object",
"properties": {
"applicationType": {
"type": "string",
"enum": [
"KYC",
"CREATE_ACCOUNT_HOLDER",
"EDIT_ACCOUNT_HOLDER"
]
},
"customFields": {
"type": "object"
},
"description": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"firstName": {
"type": "string"
},
"formID": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"individualType": {
"type": "string"
},
"kycDetails": {
"$ref": "#/definitions/KYCDetails"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"profilePicURL": {
"type": "string"
},
"salutation": {
"type": "string"
},
"source": {
"type": "string"
},
"spoolID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/Vector"
}
}
},
"title": "CreateAccountHolderApplicationRequest"
},
"CreateAccountHolderApplicationStandardRequest": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"salutation": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string"
},
"gender": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"kycDetails": {
"$ref": "#/definitions/KYCDetails"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/Vector"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"customFields": {
"type": "object"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"title": "CreateAccountHolderApplicationStandardRequest"
},
"CreateAccountHolderRequest": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"format": "date",
"example": "01/01/1990",
"description": "Date of Birth of the account holder being created",
"allowEmptyValue": false
},
"firstName": {
"type": "string",
"example": "Chandler",
"description": "First name of the account holder being created",
"allowEmptyValue": false
},
"gender": {
"type": "string",
"example": "MALE",
"description": "Gender of the account holder being created",
"allowEmptyValue": false
},
"lastName": {
"type": "string",
"example": "Bing",
"description": "Last name of the account holder being created",
"allowEmptyValue": false
},
"middleName": {
"type": "string",
"example": "Muriel",
"description": "Middle name of the account holder being created",
"allowEmptyValue": false
},
"mothersMaidenName": {
"type": "string",
"example": "Margaret",
"description": "Mother's maiden name of the account holder being created",
"allowEmptyValue": false
},
"profilePicURL": {
"type": "string",
"example": "http://abc.com/test",
"description": "URL of the pic of the account holder being created",
"allowEmptyValue": false
},
"salutation": {
"type": "string",
"example": "Mrs",
"description": "Salutation of the account holder being created",
"allowEmptyValue": false
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "CreateAccountHolderRequest"
},
"CreateAccountHolderWithAutoApprovalRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64"
},
"formID": {
"type": "string"
},
"requestID": {
"type": "string"
},
"spoolID": {
"type": "string"
},
"description": {
"type": "string"
},
"individualType": {
"type": "string"
},
"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"
},
"kycDetails": {
"$ref": "#/definitions/KYCDetails"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/VectorRequest"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"customFields": {
"type": "object"
}
},
"title": "CreateAccountHolderWithAutoApprovalRequest"
},
"CreateAccountHolderWithAutoApprovalStandardRequest": {
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"individualType": {
"type": "string"
},
"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"
},
"kycDetails": {
"$ref": "#/definitions/KYCDetails"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/VectorRequest"
}
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"customFields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"title": "CreateAccountHolderWithAutoApprovalStandardRequest"
},
"CreateAndLinkFormFactorResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"provisionFormFactorResponse": {
"type": "object"
},
"resource": {
"$ref": "#/definitions/Resource"
}
},
"title": "CreateAndLinkFormFactorResponse"
},
"CreateApplicationResponse": {
"type": "object",
"properties": {
"applicationId": {
"type": "integer",
"format": "int32",
"example": 142,
"description": "Identifier of the application that has been created",
"allowEmptyValue": false
},
"applicationType": {
"type": "string",
"example": "SIGN_UP",
"description": "Type of the application that has been created",
"allowEmptyValue": false,
"enum": [
"SIGN_UP",
"EDIT_CORPORATE"
]
}
},
"title": "CreateApplicationResponse"
},
"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"
},
"CreateCalendarRequest": {
"type": "object",
"properties": {
"ifiId": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"yearStartDay": {
"type": "integer",
"format": "int32"
},
"yearStartMonth": {
"type": "integer",
"format": "int32"
},
"weekStartOffset": {
"type": "integer",
"format": "int32"
},
"timezone": {
"type": "string"
}
},
"title": "CreateCalendarRequest"
},
"CreateCardDesignPolicyRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"background": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"backgroundExpanded": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"logo": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"textColor": {
"type": "string"
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validUntil": {
"type": "string",
"format": "date-time"
}
},
"title": "CreateCardDesignPolicyRequest"
},
"CreateCoaNodeResponsePayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"nodeId": {
"type": "integer",
"format": "int64"
}
},
"title": "CreateCoaNodeResponsePayload"
},
"CreateCoaResponsePayload": {
"type": "object",
"properties": {
"coaId": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"rootNodeId": {
"type": "integer",
"format": "int64"
}
},
"title": "CreateCoaResponsePayload"
},
"CreateCorporateBeneficiaryAccountRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"default": {
"type": "boolean"
},
"isVerified": {
"type": "boolean"
},
"nickname": {
"type": "string",
"example": true,
"description": "Nickname of the Beneficiary Account",
"allowEmptyValue": false
},
"status": {
"type": "string",
"example": "ENABLED",
"description": "Status of the Beneficiary Account",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "ZETA",
"description": "Type of beneficiary ie NEFT or IMPS or ZETA",
"allowEmptyValue": false
},
"verified": {
"type": "boolean"
},
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"isDefault": {
"type": "boolean"
}
},
"title": "CreateCorporateBeneficiaryAccountRequest"
},
"CreateCorporateBeneficiaryRequest": {
"type": "object",
"properties": {
"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": "CreateCorporateBeneficiaryRequest"
},
"CreateCouponAccountingPolicyRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"couponName": {
"type": "object"
},
"denomination": {
"type": "object"
},
"description": {
"type": "string"
},
"expiryAccount": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"isPartialRedemptionAllowed": {
"type": "boolean"
},
"validFrom": {
"type": "integer",
"format": "int64"
},
"validUntil": {
"type": "integer",
"format": "int64"
}
},
"title": "CreateCouponAccountingPolicyRequest"
},
"CreateEditCorporateApplicationRequest": {
"type": "object",
"properties": {
"corporateId": {
"type": "integer",
"format": "int32",
"example": "4baf7564-f2c4-4300-b27b-cdee926146e6",
"description": "Identifier of the corporate which is being edited",
"allowEmptyValue": false
}
},
"title": "CreateEditCorporateApplicationRequest"
},
"CreateExtendedProductFamilyRequest": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"issuancePolicy": {
"$ref": "#/definitions/CreateIssuancePolicyRequest"
},
"productFamily": {
"$ref": "#/definitions/CreateProductFamilyRequest"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "CreateExtendedProductFamilyRequest"
},
"CreateExtendedProductRequest": {
"type": "object",
"properties": {
"cardDesignPolicyRequest": {
"$ref": "#/definitions/CreateCardDesignPolicyRequest"
},
"couponAccountingPolicyRequest": {
"$ref": "#/definitions/CreateCouponAccountingPolicyRequest"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"issuancePolicyRequest": {
"$ref": "#/definitions/CreateIssuancePolicyRequest"
},
"productRequest": {
"$ref": "#/definitions/CreateProductRequest"
},
"transactionPolicyIDs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "CreateExtendedProductRequest"
},
"CreateIssuancePolicyRequest": {
"type": "object",
"properties": {
"allowedAccountHolderGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"disAllowedAccountHolderGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"validFrom": {
"type": "integer",
"format": "int64"
},
"validUntil": {
"type": "integer",
"format": "int64"
}
},
"title": "CreateIssuancePolicyRequest"
},
"CreatePolicyMappingRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"entityID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"policyEntityType": {
"type": "string",
"enum": [
"PRODUCT_FAMILY",
"PRODUCT",
"PROGRAM",
"ACCOUNT_HOLDER",
"ACCOUNT"
]
},
"policyID": {
"type": "string"
},
"policyType": {
"type": "string",
"enum": [
"TRANSACTION_POLICY",
"CARD_DESIGN_POLICY",
"ISSUANCE_POLICY",
"COUPON_ACCOUNTING_POLICY",
"NOTIFICATION_POLICY",
"FEE_CHARGES_POLICY",
"INTEREST_POLICY",
"ACCOUNT_DISCOVERY_POLICY"
]
}
},
"title": "CreatePolicyMappingRequest"
},
"CreatePolicyMappingRequestPayload": {
"type": "object",
"properties": {
"policyID": {
"type": "string"
}
},
"title": "CreatePolicyMappingRequestPayload"
},
"CreatePolicyRequestPayload": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"code": {
"type": "string"
},
"desc": {
"type": "string"
},
"effectiveFrom": {
"type": "integer",
"format": "int64"
},
"expiresAt": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifi": {
"type": "integer",
"format": "int64"
},
"policyAggregateRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
},
"policyBalanceRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyBalanceRule"
}
},
"policyTxnRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnRule"
}
},
"policyViolationAction": {
"type": "string",
"enum": [
"DECLINE_AND_NOTIFY",
"DECLINE",
"NOTIFY"
]
},
"requestID": {
"type": "string"
},
"txnConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnConstraint"
}
}
},
"title": "CreatePolicyRequestPayload"
},
"CreatePolicyResponsePayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"policyID": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
}
},
"title": "CreatePolicyResponsePayload"
},
"CreateProductFamilyRequest": {
"type": "object",
"properties": {
"accountingType": {
"type": "string",
"enum": [
"ASSET",
"LIABILITY",
"INCOME",
"EXPENSE",
"EQUITY"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"coaID": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"parentCoaNodeID": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"WALLET_BASED",
"ACCOUNT_BASED"
]
}
},
"title": "CreateProductFamilyRequest"
},
"CreateProductRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"coaID": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"BLOCKED"
]
}
},
"title": "CreateProductRequest"
},
"CreateUserTransactionCategoryRequest": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"transactionAttributes": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionCategoryStructure"
}
}
},
"title": "CreateUserTransactionCategoryRequest"
},
"CreateUserTransactionCategoryResponse": {
"type": "object",
"title": "CreateUserTransactionCategoryResponse"
},
"DeferredResultCompany": {
"type": "object",
"properties": {
"result": {
"type": "object"
},
"setOrExpired": {
"type": "boolean"
}
},
"title": "DeferredResultCompany"
},
"DeferredResultCorporate": {
"type": "object",
"properties": {
"result": {
"type": "object"
},
"setOrExpired": {
"type": "boolean"
}
},
"title": "DeferredResultCorporate"
},
"DeferredResultListCompany": {
"type": "object",
"properties": {
"result": {
"type": "object"
},
"setOrExpired": {
"type": "boolean"
}
},
"title": "DeferredResultListCompany"
},
"DispatchOrderRequest": {
"type": "object",
"properties": {
"plasticCode": {
"type": "string"
},
"thirdLineEmbossing": {
"type": "string"
},
"fourthLineEmbossing": {
"type": "string"
},
"deliveryAddress": {
"$ref": "#/definitions/Address"
},
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "DispatchOrderRequest"
},
"DocumentResponse": {
"type": "object",
"properties": {
"applicationID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"mediaType": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"subType": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"title": "DocumentResponse"
},
"Documents": {
"type": "object",
"properties": {
"cin": {
"type": "string"
},
"cinURL": {
"type": "string"
},
"gstin": {
"type": "string"
},
"gstinURL": {
"type": "string"
},
"pan": {
"type": "string"
},
"panURL": {
"type": "string"
}
},
"title": "Documents"
},
"ECDHEncryptedCardPayload": {
"type": "object",
"properties": {
"encryptedData": {
"type": "string"
},
"iv": {
"type": "string"
},
"serverPublicKey": {
"type": "string"
}
},
"title": "ECDHEncryptedCardPayload"
},
"EditCompanySectionDataObject": {
"type": "object",
"required": [
"companyId",
"remarks",
"sectionStatus",
"type"
],
"properties": {
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"company": {
"$ref": "#/definitions/Company"
},
"companyId": {
"type": "string",
"example": "ee64c930-c06f-49cb-9443-84b132b9d4e2",
"description": "Identifier of the company which is being edited",
"allowEmptyValue": false
},
"createdOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Date on which this entity was created",
"allowEmptyValue": false
},
"entityId": {
"type": "string"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"logoURL": {
"type": "string",
"example": "https://abc.com/logo.png",
"description": "URL for the logo of the company",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "Contract Change",
"description": "Name of the action being performed",
"allowEmptyValue": false
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"example": "IN_REVIEW",
"description": "Current status of the section",
"allowEmptyValue": false,
"enum": [
"EDIT_INITIATED",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"shortCode": {
"type": "string",
"example": "ABCXYZ",
"description": "Short code to be used as identifier for the company",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "PRIVATE_LIMITED",
"description": "Identification for the type of company which is being edited",
"allowEmptyValue": false,
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
},
"updatedOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Latest date on which this entity was updated",
"allowEmptyValue": false
}
},
"title": "EditCompanySectionDataObject"
},
"EditCompanySectionDataObjectResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"companyId": {
"type": "string"
},
"createdOn": {
"type": "string"
},
"documents": {
"$ref": "#/definitions/Documents"
},
"entityId": {
"type": "string"
},
"kycStatus": {
"$ref": "#/definitions/KYCStatus"
},
"logoURL": {
"type": "string"
},
"name": {
"type": "string"
},
"pointsOfPresence": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"remarks": {
"type": "string"
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"enum": [
"EDIT_INITIATED",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"shortCode": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"LLP",
"SOLE_PROPRIETOR",
"TRUST",
"PRIVATE_LIMITED",
"PARTNER_FIRM",
"PUBLIC",
"NPO_NGO",
"BRANCH_OFFICE",
"LIAISON_OFFICE",
"PUBLIC_COMPANY"
]
},
"updatedOn": {
"type": "string"
}
},
"title": "EditCompanySectionDataObjectResponse"
},
"EditCorporateDataObject": {
"type": "object",
"required": [
"corporateId",
"remarks",
"sectionStatus"
],
"properties": {
"agreementEndDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date on which the validity of the agreement ends",
"allowEmptyValue": false
},
"agreementNumber": {
"type": "string",
"example": 123456,
"description": "Number of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"agreementStartDate": {
"type": "string",
"example": "01/01/2019",
"description": "Date from which the validity of the agreement starts",
"allowEmptyValue": false
},
"agreementURL": {
"type": "string",
"example": "abc.com/agreement",
"description": "URL of the agreement between the corporate and the issuer/VBO",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"example": "myCode : ABC",
"description": "Additional information for this entity",
"allowEmptyValue": false
},
"corporateId": {
"type": "integer",
"format": "int32",
"example": "4baf7564-f2c4-4300-b27b-cdee926146e6",
"description": "Identifier of the corporate which is being edited",
"allowEmptyValue": false
},
"createdOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Date on which this entity was created",
"allowEmptyValue": false
},
"entityId": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64",
"example": 123456,
"description": "ID of the IFI (on-boarded organization) under which the corporate exists",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "MYCOMPANY",
"description": "Name of the corporate",
"allowEmptyValue": false
},
"remarks": {
"type": "string",
"example": "Application looks good",
"description": "Additional remarks for the executing the action on the application",
"allowEmptyValue": false
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"example": "IN_REVIEW",
"description": "Current status of the section",
"allowEmptyValue": false,
"enum": [
"EDIT_INITIATED",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"signingAuthority": {
"$ref": "#/definitions/SigningAuthority"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"example": "01/01/2019",
"description": "Latest date on which this entity was updated",
"allowEmptyValue": false
}
},
"title": "EditCorporateDataObject"
},
"EditCorporateDataObjectResponse": {
"type": "object",
"properties": {
"agreementEndDate": {
"type": "string"
},
"agreementNumber": {
"type": "string"
},
"agreementStartDate": {
"type": "string"
},
"agreementURL": {
"type": "string"
},
"attributes": {
"type": "object"
},
"corporateId": {
"type": "integer",
"format": "int32"
},
"createdOn": {
"type": "string"
},
"entityId": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"remarks": {
"type": "string"
},
"revisionId": {
"type": "integer",
"format": "int32"
},
"sectionId": {
"type": "integer",
"format": "int32",
"example": 143,
"description": "Identifier of the specific section",
"allowEmptyValue": false
},
"sectionStatus": {
"type": "string",
"enum": [
"EDIT_INITIATED",
"PENDING",
"TEMP_COMPLETED",
"APPROVED",
"REJECTED",
"IN_REVIEW",
"ACCEPTED"
]
},
"sectionType": {
"type": "string",
"example": "ADD_COMPANY",
"description": "Identifier of the specific section",
"allowEmptyValue": false,
"enum": [
"ADD_COMPANY",
"ADD_CORPORATE",
"EDIT_CORPORATE",
"EDIT_COMPANY"
]
},
"signingAuthority": {
"$ref": "#/definitions/SigningAuthority"
},
"updatedOn": {
"type": "string"
}
},
"title": "EditCorporateDataObjectResponse"
},
"EditIndividualApplicationRequest": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"formID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"individualID": {
"type": "string"
},
"source": {
"type": "string"
},
"spoolID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"title": "EditIndividualApplicationRequest"
},
"EditIndividualApplicationStandardRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"individualID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"title": "EditIndividualApplicationStandardRequest"
},
"EmbossAndActivateReplacementOrderRequest": {
"type": "object",
"properties": {
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"deliveryAddress": {
"$ref": "#/definitions/Address"
},
"expiry": {
"$ref": "#/definitions/JsonElement"
},
"fourthLineEmbossing": {
"type": "string"
},
"oldCardReferenceNumber": {
"type": "string"
},
"orderID": {
"type": "string"
},
"signatoryJID": {
"type": "string"
},
"signature": {
"type": "string"
},
"signed": {
"type": "boolean"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "EmbossAndActivateReplacementOrderRequest"
},
"EmptyPayload": {
"type": "object",
"title": "EmptyPayload"
},
"EntityCodeResponse": {
"type": "object",
"properties": {
"entityCode": {
"type": "string"
}
},
"title": "EntityCodeResponse"
},
"EntityGroup": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"entityType": {
"type": "string",
"enum": [
"ACCOUNT",
"ACCOUNT_HOLDER",
"BENEFICIARY",
"BENEFICIARY_ACCOUNT"
]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"schema": {
"$ref": "#/definitions/JsonObject"
}
},
"title": "EntityGroup"
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"details": {
"$ref": "#/definitions/JsonElement"
}
},
"title": "Error"
},
"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"
},
"identityID": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"policies": {
"$ref": "#/definitions/Policies"
},
"reason": {
"$ref": "#/definitions/StatusReason"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"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"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string"
}
},
"title": "FormFactorProduct"
},
"FusionConfigResponse": {
"type": "object",
"properties": {
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"description": {
"type": "string",
"example": "Description of the key",
"description": "The description for the key-value config",
"allowEmptyValue": false
},
"id": {
"type": "string"
},
"key": {
"type": "string",
"example": 123123,
"description": "The key of the key-value pair",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "SANDBOX_VBO_MAPPING",
"description": "The type for the key-value config",
"allowEmptyValue": false
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"type": "string"
},
"value": {
"type": "string",
"example": "test",
"description": "The value of the key-value pair",
"allowEmptyValue": false
}
},
"title": "FusionConfigResponse"
},
"FusionListCardsRequest": {
"type": "object",
"properties": {
"filters": {
"$ref": "#/definitions/FusionListCardsRequestFilters"
}
},
"title": "FusionListCardsRequest"
},
"FusionListCardsRequestFilters": {
"type": "object",
"properties": {
"cardID": {
"type": "string"
},
"crn": {
"type": "string"
},
"panSHA": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "FusionListCardsRequestFilters"
},
"GenericCreateApplicationResponse": {
"type": "object",
"properties": {
"applicationID": {
"type": "integer",
"format": "int32",
"example": 142,
"description": "Identifier of the application that has been created",
"allowEmptyValue": false
},
"applicationType": {
"type": "string",
"example": "SIGN_UP",
"description": "Type of the application that has been created",
"allowEmptyValue": false,
"enum": [
"SIGN_UP",
"EDIT_CORPORATE"
]
}
},
"title": "GenericCreateApplicationResponse"
},
"GenericFetchApplicationResponse": {
"type": "object",
"properties": {
"signUpRequests": {
"type": "array",
"items": {
"type": "object"
}
},
"totalRequestCount": {
"type": "integer",
"format": "int64"
}
},
"title": "GenericFetchApplicationResponse"
},
"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": {
"count": {
"type": "integer",
"format": "int64"
},
"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"
},
"GetAccountResponse": {
"type": "object",
"properties": {
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountAccessorResponse"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"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/AccountRelationResponse"
}
},
"status": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"updatedAt": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVectorResponse"
}
}
},
"title": "GetAccountResponse"
},
"GetAccountTransaction": {
"type": "object",
"properties": {
"accountID": {
"type": "string"
},
"amount": {
"type": "integer",
"format": "int64"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"currency": {
"type": "string"
},
"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": "string"
},
"transactionID": {
"type": "string"
}
},
"title": "GetAccountTransaction"
},
"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"
},
"GetAggregateExpressionListResponse": {
"type": "object",
"properties": {
"aggregateExpressions": {
"type": "array",
"items": {
"$ref": "#/definitions/AggregateExpression"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAggregateExpressionListResponse"
},
"GetAllAccountHoldersResponse": {
"type": "object",
"properties": {
"accountHolder": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolder"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAllAccountHoldersResponse"
},
"GetAllCoAsResponsePayload": {
"type": "object",
"properties": {
"coAConfigs": {
"type": "array",
"items": {
"$ref": "#/definitions/CoAConfig"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetAllCoAsResponsePayload"
},
"GetAllTransactionPoliciesByIFIResponse": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionPolicyResponse"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"totalEntries": {
"type": "integer",
"format": "int64"
}
},
"title": "GetAllTransactionPoliciesByIFIResponse"
},
"GetAllTransactionPoliciesResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionPolicyResponse"
}
}
},
"title": "GetAllTransactionPoliciesResponse"
},
"GetAllTxnCategoriesResponsePayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"transactionCategories": {
"type": "array",
"items": {
"$ref": "#/definitions/TxnCategory"
}
}
},
"title": "GetAllTxnCategoriesResponsePayload"
},
"GetApplicationDetailsResponse": {
"type": "object",
"properties": {
"applicationDetails": {
"type": "object"
}
},
"title": "GetApplicationDetailsResponse"
},
"GetBeneficiaryTransactionListResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficiaryTransaction"
}
}
},
"title": "GetBeneficiaryTransactionListResponse"
},
"GetCalendarResponsePayload": {
"type": "object",
"properties": {
"calendarInfo": {
"$ref": "#/definitions/CalendarInfo"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetCalendarResponsePayload"
},
"GetCoAResponsePayload": {
"type": "object",
"properties": {
"coAConfig": {
"$ref": "#/definitions/CoAConfig"
},
"coaGraphNodes": {
"type": "array",
"items": {
"$ref": "#/definitions/CoaGraphNode"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetCoAResponsePayload"
},
"GetCoaListResponse": {
"type": "object",
"properties": {
"coaList": {
"type": "array",
"items": {
"$ref": "#/definitions/Coa"
}
},
"count": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetCoaListResponse"
},
"GetCoaNodesResponse": {
"type": "object",
"properties": {
"coaNodeList": {
"type": "array",
"items": {
"$ref": "#/definitions/CoaNode"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetCoaNodesResponse"
},
"GetPOPListResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"popList": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
}
},
"title": "GetPOPListResponse"
},
"GetPoliciesResponsePayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/Policy"
}
}
},
"title": "GetPoliciesResponsePayload"
},
"GetPolicyMappingsResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"policyMappingResponseList": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyMappingResponse"
}
}
},
"title": "GetPolicyMappingsResponse"
},
"GetPolicyResponsePayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"policy": {
"$ref": "#/definitions/Policy"
}
},
"title": "GetPolicyResponsePayload"
},
"GetPolicyTransactionCategoryResponsePayload": {
"type": "object",
"properties": {
"attrs": {
"type": "array",
"items": {
"$ref": "#/definitions/TxnCategoryAttrs"
}
},
"code": {
"type": "string"
},
"desc": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetPolicyTransactionCategoryResponsePayload"
},
"GetProductFamilyListResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"productFamilyList": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductFamily"
}
}
},
"title": "GetProductFamilyListResponse"
},
"GetProductListResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"productList": {
"type": "array",
"items": {
"$ref": "#/definitions/Product"
}
}
},
"title": "GetProductListResponse"
},
"GetProgramListResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"programs": {
"type": "array",
"items": {
"$ref": "#/definitions/Program"
}
}
},
"title": "GetProgramListResponse"
},
"GetTransactionPolicyResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"balanceLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyBalanceRule"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"policyViolationAction": {
"type": "string",
"enum": [
"DECLINE_AND_NOTIFY",
"DECLINE",
"NOTIFY"
]
},
"status": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"txnConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnConstraint"
}
},
"txnLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnRule"
}
},
"updatedAt": {
"type": "string"
},
"validFrom": {
"type": "string"
},
"validUntil": {
"type": "string"
},
"velocityLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
},
"volumeLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
}
},
"title": "GetTransactionPolicyResponse"
},
"GetTransactionsResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "GetTransactionsResponse"
},
"GetUserTxnCategoriesResponsePayload": {
"type": "object",
"title": "GetUserTxnCategoriesResponsePayload"
},
"IBundleView": {
"type": "object",
"title": "IBundleView"
},
"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"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"targetURI": {
"type": "string"
}
},
"title": "InsertFormFactorResponse"
},
"IssueAccountArtifactRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the individual being issued with the account.",
"allowEmptyValue": false
},
"accountProductID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the account product ID which is part of the issuing bundle",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Victor",
"description": "The name which would be preferred in the account name",
"allowEmptyValue": false
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountVector"
}
},
"accessors": {
"type": "array",
"items": {
"$ref": "#/definitions/Accessor"
}
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountRelation"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "IssueAccountArtifactRequest"
},
"IssueAccountArtifactResponse": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"accountID": {
"type": "string"
},
"bundleID": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"title": "IssueAccountArtifactResponse"
},
"IssueAccountProductsRequest": {
"type": "object",
"properties": {
"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"
},
"IssueBundleRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the individual being issued with the account.",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"example": "Victor",
"description": "The name which would be preferred in the account name",
"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
},
"targetAccount": {
"type": "string",
"example": "account://account-num-1",
"description": "The account number to be assosciated with 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"
}
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "requestID as an idempotent key",
"allowEmptyValue": false
}
},
"title": "IssueBundleResponse"
},
"IssueFormFactorRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the individual being issued with the form factor.",
"allowEmptyValue": false
},
"formFactorProductID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the form factor/card which is being issued",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "requestID as an idempotent key",
"allowEmptyValue": false
},
"resourceID": {
"type": "string",
"example": "9d7ae299",
"description": "ID of the resource 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 individual's account which is to be linked to the resource/card",
"allowEmptyValue": false
},
"orderDetails": {
"type": "object"
},
"attributes": {
"type": "object"
}
},
"title": "IssueFormFactorRequest"
},
"IssueFormFactorResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"id": {
"type": "string"
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "requestID as an idempotent key",
"allowEmptyValue": false
},
"status": {
"type": "string"
},
"targetUri": {
"type": "string"
}
},
"title": "IssueFormFactorResponse"
},
"IssuePaymentProductRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the individual being issued with the resource.",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paymentProductID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the account product ID 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"
},
"IssuePaymentProductResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"status": {
"type": "string"
},
"targetAccount": {
"type": "string"
}
},
"title": "IssuePaymentProductResponse"
},
"IssueResourceRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"example": "aa267641-f475-4acb-859e-bb9c60d3e9db",
"description": "ID of the individual being issued with the resource.",
"allowEmptyValue": false
},
"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
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "requestID as an idempotent key",
"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 individual's account which is to be linked to the resource/card",
"allowEmptyValue": false
},
"attributes": {
"type": "object"
}
},
"title": "IssueResourceRequest"
},
"IssueResourceResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"bundleID": {
"type": "string"
},
"id": {
"type": "string"
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "requestID as an idempotent key",
"allowEmptyValue": false
},
"resourceID": {
"type": "string"
},
"status": {
"type": "string"
},
"targetUri": {
"type": "string"
}
},
"title": "IssueResourceResponse"
},
"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"
},
"JsonArray": {
"type": "object",
"properties": {
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asBoolean": {
"type": "boolean"
},
"asByte": {
"type": "integer",
"format": "int32",
"minimum": -128,
"maximum": 127
},
"asCharacter": {
"type": "string"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asJsonArray": {
"$ref": "#/definitions/JsonArray"
},
"asJsonNull": {
"$ref": "#/definitions/JsonNull"
},
"asJsonObject": {
"$ref": "#/definitions/JsonObject"
},
"asJsonPrimitive": {
"$ref": "#/definitions/JsonPrimitive"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asNumber": {
"$ref": "#/definitions/Number"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
},
"jsonArray": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
}
},
"title": "JsonArray"
},
"JsonElement": {
"type": "object",
"properties": {
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asBoolean": {
"type": "boolean"
},
"asByte": {
"type": "integer",
"format": "int32",
"minimum": -128,
"maximum": 127
},
"asCharacter": {
"type": "string"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asJsonArray": {
"$ref": "#/definitions/JsonArray"
},
"asJsonNull": {
"$ref": "#/definitions/JsonNull"
},
"asJsonObject": {
"$ref": "#/definitions/JsonObject"
},
"asJsonPrimitive": {
"$ref": "#/definitions/JsonPrimitive"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asNumber": {
"$ref": "#/definitions/Number"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
},
"jsonArray": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
}
},
"title": "JsonElement"
},
"JsonNull": {
"type": "object",
"properties": {
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asBoolean": {
"type": "boolean"
},
"asByte": {
"type": "integer",
"format": "int32",
"minimum": -128,
"maximum": 127
},
"asCharacter": {
"type": "string"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asJsonArray": {
"$ref": "#/definitions/JsonArray"
},
"asJsonNull": {
"$ref": "#/definitions/JsonNull"
},
"asJsonObject": {
"$ref": "#/definitions/JsonObject"
},
"asJsonPrimitive": {
"$ref": "#/definitions/JsonPrimitive"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asNumber": {
"$ref": "#/definitions/Number"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
},
"jsonArray": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
}
},
"title": "JsonNull"
},
"JsonObject": {
"type": "object",
"properties": {
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asBoolean": {
"type": "boolean"
},
"asByte": {
"type": "integer",
"format": "int32",
"minimum": -128,
"maximum": 127
},
"asCharacter": {
"type": "string"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asJsonArray": {
"$ref": "#/definitions/JsonArray"
},
"asJsonNull": {
"$ref": "#/definitions/JsonNull"
},
"asJsonObject": {
"$ref": "#/definitions/JsonObject"
},
"asJsonPrimitive": {
"$ref": "#/definitions/JsonPrimitive"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asNumber": {
"$ref": "#/definitions/Number"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
},
"jsonArray": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
}
},
"title": "JsonObject"
},
"JsonPrimitive": {
"type": "object",
"properties": {
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asBoolean": {
"type": "boolean"
},
"asByte": {
"type": "integer",
"format": "int32",
"minimum": -128,
"maximum": 127
},
"asCharacter": {
"type": "string"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asJsonArray": {
"$ref": "#/definitions/JsonArray"
},
"asJsonNull": {
"$ref": "#/definitions/JsonNull"
},
"asJsonObject": {
"$ref": "#/definitions/JsonObject"
},
"asJsonPrimitive": {
"$ref": "#/definitions/JsonPrimitive"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asNumber": {
"$ref": "#/definitions/Number"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
},
"boolean": {
"type": "boolean"
},
"jsonArray": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
},
"number": {
"type": "boolean"
},
"string": {
"type": "boolean"
}
},
"title": "JsonPrimitive"
},
"KYCDetails": {
"type": "object",
"properties": {
"authData": {
"$ref": "#/definitions/JsonObject"
},
"authType": {
"type": "string"
},
"expiryTime": {
"$ref": "#/definitions/Timestamp"
},
"kycAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"kycStatus": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"updateTime": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "KYCDetails"
},
"KYCDetailsResponse": {
"type": "object",
"properties": {
"expiryTime": {
"$ref": "#/definitions/Timestamp"
},
"kycAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"kycStatus": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"updateTime": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "KYCDetailsResponse"
},
"KYCDetailsStandard": {
"type": "object",
"properties": {
"authData": {
"$ref": "#/definitions/JsonObject"
},
"authType": {
"type": "string"
},
"expiryTime": {
"type": "string"
},
"kycAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"kycStatus": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"updateTime": {
"type": "string"
}
},
"title": "KYCDetailsStandard"
},
"KYCDetailsStandardResponse": {
"type": "object",
"properties": {
"expiryTime": {
"type": "string"
},
"kycAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"kycStatus": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"updateTime": {
"type": "string"
}
},
"title": "KYCDetailsStandardResponse"
},
"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"
},
"standardExpiryTime": {
"type": "string"
},
"standardUpdateTime": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
},
"title": "KYCStatus"
},
"LedgerResponse": {
"type": "object",
"properties": {
"aggregateExpressions": {
"type": "array",
"items": {
"$ref": "#/definitions/AggregateExpression"
}
},
"count": {
"type": "integer",
"format": "int64"
}
},
"title": "LedgerResponse"
},
"ListEntityGroupResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"entityGroupList": {
"type": "array",
"items": {
"$ref": "#/definitions/EntityGroup"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "ListEntityGroupResponse"
},
"ListPaymentProductResponse": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paymentProducts": {
"type": "array",
"items": {
"$ref": "#/definitions/PaymentProduct"
}
}
},
"title": "ListPaymentProductResponse"
},
"ListPaymentResponse": {
"type": "object",
"properties": {
"payments": {
"type": "array",
"items": {
"$ref": "#/definitions/Payment"
}
}
},
"title": "ListPaymentResponse"
},
"Map«string,string»": {
"type": "object",
"title": "Map«string,string»",
"additionalProperties": {
"type": "string"
}
},
"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"
},
"Money": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "string"
}
},
"title": "Money"
},
"Number": {
"type": "object",
"title": "Number"
},
"Optional«int»": {
"type": "object",
"properties": {
"present": {
"type": "boolean"
}
},
"title": "Optional«int»"
},
"OrderDetails": {
"type": "object",
"properties": {
"cardSku": {
"$ref": "#/definitions/CardSku"
},
"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"
},
"OverrideIssuanceRequest": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "Different than SDN",
"description": "Operator provided remarks/reasons for issuance",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "The request-id of the request that needs to be overriden",
"allowEmptyValue": false
},
"remarks": {
"type": "string",
"example": "Different than SDN",
"description": "Operator provided remarks/reasons for issuance",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "ba3673211-g586-4acb-859e-bb9c60d3qu72",
"description": "The request-id of the request that needs to be overriden",
"allowEmptyValue": false
}
},
"title": "OverrideIssuanceRequest"
},
"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"
},
"POPResponse": {
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"contactList": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
},
"createdAt": {
"type": "string"
},
"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"
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"title": "POPResponse"
},
"PageMetadata": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int64"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int64"
}
},
"title": "PageMetadata"
},
"PagedModel": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"type": "object"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel"
},
"PagedModel«AbstractApplicationDataObject»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/AbstractApplicationDataObject"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«AbstractApplicationDataObject»"
},
"PagedModel«AccountHolderRelationResponse»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderRelationResponse"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«AccountHolderRelationResponse»"
},
"PagedModel«Coa»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/Coa"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«Coa»"
},
"PagedModel«CompanyResponse»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/CompanyResponse"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«CompanyResponse»"
},
"PagedModel«GetAccountTransaction»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/GetAccountTransaction"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«GetAccountTransaction»"
},
"PagedModel«GetTransactionPolicyResponse»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/GetTransactionPolicyResponse"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«GetTransactionPolicyResponse»"
},
"PagedModel«POPResponse»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/POPResponse"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«POPResponse»"
},
"PagedModel«ProductFamilyResponse»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductFamilyResponse"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«ProductFamilyResponse»"
},
"PagedModel«ProductResponse»": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductResponse"
}
},
"metadata": {
"$ref": "#/definitions/PageMetadata"
}
},
"title": "PagedModel«ProductResponse»"
},
"PaginatedResponse«AccountResponse»": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountResponse"
}
},
"hasNext": {
"type": "boolean"
},
"nextPageIndex": {
"type": "string"
},
"prevPageIndex": {
"type": "string"
},
"totalCount": {
"type": "integer",
"format": "int64"
}
},
"title": "PaginatedResponse«AccountResponse»"
},
"PaginatedResponse«SupportTxn»": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/definitions/SupportTxn"
}
},
"hasNext": {
"type": "boolean"
},
"nextPageIndex": {
"type": "string"
},
"prevPageIndex": {
"type": "string"
},
"totalCount": {
"type": "integer",
"format": "int64"
}
},
"title": "PaginatedResponse«SupportTxn»"
},
"PaginatedResponse«TachyonAccountHolderResponse»": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/definitions/TachyonAccountHolderResponse"
}
},
"hasNext": {
"type": "boolean"
},
"nextPageIndex": {
"type": "string"
},
"prevPageIndex": {
"type": "string"
},
"totalCount": {
"type": "integer",
"format": "int64"
}
},
"title": "PaginatedResponse«TachyonAccountHolderResponse»"
},
"PaginatedResponse«TachyonAccountResponse»": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/definitions/TachyonAccountResponse"
}
},
"hasNext": {
"type": "boolean"
},
"nextPageIndex": {
"type": "string"
},
"prevPageIndex": {
"type": "string"
},
"totalCount": {
"type": "integer",
"format": "int64"
}
},
"title": "PaginatedResponse«TachyonAccountResponse»"
},
"Payment": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"error": {
"$ref": "#/definitions/Error"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"payee": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"payer": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paymentRequest": {
"$ref": "#/definitions/PublicPaymentRequestWrapper"
},
"receipts": {
"type": "array",
"items": {
"$ref": "#/definitions/Receipt"
}
},
"requestChannelType": {
"type": "string",
"enum": [
"ZETA_POS",
"SUPER_CARD",
"COLLECT_CARD",
"COLLECT_CALL",
"ZETA_PAYMENT_PAGE",
"ZETA_USER_APP",
"ZETA_API",
"ZETA_EXPRESS_REMOTE",
"ZETA_EXPRESS_KIOSK",
"ZETA_SHADOW_CARD",
"ZETA_UNKNOWN",
"UPI",
"VOID",
"IMPS",
"NEFT"
]
},
"state": {
"type": "string",
"enum": [
"VOID",
"PAYMENT_REQUESTED",
"PAYMENT_AUTHORIZATION_REQUESTED",
"CHALLENGE_REQUIRED",
"CHALLENGE_SUBMITTED",
"PAYMENT_AUTHORIZATION_RECEIVED",
"PAYMENT_EFFECTED",
"PAYMENT_CAPTURED",
"REVERSAL_INITIATED",
"PAYMENT_REVERSED",
"PAYMENT_REQUEST_CANCELLED",
"PAYMENT_REQUEST_DECLINED",
"PAYMENT_REQUEST_FAILED",
"PAYMENT_DECLINED",
"PAYMENT_FAILED"
]
},
"stateTransitions": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"value": {
"$ref": "#/definitions/Money"
}
},
"title": "Payment"
},
"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"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "PaymentProduct"
},
"PersonalizedOrderRequest": {
"type": "object",
"properties": {
"cardSkuID": {
"type": "string"
},
"expiry": {
"$ref": "#/definitions/Expiry"
},
"orderID": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/definitions/PersonalizedOrderRequestRecord"
}
}
},
"title": "PersonalizedOrderRequest"
},
"PersonalizedOrderRequestRecord": {
"type": "object",
"properties": {
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"deliveryAddress": {
"$ref": "#/definitions/Address"
},
"fourthLineEmbossing": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"recordID": {
"type": "integer",
"format": "int32"
},
"tenantAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"thirdLineEmbossing": {
"type": "string"
},
"vendorAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "PersonalizedOrderRequestRecord"
},
"Policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {
"type": "string"
}
},
"paymentPolicies": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "Policies"
},
"Policy": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "integer",
"format": "int64"
},
"desc": {
"type": "string"
},
"effectiveFrom": {
"type": "integer",
"format": "int64"
},
"expiresAt": {
"type": "integer",
"format": "int64"
},
"id": {
"type": "integer",
"format": "int64"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"policyAggregateRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
},
"policyBalanceRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyBalanceRule"
}
},
"policyTxnRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnRule"
}
},
"policyViolationAction": {
"type": "string",
"enum": [
"DECLINE_AND_NOTIFY",
"DECLINE",
"NOTIFY"
]
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"txnConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnConstraint"
}
},
"updatedAt": {
"type": "integer",
"format": "int64"
},
"version": {
"type": "integer",
"format": "int64"
}
},
"title": "Policy"
},
"PolicyAggregateRule": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"DEBIT",
"CREDIT",
"DEBIT_REVERSAL",
"CREDIT_REVERSAL"
]
},
"aggExpressionCode": {
"type": "string"
},
"aggExpressionID": {
"type": "integer",
"format": "int64"
},
"categoryCode": {
"type": "string"
},
"dailyLimit": {
"type": "integer",
"format": "int64"
},
"errorCode": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"monthlyLimit": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
},
"quarterlyLimit": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"VELOCITY",
"VOLUME"
]
},
"weeklyLimit": {
"type": "integer",
"format": "int64"
},
"yearlyLimit": {
"type": "integer",
"format": "int64"
}
},
"title": "PolicyAggregateRule"
},
"PolicyBalanceRule": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"DEBIT",
"CREDIT",
"DEBIT_REVERSAL",
"CREDIT_REVERSAL"
]
},
"errorCode": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"maxAllowedBalance": {
"type": "integer",
"format": "int64"
},
"maxAllowedBalanceBeforeTxn": {
"type": "integer",
"format": "int64"
},
"minRequiredBalance": {
"type": "integer",
"format": "int64"
},
"minRequiredBalanceBeforeTxn": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
},
"transactionCategory": {
"type": "string"
}
},
"title": "PolicyBalanceRule"
},
"PolicyMappingResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"createdAt": {
"type": "integer",
"format": "int64"
},
"entityID": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"policyEntityType": {
"type": "string",
"enum": [
"PRODUCT_FAMILY",
"PRODUCT",
"PROGRAM",
"ACCOUNT_HOLDER",
"ACCOUNT"
]
},
"policyID": {
"type": "string"
},
"policyType": {
"type": "string",
"enum": [
"TRANSACTION_POLICY",
"CARD_DESIGN_POLICY",
"ISSUANCE_POLICY",
"COUPON_ACCOUNTING_POLICY",
"NOTIFICATION_POLICY",
"FEE_CHARGES_POLICY",
"INTEREST_POLICY",
"ACCOUNT_DISCOVERY_POLICY"
]
},
"updatedAt": {
"type": "integer",
"format": "int64"
}
},
"title": "PolicyMappingResponse"
},
"PolicyMappingStandardResponse": {
"type": "object",
"title": "PolicyMappingStandardResponse"
},
"PolicyResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"desc": {
"type": "string"
},
"effectiveFrom": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"policyAggregateRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
},
"policyBalanceRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyBalanceRule"
}
},
"policyTxnRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnRule"
}
},
"policyViolationAction": {
"type": "string",
"enum": [
"DECLINE_AND_NOTIFY",
"DECLINE",
"NOTIFY"
]
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"txnConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnConstraint"
}
},
"updatedAt": {
"type": "string"
},
"version": {
"type": "integer",
"format": "int64"
}
},
"title": "PolicyResponse"
},
"PolicyTxnConstraint": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"DEBIT",
"CREDIT",
"DEBIT_REVERSAL",
"CREDIT_REVERSAL"
]
},
"allowedTimeSlices": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedTxnCategoryCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"disallowedTimeSlices": {
"type": "array",
"items": {
"type": "string"
}
},
"disallowedTxnCategoryCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"errorCode": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
}
},
"title": "PolicyTxnConstraint"
},
"PolicyTxnRule": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"DEBIT",
"CREDIT",
"DEBIT_REVERSAL",
"CREDIT_REVERSAL"
]
},
"categoryCode": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"maxAllowedAmount": {
"type": "integer",
"format": "int64"
},
"minRequiredAmount": {
"type": "integer",
"format": "int64"
},
"policyVersionID": {
"type": "integer",
"format": "int64"
}
},
"title": "PolicyTxnRule"
},
"Posting": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cardProgramID": {
"type": "string"
},
"coupons": {
"type": "array",
"items": {
"$ref": "#/definitions/JsonObject"
}
},
"ifi": {
"type": "integer",
"format": "int64"
},
"instrumentType": {
"type": "string"
},
"newBalance": {
"$ref": "#/definitions/Money"
},
"postingID": {
"type": "string"
},
"productType": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Money"
}
},
"title": "Posting"
},
"Product": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"auraAccountGroupID": {
"type": "integer",
"format": "int64"
},
"coaID": {
"type": "integer",
"format": "int64"
},
"coaNodeID": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"BLOCKED"
]
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string",
"enum": [
"ACCOUNT_BASED",
"WALLET_BASED"
]
}
},
"title": "Product"
},
"ProductFamily": {
"type": "object",
"properties": {
"accountingType": {
"type": "string",
"enum": [
"ASSET",
"LIABILITY",
"INCOME",
"EXPENSE",
"EQUITY"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"auraAccountGroupID": {
"type": "integer",
"format": "int64"
},
"coaID": {
"type": "integer",
"format": "int64"
},
"coaNodeID": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"parentCoaNodeID": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"BLOCKED"
]
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string",
"enum": [
"WALLET_BASED",
"ACCOUNT_BASED"
]
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
}
},
"title": "ProductFamily"
},
"ProductFamilyResponse": {
"type": "object",
"title": "ProductFamilyResponse"
},
"ProductInfoRequest": {
"type": "object",
"properties": {
"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
},
"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",
"description": "The UUIDs of the programs which will be associated to the account product at the time of issuance",
"allowEmptyValue": false,
"items": {
"type": "string"
}
}
},
"title": "ProductInfoRequest"
},
"ProductMappingRequest": {
"type": "object",
"properties": {
"accountProductInfoRequest": {
"$ref": "#/definitions/ProductInfoRequest"
},
"paymentProductInfoRequest": {
"type": "array",
"items": {
"$ref": "#/definitions/ProductInfoRequest"
}
}
},
"title": "ProductMappingRequest"
},
"ProductResponse": {
"type": "object",
"title": "ProductResponse"
},
"Program": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"auraAccountGroupID": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"createdAt": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"productFamilyID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"updatedAt": {
"type": "integer",
"format": "int64"
}
},
"title": "Program"
},
"PublicPaymentRequestWrapper": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"dueBy": {
"type": "integer",
"format": "int64"
},
"paymentRequestID": {
"type": "string"
},
"requestFrom": {
"type": "string"
},
"requestTo": {
"type": "string"
},
"towards": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Money"
}
}
},
"title": "PublicPaymentRequestWrapper"
},
"Receipt": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"credits": {
"type": "array",
"items": {
"$ref": "#/definitions/Posting"
}
},
"debits": {
"type": "array",
"items": {
"$ref": "#/definitions/Posting"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"payeeInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"payerInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"payloadVersion": {
"$ref": "#/definitions/Optional«int»"
},
"paymentFrom": {
"type": "string"
},
"paymentID": {
"type": "string"
},
"paymentRequestID": {
"type": "string"
},
"paymentTo": {
"type": "string"
},
"receiptID": {
"type": "integer",
"format": "int64"
},
"receiptType": {
"type": "string",
"enum": [
"AUTHORIZATION",
"PAYMENT",
"REVERSAL"
]
},
"reversedReceiptID": {
"type": "integer",
"format": "int64"
},
"signatoryJID": {
"$ref": "#/definitions/JID"
},
"signature": {
"type": "string"
},
"signed": {
"type": "boolean"
},
"time": {
"type": "integer",
"format": "int64"
},
"towards": {
"type": "string"
},
"transactionCode": {
"type": "string"
},
"transactionHash": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"$ref": "#/definitions/Money"
},
"zetaSignature": {
"$ref": "#/definitions/ZetaSignature"
}
},
"title": "Receipt"
},
"ReplacePolicyRequestPayload": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"effectiveFrom": {
"type": "integer",
"format": "int64"
},
"expiresAt": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"ifi": {
"type": "integer",
"format": "int64"
},
"policyAggregateRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
},
"policyBalanceRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyBalanceRule"
}
},
"policyTxnRules": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnRule"
}
},
"policyViolationAction": {
"type": "string",
"enum": [
"DECLINE_AND_NOTIFY",
"DECLINE",
"NOTIFY"
]
},
"txnConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnConstraint"
}
}
},
"title": "ReplacePolicyRequestPayload"
},
"ReplacePolicyResponsePayload": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"policyVersionID": {
"type": "integer",
"format": "int64"
}
},
"title": "ReplacePolicyResponsePayload"
},
"ReplaceTransactionPolicyRequestPayload": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"balanceLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyBalanceRule"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"policyViolationAction": {
"type": "string",
"enum": [
"DECLINE_AND_NOTIFY",
"DECLINE",
"NOTIFY"
]
},
"txnConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnConstraint"
}
},
"txnLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnRule"
}
},
"validFrom": {
"type": "integer",
"format": "int64"
},
"validUntil": {
"type": "integer",
"format": "int64"
},
"velocityLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
},
"volumeLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
}
},
"title": "ReplaceTransactionPolicyRequestPayload"
},
"Resource": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"authProfileId": {
"type": "string"
},
"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"
},
"requestId": {
"type": "string"
},
"resourceProduct": {
"$ref": "#/definitions/ResourceProduct"
},
"resourceProductId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"targetURI": {
"type": "string"
},
"uri": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"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"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "ResourceProduct"
},
"ResponseEntity": {
"type": "object",
"properties": {
"body": {
"type": "object"
},
"statusCode": {
"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"
]
},
"statusCodeValue": {
"type": "integer",
"format": "int32"
}
},
"title": "ResponseEntity"
},
"ReversalRequest": {
"type": "object",
"required": [
"amount",
"currency",
"remarks",
"requestID",
"transferCode"
],
"properties": {
"amount": {
"type": "integer",
"example": 1,
"description": "Amount that needs to be reversed.",
"allowEmptyValue": false
},
"currency": {
"type": "string",
"example": "INR",
"description": "Currency for which reversal is required.",
"allowEmptyValue": false
},
"doPartialReversal": {
"type": "boolean",
"example": true,
"description": "Pass value as `true` for partial reversal of transaction else pass `false`.",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"remarks": {
"type": "string",
"example": "Reversal of vbo1",
"description": "Remark of the reversal.",
"allowEmptyValue": false
},
"requestID": {
"type": "string",
"example": "93480e72-b883-46fa-8f3f-abe326ab9df7",
"description": "Request ID for A2A Reversal.",
"allowEmptyValue": false
},
"transferCode": {
"type": "string",
"example": "ATLAS_P2M_AUTH-REVERSAL",
"description": "Denotes reversal transfer code.",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "ReversalRequest"
},
"SensitiveCardView": {
"type": "object",
"properties": {
"algo": {
"type": "string",
"enum": [
"ECDH"
]
},
"value": {
"$ref": "#/definitions/ECDHEncryptedCardPayload"
}
},
"title": "SensitiveCardView"
},
"SignatureAlgorithm": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
},
"title": "SignatureAlgorithm"
},
"SigningAuthority": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "Victor@victor.com",
"description": "Email ID of the signing authority",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "Victor",
"description": "Name of the signing authority",
"allowEmptyValue": false
},
"phoneNumber": {
"type": "string",
"example": "+919876543210",
"description": "Phone number of the signing authority",
"allowEmptyValue": false
}
},
"title": "SigningAuthority"
},
"StatusReason": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"LOST_OR_STOLEN",
"DAMAGED",
"HOTLISTED",
"OTHER"
]
},
"description": {
"type": "string"
}
},
"title": "StatusReason"
},
"SupportTxn": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"txn": {
"$ref": "#/definitions/JsonElement"
},
"type": {
"type": "string"
}
},
"title": "SupportTxn"
},
"TachyonAccountHolderResponse": {
"type": "object",
"properties": {
"accountHolderProviderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"dob": {
"type": "string",
"format": "date"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"gender": {
"type": "string"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"kycstatus": {
"$ref": "#/definitions/KYCStatus"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mobileNumber": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"profilePicURL": {
"type": "string"
},
"requestID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "TachyonAccountHolderResponse"
},
"TachyonAccountResponse": {
"type": "object",
"properties": {
"accountHolder": {
"description": "account owner information",
"allowEmptyValue": false,
"$ref": "#/definitions/AccountHolder"
},
"accountHolderID": {
"type": "string",
"example": "0bb234-89c2-4397-b413-3553",
"description": "Account owners id",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"example": "17-03-2019 22:18:59",
"description": "Creation time",
"allowEmptyValue": false
},
"getAccountBalanceResponse": {
"description": "account balance information",
"allowEmptyValue": false,
"$ref": "#/definitions/GetAccountBalanceResponse"
},
"id": {
"type": "string",
"example": "8cb48e48-89c2-4397-b413-46949ef6e357",
"description": "Account id",
"allowEmptyValue": false
},
"ifiID": {
"type": "integer",
"format": "int64",
"example": 12345,
"description": "IFI id",
"allowEmptyValue": false
},
"name": {
"type": "string",
"example": "Fampay wallet bundle001",
"description": "name",
"allowEmptyValue": false
},
"product": {
"description": "product information",
"allowEmptyValue": false,
"$ref": "#/definitions/Product"
},
"productFamily": {
"description": "product family information",
"allowEmptyValue": false,
"$ref": "#/definitions/ProductFamily"
},
"productFamilyName": {
"type": "string",
"example": "GPR",
"description": "product family name",
"allowEmptyValue": false
},
"productID": {
"type": "integer",
"format": "int64",
"example": 5238809619860239000,
"description": "Product UUID",
"allowEmptyValue": false
},
"productName": {
"type": "string",
"example": "GPR_SELF_KYC",
"description": "product name",
"allowEmptyValue": false
},
"programIDs": {
"type": "array",
"description": "List of program ids",
"allowEmptyValue": false,
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"example": "ENABLED",
"description": "status",
"allowEmptyValue": false
},
"updatedAt": {
"type": "string",
"format": "date-time",
"example": "17-03-2019 22:18:59",
"description": "updated time",
"allowEmptyValue": false
}
},
"title": "TachyonAccountResponse"
},
"Tag": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"title": "Tag"
},
"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"
},
"TransactionCategoryStructure": {
"type": "object",
"properties": {
"attrKey": {
"type": "string"
},
"attrVal": {
"type": "string"
},
"txnCategoryComparator": {
"type": "string",
"enum": [
"EQUALS",
"CONTAINS"
]
}
},
"title": "TransactionCategoryStructure"
},
"TransactionPolicyResponse": {
"type": "object",
"properties": {
"attributes": {
"type": "object"
},
"balanceLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyBalanceRule"
}
},
"code": {
"type": "string"
},
"createdAt": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string"
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"policyViolationAction": {
"type": "string",
"enum": [
"DECLINE_AND_NOTIFY",
"DECLINE",
"NOTIFY"
]
},
"status": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"txnConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnConstraint"
}
},
"txnLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyTxnRule"
}
},
"updatedAt": {
"type": "integer",
"format": "int64"
},
"validFrom": {
"type": "integer",
"format": "int64"
},
"validUntil": {
"type": "integer",
"format": "int64"
},
"velocityLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
},
"volumeLimits": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyAggregateRule"
}
}
},
"title": "TransactionPolicyResponse"
},
"TransactionPolicyStandardResponse": {
"type": "object",
"title": "TransactionPolicyStandardResponse"
},
"TransferRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"INR",
"USD",
"EUR",
"IDR",
"VND"
]
},
"amount": {
"type": "integer",
"format": "int64"
},
"transferCode": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"creditAccountID": {
"type": "string"
},
"transferTime": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
}
},
"title": "TransferRequest"
},
"TransferRequestV1": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"requestID": {
"type": "string"
},
"amount": {
"$ref": "#/definitions/Money"
},
"transferCode": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"creditAccountID": {
"type": "string"
},
"transferTime": {
"type": "integer",
"format": "int64"
},
"remarks": {
"type": "string"
}
},
"title": "TransferRequestV1"
},
"TransferResponse": {
"type": "object",
"properties": {
"isRetriableFailure": {
"type": "string"
},
"message": {
"type": "string"
},
"requestID": {
"type": "string"
},
"status": {
"type": "string"
},
"transferID": {
"type": "string"
}
},
"title": "TransferResponse"
},
"TxnCategory": {
"type": "object",
"properties": {
"attrs": {
"type": "array",
"items": {
"$ref": "#/definitions/TxnCategoryAttrs"
}
},
"code": {
"type": "string"
},
"desc": {
"type": "string"
},
"ifi": {
"type": "integer",
"format": "int64"
}
},
"title": "TxnCategory"
},
"TxnCategoryAttrs": {
"type": "object",
"properties": {
"attrKey": {
"type": "string"
},
"attrVal": {
"type": "string"
},
"code": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"txnCategoryComparator": {
"type": "string",
"enum": [
"EQUALS",
"CONTAINS"
]
}
},
"title": "TxnCategoryAttrs"
},
"UpdateAccountHolderApplicationRequest": {
"type": "object",
"properties": {
"applicationID": {
"type": "string"
},
"dob": {
"type": "string",
"format": "date"
},
"firstName": {
"type": "string"
},
"gender": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"salutation": {
"type": "string"
}
},
"title": "UpdateAccountHolderApplicationRequest"
},
"UpdateAccountHolderApplicationStandardRequest": {
"type": "object",
"properties": {
"applicationID": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"salutation": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"profilePicURL": {
"type": "string"
},
"dob": {
"type": "string"
},
"gender": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
}
},
"title": "UpdateAccountHolderApplicationStandardRequest"
},
"UpdateAccountHolderRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"dob": {
"type": "string",
"format": "date",
"description": "Date of Birth of account holder",
"allowEmptyValue": false
},
"firstName": {
"type": "string",
"description": "First Name of account holder",
"allowEmptyValue": false
},
"gender": {
"type": "string",
"description": "Gender of account holder",
"allowEmptyValue": false
},
"kycstatus": {
"$ref": "#/definitions/KYCStatus"
},
"lastName": {
"type": "string",
"description": "Last Name of account holder",
"allowEmptyValue": false
},
"middleName": {
"type": "string",
"description": "Middle Name of account holder",
"allowEmptyValue": false
},
"mothersMaidenName": {
"type": "string",
"description": "Mothers Maiden Name of account holder",
"allowEmptyValue": false
},
"pops": {
"type": "array",
"description": "List of POPs",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/POP"
}
},
"profilePicURL": {
"type": "string",
"description": "Profile Pic URL of account holder",
"allowEmptyValue": false
},
"salutation": {
"type": "string",
"description": "Salutation",
"allowEmptyValue": false
},
"status": {
"type": "string",
"description": "Account holder Status",
"allowEmptyValue": false
},
"type": {
"type": "string",
"description": "Account holder Type",
"allowEmptyValue": false,
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"KYCStatus": {
"$ref": "#/definitions/KYCStatus"
}
},
"title": "UpdateAccountHolderRequest"
},
"UpdateAccountHolderResponse": {
"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"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"kycstatus": {
"$ref": "#/definitions/KYCStatus"
},
"lastName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"mothersMaidenName": {
"type": "string"
},
"pops": {
"type": "array",
"items": {
"$ref": "#/definitions/POP"
}
},
"profilePicURL": {
"type": "string"
},
"requestID": {
"type": "string"
},
"salutation": {
"type": "string"
},
"status": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"vectors": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountHolderVector"
}
}
},
"title": "UpdateAccountHolderResponse"
},
"UpdateAccountStatusRequest": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the account to be changed",
"allowEmptyValue": false
}
},
"title": "UpdateAccountStatusRequest"
},
"UpdateAccountStatusResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string"
}
},
"title": "UpdateAccountStatusResponse"
},
"UpdateBeneficiaryAccountFusionRequest": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"status": {
"type": "string"
},
"isVerified": {
"type": "boolean"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "UpdateBeneficiaryAccountFusionRequest"
},
"UpdateBeneficiaryAccountRequest": {
"type": "object",
"properties": {
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"beneficiaryID": {
"type": "string"
},
"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"
},
"verified": {
"type": "boolean"
}
},
"title": "UpdateBeneficiaryAccountRequest"
},
"UpdateBeneficiaryRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"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"
},
"salutation": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
}
},
"title": "UpdateBeneficiaryRequest"
},
"UpdateBundleRequest": {
"type": "object",
"properties": {
"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
},
"picURL": {
"type": "string",
"description": "The URL to get the bundle's display pic",
"allowEmptyValue": false
}
},
"title": "UpdateBundleRequest"
},
"UpdateCorporateBeneficiaryAccountRequest": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"default": {
"type": "boolean"
},
"isVerified": {
"type": "boolean"
},
"nickname": {
"type": "string",
"example": true,
"description": "Nickname of the Beneficiary Account",
"allowEmptyValue": false
},
"status": {
"type": "string",
"example": "ENABLED",
"description": "Status of the Beneficiary Account",
"allowEmptyValue": false
},
"type": {
"type": "string",
"description": "Type of beneficiary ie NEFT or IMPS or ZETA",
"allowEmptyValue": false
},
"verified": {
"type": "boolean"
},
"accountInfo": {
"$ref": "#/definitions/BeneficiaryAccountInfo"
},
"isDefault": {
"type": "boolean"
}
},
"title": "UpdateCorporateBeneficiaryAccountRequest"
},
"UpdateCorporateBeneficiaryRequest": {
"type": "object",
"properties": {
"customFields": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"dob": {
"type": "string",
"format": "date",
"example": "01/01/1990",
"description": "Date of Birth of the account holder being created",
"allowEmptyValue": false
},
"firstName": {
"type": "string",
"example": "Chandler",
"description": "First name of the beneficiary being created",
"allowEmptyValue": false
},
"gender": {
"type": "string",
"example": "Male",
"description": "Gender of the beneficiary being created",
"allowEmptyValue": false
},
"lastName": {
"type": "string",
"example": "Bing",
"description": "Last name of the beneficiary being created",
"allowEmptyValue": false
},
"middleName": {
"type": "string",
"example": "Muriel",
"description": "Middle name of the beneficiary being created",
"allowEmptyValue": false
},
"profilePicURL": {
"type": "string",
"example": "http://abc.com",
"description": "Profile pic URL of the beneficiary being created",
"allowEmptyValue": false
},
"relationship": {
"type": "string",
"example": "Brother",
"description": "Relation of the beneficiary being created with the individual",
"allowEmptyValue": false
},
"salutation": {
"type": "string",
"example": "Mr",
"description": "Salutation of the beneficiary being created",
"allowEmptyValue": false
},
"type": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
}
},
"title": "UpdateCorporateBeneficiaryRequest"
},
"UpdateFusionConfigRequest": {
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "Description of the key",
"description": "The type for the key-value config",
"allowEmptyValue": false
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"key": {
"type": "string",
"example": 123123,
"description": "The key of the key-value pair",
"allowEmptyValue": false
},
"type": {
"type": "string",
"example": "SANDBOX_VBO_MAPPING",
"description": "The type for the key-value config",
"allowEmptyValue": false
},
"value": {
"type": "string",
"example": "test",
"description": "The value of the key-value pair",
"allowEmptyValue": false
}
},
"title": "UpdateFusionConfigRequest"
},
"UpdateKYCStatusResponse": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"expiryTime": {
"type": "string",
"format": "date-time"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"kycStatus": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"standardExpiryTime": {
"type": "string"
},
"standardUpdateTime": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
},
"title": "UpdateKYCStatusResponse"
},
"UpdateKycStatusRequest": {
"type": "object",
"properties": {
"accountHolderID": {
"type": "string",
"description": "Account Holder ID",
"allowEmptyValue": false
},
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"expiryTime": {
"type": "string",
"format": "date-time",
"description": "Kyc Expiry time",
"allowEmptyValue": false
},
"kycStatus": {
"type": "string",
"description": "Kyc Status to be updated",
"allowEmptyValue": false
},
"kycStatusPostExpiry": {
"type": "string",
"description": "Kyc status post expiry of kyc",
"allowEmptyValue": false
}
},
"title": "UpdateKycStatusRequest"
},
"UpdateKycStatusStandardRequest": {
"type": "object",
"properties": {
"kycStatus": {
"type": "string"
},
"expiryTime": {
"type": "string"
},
"kycStatusPostExpiry": {
"type": "string"
},
"kycAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"authType": {
"type": "string"
},
"authData": {
"$ref": "#/definitions/JsonObject"
}
},
"title": "UpdateKycStatusStandardRequest"
},
"UpdatePOPRequest": {
"type": "object",
"properties": {
"address": {
"description": "Address Details",
"allowEmptyValue": false,
"$ref": "#/definitions/Address"
},
"attributes": {
"type": "object",
"description": "Any additional information which you would like to provide",
"allowEmptyValue": false,
"additionalProperties": {
"type": "string"
}
},
"contactList": {
"type": "array",
"description": "List of contacts",
"allowEmptyValue": false,
"items": {
"$ref": "#/definitions/Contact"
}
},
"label": {
"type": "string",
"description": "Label",
"allowEmptyValue": false
}
},
"title": "UpdatePOPRequest"
},
"UpdatePOPResponse": {
"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"
},
"id": {
"type": "string"
},
"ifiID": {
"type": "integer",
"format": "int64"
},
"label": {
"type": "string"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
}
},
"title": "UpdatePOPResponse"
},
"UpdatePolicyStateRequestPayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"policyId": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
}
},
"title": "UpdatePolicyStateRequestPayload"
},
"UpdateProductForAllAccountsRequest": {
"type": "object",
"properties": {
"accountHolderType": {
"type": "string",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"object": {
"type": "string"
},
"subject": {
"type": "string"
},
"accountHolderID": {
"type": "string"
}
},
"title": "UpdateProductForAllAccountsRequest"
},
"UpdateTransactionPolicyStateRequestPayload": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ifiId": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"transactionPolicyID": {
"type": "string"
}
},
"title": "UpdateTransactionPolicyStateRequestPayload"
},
"Vector": {
"type": "object",
"properties": {
"aetherID": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"$ref": "#/definitions/Timestamp"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"type": {
"type": "string"
},
"updatedAt": {
"$ref": "#/definitions/Timestamp"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"title": "Vector"
},
"VectorRequest": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"value": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"isVerified": {
"type": "boolean"
}
},
"title": "VectorRequest"
},
"View": {
"type": "object",
"properties": {
"contentType": {
"type": "string"
}
},
"title": "View"
},
"ZetaSignature": {
"type": "object",
"properties": {
"algoID": {
"type": "integer",
"format": "int32"
},
"publicKeyID": {
"type": "string"
},
"signature": {
"type": "string",
"format": "byte"
},
"signatureAlgorithm": {
"$ref": "#/definitions/SignatureAlgorithm"
}
},
"title": "ZetaSignature"
},
"Unauthorized": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"example": "Unauthorized"
}
}
},
"NotFound": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "NOT_FOUND"
},
"message": {
"type": "string",
"example": "Not found"
}
}
},
"ApiV1IfiTransfersRequest": {
"title": "TransfersRequest",
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"amount": {
"$ref": "#/definitions/Amount"
},
"transferCode": {
"type": "string"
},
"debitAccountID": {
"type": "string"
},
"creditAccountID": {
"type": "string"
},
"transferTime": {
"description": "<epoch timestamp in millis>, // for offline transfers; optional for now",
"type": "number",
"format": "double"
},
"remarks": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"Amount": {
"title": "Amount",
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int64"
},
"currency": {
"type": "string"
}
}
},
"ApiV1IfiTransfersResponse": {
"title": "TransfersResponse",
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"transferID": {
"type": "string"
},
"status": {
"$ref": "#/definitions/Status"
}
}
},
"Status": {
"title": "Status",
"example": "SUCCESS",
"type": "string",
"enum": [
"SUCCESS"
]
},
"ApiV1IfiTransfers500Error": {
"title": "Transfers500Error",
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"transferID": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"$ref": "#/definitions/Status1"
},
"isRetriableFailure": {
"type": "boolean"
}
}
},
"Status1": {
"title": "Status1",
"example": "FAILED",
"type": "string",
"enum": [
"FAILED"
]
},
"ApiV1IfiTransfersResponse1": {
"title": "TransfersResponse",
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"transferID": {
"type": "string"
},
"amount": {
"$ref": "#/definitions/Amount"
},
"transferCode": {
"type": "string"
},
"sourceAccountID": {
"type": "string"
},
"destinationAccountID": {
"type": "string"
},
"status": {
"type": "string"
},
"statusUpdatedAt": {
"type": "number",
"format": "double"
},
"transferTime": {
"description": "<epoch>, // for offline transfers; optional for now",
"type": "number",
"format": "double"
},
"remarks": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"ApiV1IfiTransfersReversalRequest": {
"title": "TransfersReversalRequest",
"type": "object",
"properties": {
"requestID": {
"type": "string"
},
"remarks": {
"type": "string"
},
"reversalTime": {
"type": "number",
"format": "double"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"ApiV1IfiTransfersReversalResponse": {
"title": "TransfersReversalResponse",
"type": "object",
"properties": {
"status": {
"$ref": "#/definitions/Status"
}
}
}
},
"components": {
"schemas": {
"updateFormFactorRequest":{
"title":"",
"type":"object",
"properties":{
"status":{
"type":"string",
"description":"status of the Form Factor",
"enum":["ACTIVE","INACTIVE","DELETED"]
},
"reason":{
"description":"Reason for changing the status of the Form Factor. Optional for `ACTIVE` and `INACTIVE`. Required for `DELETED`.",
"type":"object",
"properties":{
"code":{
"type":"string",
"description":"Code of the reason for changing the status of the Form Factor. Optional for `ACTIVE` and `INACTIVE`. Required for `DELETED`.",
"enum":["LOST_OR_STOLEN", "DAMAGED", "HOTLISTED", "OFAC_BLOCKED","OTHER"]
},
"description":{
"type":"string",
"description":"Human readable description of the reason for changing the status of the Form Factor. Length must be less than 200 characters. Optional for `ACTIVE` and `INACTIVE`. Required for `DELETED`."
}
}
}
}
},
"ListResourceRequest": {
"type": "object",
"properties": {
"formFactorProductID": {
"type": "string"
},
"resourceProductID": {
"type": "string"
},
"resourceTargetUri": {
"format": "uri",
"type": "string"
},
"formFactorTargetUri": {
"format": "uri",
"type": "string"
},
"formFactorProvider": {
"type": "string"
}
}
},
"ListFormFactorRequest": {
"type": "object",
"properties": {
"formFactorProductID": {
"type": "string"
},
"resourceProductID": {
"type": "string"
},
"targetUri": {
"$ref": "#/components/schemas/Target"
},
"formFactorProvider": {
"type": "string"
}
}
},
"ListFormFactorFromProviderRequest": {
"type": "object",
"properties": {
"crn": {
"type": "string"
},
"plasticCode": {
"type": "string"
},
"productCode": {
"type": "string"
},
"designID": {
"type": "string"
},
"skuID": {
"type": "string"
},
"productID": {
"type": "string"
},
"orderID": {
"type": "string"
},
"accountUri": {
"format": "uri",
"type": "string"
},
"accountHolderUri": {
"format": "uri",
"type": "string"
}
}
},
"MakeFormFactorProviderRequest": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CMS"
},
"description": {
"type": "string",
"example": "FormFactorProvider Description"
}
}
},
"FormFactorProvider": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CMS"
},
"description": {
"type": "string",
"example": "FormFactorProvider : Description"
}
}
},
"ListFormFactorProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormFactorProvider"
}
},
"Policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"IP001",
"IP002"
]
},
"paymentPolicies": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"PP001",
"PP002"
]
}
}
},
"MakeFormFactorProductRequest": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "FF001"
},
"name": {
"type": "string",
"example": "Card form factor"
},
"description": {
"type": "string",
"example": "Diwali celebration cards"
},
"type": {
"type": "string",
"example": "CARD"
},
"policies": {
"$ref": "#/components/schemas/Policies"
},
"provider": {
"type": "string",
"example": "CMS"
},
"skuID": {
"type": "string",
"example": "SKU123"
},
"attributes": {
"type": "object"
},
"issuanceStatus": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"example": "ACTIVE"
},
"paymentStatus": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"example": "INACTIVE"
}
}
},
"FetchFormFactorProduct": {
"type": "object",
"properties": {
"ifi": {
"type": "string",
"example": 140827
},
"id": {
"type": "string",
"example": "a1b2c3d4e5c6"
},
"code": {
"type": "string",
"example": "FF001"
},
"name": {
"type": "string",
"example": "Card form factor"
},
"description": {
"type": "string",
"example": "Diwali celebration cards"
},
"type": {
"type": "string",
"example": "CARD"
},
"policies": {
"$ref": "#/components/schemas/Policies"
},
"provider": {
"type": "string",
"example": "CMS"
},
"skuID": {
"type": "string",
"example": "SKU123"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"tag://vbo/0f01e45b-f2d3-4592-9b01-c259988b8582"
]
},
"attributes": {
"type": "object"
},
"issuanceStatus": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"example": "ACTIVE"
},
"paymentStatus": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"example": "INACTIVE"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"format": "date-time",
"type": "string"
},
"headers": {
"type": "object",
"properties": {
"tenantID": {
"type": "string",
"example": 140827
},
"object": {
"type": "string",
"example": "140827@tenant.zeta.in"
}
}
}
}
},
"ListFormFactorProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FetchFormFactorProduct"
}
},
"MakeResourceProductRequest": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "R001"
},
"name": {
"type": "string",
"example": "ResourceProduct001"
},
"description": {
"type": "string",
"example": "Resource Product Description"
},
"formFactorProducts": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"formFactor001",
"formFactor002"
]
},
"policies": {
"$ref": "#/components/schemas/Policies"
},
"attributes": {
"type": "object"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
}
}
},
"ListResourceProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceProduct"
}
},
"MakeChannelRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Channel001"
},
"type": {
"type": "string",
"example": "MASTERCARD"
},
"description": {
"type": "string",
"example": "MasterCard Channel"
},
"paymentCodes": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"MASTERCARD_POS",
"MASTERCARD_ECOM"
]
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
}
}
},
"Channel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "b1a2d3c4e5c6"
},
"name": {
"type": "string",
"example": "Channel001"
},
"type": {
"type": "string",
"example": "MasterCard"
},
"description": {
"type": "string",
"example": "MASTERCARD"
},
"paymentCodes": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"RUPAY_POS",
"RUPAY_ECOM"
]
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"format": "date-time",
"type": "string"
}
}
},
"ListChannels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Channel"
}
},
"MakePaymentProductRequest": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "PP001"
},
"name": {
"type": "string",
"example": "PaymentProduct001"
},
"description": {
"type": "string",
"example": "Payment Product description"
},
"channels": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Channel001",
"Channel002"
]
},
"resourceProduct": {
"type": "string",
"example": "ResourceProduct001"
},
"attributes": {
"type": "object"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
}
}
},
"PaymentProduct": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "a1d2g3j4k5p6"
},
"code": {
"type": "string",
"example": "PP001"
},
"name": {
"type": "string",
"example": "PaymentProduct001"
},
"description": {
"type": "string",
"example": "Payment Product description"
},
"channels": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Channel001",
"Channel002"
]
},
"resourceProduct": {
"type": "string",
"example": "ResourceProduct001"
},
"attributes": {
"type": "object"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"format": "date-time",
"type": "string"
}
}
},
"ListPaymentProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentProduct"
}
},
"MakeAndLinkResourceFormFactor": {
"type": "object",
"properties": {
"provisionFormFactorRequest": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/embossAndAssociateOrderRequest"
},
"account": {
"$ref": "#/components/schemas/account"
},
"accountHolder": {
"$ref": "#/components/schemas/accountHolder"
},
"view": {
"$ref": "#/components/schemas/cardView"
},
"cardStatus": {
"$ref": "#/components/schemas/cardStatus"
}
}
},
"policies": {
"$ref": "#/components/schemas/Policies"
},
"targetUri": {
"$ref": "#/components/schemas/Target"
}
}
},
"cardView": {
"description": "The view to be fetched",
"enum": [
"BASIC",
"EXPANDED",
"EXPANDED_SENSITIVE"
],
"type": "string"
},
"cardStatus": {
"enum": [
"ACTIVE",
"INACTIVE",
"DISABLED",
"BLOCKED",
"HOTLISTED"
],
"type": "string"
},
"account": {
"description": "Account Details",
"required": [
"id",
"target"
],
"type": "object",
"properties": {
"uri": {
"format": "uri",
"description": "Account identifier",
"type": "string",
"example": "account:123456"
},
"attributes": {
"description": "Additional account specific attributes",
"type": "object"
}
}
},
"accountHolder": {
"description": "Account Holder Details",
"required": [
"id"
],
"type": "object",
"properties": {
"uri": {
"format": "uri",
"description": "Account Holder identifier",
"type": "string",
"example": "accountholder:123"
},
"attributes": {
"type": "object"
},
"name": {
"type": "string"
}
}
},
"embossAndAssociateOrderRequest": {
"required": [
"quantitiy",
"orderID",
"cardSkuID"
],
"type": "object",
"properties": {
"orderID": {
"type": "string"
},
"cardSkuID": {
"type": "string"
},
"formFactorProductID": {
"type": "string"
},
"expiry": {
"$ref": "#/components/schemas/yearMonth"
},
"thirdLineEmbossing": {
"type": "string"
},
"fourthLineEmbossing": {
"type": "string"
},
"deliveryAddress": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"addressLine4": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"contactNumber": {
"type": "string"
}
}
},
"tenantAttrributes": {
"type": "object",
"properties": {
"corporateName": {
"type": "string"
},
"corporateID": {
"type": "string"
},
"templateID": {
"type": "string"
}
}
},
"vendorAttributes": {
"description": "Free flowing attributes for vendor",
"type": "object",
"properties": {
"consignmentID": {
"type": "string"
}
}
}
}
},
"yearMonth": {
"type": "object",
"properties": {
"month": {
"type": "number",
"example": 2
},
"year": {
"type": "number",
"example": 2020
}
}
},
"ResourceAndLinkedFormFactor": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/Resource"
},
"provisionFormFactorResponse": {
"type": "object",
"properties": {
"cardID": {
"description": "Card Identifier",
"type": "string"
},
"crn": {
"description": "Card Reference Number",
"type": "string"
},
"cardType": {
"enum": [
"PHYSICAL",
"VIRTUAL"
],
"type": "string"
},
"maskedPan": {
"type": "string"
},
"network": {
"type": "string"
},
"orderDetails": {
"type": "object",
"properties": {
"orderID": {
"type": "string"
},
"cardSkuID": {
"type": "string"
},
"recordID": {
"type": "number"
},
"thirdLineEmbossing": {
"type": "string"
},
"fourthLineEmbossing": {
"type": "string"
},
"expiry": {
"$ref": "#/components/schemas/yearMonth"
},
"deliveryAddress": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"addressLine4": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"contactNumber": {
"type": "string"
}
}
},
"tenantAttrributes": {
"type": "object",
"properties": {
"corporateName": {
"type": "string"
},
"corporateID": {
"type": "string"
},
"templateID": {
"type": "string"
}
}
},
"vendorAttributes": {
"type": "object",
"properties": {
"consignmentID": {
"type": "string"
}
}
},
"orderStatus": {
"$ref": "#/components/schemas/orderStatus"
},
"embossedAt": {
"format": "date-time",
"description": "date in UTC when card was Created/Embossed.",
"type": "string"
},
"orderedAt": {
"format": "date-time",
"description": "date in UTC when card was requested/Order placed.",
"type": "string"
}
}
},
"account": {
"$ref": "#/components/schemas/account"
},
"accountHolder": {
"$ref": "#/components/schemas/accountHolder"
},
"resource": {
"type": "object",
"properties": {
"uri": {
"format": "uri",
"type": "string",
"example": "resource:111"
},
"attributes": {
"type": "object"
}
}
}
}
}
}
},
"orderStatus": {
"enum": [
"ORDER_PLACED",
"ORDER_FAILED",
"ORDER_CANCELLED",
"CARD_REQUEST_GENERATED",
"EMBOSSING_FILE_GENERATED",
"ORDER_COMPLETED"
],
"type": "string"
},
"Target": {
"format": "uri",
"type": "string",
"example": "wallet://123"
},
"MakeResourceRequest": {
"type": "object",
"properties": {
"targetUri": {
"$ref": "#/components/schemas/Target"
},
"formFactors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"formFactorProductID": {
"type": "string",
"example": "a1b2c3d4e5c6"
},
"formFactorID": {
"type": "string",
"example": "CRN12345"
},
"policies": {
"$ref": "#/components/schemas/Policies"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
},
"attributes": {
"type": "object"
}
}
}
},
"policies": {
"$ref": "#/components/schemas/Policies"
},
"attributes": {
"type": "object"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
}
}
},
"ListResources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
}
},
"MakeFormFactorRequest": {
"type": "object",
"properties": {
"formFactorProductID": {
"type": "string",
"example": "a1b2c3d4e5c5"
},
"formFactorID": {
"type": "string",
"example": "CRN12346"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"type": "string",
"example": "ACTIVE"
},
"targetUri": {
"format": "uri",
"type": "string"
},
"attributes": {
"type": "object"
}
}
},
"LinkTargetRequest": {
"type": "object",
"properties": {
"targetUri": {
"$ref": "#/components/schemas/Target"
}
}
},
"LinkFormFactorToResourceProduct": {
"type": "object",
"properties": {
"formFactorID": {
"type": "string",
"example": "q1w2e3r4t5"
}
}
},
"LinkChannelToPaymentProduct": {
"type": "object",
"properties": {
"channelID": {
"type": "string",
"example": "w1q2e3r4t5"
}
}
},
"LinkResourceProductToPaymentProduct": {
"type": "object",
"properties": {
"resourceProductID": {
"type": "string",
"example": "a1s2d3f4g5"
}
}
},
"BadRequest": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Bad Request"
},
"code": {
"type": "string",
"example": "BAD_REQUEST"
}
}
},
"Unauthorized": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"example": "Unauthorized"
}
}
},
"AlreadyExists": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "ALREADY_EXISTS"
},
"message": {
"type": "string",
"example": "Already exists"
}
}
},
"NotFound": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "NOT_FOUND"
},
"message": {
"type": "string",
"example": "Not found"
}
}
},
"ResourceProduct": {
"title": "ResourceProduct",
"description": "",
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object"
},
"issuanceStatus": {
"type": "string"
},
"paymentStatus": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object",
"properties": {
"tenantID": {
"type": "string"
},
"object": {
"type": "string"
}
}
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
},
"example": {
"ifi": 140827,
"id": "7f2fbeb5-04f9-4b23-9565-46434c7a3969",
"code": "RPFAMFARTESTsbfmt",
"name": "FAMPAY RESOURCE PRODUCT TEST sbfmt",
"description": "Resource Product for Fampay test1",
"formFactorProducts": [
{
"ifi": 140827,
"id": "0397e382-c9a7-4738-b366-ea5b4d635dc4",
"code": "CMSFFFARTESTsbfmt",
"name": "ABC Form Factor Test sbfmt",
"description": "Form Factor Test for ABC",
"type": "card",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "CMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/0f01e45b-f2d3-4592-9b01-c259988b8582"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 19, 2020 4:14:53 PM",
"modifiedAt": "Mar 19, 2020 4:14:53 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
},
{
"ifi": 140827,
"id": "f02c44ed-6868-49a9-b592-92162ce2b225",
"code": "CMSFFFARTESTsbfmt1",
"name": "ABC Form Factor Test sbfmt1",
"description": "Form Factor Test for ABC",
"type": "phoneNumber",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "PMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/fam001"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 19, 2020 4:14:57 PM",
"modifiedAt": "Mar 19, 2020 4:14:57 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
}
],
"tags": [
"tag://vbo/fam001"
],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 4:14:59 PM",
"modifiedAt": "Mar 19, 2020 4:14:59 PM",
"headers": {}
}
},
"PaymentProductDe": {
"title": "PaymentProductDe",
"description": "",
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"channels": {
"type": "array",
"items": {}
},
"resourceProduct": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
},
"example": {
"ifi": 140827,
"id": "5291112c-4b42-4e92-a7db-c3fcf0f96b89",
"code": "PPFAMFARTEST_sbfmt",
"name": "PAY PAYMENT PRODUCT test",
"description": "Payment Product for Fampay Test",
"channels": [],
"resourceProduct": "7f2fbeb5-04f9-4b23-9565-46434c7a3969",
"tags": [
"tag://vbo/fam001"
],
"attributes": {},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 4:15:01 PM",
"modifiedAt": "Mar 19, 2020 4:15:01 PM",
"headers": {}
}
},
"Resource": {
"title": "Resource",
"description": "",
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"resourceProductId": {
"type": "string"
},
"resourceProduct": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object"
},
"issuanceStatus": {
"type": "string"
},
"paymentStatus": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object",
"properties": {
"tenantID": {
"type": "string"
},
"object": {
"type": "string"
}
}
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
},
"targetURI": {
"type": "string"
},
"formFactors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifi": {
"format": "int32",
"type": "integer"
},
"formFactorProductID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"targetURI": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"attributes": {
"type": "object"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"vectors": {
"type": "array",
"items": {}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"attributes": {
"type": "object"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
},
"example": {
"ifi": 140827,
"id": "5ae9fa20-a784-4fb6-81c1-bb1625f0559a",
"resourceProductId": "5ab55925-2a51-4c8b-b30c-86b0d6888551",
"resourceProduct": {
"ifi": 140827,
"id": "5ab55925-2a51-4c8b-b30c-86b0d6888551",
"code": "RPFAMFARTESTxdvvqg",
"name": "FAMPAY RESOURCE PRODUCT TEST xdvvqg",
"description": "Resource Product for Fampay test1",
"formFactorProducts": [
{
"ifi": 140827,
"id": "7c584394-cd09-40d2-860d-7cc6b1f39782",
"code": "CMSFFFARTESTxdvvqg",
"name": "ABC Form Factor Test xdvvqg",
"description": "Form Factor Test for ABC",
"type": "card",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "CMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/0f01e45b-f2d3-4592-9b01-c259988b8582"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 19, 2020 7:25:15 PM",
"modifiedAt": "Mar 19, 2020 7:25:15 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
},
{
"ifi": 140827,
"id": "3e944456-a7f6-49c0-8f12-b9a8d61934ea",
"code": "CMSFFFARTESTxdvvqg1",
"name": "ABC Form Factor Test xdvvqg1",
"description": "Form Factor Test for ABC",
"type": "phoneNumber",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "PMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/fam001"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 19, 2020 7:25:17 PM",
"modifiedAt": "Mar 19, 2020 7:25:17 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
}
],
"tags": [
"tag://vbo/fam001"
],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 7:25:21 PM",
"modifiedAt": "Mar 19, 2020 7:25:21 PM",
"headers": {}
},
"targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1",
"formFactors": [
{
"id": "3a53c5ad-2468-460f-a2b6-34286d9e0612",
"ifi": 140827,
"formFactorProductID": "3e944456-a7f6-49c0-8f12-b9a8d61934ea",
"formFactorID": 919520128865,
"targetURI": "account://71227305-whatMobile2",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 7:25:26 PM",
"modifiedAt": "Mar 19, 2020 7:25:26 PM",
"headers": {}
},
{
"id": "98a4f301-c31b-4efc-8146-88ba733dedaf",
"ifi": 140827,
"formFactorProductID": "7c584394-cd09-40d2-860d-7cc6b1f39782",
"formFactorID": "a9047464-4420-4406-87cb-705a3dc033d2",
"targetURI": "account://123Provision1",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 7:25:26 PM",
"modifiedAt": "Mar 19, 2020 7:25:26 PM",
"headers": {}
}
],
"tags": [
"tag://vbo/fam001"
],
"vectors": [],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"attributes": {},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 7:25:26 PM",
"modifiedAt": "Mar 19, 2020 7:25:26 PM",
"headers": {}
}
},
"ResourceProductList": {
"title": "ResourceProductList",
"description": "",
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"resourceProductId": {
"type": "string"
},
"resourceProduct": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object"
},
"issuanceStatus": {
"type": "string"
},
"paymentStatus": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object",
"properties": {
"tenantID": {
"type": "string"
},
"object": {
"type": "string"
}
}
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
},
"targetURI": {
"type": "string"
},
"formFactors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifi": {
"format": "int32",
"type": "integer"
},
"formFactorProductID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"targetURI": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"attributes": {
"type": "object"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"vectors": {
"type": "array",
"items": {}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"attributes": {
"type": "object"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
}
},
"headers": {
"type": "object"
}
},
"example": {
"resources": [
{
"ifi": 140827,
"id": "a8e27abb-3490-4b4b-9a5f-82de543f8b96",
"resourceProductId": "7f2fbeb5-04f9-4b23-9565-46434c7a3969",
"resourceProduct": {
"ifi": 140827,
"id": "7f2fbeb5-04f9-4b23-9565-46434c7a3969",
"code": "RPFAMFARTESTsbfmt",
"name": "FAMPAY RESOURCE PRODUCT TEST sbfmt",
"description": "Resource Product for Fampay test1",
"formFactorProducts": [
{
"ifi": 140827,
"id": "0397e382-c9a7-4738-b366-ea5b4d635dc4",
"code": "CMSFFFARTESTsbfmt",
"name": "ABC Form Factor Test sbfmt",
"description": "Form Factor Test for ABC",
"type": "card",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "CMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/0f01e45b-f2d3-4592-9b01-c259988b8582"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 19, 2020 4:14:53 PM",
"modifiedAt": "Mar 19, 2020 4:14:53 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
},
{
"ifi": 140827,
"id": "f02c44ed-6868-49a9-b592-92162ce2b225",
"code": "CMSFFFARTESTsbfmt1",
"name": "ABC Form Factor Test sbfmt1",
"description": "Form Factor Test for ABC",
"type": "phoneNumber",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "PMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/fam001"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 19, 2020 4:14:57 PM",
"modifiedAt": "Mar 19, 2020 4:14:57 PM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
}
],
"tags": [
"tag://vbo/fam001"
],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 4:14:59 PM",
"modifiedAt": "Mar 19, 2020 4:14:59 PM",
"headers": {}
},
"targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1",
"formFactors": [
{
"id": "d867f147-9f7a-412e-aebe-c31d028111eb",
"ifi": 140827,
"formFactorProductID": "0397e382-c9a7-4738-b366-ea5b4d635dc4",
"formFactorID": "f0c1bb24-d800-4024-bd34-67a61aaab588",
"targetURI": "account://123Provision1",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 4:15:04 PM",
"modifiedAt": "Mar 19, 2020 4:15:04 PM",
"headers": {}
}
],
"tags": [
"tag://vbo/fam001"
],
"vectors": [],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"attributes": {},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 4:15:03 PM",
"modifiedAt": "Mar 20, 2020 5:35:12 AM",
"headers": {}
}
],
"headers": {}
}
},
"VectorResource": {
"title": "VectorResource",
"description": "",
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"resourceProductId": {
"type": "string"
},
"resourceProduct": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object"
},
"issuanceStatus": {
"type": "string"
},
"paymentStatus": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object",
"properties": {
"tenantID": {
"type": "string"
},
"object": {
"type": "string"
}
}
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
},
"targetURI": {
"type": "string"
},
"formFactors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifi": {
"format": "int32",
"type": "integer"
},
"formFactorProductID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"targetURI": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"attributes": {
"type": "object"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"vectors": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"attributes": {
"type": "object"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
},
"example": {
"ifi": 140827,
"id": "178c7412-2143-49bc-b4ab-b9b34f4cee6e",
"resourceProductId": "18745857-10d0-4d72-8666-a51f3b8bc550",
"resourceProduct": {
"ifi": 140827,
"id": "18745857-10d0-4d72-8666-a51f3b8bc550",
"code": "RPFAMFARTESTdvjre4",
"name": "FAMPAY RESOURCE PRODUCT FARZAN TEST dvjre4",
"description": "Resource Product for Fampay Farzan test1",
"formFactorProducts": [
{
"ifi": 140827,
"id": "28ac4349-e2d0-49cf-ae35-44daf7a5e8be",
"code": "CMSFFFARTESTdvjre4",
"name": "ABC Form Factor Farzan Test dvjre4",
"description": "Form Factor Farzan Test for ABC",
"type": "card",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "CMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://VBO/FAM001"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 2, 2020 11:18:34 AM",
"modifiedAt": "Mar 2, 2020 11:18:34 AM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
},
{
"ifi": 140827,
"id": "12cc539c-ef94-4a24-9324-147523a6c00f",
"code": "CMSFFFARTESTdvjre41",
"name": "ABC Form Factor Farzan Test dvjre41",
"description": "Form Factor Farzan Test for ABC",
"type": "phoneNumber",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "PMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://VBO/FAM001"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 2, 2020 11:18:38 AM",
"modifiedAt": "Mar 2, 2020 11:18:38 AM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
}
],
"tags": [
"tag://VBO/FAM001"
],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 2, 2020 11:18:40 AM",
"modifiedAt": "Mar 2, 2020 11:18:40 AM",
"headers": {}
},
"targetURI": "account://badb2a7d-0d4b-4d48-8ea5-84ae0be45a4c",
"formFactors": [
{
"id": "7db667d9-885e-4a53-afb4-b0ffb49d9f55",
"ifi": 140827,
"formFactorProductID": "12cc539c-ef94-4a24-9324-147523a6c00f",
"formFactorID": 919681519532,
"targetURI": "account://71227305-whatMobile2",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 2, 2020 11:18:45 AM",
"modifiedAt": "Mar 2, 2020 11:18:45 AM",
"headers": {}
},
{
"id": "90208df0-cdd5-497a-b3ff-f98bf3c6a2c2",
"ifi": 140827,
"formFactorProductID": "28ac4349-e2d0-49cf-ae35-44daf7a5e8be",
"formFactorID": "ac986fcd-25bd-4a6d-aa46-021069519b33",
"targetURI": "account://123Provision1",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 2, 2020 11:18:58 AM",
"modifiedAt": "Mar 2, 2020 11:18:58 AM",
"headers": {}
}
],
"tags": [
"tag://VBO/FAM001"
],
"vectors": [
"vector://ACCOUNT_HOLDER/49958542-8284-7221-12138140"
],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"attributes": {},
"status": "ACTIVE",
"createdAt": "Mar 2, 2020 11:18:45 AM",
"modifiedAt": "Mar 2, 2020 11:18:45 AM",
"headers": {}
}
},
"FormFactor": {
"title": "FormFactor",
"description": "",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifi": {
"format": "int32",
"type": "integer"
},
"formFactorProductID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"targetURI": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"attributes": {
"type": "object"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
},
"example": {
"id": "c7845612-c10d-4524-beb4-10b834655c47",
"ifi": 140827,
"formFactorProductID": "dc3c2d30-7a6a-4714-b1c4-66dc39c2df2b",
"formFactorID": 919397432115,
"targetURI": "account://71227305-whatMobile2",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 19, 2020 7:10:27 PM",
"modifiedAt": "Mar 20, 2020 5:35:15 AM",
"headers": {}
}
},
"AssociateFormFactor": {
"title": "AssociateFormFactor",
"description": "",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifi": {
"format": "int32",
"type": "integer"
},
"formFactorProductID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"targetURI": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
},
"example": {
"id": "af26d892-d872-41bf-9a36-36e11696864e",
"ifi": 140827,
"formFactorProductID": "61787ab5-68f7-4020-b4f9-57eb7ccd04de",
"formFactorID": 91987364658,
"targetURI": "account://71227305-whatMobile2",
"tags": [],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 23, 2020 10:28:03 AM",
"modifiedAt": "Mar 23, 2020 10:28:03 AM",
"headers": {}
}
},
"provisionAndLinkFormFactorRequest": {
"title": "provisionAndLinkFormFactorRequest",
"description": "",
"type": "object",
"properties": {
"formFactorProductID": {
"type": "string"
},
"orderDetails": {
"type": "object",
"properties": {
"orderID": {
"type": "string"
},
"cardSkuID": {
"type": "string"
},
"expiry": {
"type": "object",
"properties": {
"month": {
"format": "int32",
"type": "integer"
},
"year": {
"format": "int32",
"type": "integer"
}
}
},
"deliveryAddress": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"addressLine4": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"contactNumber": {
"type": "string"
}
}
}
}
},
"targetURI": {
"type": "string"
},
"status": {
"type": "string"
},
"vectors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"formFactorProductID": "688247db-f80b-4e80-88c8-467a8ce6e2d2",
"orderDetails": {
"orderID": "string",
"cardSkuID": "ABC_FAMPAY_PHYSICAL",
"expiry": {
"month": 0,
"year": 10
},
"deliveryAddress": {
"name": "Farzan",
"addressLine1": "Test Line 1",
"addressLine2": "Test2",
"addressLine3": "Test Line 3",
"addressLine4": "Test2",
"city": "dkwkr",
"state": "dfejhr",
"country": "IN",
"postalCode": "400050",
"contactNumber": "9867962795"
}
},
"targetURI": "account://123Provision1",
"status": "ACTIVE",
"vectors": [
"vector://ACCOUNT_HOLDER/provisionedffValue1"
]
}
},
"provisionAndLinkFormFactorResponse": {
"title": "provisionAndLinkFormFactorResponse",
"description": "",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"resourceProductId": {
"type": "string"
},
"resourceProduct": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"formFactorProducts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ifi": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"provider": {
"type": "string"
},
"skuID": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"attributes": {
"type": "object"
},
"issuanceStatus": {
"type": "string"
},
"paymentStatus": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object",
"properties": {
"tenantID": {
"type": "string"
},
"object": {
"type": "string"
}
}
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
},
"targetURI": {
"type": "string"
},
"formFactors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ifi": {
"format": "int32",
"type": "integer"
},
"formFactorProductID": {
"type": "string"
},
"formFactorID": {
"type": "string"
},
"targetURI": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"attributes": {
"type": "object"
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"vectors": {
"type": "array",
"items": {}
},
"policies": {
"type": "object",
"properties": {
"issuancePolicies": {
"type": "array",
"items": {}
},
"paymentPolicies": {
"type": "array",
"items": {}
}
}
},
"attributes": {
"type": "object"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"headers": {
"type": "object"
}
}
},
"provisionFormFactorResponse": {
"type": "object",
"properties": {
"resourceId": {
"type": "string"
},
"cardID": {
"type": "string"
},
"crn": {
"type": "string"
},
"cardType": {
"type": "string"
},
"maskedPan": {
"type": "string"
},
"network": {
"type": "string"
},
"cardStatus": {
"type": "string"
}
}
},
"headers": {
"type": "object"
}
},
"example": {
"resource": {
"ifi": 140827,
"id": "98470506-1fc3-4d76-abdc-3be1300bf0ba",
"resourceProductId": "03294d01-18cd-401b-bd3c-bf513be3bd0d",
"resourceProduct": {
"ifi": 140827,
"id": "03294d01-18cd-401b-bd3c-bf513be3bd0d",
"code": "RPFAMFARTESTwybw6o",
"name": "FAMPAY RESOURCE PRODUCT TEST wybw6o",
"description": "Resource Product for Fampay test1",
"formFactorProducts": [
{
"ifi": 140827,
"id": "688247db-f80b-4e80-88c8-467a8ce6e2d2",
"code": "CMSFFFARTESTwybw6o",
"name": "ABC Form Factor Test wybw6o",
"description": "Form Factor Test for ABC",
"type": "card",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "CMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/0f01e45b-f2d3-4592-9b01-c259988b8582"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 20, 2020 5:47:24 AM",
"modifiedAt": "Mar 20, 2020 5:47:24 AM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
},
{
"ifi": 140827,
"id": "0900cc44-f5a6-49f3-aaab-d3a14f122837",
"code": "CMSFFFARTESTwybw6o1",
"name": "ABC Form Factor Test wybw6o1",
"description": "Form Factor Test for ABC",
"type": "phoneNumber",
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"provider": "PMS",
"skuID": "RUPAY_ABC_VBO_PHYSICAL",
"tags": [
"tag://vbo/fam001"
],
"attributes": {},
"issuanceStatus": "ACTIVE",
"paymentStatus": "ACTIVE",
"createdAt": "Mar 20, 2020 5:47:26 AM",
"modifiedAt": "Mar 20, 2020 5:47:26 AM",
"headers": {
"tenantID": "140827",
"object": "140827@tenant.zeta.in"
}
}
],
"tags": [
"tag://vbo/fam001"
],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 20, 2020 5:47:28 AM",
"modifiedAt": "Mar 20, 2020 5:47:28 AM",
"headers": {}
},
"targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1",
"formFactors": [
{
"id": "30cccceb-af50-41de-b5c6-f879808503e5",
"ifi": 140827,
"formFactorProductID": "0900cc44-f5a6-49f3-aaab-d3a14f122837",
"formFactorID": 919740431612,
"targetURI": "account://71227305-whatMobile2",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 20, 2020 5:47:33 AM",
"modifiedAt": "Mar 20, 2020 5:47:33 AM",
"headers": {}
},
{
"id": "901dbbf9-1845-40d2-abe6-4ac0ae67ea67",
"ifi": 140827,
"formFactorProductID": "688247db-f80b-4e80-88c8-467a8ce6e2d2",
"formFactorID": "71ce8712-050a-412b-b953-09ce737584a4",
"targetURI": "account://123Provision1",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 20, 2020 5:47:35 AM",
"modifiedAt": "Mar 20, 2020 5:47:35 AM",
"headers": {}
},
{
"id": "5639a9e3-313b-4253-bbb8-d481b225d61a",
"ifi": 140827,
"formFactorProductID": "688247db-f80b-4e80-88c8-467a8ce6e2d2",
"formFactorID": "f3ba91d4-59c4-4f26-ab1f-63eaffbb09ed",
"targetURI": "account://123Provision1",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 20, 2020 1:07:18 PM",
"modifiedAt": "Mar 20, 2020 1:07:18 PM",
"headers": {}
},
{
"id": "ded52de6-04a3-4bc9-809d-f2b09ebe5495",
"ifi": 140827,
"formFactorProductID": "688247db-f80b-4e80-88c8-467a8ce6e2d2",
"formFactorID": "70c70535-b3b4-4805-bf08-83f857262f96",
"targetURI": "account://123Provision1",
"tags": [],
"attributes": {},
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"status": "ACTIVE",
"createdAt": "Mar 23, 2020 12:15:57 PM",
"modifiedAt": "Mar 23, 2020 12:15:57 PM",
"headers": {}
}
],
"tags": [
"tag://vbo/fam001"
],
"vectors": [],
"policies": {
"issuancePolicies": [],
"paymentPolicies": []
},
"attributes": {},
"status": "ACTIVE",
"createdAt": "Mar 20, 2020 5:47:33 AM",
"modifiedAt": "Mar 20, 2020 5:47:33 AM",
"headers": {}
},
"provisionFormFactorResponse": {
"resourceId": "resource://98470506-1fc3-4d76-abdc-3be1300bf0ba",
"cardID": "70c70535-b3b4-4805-bf08-83f857262f96",
"crn": "123055947407",
"cardType": "PHYSICAL_RUPAY_SUPERCARD",
"maskedPan": "508645-xxxxxx-9022",
"network": "RUPAY",
"cardStatus": "ACTIVE"
},
"headers": {}
}
},
"updateformfactor": {
"title": "Root Type for updateformfactor",
"description": "",
"type": "object",
"properties": {
"status": {
"type": "string"
},
"reason": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
},
"example": {
"status": "DELETED",
"reason": {
"code": "LOST_OR_STOLEN/DAMAGED/HOTLISTED/OFAC_BLOCKED/OTHERS",
"description": "User's card was lost/stolen"
}
}
}
}
}
}
|