Unknown macro: {hivestonebreadcrumb}
Fusion
Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

A payment is a series of debit/credit entries that affect the asset and liability side of multiple ledgers. A typical payment consists of a payer (customer, buyer) and a payee (merchant),  where the payer’s account is debited and payee’s account is credited. 

{ "openapi": "3.0.0", "info": { "title": "", "version": "", "description": "" }, "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." } } } } }, "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" } } } } }, "tags": [ { "name": "Payment Transfer" }, { "name": "Payment Product" }, { "name": "Form Factor Product" }, { "name": "Resource Product" }, { "name": "Resource" }, { "name": "Form Factor" } ] }

On this page:

Need Help?

Drop a mail at fusion-support@zeta.tech or call us on 080-6690 5995.

  • No labels

© 2019 Better World Technology Pvt. Ltd.