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

Cards are payment instruments that may or may not be associated with an Account Holder. Fusion provides APIs to perform various Card-related operations like issuance, personalization, orders and so on.

{ "openapi": "3.0.0", "info": { "title": "", "version": "", }, "tags": [ { "name": "Card order" }, { "name": "Card lifecycle" }, { "name": "Card details" }, { "name": "Card payment" } ], "paths": { "/api/v1/ifi/{ifiID}/cards/orders": { "post": { "operationId": "createOrder", "summary": "Place new bulk card order", "description": "A bulk card order allows you to order cards in large quantities with common attributes. When you create a bulk order, properties like cardholder details, delivery address, expiration date, and IFI ID for all the cards will be the same. Card number and CVV will be different for each card.", "requestBody": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/OrderRequest", "example": { "quantity": "1", "orderID": "cardorder807", "cardSkuID": "RUPAY_ABC_VBO_PHYSICAL", "plasticCode": "WHITEC", "expiry": { "month": 1, "year": 3, "separator": "/" }, "thirdLineEmbossing": "NA", "fourthLineEmbossing": "NA", "deliveryAddress": { "name": "DirectiPlex", "addressLine1": "Directiplex, Old Nagardas road", "addressLine2": "Andheri (East)", "addressLine3": "Mumbai", "addressLine4": "NA", "city": "Mumbai", "state": "Maharashtra", "country": "India", "postalCode": "400053", "contactNumber": "02228875511" }, "tenantAttributes": { "corporateName": "", "corporateID": "", "templateID": "" }, "vendorAttributes": { "consignmentID": "" } } ] } } }, "required": true }, "tags": [ "Card order" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/Order", "example": { "quantity": 1, "orderID": "cardorder807", "cardSkuID": "RUPAY_ABC_VBO_PHYSICAL", "plasticCode": "WHITEC", "expiry": { "month": 1, "year": 3 }, "thirdLineEmbossing": "NA", "fourthLineEmbossing": "NA", "deliveryAddress": { "name": "DirectiPlex", "addressLine1": "Directiplex, Old Nagardas road", "addressLine2": "Andheri (East)", "addressLine3": "Mumbai", "addressLine4": "NA", "city": "Mumbai", "state": "Maharashtra", "country": "India", "postalCode": "400053", "contactNumber": "02228875511" }, "tenantAttributes": { "corporateName": "", "corporateID": "", "templateID": "" }, "vendorAttributes": { "consignmentID": "" } } ] } } }, "description": "Order placed" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlreadyExists" } } }, "description": "Already exists" } }, } }, "/api/v1/ifi/{ifiID}/cards/orders/personalized": { "post": { "operationId": "createPersonalizedOrder", "summary": "Place new personalized card order", "description": "Ordering personalized cards allows you to specify different cardholder details, delivery address and IFI details for each card. Each card order is identified by a record identifier, `recordID`.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonlizedOrderRequest" } } }, "required": true }, "tags": [ "Card order" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalizedOrderReceived" } } }, "description": "Order Received" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalizedOrderPending" } } }, "description": "Order Records Pending" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlreadyExists" } } }, "description": "Already exists" } }, } }, "/api/v1/ifi/{ifiID}/cards/{cardID}/dispatch": { "post": { "operationId": "dispatchCardEmbossingRequest", "summary": "Generate embossing file", "description": "This endpoint will generate an embossing file based on the card SKU which contains details like cardholder's name, CVV, expiration date, and so on. This endpoint only applies to those orders that just have a single card ID to process in that specific order.</br> To obtain the card ID, use `orders/{orderID}/cards/list` endpoint. Fetch all the cards in the order and note the `cardID` of the card for which the embossing file is to be generated.", "requestBody": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/dispatchCardEmbossingRequest", "example": { "plasticCode": "WHITEC", "thirdLineEmbossing": "Rohit", "fourthLineEmbossing": "Tandon", "deliveryAddress": { "name": "Atash Shaikh", "addressLine1": "Directiplex", "addressLine2": "Near Andheri Subway", "addressLine3": "Old Nagardas Road", "addressLine4": "Andheri East", "city": "Mumbai", "state": "Maharashtra", "country": "India", "postalCode": "400069", "contactNumber": 919090909090 }, "vendorAttributes": { "shipping-partner.name": "BLUEDART", "shipping-partner.trackingNumber": "098137643242412312414", "welcome-kit.fullName": "Rohit Tondon", "welcome-kit.qrCode": "c48tn73793cfh93cg24c872t478r4ft3ubdcy8g3cr", "welcome-kit.templateID": "template-id" } } ] } } }, "required": true }, "tags": [ "Card order" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "cardID", "description": "Unique identifier of the card for which the embossing file is to be generated.", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchCardResponse" } } }, "description": "Request processed successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntity" } } }, "description": "Card cannot be dispatched" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Error occurred. Please try again after some time." } }, } }, "/api/v1/ifi/{ifiID}/cards/orders/{orderID}": { "get": { "summary": "Get card order details by Order ID", "description": "Get details like quantity, card SKU, and expiry for a specific order.", "tags": [ "Card order" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "orderID", "description": "Unique identifier of the card order for which details are being fetched.", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderRetreive" } } }, "description": "Returns order details" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Order does not exist" } }, } }, "/api/v1/ifi/{ifiID}/cards/orders/{orderID}/cancel": { "post": { "summary": "Cancel order by order ID", "description": "Cancel an existing order by order ID. You can cancel an order only if:<ul><li>The order status is in `ORDER_PLACED` or `CARD_REQUEST_GENERATED` state; and has not moved to `EMBOSSING_FILE_PENDING` state. </li><li>The card status is in the `REQUEST_RECEIVED` state.</li></ul>Before canceling an order, use the `/cards/orders/{orderID}` endpoint to check for order status.", "tags": [ "Card order" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "orderID", "description": "ID of the Card Order to be canceled.", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "description": "Returns 200 (ok) status code, indicating that the request is successful." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Order does not exist" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationNotPermitted" } } }, "description": "Cannot cancel as order has already been processed" } }, } }, "/api/v1/ifi/{ifiID}/orders/{orderID}/cards/list": { "get": { "operationId": "listCardInfoByOrderID", "summary": "List cards by Order ID", "description": "Use the endpoint to get an array of cards in a specific card order, and displays details like Resource ID, CRN, and BIN for each card. ", "tags": [ "Card details" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "orderID", "description": "Unique identifier of the card order for which details is fetched.", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "limit", "description": "Number of records to be returned", "schema": { "type": "integer" }, "in": "query" }, { "name": "offset", "description": "Starting point of records to return. Used in conjunction with `limit`", "schema": { "type": "integer" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listcardbyorderresponse" } } }, "description": "Returns the card information for the specified order ID." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Order does not exist" } }, } }, "/api/v1/ifi/{ifiID}/cards/list": { "post": { "requestBody": { "description": "Pass any of the filter option along with the relevant value under the filter object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listCardsRequest" }, "examples": { "CRN": { "value": { "filters": { "crn": "137798489315" } } }, "cardID": { "value": { "filters": { "cardID": "93d677d8-5fcb-4a12-ba30-ff19caf8d91e" } } }, "panSHA": { "value": { "filters": { "panSHA": "op5ahh1bPVAY4i7j67CADA8uspWEvpIAO2Ht9hQtQUs=" } } } } } }, "required": true }, "tags": [ "Card details" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/basicCardView" } } } }, "description": "Successful operation.\nThis is the response when the view selected is BASIC" }, "233": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expandedCardView" } } } }, "description": "Successful operation.\nThis is the response when the view selected is EXPANDED Detailed View." }, "244": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expandedSensitiveView" } } } }, "description": "- Successful operation. \n - This is the response when the view selected is EXPANDED_SENSITIVE. " }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occoured.Please try agian after some time." } }, "operationId": "listCards", "summary": "List all cards based on specific filter criteria", "description": " Fetch card information based on card ID, panSha or CRN. \n \n The endpoint supports the following views -\n - BASIC\n - EXPANDED\n - EXPANDED_SENSITIVE. Supported only if you are PCI DSS compliant." } }, "/api/v1/ifi/{ifiID}/cards/{cardID}": { "get": { "operationId": "getCard", "summary": "Get card details by card ID", "description": " Get card and order details for a specific card by specifying its ID.The endpoint supports the following views -\n - BASIC\n - EXPANDED\n - EXPANDED_SENSITIVE. Supported only if you are PCI DSS compliant.\n \n ", "tags": [ "Card details" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "cardID", "description": "ID of the Card for which details are being retrieved", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basicCardView" } } }, "description": "Successful operation.\nThis is the response when the view selected is BASIC" }, "233": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expandedCardView" } } }, "description": "Successful operation.\nThis is the response when the view selected is EXPANDED Detailed View." }, "244": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expandedSensitiveView" } } }, "description": "- Successful operation. \n - This is the response when the view selected is EXPANDED_SENSITIVE. " }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occoured.Please try again after some time." } }, } }, "/api/v1/ifi/{ifiID}/cards/{crn}": { "get": { "operationId": "getCardbyCRN", "summary": "Get card details by CRN", "description": " Get card and order details for a specific card by specifying its Card Reference Number(CRN).\n The endpoint supports the following views -\n - BASIC\n - EXPANDED\n - EXPANDED_SENSITIVE. Supported only if you are PCI DSS compliant.\n \n", "tags": [ "Card details" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "crn", "description": "CRN of the card being retrieved.", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basicCardView" } } }, "description": "Successful operation.\nThis is the response when the view selected is BASIC" }, "233": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expandedCardView" } } }, "description": "Successful operation.\nThis is the response when the view selected is EXPANDED Detailed View." }, "244": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expandedSensitiveView" } } }, "description": "- Successful operation. \n - This is the response when the view selected is EXPANDED_SENSITIVE. " }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occoured.Please try again after some time." } }, } }, "/api/v1/ifi/{ifiID}/resources/{resourceID}/form_factors": { "post": { "operationId": "associateCardsByIdentifier", "summary": "Associate Form Factor with a Resource", "description": "Use the endpoint to associate a Form Factor with an existing Resource. For example you can associate an additional card with an Account Holder. </br> If you created a card order explicitly (without issuing a Bundle), you must use this endpoint to associate the card (Form Factor) with the Account Holder (Resource).", "tags": [ "Card lifecycle" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "resourceID", "description": "ID of the Resource to which the Form Factor is associated to", "schema": { "type": "string" }, "in": "path", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/associateCardByIdentifierRequest", "example":{ "formFactorProductID": "4f6ed594", "formFactorID": "6c787a7a-f56b-428e-9d07-a3bd9920fd7a", "targetURI": "account://94e64ec5-bd43-464c-b043-8e782d8a38f4", "status": "ACTIVE" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/AssignFormFactorToResourceResponse", "example":{ "id": "a9b9b2c8-5a24-46b2-9f8e-861e3d0ebdf4", "ifi": 140827, "formFactorProductID": "4f6ed594", "formFactorID": "6c787a7a-f56b-428e-9d07-a3bd9920fd7a", "targetURI": "account://94e64ec5-bd43-464c-b043-8e782d8a38f4", "tags": [], "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "status": "ACTIVE", "createdAt": "Apr 30, 2020 1:14:22 PM", "modifiedAt": "Apr 30, 2020 1:14:22 PM", "headers": {} } ] } } }, "description": "Successful operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationNotPermitted" } } }, "description": "Operation not permitted." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occurred. Please try again after some time." } }, } }, "/api/v1/ifi/{ifiID}/resources/{resourceID}/form_factors/create": { "post": { "operationId": "orderAndAssociate", "summary": "Provision new Form Factor and associate with Resource", "description": "Use the endpoint to provision a new Form Factor and associate it with a given Resource. For example you can provision a new card (Form Factor) and associate it with an existing Account Holder (Resource).", "requestBody": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/ProvisionFormFactorToResourceRequest", "example":{ "formFactorProductID": "ffa6dd42-622d-4355-b5ff-0d2c847cc0c8", "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" ] } ] } } } }, "tags": [ "Card lifecycle" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "resourceID", "description": "ID of the Resource to which the Form Factor is associated to", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "allOf":[ "example":{ "resource": { "ifi": 140827, "id": "a243b054-6aac-407c-85a1-e436c440e54e", "resourceProductId": "a19ae813-876c-4767-b75d-1e0cf4bd928f", "resourceProduct": { "ifi": 140827, "id": "a19ae813-876c-4767-b75d-1e0cf4bd928f", "code": "RPFAMFARTEST9t06ng", "name": "FAMPAY RESOURCE PRODUCT TEST 9t06ng", "description": "Resource Product for Fampay test1", "formFactorProducts": [ { "ifi": 140827, "id": "ffa6dd42-622d-4355-b5ff-0d2c847cc0c8", "code": "CMSFFFARTEST9t06ng", "name": "ABC Form Factor Test 9t06ng", "description": "Form Factor Test for ABC", "type": "card", "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "provider": "CMS", "skuID": "RUPAY_ABC_VBO_PHYSICAL", "tags": [ "tag://vbo/4fa18593-d2d9-4bf3-bea7-7f6deb9f2ca4" ], "attributes": {}, "issuanceStatus": "ACTIVE", "paymentStatus": "ACTIVE", "createdAt": "Apr 30, 2020 5:48:42 AM", "modifiedAt": "Apr 30, 2020 5:48:42 AM", "headers": { "tenantID": "140827", "object": "140827@tenant.zeta.in" } }, { "ifi": 140827, "id": "9108432e-12fe-414c-bd6e-72234f59772d", "code": "CMSFFFARTEST9t06ng1", "name": "ABC Form Factor Test 9t06ng1", "description": "Form Factor Test for ABC", "type": "phoneNumber", "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "provider": "PMS", "skuID": "RUPAY_ABC_VBO_PHYSICAL", "tags": [ "tag://vbo/4fa18593-d2d9-4bf3-bea7-7f6deb9f2ca4" ], "attributes": {}, "issuanceStatus": "ACTIVE", "paymentStatus": "ACTIVE", "createdAt": "Apr 30, 2020 5:48:44 AM", "modifiedAt": "Apr 30, 2020 5:48:44 AM", "headers": { "tenantID": "140827", "object": "140827@tenant.zeta.in" } } ], "tags": [ "tag://vbo/4fa18593-d2d9-4bf3-bea7-7f6deb9f2ca4" ], "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "status": "ACTIVE", "createdAt": "Apr 30, 2020 5:48:47 AM", "modifiedAt": "Apr 30, 2020 5:48:47 AM", "headers": {} }, "targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1", "formFactors": [ { "id": "8b65dfbf-b337-43ef-96a7-510db71175b4", "ifi": 140827, "formFactorProductID": "9108432e-12fe-414c-bd6e-72234f59772d", "formFactorID": "+919114400268", "targetURI": "account://71227305-whatMobile2", "tags": [], "attributes": {}, "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "status": "ACTIVE", "createdAt": "Apr 30, 2020 5:52:42 AM", "modifiedAt": "Apr 30, 2020 5:52:42 AM", "headers": {} }, { "id": "13cd44c1-3acc-4fbf-98b8-220d075b2768", "ifi": 140827, "formFactorProductID": "ffa6dd42-622d-4355-b5ff-0d2c847cc0c8", "formFactorID": "42b2ec14-80a0-4ec2-a724-b9f5f2392b5a", "targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1", "tags": [], "attributes": {}, "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "status": "ACTIVE", "createdAt": "Apr 30, 2020 5:52:42 AM", "modifiedAt": "Apr 30, 2020 5:52:42 AM", "headers": {} }, { "id": "abfc5f1d-f80d-4b93-ae1c-52e076d98cea", "ifi": 140827, "formFactorProductID": "ffa6dd42-622d-4355-b5ff-0d2c847cc0c8", "formFactorID": "f487eda0-5650-443b-b8c8-a4128870d014", "targetURI": "account://123Provision1", "tags": [], "attributes": {}, "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "status": "ACTIVE", "createdAt": "Apr 30, 2020 3:15:14 PM", "modifiedAt": "Apr 30, 2020 3:15:14 PM", "headers": {} } ], "tags": [ "tag://vbo/4fa18593-d2d9-4bf3-bea7-7f6deb9f2ca4" ], "vectors": [ "vector://ACCOUNTHOLDER/de2a8f70-0a29-4fa7-bd08-49ce6cc9f9c4" ], "policies": { "issuancePolicies": [], "paymentPolicies": [] }, "attributes": {}, "status": "ACTIVE", "createdAt": "Apr 30, 2020 5:52:42 AM", "modifiedAt": "Apr 30, 2020 5:52:42 AM", "headers": {} }, "provisionFormFactorResponse": { "resourceId": "resource://a243b054-6aac-407c-85a1-e436c440e54e", "cardID": "f487eda0-5650-443b-b8c8-a4128870d014", "crn": "121161307914", "cardType": "PHYSICAL_RUPAY_SUPERCARD", "maskedPan": "508645-xxxxxx-4963", "network": "RUPAY", "cardStatus": "ACTIVE" }, "headers": {} } ] } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlreadyExists" } } }, "description": "Order already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occurred. Please try again after some time." } }, } }, "/api/v1/ifi/{ifiID}/cards/{cardID}/setPin": { "post": { "operationId": "setPinByIdentifier", "summary": "Set card PIN", "description": "Use the endpoint to set PIN for card. Old PIN is not required for setting a new PIN.</br>To use the endpoint, you must be PCI DSS compliant. To use the endpoint without compliance, integrate Fusion Card SDK into your application.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setPinByIdentifierRequest" } } } }, "tags": [ "Card lifecycle" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "cardID", "description": "ID of the Card for which PIN is being set.", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "204": { "description": "New Pin set successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationNotPermitted" } } }, "description": "Operation not permitted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occured. Please try again after sometime." } }, } }, "/api/v1/ifi/{ifiID}/cards/{cardID}/changePin": { "post": { "operationId": "changePinByIdentifier", "summary": "Change card PIN ", "description": "Use the endpoint to change PIN for card. You must provide the card's old PIN to set a new PIN. </br>To use the endpoint, you must be PCI DSS compliant. To use the endpoint without compliance, integrate Fusion Card SDK into your application.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/changePinByIdentifierRequest" } } } }, "tags": [ "Card lifecycle" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "cardID", "description": "ID of the Card for which the PIN is being changed.", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "204": { "description": "New Pin set successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationNotPermitted" } } }, "description": "Operation not permitted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occoured.Please try agian after some time." } }, } }, "/api/v1/ifi/{ifiID}/cards/{cardID}/generatePin": { "post": { "operationId": "generatePIN", "summary": "Generate card PIN", "description": "Use the endpoint to generate a new PIN for card. A randomly generated 4-digit PIN is sent to the delivery channel (phone,e-mail) provided in the request. The same delivery channel (vector) mentioned during Account Holder creation must be provided. The PIN is valid till a new PIN is set, changed or generated again.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePinRequest" } } } }, "tags": [ "Card lifecycle" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true }, { "name": "cardID", "description": "ID of the Card for which the PIN is being generated.", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK." }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Form Factor Not Found" }, "409": { "description": "Conflict, Channel Not Supported or Channel Not Enabled or Account Holder Does Not Have Vector For Corresponding Channel." } }, } }, "/api/v1/ifi/{ifiID}/resources/{resourceID}/form_factors/{formFactorID}": { "patch": { "operationId": "updateFormFactor", "summary": "Deactivate/Activate/Delete card by Form Factor ID", "description": " Use the endpoint to activate, deactivate, or delete a card by changing its status. Please note that if you are deleting the card, specifying the reason(request body parameter) is required.</br></br>To get the Resource ID and Form Factor ID for the endpoint, 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.", "parameters": [ { "name": "resourceID", "in": "path", "description": "Unique identifier of the Resource with which the Card is associated with.", "required": true, "schema": { "type": "string" } }, { "name": "formFactorID", "in": "path", "description": "Unique identifier of the Card.", "required": true, "schema": { "type": "string" } }, { "name": "ifiID", "in": "path", "description": "Unique identifier of the IFI.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Specify the following parameters in the request body to change the status of the card. Please note that if you are deleting the card, specifying the reason (code, description) is required.<ul><li>`status`: Required. Status of the card.<br/>Supported values — `ACTIVE` to activate the card; `INACTIVE` to deactivate the card; `DELETED` to delete the card.</li><li>`code`: Code of the reason for changing the status of the card. Optional for activating/deactivating the card. Required for deleting the card.<br/>Supported values: `LOST_OR_STOLEN`, `DAMAGED`, `HOTLISTED`, `OFAC_BLOCKED`, `OTHER` </li><li>`description`: Human-readable description of the reason for changing the status of the card. Length must be less than 200 characters. Optional for activating/deactivating the card. Required for deleting the card.</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" } } }, "Cancel": { "value": { "status": "DELETED", "reason": { "code": "DAMAGED", "description": "Card is damaged and needs to be replaced" } } } } } }, "required": true }, "tags": [ "Card lifecycle" ], "responses": { "200": { "content": { "application/json": { "schema": { "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": "INACTIVE", "createdAt": "Mar 19, 2020 7:10:27 PM", "modifiedAt": "Apr 20, 2020 10:17:23 AM", "headers": {} } } } }, "description": "Card successfully deactivated" }, "201": { "content": { "application/json": { "schema": { "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": "DELETED", "reason": { "code": "DAMAGED", "description": "Card is damaged and needs to be replaced" }, "createdAt": "Mar 19, 2020 7:10:27 PM", "modifiedAt": "Apr 22, 2020 12:50:45 PM", "headers": {} } } } }, "description": "Card successfully canceled" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errorCode" } } }, "description": "Unexpected Error occoured.Please try agian after some time." } }, } }, "/api/v1/ifi/{ifiID}/cards/orders/replacement":{ "post": { "operationId": "createReplacementOrder", "summary": "Order card replacement", "description": "Use the endpoint to order a replacement for a card. A new card order must be created with the old card's reference number (CRN).</br> <i>Note: </i>Before ordering for a replacement, cancel the old card first.", "requestBody": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/ReplacementOrderRequest", "example": { "orderID": "testOrdr10116", "oldCardReferenceNumber": "193825515652", "expiry": { "month": 2, "year": 5 }, "thirdLineEmbossing": "Rohit", "fourthLineEmbossing": "Jospeh", "deliveryAddress": { "name": "Rohit Joseph", "addressLine1": "Directiplex", "addressLine2": "Near Andheri Subway", "addressLine3": "Old Nagardas Road", "addressLine4": "Andheri East", "city": "Mumbai", "state": "Maharashtra", "country": "India", "postalCode": "400069", "contactNumber": "+919090909090" }, "tenantAttributes": { "corporateName": "", "corporateID": "", "templateID": "" }, "vendorAttributes": { "consignmentID" :"" } } ] } } }, "required": true }, "tags": [ "Card lifecycle" ], "parameters": [ { "name": "ifiID", "description": "Unique identifier of the IFI", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "allOf":[ "$ref": "#/components/schemas/ReplaceOrderResponse", "example": { "quantity": 1, "orderID": "testOrdr10116", "cardSkuID": "ABC_FAMPAY_MS", "plasticCode": "WHITEC", "expiry": { "month": 2, "year": 5 }, "thirdLineEmbossing": "Rohit", "fourthLineEmbossing": "Jospeh", "deliveryAddress": { "name": "Rohit Joseph", "addressLine1": "Directiplex", "addressLine2": "Near Andheri Subway", "addressLine3": "Old Nagardas Road", "addressLine4": "Andheri East", "city": "Mumbai", "state": "Maharashtra", "country": "India", "postalCode": "400069", "contactNumber": "+919090909090" }, "tenantAttributes": { "templateID": "", "corporateID": "", "corporateName": "" }, "vendorAttributes": { "consignmentID": "" }, "additionalAttributes": { "oldCrn": "193825515652" }, "orderStatus": "CARD_REQUEST_GENERATED", "orderedAt": "2020-04-30T06:45:56.523Z" } ] } } }, "description": "Order placed" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlreadyExists" } } }, "description": "Already exists" } }, } }, "/api/v1/ifi/{ifiID}/resources/{resourceID}/payments/list": { "get": { "tags": [ "Card payment" ], "summary": "List all payment records for a Resource", "description":"Use the endpoint to list all the payment records and their details for a Resource. If multiple Form Factors are associated with the Resource, then payment records of all of them are displayed. Payment details for each Form Factor can be determined using the respective card ID.", "operationId": "ListPaymentByResourceID", "parameters": [ { "name": "ifiID", "in": "path", "description":"Unique identifier of the IFI", "required": true, "schema": { "type": "string" } }, { "name": "resourceID", "in": "path", "description":"Unique identifier of Resource for which payment details are fetched.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description":"Starting date in the format YYYY-MM-DD'T'HH:MM:SS.sss'Z'", "required": true, "schema": { "type": "string" }, }, { "name": "endDate", "in": "query", "description":"End date in the format YYYY-MM-DD'T'HH:MM:SS.sss'Z'", "required": true, "schema": { "type": "string" }, }, { "name": "limit", "in": "query", "description":"Number of records to be returned. Maximum allowed value is 20", "required": false, "schema": { "type": "string" }, }, { "name": "offset", "in": "query", "description":"Starting point of records to return. Used in conjunction with limit", "required": false, "schema": { "type": "string" }, } ], "responses": { "200": { "description": "Returns the list of payment records", "content": { "*/*": { "schema": { "example": [ { "id": 285696000008, "ifi": 140827, "requestChannelType": "SUPER_CARD", "state": "PAYMENT_CAPTURED", "value": { "currency": "INR", "amount": 100 }, "stateTransitions": { "PAYMENT_EFFECTED": 1585158596564, "PAYMENT_AUTHORIZATION_REQUESTED": 1585158595645, "PAYMENT_CAPTURED": 1585158596749, "PAYMENT_REQUESTED": 1585158595011, "PAYMENT_AUTHORIZATION_RECEIVED": 1585158595702 }, "payer": { "type": "RESOURCE", "targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1", "resourceID": "b60fde11-64fd-47a8-a0b3-4c94edea626a", "formFactorURI": "card://59dc47e8-65e1-49e9-ad2b-39028479c69e" }, "payee": { "name": "TEST MERCHANT", "type": "EXTERNAL_BUSINESS", "location": "MUMBAI" }, "paymentRequest": { "paymentRequestID": "T00001_111111_200325174954_360343071373_59dc47e8-65e1-49e9-ad2b-39028479c69e", "requestFrom": "5425484178419227662@ledger.zeta.in", "requestTo": "card://59dc47e8-65e1-49e9-ad2b-39028479c69e", "value": [ { "currency": "INR", "amount": 100 } ], "dueBy": 1585159794974, "towards": "Physical Super Card POS Purchase", "attributes": { "super-card.ifi": "140827", "super-card.mcc": "5411", "super-card.mid": "M00001", "super-card.rrn": "360343071373", "super-card.tid": "T00001", "super-card.stan": "800656", "super-card.card-id": "resource://b60fde11-64fd-47a8-a0b3-4c94edea626a_59dc47e8-65e1-49e9-ad2b-39028479c69e", "journal.voucherCode": "RUPAY-508645_POS_AUTH", "super-card.acquirer": "111111", "super-card.card-6x4": "508645-xxxxxx-7801", "super-card.card-bin": "508645", "super-card.trans-id": "M00001_T00001_800656_360343071373", "super-card.txn-type": "POS", "super-card.init-time": "200325174954", "super-card.merchant-lat": "18.975", "super-card.merchant-lon": "72.825833", "super-card.merchant-city": "MUMBAI", "super-card.merchant-name": "TEST MERCHANT", "super-card.otp-enter-mode": "manual", "super-card.merchant-country": "IN" } }, "receipts": [ { "receiptType": "AUTHORIZATION", "paymentID": "a62a9ed5-1185-418d-b035-3e3922e264d3", "paymentRequestID": "T00001_111111_200325174954_360343071373_59dc47e8-65e1-49e9-ad2b-39028479c69e", "receiptID": 285696000008, "transactionHash": "AqrILw==", "transactionCode": "142003", "paymentTo": "5425484178419227662@ledger.zeta.in", "time": 1585158596390, "debits": [ { "postingID": "849826", "ifi": 140827, "value": { "currency": "INR", "amount": 100 }, "newBalance": { "currency": "INR", "amount": 4191 }, "instrumentType": "MCC_VOUCHER_RECIPIENT", "attributes": {}, "coupons": [ { "value": { "amount": 100, "currency": "INR" }, "couponID": "78bef2a6-8e90-4301-90b4-4ccf1e417da2" } ] } ], "credits": [ { "postingID": "516508", "ifi": 140827, "value": { "currency": "INR", "amount": 100 }, "newBalance": { "currency": "INR", "amount": 685104 }, "instrumentType": "SYSTEM", "attributes": {}, "coupons": [] } ], "towards": "Physical Super Card POS Purchase", "attributes": { "super-card.ifi": "140827", "super-card.mcc": "5411", "super-card.mid": "M00001", "super-card.rrn": "360343071373", "super-card.tid": "T00001", "super-card.stan": "800656", "super-card.card-id": "resource://b60fde11-64fd-47a8-a0b3-4c94edea626a_59dc47e8-65e1-49e9-ad2b-39028479c69e", "journal.voucherCode": "RUPAY-508645_POS_AUTH", "payment.channelType": "SUPER_CARD", "super-card.acquirer": "111111", "super-card.card-6x4": "508645-xxxxxx-7801", "super-card.card-bin": "508645", "super-card.trans-id": "M00001_T00001_800656_360343071373", "super-card.txn-type": "POS", "super-card.init-time": "200325174954", "super-card.merchant-lat": "18.975", "super-card.merchant-lon": "72.825833", "super-card.merchant-city": "MUMBAI", "super-card.merchant-name": "TEST MERCHANT", "super-card.otp-enter-mode": "manual", "super-card.merchant-country": "IN" }, "value": { "currency": "INR", "amount": 100 }, "payerInfo": { "type": "RESOURCE", "targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1", "resourceID": "b60fde11-64fd-47a8-a0b3-4c94edea626a", "formFactorURI": "card://59dc47e8-65e1-49e9-ad2b-39028479c69e" }, "payeeInfo": { "name": "TEST MERCHANT", "type": "EXTERNAL_BUSINESS", "location": "MUMBAI" }, "headers": { "signature": "AAHQ7ygwRQIhAIuHozivJQTZ5mP6UxhQ+n6TxKi7imDa7xxGkSR/ldZCAiBIGiTD4o5O68jJkihbNztf5hF0pADNylYbH4iZrV85ow==", "signatoryJID": "11@zetauser.zeta.in/1" } }, { "receiptType": "PAYMENT", "paymentID": "a62a9ed5-1185-418d-b035-3e3922e264d3", "paymentRequestID": "T00001_111111_200325174954_360343071373_59dc47e8-65e1-49e9-ad2b-39028479c69e", "receiptID": 285696000008, "transactionHash": "AqrILw==", "transactionCode": "142003", "paymentTo": "5425484178419227662@ledger.zeta.in", "time": 1585158596744, "debits": [ { "postingID": "849826", "ifi": 140827, "value": { "currency": "INR", "amount": 100 }, "newBalance": { "currency": "INR", "amount": 4191 }, "instrumentType": "MCC_VOUCHER_RECIPIENT", "attributes": {}, "coupons": [ { "value": { "amount": 100, "currency": "INR" }, "couponID": "78bef2a6-8e90-4301-90b4-4ccf1e417da2" } ] } ], "credits": [ { "postingID": "516508", "ifi": 140827, "value": { "currency": "INR", "amount": 100 }, "newBalance": { "currency": "INR", "amount": 685104 }, "instrumentType": "SYSTEM", "attributes": {}, "coupons": [] } ], "towards": "Physical Super Card POS Purchase", "attributes": { "super-card.ifi": "140827", "super-card.mcc": "5411", "super-card.mid": "M00001", "super-card.rrn": "360343071373", "super-card.tid": "T00001", "super-card.stan": "800656", "super-card.card-id": "resource://b60fde11-64fd-47a8-a0b3-4c94edea626a_59dc47e8-65e1-49e9-ad2b-39028479c69e", "journal.voucherCode": "RUPAY-508645_POS_AUTH", "payment.channelType": "SUPER_CARD", "super-card.acquirer": "111111", "super-card.card-6x4": "508645-xxxxxx-7801", "super-card.card-bin": "508645", "super-card.trans-id": "M00001_T00001_800656_360343071373", "super-card.txn-type": "POS", "super-card.init-time": "200325174954", "super-card.merchant-lat": "18.975", "super-card.merchant-lon": "72.825833", "super-card.merchant-city": "MUMBAI", "super-card.merchant-name": "TEST MERCHANT", "super-card.otp-enter-mode": "manual", "super-card.merchant-country": "IN" }, "value": { "currency": "INR", "amount": 100 }, "payerInfo": { "type": "RESOURCE", "targetURI": "account://22cf4cdd-a01a-40c4-91ac-d8d88aac7ea1", "resourceID": "b60fde11-64fd-47a8-a0b3-4c94edea626a", "formFactorURI": "card://59dc47e8-65e1-49e9-ad2b-39028479c69e" }, "payeeInfo": { "name": "TEST MERCHANT", "type": "EXTERNAL_BUSINESS", "location": "MUMBAI" }, "headers": { "signature": "AAHQ7ygwRgIhAOGdcbAVyyPCYetnL/ZhwMvVi3mBSdwYefroycFMbg2DAiEAh0SkmtTS1gZP1wz4YVl5vzUzkh8KPj9vnzzInLM5l9I=", "signatoryJID": "11@zetauser.zeta.in/1" } } ], "attributes": {}, "headers": {} } ], "type": "array", "items": { } } } } } } } }, "/api/v1/ifi/{ifiID}/resources/{resourceID}/payments/{paymentID}": { "get": { "tags": [ "Card payment" ], "summary": "Get payment details by payment ID", "description":"Use the endpoint to get payment details for a specific payment record. Each payment record for a Resource is identified by a payment ID. ", "operationId": "GetPaymentByPaymentID", "parameters": [ { "name": "ifiID", "in": "path", "description":"Unique identifier of the IFI", "required": true, "schema": { "type": "string" } }, { "name": "resourceID", "in": "path", "description":"Unique identifier of Resource for which payment details are being fetched", "required": true, "schema": { "type": "string" } }, { "name": "paymentID", "in": "path", "description":"Unique identifier of payment for which details are fetched", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description":"Starting date in the format YYYY-MM-DD'T'HH:MM:SS.sss'Z'", "required": true, "schema": { "type": "string" }, }, { "name": "endDate", "in": "query", "description":"End date in the format YYYY-MM-DD'T'HH:MM:SS.sss'Z'", "required": true, "schema": { "type": "string" }, }, { "name": "limit", "in": "query", "description":"Number of records to be returned. Maximum allowed value is 20", "required": false, "schema": { "type": "string" }, }, { "name": "offset", "in": "query", "description":"Starting point of records to return. Used in conjunction with limit", "required": false, "schema": { "type": "string" }, } ], "responses": { "200": { "description": "Returns the payment record", "content": { "*/*": { "schema": { "example": { "id": 901658000005, "ifi": 140827, "requestChannelType": "SUPER_CARD", "state": "PAYMENT_REVERSED", "value": { "currency": "INR", "amount": 100 }, "stateTransitions": { "PAYMENT_CAPTURED": 1584371169397, "PAYMENT_REVERSED": 1584371438794, "REVERSAL_INITIATED": 1584371438401, "PAYMENT_REQUESTED": 1584371167040, "PAYMENT_AUTHORIZATION_RECEIVED": 1584371167497, "PAYMENT_EFFECTED": 1584371167954, "PAYMENT_AUTHORIZATION_REQUESTED": 1584371167256 }, "payer": { "type": "RESOURCE", "targetURI": "account://6b2dfb83-9276-422c-8781-07eda71fc261", "resourceID": "0c97e84f-999d-4fdf-a53f-24cb99b11e76", "formFactorURI": "card://ff936322-287f-43e4-9497-a86d94bd97a9" }, "payee": { "name": "TEST MERCHANT", "type": "EXTERNAL_BUSINESS", "location": "MUMBAI" }, "paymentRequest": { "paymentRequestID": "T00001_111111_200316150606_328435404334_ff936322-287f-43e4-9497-a86d94bd97a9", "requestFrom": "1971050374361855296@ledger.zeta.in", "requestTo": "card://ff936322-287f-43e4-9497-a86d94bd97a9", "value": [ { "currency": "INR", "amount": 100 } ], "dueBy": 1584372366609, "towards": "Physical Super Card ECOM Purchase", "attributes": { "zeta.amc": "5811", "super-card.ifi": "140827", "super-card.ink": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36", "super-card.mcc": "5411", "super-card.mid": "M00001", "super-card.rrn": "328435404334", "super-card.tid": "T00001", "super-card.stan": "632986", "super-card.card-id": "resource://0c97e84f-999d-4fdf-a53f-24cb99b11e76_ff936322-287f-43e4-9497-a86d94bd97a9", "journal.voucherCode": "RUPAY-508645_ECOM_AUTH", "super-card.acquirer": "111111", "super-card.card-6x4": "508645-xxxxxx-0289", "super-card.card-bin": "508645", "super-card.trans-id": "M00001_T00001_111111_632986_328435404334_200316150606", "super-card.txn-type": "ECOM", "super-card.acs-txnId": "459906094777449499477093783879", "super-card.init-time": "200316150606", "super-card.merchant-lat": "18.975", "super-card.merchant-lon": "72.825833", "super-card.merchant-city": "MUMBAI", "super-card.merchant-name": "TEST MERCHANT", "super-card.otp-enter-mode": "manual", "super-card.merchant-country": "IN" } }, "receipts": { "transactionReceipts": [ { "signedDoc": { "debits": [ { "ifi": 140827, "value": { "amount": 100, "currency": "INR" }, "ledgerID": 1897735027140461000, "noteHash": "3lh5iA==", "postingID": "556300", "ledgerType": "MCC_VOUCHER_RECIPIENT", "newBalance": { "amount": 23358, "currency": "INR" }, "redeemedCoupons": [ { "couponID": "2dc7343b-9bef-42ef-b061-c116c4d2e3bb", "redeemedValue": 100 } ] } ], "credits": [ { "ifi": 140827, "value": { "amount": 100, "currency": "INR" }, "ledgerID": 1971050374361855200, "noteHash": "ZFGrZA==", "postingID": "267391", "ledgerType": "SYSTEM", "newBalance": { "amount": 759713, "currency": "INR" }, "redeemedCoupons": [] } ], "headers": { "signature": "AAHi4ZwwRQIgSngz/WTNOLTWkiLyEtTUfSELCwmGVxKnv2/BMIzP8q0CIQDirOZ1dTwyrwQcvd/6z+Gf620jZYoTtlrxBrFyshbLYg==", "signatoryJID": "901322@journal.services.olympus" }, "requestID": "901658000005", "timestamp": 1584371167634, "transactionID": 2.0200316150607624e+31 }, "version": 1, "headers": {} } ], "reversalTransactionReceipts": [ { "signedDoc": { "debits": [ { "ifi": 140827, "value": { "amount": 100, "currency": "INR" }, "ledgerID": 1971050374361855200, "noteHash": "8pr6Ng==", "postingID": "267392", "ledgerType": "SYSTEM", "newBalance": { "amount": 759613, "currency": "INR" }, "redeemedCoupons": [] } ], "credits": [ { "ifi": 140827, "value": { "amount": 100, "currency": "INR" }, "ledgerID": 1897735027140461000, "noteHash": "2vTNRg==", "postingID": "556301", "ledgerType": "MCC_VOUCHER_RECIPIENT", "newBalance": { "amount": 23458, "currency": "INR" }, "redeemedCoupons": [] } ], "headers": { "signature": "AAHi4ZwwRAIgRBqB9kfRTa4xbsWeMSvfvB4ECzxdG7oa4Uer2opFo1ACID/kVeEpQXA2WIwIJRrXvxCF372Wi3JxTPmjRHgOXeZy", "signatoryJID": "901322@journal.services.olympus" }, "requestID": "revert_901658000005_901658000005_87c1fc9b-66ef-4211-8dfd-4e06920f0a97", "timestamp": 1584371438471, "transactionID": "20200316151038461_489_revert_901658000005_901658000005_87c1fc9b-66ef-4211-8dfd-4e06920f0a97", "revertTransactionID": 2.0200316150607624e+31 }, "version": 1, "headers": {} } ] }, "attributes": {} } } } } } } } }, }, "components": { "schemas": { "Resource": { "type": "object", "properties": { "uri": { "format": "uri", "type": "string", "example": "resource:q1w2e3r4t5" }, "attributes": { "type": "object" } } }, "updateFormFactorRequest":{ "title":"", "type":"object", "properties":{ "status":{ "type":"string", "description":"status of the card", "enum":["ACTIVE","INACTIVE","DELETED"] }, "reason":{ "description":"Reason for changing the status of the card. Optional for activating/deactivating the card. Required for deleting the card.", "type":"object", "properties":{ "code":{ "type":"string", "description":"Code of the reason for cancelling the card. Optional for activating/deactivating the card. Required for deleting the card.", "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 card. Length must be less than 200 characters. Optional for activating/deactivating the card. Required for deleting the card." } } } } }, "AssignFormFactorToResourceResponse":{ "type": "object", "properties": { "id": { "type": "string", "description":"Uniqued identifier of the Form Factor to be associated." }, "ifi": { "type": "integer", "description":"Unique identifier of the IFI" }, "formFactorProductID": { "type": "string", "description":"Unique identifier of the Form Factor Product to which the Form Factor belongs." }, "formFactorID": { "type": "string" }, "targetURI": { "type": "string", "description":"Unique identifier of the account to which the Form Factor is mapped to." }, "tags": { "type": "array", "items":{ } }, "policies": { "description":"Policies applied on the Form Factor", "type": "object", "properties": { "issuancePolicies": { "type": "array", "items":{} }, "paymentPolicies": { "type": "array", "items":{} } } }, "status": { "description":"Current status of the Form Factor.", "type": "string", "enum":["ACTIVE,INACTIVE,DELETED"] }, "createdAt": { "description":"Date and time of when the Form Factor is associated with the Resource", "format": "data-time", "type": "string" }, "modifiedAt": { "description":"Date and time of when details of Form Factor's association with Resource is modified.", "format": "date-time", "type": "string" } }, }, "ProvisionFormFactorToResourceRequest":{ "type": "object", "properties": { "formFactorProductID": { "type": "string", "description":"Unique identifier of the Form Factor Product to which the Form Factor belongs." }, "OrderDetails": { "type": "object", "properties": { "orderID": { "type": "string", "description":"Unique identifier of the order." }, "cardSkuID": { "type": "string", "description":"Unique identifier for card's configurational properties like card network, BIN, card-type, embossing vendor details.", }, "expiry": { "description":"Expiration date for the card. The date will be set according to the formula currentMonth + Month and current Year+Year.", "type": "object", "properties": { "month": { "format": "int32", "type": "integer" }, "year": { "format": "int32", "type": "integer" } } }, } }, "deliveryAddress": { "description":"Address where the card is delivered to.", "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", "description":"Unique identifier of the account to which the Form Factor is mapped to." }, }, }, "ProvisionFormFactorToResourceResponse":{ "type": "object", "properties": { "resource":{ "type":"object", "properties":{ "formFactorProductID": { "type": "string", "description":"Unique identifier of the Form Factor Product to which the Form Factor belongs." }, "OrderDetails": { "type": "object", "properties": { "orderID": { "type": "string", "description":"Unique identifier of the order." }, "cardSkuID": { "type": "string", "description":"Unique identifier for card's configurational properties like card network, BIN, card-type, embossing vendor details.", }, "expiry": { "description":"Expiration date for the card. The date will be set according to the formula currentMonth + Month and current Year+Year.", "type": "object", "properties": { "month": { "format": "int32", "type": "integer" }, "year": { "format": "int32", "type": "integer" } } }, } }, "deliveryAddress": { "description":"Address where the card is delivered to.", "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", "description":"Unique identifier of the account to which the Form Factor is mapped to." }, } } }, }, "cardView": { "description": "The view to be fetched", "enum": [ "BASIC", "EXPANDED", "EXPANDED_SENSITIVE" ], "type": "string" }, "AddBINRequest": { "type": "object", "properties": { "cardNetwork": { "type": "string" }, "rangeLength": { "type": "number" }, "clearingType": { "type": "string" }, "sponsorBank": { "type": "string" }, "attributes": { "type": "object" } } }, "BIN": { "type": "object", "properties": { "bin": { "type": "string" }, "cardNetwork": { "type": "string" }, "rangeLength": { "type": "number" }, "clearingType": { "type": "string" }, "sponsorBank": { "type": "string" }, "attributes": { "type": "object" } } }, "AddBinRangeRequest": { "type": "object", "properties": { "cardType": { "type": "string" }, "ifi": { "type": "number" }, "cardConfig": { "type": "object" }, "keyConfig": { "type": "object", "properties": { "cvv1.service.code": { "type": "string" }, "cvv1.alias": { "type": "string" }, "cvv1.password": { "type": "string" }, "cvv12.alias": { "type": "string" }, "cvv12.password": { "type": "string" } } }, "clearing": { "type": "object", "properties": { "debit.isEnabled": { "type": "string" }, "refund.isEnabled": { "type": "string" }, "debit.blocked.mcc.list": { "type": "string" }, "refund.partial.isEnabled": { "type": "string" }, "refund.partial.blocked.mcc.list": { "type": "string" } } }, "acs": { "type": "object", "properties": { "urlid": { "type": "string" } } }, "iso": { "type": "object", "properties": { "atm.zpk.alias": { "type": "string" }, "pos.zpk.alias": { "type": "string" }, "atm.zpk.password": { "type": "string" }, "pos.zpk.password": { "type": "string" } } }, "embossing": { "type": "object", "properties": { "vendorsSupported": { "type": "array", "items": { "type": "string" } } } }, "attributes": { "type": "object", "properties": { "giftCard": { "type": "string" } } } } }, "BinRange": { "type": "object", "properties": { "bin": { "type": "string" }, "range": { "type": "string" }, "cardType": { "type": "string" }, "ifi": { "type": "number" }, "cardConfig": { "type": "object" }, "keyConfig": { "type": "object", "properties": { "cvv1.service.code": { "type": "string" }, "cvv1.alias": { "type": "string" }, "cvv1.password": { "type": "string" }, "cvv12.alias": { "type": "string" }, "cvv12.password": { "type": "string" } } }, "clearing": { "type": "object", "properties": { "debit.isEnabled": { "type": "string" }, "refund.isEnabled": { "type": "string" }, "debit.blocked.mcc.list": { "type": "string" }, "refund.partial.isEnabled": { "type": "string" }, "refund.partial.blocked.mcc.list": { "type": "string" } } }, "acs": { "type": "object", "properties": { "urlid": { "type": "string" } } }, "iso": { "type": "object", "properties": { "atm.zpk.alias": { "type": "string" }, "pos.zpk.alias": { "type": "string" }, "atm.zpk.password": { "type": "string" }, "pos.zpk.password": { "type": "string" } } }, "attributes": { "type": "object", "properties": { "giftCard": { "type": "string" } } } } }, "ProductPolicyCreateRequest": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "state": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" }, "policyType": { "enum": [ "AGGREGATION", "NON_AGGREGATION" ], "type": "string" }, "category": { "enum": [ "TRANSACTION" ], "type": "string" }, "policyRule": { "type": "object", "properties": { "parser": { "enum": [ "JS" ], "type": "string" }, "rule": { "type": "string" } } }, "additionalConfig": { "type": "object", "properties": { "aggregationConfig": { "type": "object", "properties": { "timeRange": { "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "type": "string" }, "window": { "enum": [ "CALENDAR", "SLIDING" ], "type": "string" }, "metric": { "type": "object", "properties": { "operation": { "enum": [ "SUM", "AVERAGE" ], "type": "string" }, "value": { "enum": [ "TRANSACTION_AMOUNT" ], "type": "string" } } }, "dimension": { "type": "array", "items": { "enum": [ "CARD", "PRODUCT" ], "type": "string" } } } } } }, "validFrom": { "format": "date-time", "type": "string" }, "validUtil": { "format": "date-time", "type": "string" }, "errorCode": { "enum": [ "DAILY_LIMIT_EXCEEDED" ], "type": "string" } } }, "ProductPolicyCreateGetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "state": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" }, "policyType": { "enum": [ "AGGREGATION", "NON_AGGREGATION" ], "type": "string" }, "category": { "enum": [ "TRANSACTION" ], "type": "string" }, "policyRule": { "type": "object", "properties": { "parser": { "enum": [ "JS" ], "type": "string" }, "rule": { "type": "string" } } }, "additionalConfig": { "type": "object", "properties": { "aggregationConfig": { "type": "object", "properties": { "timeRange": { "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "type": "string" }, "window": { "enum": [ "CALENDAR", "SLIDING" ], "type": "string" }, "metric": { "type": "object", "properties": { "operation": { "enum": [ "SUM", "AVERAGE" ], "type": "string" }, "value": { "enum": [ "TRANSACTION_AMOUNT" ], "type": "string" } } }, "dimension": { "type": "array", "items": { "enum": [ "CARD", "POLICY" ], "type": "string" } } } } } }, "validFrom": { "format": "date-time", "type": "string" }, "validUtil": { "format": "date-time", "type": "string" }, "errorCode": { "enum": [ "DAILY_LIMIT_EXCEEDED" ], "type": "string" } } }, "ProductDetails": { "type": "object", "properties": { "productID": { "type": "string" }, "productCode": { "type": "string" }, "description": { "type": "string" }, "bin": { "type": "string" }, "range": { "type": "string" }, "features": { "type": "array", "items": { "type": "object", "properties": { "featureType": { "enum": [ "EMV", "MAG_STRIPE", "HYBRID", "NFC", "PHOTO_ID", "USE_ORIGINAL_CARD_EXPIRY" ], "type": "string" }, "attributes": { "type": "object" } } } }, "policies": { "type": "array", "items": { "description": "Policy ID", "enum": [ "policyID" ], "type": "string" } }, "design": { "type": "array", "items": { "description": "Design ID", "enum": [ "designID" ], "type": "string" } }, "expiry": { "type": "object", "properties": { "month": { "type": "number" }, "year": { "type": "number" } } }, "additionalAttributes": { "type": "object" } } }, "ProductCreatUpdateRequest": { "type": "object", "properties": { "productCode": { "type": "string" }, "description": { "type": "string" }, "bin": { "type": "string" }, "range": { "type": "string" }, "features": { "type": "array", "items": { "type": "object", "properties": { "featureType": { "enum": [ "EMV", "MAG_STRIPE", "HYBRID", "NFC", "PHOTO_ID" ], "type": "string" }, "attributes": { "type": "object" } } } }, "policies": { "type": "array", "items": { "description": "Policy ID", "enum": [ "policyID" ], "type": "string" } }, "design": { "type": "array", "items": { "description": "Design ID", "enum": [ "designID" ], "type": "string" } }, "expiry": { "type": "object", "properties": { "month": { "type": "number" }, "year": { "type": "number" } } }, "additionalAttributes": { "type": "object" } } }, "VendorDesignMappingRequest": { "type": "array", "items": { "type": "object", "properties": { "designID": { "type": "string" }, "plasticCode": { "type": "string" } } } }, "DesignCreateUpdateRequest": { "type": "object", "properties": { "designID": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "imageURL": { "type": "string" }, "additionalAttributes": { "type": "object" } } }, "DesignDetails": { "type": "object", "properties": { "designID": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "imageURL": { "type": "string" }, "additionalAttributes": { "type": "object" } } }, "Policy": { "type": "object", "properties": { "policyID": { "type": "string" }, "applyOn": { "enum": [ "MATCH", "MISMATCH" ], "type": "string" }, "applicableFor": { "type": "object", "properties": { "productCode": { "type": "string" }, "plasticCode": { "type": "string" }, "bin": { "type": "string" }, "binRange": { "type": "string" }, "cardType": { "$ref": "#/components/schemas/cardType" }, "cardID": { "type": "string" }, "channelAttributes": { "type": "object" }, "connectorAttributes": { "type": "object" }, "cardStatus": { "$ref": "#/components/schemas/cardStatus" }, "posEntryMode": { "$ref": "#/components/schemas/POSEntryMode" }, "paymentType": { "$ref": "#/components/schemas/CardPaymentType" } } }, "expressionGroup": { "type": "object", "properties": { "operation": { "enum": [ "AND", "OR", "NOT" ], "type": "string" }, "expressionGroups": { "type": "array", "items": { "type": "object", "properties": { "expressionGroup": { "type": "object" }, "operation": { "enum": [ "AND", "OR", "NOT" ], "type": "string" } } } }, "expression": { "type": "string" } } }, "errorOnMatch": { "type": "object", "properties": { "errorType": { "type": "string" } } }, "errorOnMismatch": { "type": "object", "properties": { "errorType": { "type": "string" } } } } }, "cardVector": { "type": "object", "properties": { "type": { "enum": [ "CARD", "CRN", "CARD_ID" ], "type": "string" }, "value": { "type": "object", "properties": { "pan": { "type": "string" }, "cvv": { "type": "string" }, "expiry": { "$ref": "#/components/schemas/yearMonth" }, "cardID": { "type": "string" } } } }, "example": { "type": "CARD", "value": { "pan": "1234567890123456", "expiry": { "month": 2, "year": 2020 }, "cvv": "123" } } }, "yearMonth": { "type": "object", "properties": { "month": { "type": "number", "example": 2 }, "year": { "type": "number", "example": 2020 } } }, "orderStatus": { "enum": [ "ORDER_PLACED", "ORDER_FAILED", "ORDER_CANCELLED", "CARD_REQUEST_GENERATED", "EMBOSSING_FILE_GENERATED", "ORDER_COMPLETED" ], "type": "string" }, "cardStatus": { "enum": [ "ACTIVE", "INACTIVE", "DELETED" ], "type": "string" }, "errorCode": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "number" }, "message": { "type": "string" } }, "example": { "code": "INTERNAL_SERVER_ERROR", "message": "Unexpected error" } }, "basicCardView": { "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/Resource" }, "account": { "$ref": "#/components/schemas/account" }, "accountHolder": { "$ref": "#/components/schemas/accountHolder" }, "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" }, "cardStatus": { "$ref": "#/components/schemas/cardStatus" } } }, "transactionSearchResponse": { "type": "object", "properties": { "acquirerReferenceData": { "type": "string" }, "mcc": { "type": "integer" }, "network": { "type": "string" }, "mid": { "type": "string" }, "tid": { "type": "string" }, "merchantName": { "type": "string" }, "approvalCode": { "type": "string" }, "retrievalReferenceNumber": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "maskedPan": { "type": "string" }, "bin": { "type": "string" }, "ifi": { "type": "string" }, "amount": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "amount": { "type": "integer" }, "currencyCode": { "type": "string" } } }, "settlement": { "type": "object", "properties": { "amount": { "type": "integer" }, "currencyCode": { "type": "string" } } }, "billing": { "type": "object", "properties": { "amount": { "type": "integer" }, "currencyCode": { "type": "string" } } } } }, "clearanceAttributes": { "type": "object", "properties": { "messageSequenceNumber": { "type": "string" }, "mti": { "type": "string" }, "settlementDate": { "type": "string" }, "fileId": { "type": "string" }, "settlementCycle": { "type": "string" }, "reason": { "type": "string" }, "settlementIndicator": { "type": "string" }, "entryType": { "type": "string" }, "fees": { "type": "array", "items": { "type": "object", "properties": { "feeTypeCode": { "type": "string" }, "interchangeCategory": { "type": "string" }, "feeAmount": { "type": "string" }, "feeIndicator": { "type": "string" }, "feeCurrency": { "type": "string" } } } }, "netFeeAmount": { "type": "integer" }, "netFeeIndicator": { "type": "string" }, "netFeeCurrencyCode": { "type": "string" } } }, "paymentEngineAttributes": { "type": "object", "properties": { "paymentId": { "type": "string" }, "receiptId": { "type": "string" }, "paymentRequestId": { "type": "string" }, "paymentRequester": { "type": "string" }, "paymentAuthorizationSignatory": { "type": "string" }, "retrialCount": { "type": "number" } } } }, "example": { "acquirerReferenceData": "string", "mcc": 5812, "network": "SODEXO", "mid": "123456789101112", "tid": "87654321", "merchantName": "SaveCardReceiveMerchant", "approvalCode": "775663", "retrievalReferenceNumber": 136869, "type": "FIRST_PRESENTMENT", "status": "SUCCESS", "maskedPan": "637513-xxxxxx-7642", "bin": "637513", "ifi": "141617", "amount": { "transaction": { "amount": 1250, "currencyCode": "356" }, "settlement": { "amount": 1250, "currencyCode": "356" }, "billing": { "amount": 1250, "currencyCode": "356" } }, "clearanceAttributes": { "messageSequenceNumber": 8.765432100000014e+39, "mti": "0210", "settlementDate": "1560767890", "fileId": "SFBIFR0703201919001401", "settlementCycle": "01", "reason": "string", "settlementIndicator": "DEBIT", "entryType": "KNOWN_USER_ORPHAN_AUTH", "fees": [ { "feeTypeCode": "0001", "interchangeCategory": "1134", "feeAmount": "245", "feeIndicator": "C", "feeCurrency": "356" } ], "netFeeAmount": 0, "netFeeIndicator": "CREDIT", "netFeeCurrencyCode": "356" }, "paymentEngineAttributes": { "paymentId": "string", "receiptId": "string", "paymentRequestId": "string", "paymentRequester": "string", "paymentAuthorizationSignatory": "string", "retrialCount": "string" } } }, "expandedCardView": { "allOf": [ { "$ref": "#/components/schemas/basicCardView" }, { "type": "object", "properties": { "associatedAt": { "format": "date-time", "description": "date in UTC when request was activated.", "type": "string" }, "product": { "$ref": "#/components/schemas/ProductDetails" }, "design": { "$ref": "#/components/schemas/DesignDetails" }, "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" } } } } } ] }, "vendorDetails": { "type": "object", "properties": { "vendorName": { "enum": [ "DZ", "SESHAASAI", "FAO", "NA", "DEFAULT" ], "type": "string" } } }, "accountInformation": { "required": [ "accountId" ], "type": "object", "properties": { "accountHolderID": { "type": "string", "example": "accountholder:12345" }, "accountID": { "type": "string", "example": "account:12345" }, "accountAttributes": { "type": "object", "properties": { "target": { "enum": [ "WALLET", "ACCOUNT" ], "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:12345" }, "attributes": { "type": "object" }, "name": { "type": "string", "example": "Mr. X" } } }, "expandedSensitiveView": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/expandedCardView" }, { "type": "object", "properties": { "sensitiveCard": { "required": [ "payload", "serverPublicKey" ], "type": "object", "properties": { "type": { "enum": [ "ENCRYPTED" ], "type": "string" }, "value": { "type": "object", "properties": { "serverPublicKey": { "type": "string" }, "encryptedData": { "type": "string" } } } } } } } ] }, "associateCardRequest": { "required": [ "cardVector" ], "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/Resource" }, "cardVector": { "$ref": "#/components/schemas/cardVector" }, "cardStatus": { "$ref": "#/components/schemas/cardStatus" }, "view": { "$ref": "#/components/schemas/cardView" } }, "example": { "cardVector": { "type": "CARD_ID", "value": { "cardID": "Random GUID" } }, "cardStatus": "ACTIVE", "view": "BASIC" } }, "associateCardByIdentifierRequest": { "type": "object", "properties": { "formFactorProductID": { "description":"Unique identifier of the Form Factor Product.", }, "formFactorID": { "description":"Form Factor ID. Same as CardID and CGUID.", }, "targetURI": { "description":"Unique identifier of the account generated while issuing Bundle to Account Holder.", }, "status": { "description":"Current status of the Form Factor.", }, }, }, "updateCardByIdentifierRequest": { "required": [ "cardVector", "view" ], "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/Resource" }, "account": { "$ref": "#/components/schemas/account" }, "accountHolder": { "$ref": "#/components/schemas/accountHolder" }, "cardStatus": { "$ref": "#/components/schemas/cardStatus" }, "view": { "$ref": "#/components/schemas/cardView" } } }, "embossAndAssociateOrderRequest": { "required": [ "quantitiy", "orderID", "cardSkuID" ], "type": "object", "properties": { "orderID": { "type": "string" }, "cardSkuID": { "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" } } } } }, "OrderAndAssociateRequest": { "required": [ "resource", "order" ], "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/Resource" }, "account": { "$ref": "#/components/schemas/account" }, "accountHolder": { "$ref": "#/components/schemas/accountHolder" }, "order": { "$ref": "#/components/schemas/embossAndAssociateOrderRequest" }, "view": { "$ref": "#/components/schemas/cardView" }, "cardStatus": { "$ref": "#/components/schemas/cardStatus" } } }, "changePinByIdentifierRequest": { "required": [ "newPin", "oldPin" ], "type": "object", "properties": { "oldPin": { "description":"old Card PIN", "type": "string" }, "newPin": { "description":"New Card PIN", "type": "string" } }, "example": { "oldPin": "1234", "newPin": "1111" } }, "setPinByIdentifierRequest": { "required": [ "newPin", "nonce" ], "type": "object", "properties": { "newPin": { "description":"new PIN to be set for the card", "type": "string" }, "nonce": { "description":"Unix epoch time", "type": "integer" }, }, "example": { "newPin": "1111", "nonce" :1588261488 } }, "GeneratePinRequest": { "required": [ "deliveryChannel" ], "type": "object", "properties": { "deliveryChannel": { "description":"Channel where the newly generated PIN is sent.", "type": "string", "enum":["PHONE","EMAIL"], } }, "example": { "deliveryChannel": "PHONE" } }, "OrderRequest": { "type": "object", "properties": { "orderID": { "description": "Unique identifier for the order", "type": "string" }, "quantity": { "format": "int32", "description": "Number of cards to be ordered", "type": "number" }, "cardSkuID": { "description": "Unique identifier for card's configurational properties like card network, BIN, card-type, embossing vendor details.", "type": "string" }, "expiry": { "type":"integer", "description":"Expiration date for the card. The date will be set according to the format currentMonth + Month and current Year+Year." }, "thirdLineEmbossing": { "type": "string", "description":"Cardholder's name displayed on the card." }, "fourthLineEmbossing": { "type": "string", "description":"Additional cardholder details, like company name, displayed on the card." }, "deliveryAddress": { "description": "Address where the cards should be delivered to", "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" } } }, "tenantAttributes": { "description": "IFI related information", "type": "object", "properties": { "corporateName": { "type": "string" }, "corporateID": { "type": "string" }, "templateID": { "type": "string" } } }, "vendorAttributes": { "description": "Vendor related information like shipping partner, tracking ID, and welcome kit", "type": "object", "properties": { "consignmentID": { "type": "string" } } } } }, "Record": { "type": "object", "properties": { "recordID": { "type": "number" }, "deliveryAddress": { "description": "Address of the consignment recipient", "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" } } }, "tenantAttributes": { "description": "Attributes added by tenant for tagging", "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" } } }, "thirdLineEmbossing": { "type": "string" }, "fourthLineEmbossing": { "type": "string" } } }, "PersonalizedOrderPending": { "type": "object", "properties": { "quantity": { "format": "int32", "description": "Number of cards to be generated", "type": "number" }, "orderID": { "description": "Order identifier", "type": "string" }, "cardSkuID": { "description": "Identifier of Card SKU which represent product configuration", "type": "string" }, "expiry": { "$ref": "#/components/schemas/yearMonth" }, "orderStatus": { "enum": [ "ORDER_RECORDS_PENDING" ], "type": "string" }, "orderedAt": { "format": "date-time", "description": "date in UTC when card was requested/Order placed.", "type": "string" } } }, "LineFormat": { "type": "object", "properties": { "header": { "type": "string" }, "format": { "type": "string" } } }, "VendorRequest": { "type": "object", "properties": { "name": { "type": "string" }, "mode": { "type": "string" }, "notificationEndpoints": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "endpoint": { "type": "string" } } } }, "format": { "type": "array", "items": { "type": "object", "properties": { "fileType": { "enum": [ "EMBOSSING", "PIN" ], "type": "string" }, "fileNameFormat": { "$ref": "#/components/schemas/LineFormat" }, "header": { "$ref": "#/components/schemas/LineFormat" }, "row": { "$ref": "#/components/schemas/LineFormat" }, "trailer": { "$ref": "#/components/schemas/LineFormat" } } } }, "keyConfig": { "type": "object", "properties": { "zpkAlias": { "type": "string" }, "zmkAlias": { "type": "string" } } } } }, "Vendor": { "type": "object", "properties": { "vendorID": { "type": "string" }, "name": { "type": "string" }, "mode": { "type": "string" }, "notificationEndpoints": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "endpoint": { "type": "string" } } } }, "format": { "type": "array", "items": { "type": "object", "properties": { "fileType": { "enum": [ "EMBOSSING", "PIN" ], "type": "string" }, "fileName": { "$ref": "#/components/schemas/LineFormat" }, "header": { "$ref": "#/components/schemas/LineFormat" }, "row": { "$ref": "#/components/schemas/LineFormat" }, "footer": { "$ref": "#/components/schemas/LineFormat" }, "backupLocation": { "$ref": "#/components/schemas/LineFormat" }, "backupMode": { "enum": [ "S3", "SFTP" ], "type": "string" } } } }, "cardFeaturesSupported": { "type": "array", "items": { "$ref": "#/components/schemas/featureType" } }, "keyConfig": { "type": "object", "properties": { "zpkAlias": { "type": "string" }, "zmkAlias": { "type": "string" } } }, "designs": { "type": "array", "items": { "type": "object", "properties": { "designID": { "type": "string" }, "placticCode": { "type": "string" } } } } } }, "CardSKU": { "type": "object", "properties": { "cardSkuID": { "type": "string" }, "productID": { "type": "string" }, "designID": { "type": "string" }, "fileAttributes": { "type": "object", "properties": { "bankIdentifier": { "type": "string" } } }, "vendorID": { "type": "string" } } }, "MakePaymentRequest": { "type": "object", "properties": { "parentPaymentID": { "type": "string" }, "channel": { "$ref": "#/components/schemas/Channel" }, "network": { "type": "string" }, "cardVector": { "type": "object", "properties": { "pan": { "type": "string" }, "track2": { "type": "string" }, "cvv2": { "type": "string" }, "expiry": { "$ref": "#/components/schemas/yearMonth" }, "cardID": { "type": "string" }, "crn": { "type": "string" }, "pin": { "type": "string" } } }, "posEntryMode": { "$ref": "#/components/schemas/POSEntryMode" }, "financialImpact": { "$ref": "#/components/schemas/FinancialImpact" }, "paymentType": { "$ref": "#/components/schemas/CardPaymentType" }, "amount": { "type": "number", "example": 100 }, "currencyCode": { "enum": [ "INR" ], "type": "string" }, "connectorAttributes": { "type": "object" }, "settlementDate": { "format": "date", "type": "string" }, "settlementCycle": { "type": "string" }, "settlementImpact": { "enum": [ "DEBIT", "CREDIT", "NONE" ], "type": "string" } } }, "GetCardPaymentsRequest": { "required": [ "filters", "limit", "offset" ], "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "filters": { "type": "object", "allOf": [ { "type": "object", "properties": { "cardID": { "type": "string" }, "status": { "$ref": "#/components/schemas/CardPaymentStatus" }, "pan": { "type": "string" }, "crn": { "type": "string" }, "account": { "$ref": "#/components/schemas/account" }, "accountHolder": { "$ref": "#/components/schemas/accountHolder" }, "posEntryMode": { "$ref": "#/components/schemas/POSEntryMode" }, "paymentType": { "$ref": "#/components/schemas/CardPaymentType" }, "authorizationResponse": { "$ref": "#/components/schemas/CardAuthorizationResponse" }, "channelAttributes": { "type": "object" }, "connectorAttributes": { "type": "object" }, "fromAccount": { "$ref": "#/components/schemas/account" }, "toAccount": { "$ref": "#/components/schemas/account" }, "tenantResponse": { "$ref": "#/components/schemas/TenantPaymentResponse" }, "settlementDate": { "type": "string" }, "settlementCycle": { "type": "string" }, "financialImpact": { "$ref": "#/components/schemas/FinancialImpact" }, "settlementImpact": { "$ref": "#/components/schemas/settlementImpact" }, "startDate": { "format": "date", "type": "string" }, "network": { "type": "string" }, "endDate": { "format": "date", "type": "string" } } } ] } } }, "Channel": { "enum": [ "SUPER_CARD" ], "type": "string" }, "POSEntryMode": { "enum": [ "MAGSTRIPE_POS", "EMV_CONTACT_POS", "EMV_CONTACTLESS_POS", "MAGSTRIPE_ATM", "EMV_CONTACT_ATM", "EMV_CONTACTLESS_ATM", "MAGSTRIPE_FALLBACK", "ECOM", "CONTROL_CENTER" ], "type": "string" }, "CardPaymentType": { "enum": [ "PURCHASE_AUTHORIZATION", "MONEY_ADD_AUTHORIZATION", "PURCHASE_CLEARANCE", "MONEY_ADD_CLEARANCE", "PURCHASE_REVERSAL", "MONEY_ADD_REVERSAL", "TIP_AND_SURCHARGE", "PURCHASE_REFUND", "MONEY_ADD_REFUND" ], "type": "string" }, "CardPaymentStatus": { "enum": [ "PAYMENT_CAPTURED", "PAYMENT_AUTHORIZATION_REQUESTED", "PAYMENT_AUTHORIZATION_FAILED", "PAYMENT_AUTHORIZATION_RECEIVED", "PAYMENT_EFFECTED", "PAYMENT_REQUEST_FAILED", "PAYMENT_FAILED" ], "type": "string" }, "CardAuthorizationResponse": { "type": "object", "properties": { "status": { "enum": [ "SUCCESS", "INACTIVE_CARD", "DISABLED_CARD", "BLOCKED_CARD", "INCORRECT_PIN", "INCORRECT_CVV", "EXPIRED_CARD", "INCORRECT_EXPIRY", "PIN_BLOCKED" ], "type": "string" }, "attributes": { "type": "object" } } }, "FinancialImpact": { "enum": [ "DEBIT", "CREDIT" ], "type": "string" }, "CardPaymentSummary": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/Channel" }, "posEntryMode": { "$ref": "#/components/schemas/POSEntryMode" }, "paymentType": { "$ref": "#/components/schemas/CardPaymentType" }, "status": { "$ref": "#/components/schemas/CardPaymentStatus" }, "financialImpact": { "$ref": "#/components/schemas/FinancialImpact" }, "authorizationResponseStatus": { "$ref": "#/components/schemas/status" }, "tenantResponseStatus": { "$ref": "#/components/schemas/status1" }, "settlementDate": { "type": "string" }, "network": { "type": "string" }, "settlementCycle": { "type": "string" }, "settlementImpact": { "$ref": "#/components/schemas/settlementImpact" }, "amount": { "type": "number" } } }, "TenantPaymentResponse": { "type": "object", "properties": { "tenantTransactionID": { "type": "string" }, "status": { "type": "string" }, "attributes": { "type": "string" } } }, "CardPaymentView": { "type": "object", "properties": { "paymentID": { "type": "string" }, "parentPaymentID": { "type": "string" }, "card": { "$ref": "#/components/schemas/basicCardView" }, "channel": { "$ref": "#/components/schemas/Channel" }, "posEntryMode": { "$ref": "#/components/schemas/POSEntryMode" }, "financialImpact": { "$ref": "#/components/schemas/FinancialImpact" }, "paymentType": { "$ref": "#/components/schemas/CardPaymentType" }, "amount": { "type": "number", "example": 100 }, "currencyCode": { "enum": [ "INR" ], "type": "string" }, "status": { "$ref": "#/components/schemas/CardPaymentStatus" }, "authorizationResponse": { "$ref": "#/components/schemas/CardAuthorizationResponse" }, "channelAttributes": { "type": "object" }, "connectorAttributes": { "type": "object" }, "tenantResponse": { "$ref": "#/components/schemas/TenantPaymentResponse" }, "transactionDate": { "format": "date-time", "type": "string" }, "fromAccount": { "$ref": "#/components/schemas/account" }, "toAccount": { "$ref": "#/components/schemas/account" }, "settlementDate": { "format": "date", "type": "string" }, "settlementCycle": { "type": "string" }, "settlementImpact": { "enum": [ "DEBIT", "CREDIT", "NONE" ], "type": "string" } } }, "GetInventoryRequest": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "bin": { "type": "array", "items": { "type": "string" } }, "range": { "type": "array", "items": { "type": "string" } }, "productID": { "type": "array", "items": { "type": "string" } }, "cardSkuID": { "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "items": { "type": "string" } }, "cardFeatures": { "type": "array", "items": { "type": "string" } } } }, "groupBy": { "type": "array", "items": { "enum": [ "productID", "status" ], "type": "string" } } } }, "Inventory": { "type": "object", "properties": { "productID": { "enum": [ "id" ], "type": "string" }, "cardSkuID": { "enum": [ "id" ], "type": "string" }, "count": { "type": "number" } } }, "CreateInventoryConfigRequest": { "type": "object", "properties": { "productID": { "type": "string" }, "minimumAvailableCards": { "type": "number" }, "maximumAvailableCards": { "type": "number" }, "refillingRate": { "type": "object", "properties": { "count": { "type": "number" }, "unit": { "type": "string" } } } } }, "InventoryConfig": { "type": "object", "properties": { "inventoryConfigID": { "type": "string" }, "productID": { "type": "string" }, "bin": { "type": "string" }, "range": { "type": "string" }, "cardSkuID": { "type": "string" }, "minimumAvailableCards": { "type": "number" }, "maximumAvailableCards": { "type": "number" }, "refillingRate": { "type": "object", "properties": { "count": { "type": "number" }, "unit": { "type": "string" } } } } }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "InactiveCard": { "type": "object", "properties": { "message": { "type": "string", "example": "Card is inactive" }, "code": { "type": "string", "example": "INACTIVE_CARD" } } }, "DisabledCard": { "type": "object", "properties": { "message": { "type": "string", "example": "Card is disabled" }, "code": { "type": "string", "example": "DISABLED_CARD" } } }, "BlockedCard": { "type": "object", "properties": { "message": { "type": "string", "example": "Card is blocked" }, "code": { "type": "string", "example": "BLOCKED_CARD" } } }, "IncorrectCVV1": { "type": "object", "properties": { "message": { "type": "string", "example": "CVV1 is incorrect" }, "code": { "type": "string", "example": "INCORRECT_CVV1" } } }, "IncorrectCVV2": { "type": "object", "properties": { "message": { "type": "string", "example": "CVV2 is incorrect" }, "code": { "type": "string", "example": "INCORRECT_CVV2" } } }, "IncorrectiCVV": { "type": "object", "properties": { "message": { "type": "string", "example": "iCVV is incorrect" }, "code": { "type": "string", "example": "INCORRECT_ICVV" } } }, "IncorrectExpiry": { "type": "object", "properties": { "message": { "type": "string", "example": "Expiry is incorrect" }, "code": { "type": "string", "example": "INCORRECT_EXPIRY" } } }, "CardExpired": { "type": "object", "properties": { "message": { "type": "string", "example": "Card has expired" }, "code": { "type": "string", "example": "EXPIRED_CARD" } } }, "IncorrectPin": { "type": "object", "properties": { "message": { "type": "string", "example": "Invalid pin entered" }, "code": { "type": "string", "example": "INCORRECT_PIN" } } }, "InsufficientFunds": { "type": "object", "properties": { "message": { "type": "string", "example": "Insufficient balance to fulfill transaction" }, "code": { "type": "string", "example": "INSUFFICIENT_BALANCE" } } }, "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" } } }, "OperationNotPermitted": { "type": "object", "properties": { "code": { "type": "string", "example": "OPERATION_NOT_PERMITTED" }, "message": { "type": "string", "example": "Operation not permitted at current state" } } }, "UnprocessableEntity": { "type": "object", "properties": { "message": { "type": "string", "example": "Unprocessable entity" }, "code": { "type": "string", "example": "UNPROCESSABLE_ENTITY" } } }, "Order": { "title": "Order", "description": "", "type": "object", "properties": { "quantity": { "format": "int32", "type": "integer" }, "orderID": { "type": "string" }, "cardSkuID": { "type": "string" }, "plasticCode": { "type": "string" }, "expiry": { "type": "object", "properties": { "month": { "format": "int32", "type": "integer" }, "year": { "format": "int32", "type": "integer" } } }, "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" } } }, "tenantAttributes": { "type": "object", "properties": { "corporateName": { "type": "string" }, "corporateID": { "type": "string" }, "templateID": { "type": "string" } } }, "vendorAttributes": { "type": "object", "properties": { "consignmentID": { "type": "string" } } } }, }, "OrderRetreive": { "title": "OrderRetreive", "description": "", "type": "object", "properties": { "quantity": { "format": "int32", "type": "integer", "description":"" }, "orderID": { "type": "string", "description":"Unique identifier of the card order for which details are being retrieved." }, "cardSkuID": { "type": "string", "description":"Unique identifier for card's configurational properties like card network, BIN, card-type, embossing vendor details." }, "plasticCode": { "type": "string", "description":"Unique identifier for the program configured for card. In case of multiple benefit programs, each program is represented by a separate `plasticCode`." }, "expiry": { "description":"Expiration date for the card.", "type": "object", "properties": { "month": { "format": "int32", "type": "integer" }, "year": { "format": "int32", "type": "integer" } } }, "thirdLineEmbossing": { "description":"Cardholder's name displayed on the card.", "type": "string" }, "fourthLineEmbossing": { "description":"Additional cardholder details, like company name, displayed on the card.", "type": "string" }, "deliveryAddress": { "description":"Address where the card is delivered to.", "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" } } }, "tenantAttributes": { "description":"IFI related information.", "type": "object", "properties": { "templateID": { "type": "string" }, "corporateID": { "type": "string" }, "corporateName": { "type": "string" } } }, "vendorAttributes": { "description":"Vendor related information like shipping partner, tracking ID, and welcome kit.", "type": "object", "properties": { "consignmentID": { "type": "string" } } }, "additionalAttributes": { "description":"Additional information", "type": "object" }, "orderStatus": { "description":"Current status of the order. Allowed values: `ORDER_PLACED`, `CARD_REQUEST_GENERATED`, `EMBOSSING_FILE_GENERATED`, `ORDER_COMPLETED`, `ORDER_FAILED`, `ORDER_CANCELLED`", "type": "string" }, "orderedAt": { "description":"Timestamp of order placment in the ISO 8601 format YYYY-MM-DD'T'HH:MM:SS:sss'Z' ", "format": "date-time", "type": "string" } }, "example": { "quantity": 1, "orderID": "cardfarzan6u8kbm", "cardSkuID": "RUPAY_ABC_VBO_PHYSICAL", "plasticCode": "WHITEC", "expiry": { "month": 1, "year": 2023 }, "thirdLineEmbossing": "NA", "fourthLineEmbossing": "NA", "deliveryAddress": { "name": "DirectiPlex", "addressLine1": "Directiplex, Old Nagardas road", "addressLine2": "Andheri (East)", "addressLine3": "Mumbai", "addressLine4": "NA", "city": "Mumbai", "state": "Maharashtra", "country": "India", "postalCode": "400053", "contactNumber": "02228875511" }, "tenantAttributes": { "templateID": "", "corporateID": "", "corporateName": "" }, "vendorAttributes": { "consignmentID": "" }, "additionalAttributes": {}, "orderStatus": "CARD_REQUEST_GENERATED", "orderedAt": "2020-03-19T19:21:09.286Z" } }, "PersonlizedOrderRequest": { "title": "PersonlizedOrderRequest", "description": "", "type": "object", "properties": { "orderID": { "description": "Unique identifier for the order", "type": "string" }, "quantity": { "format": "int32", "type": "integer", "description": "Number of cards to be ordered", }, "cardSkuID": { "description": "Unique identifier for card's configurational properties like card network, BIN, card-type, embossing vendor details.", "type": "string" }, "plasticCode": { "description":"Unique identifier for the program configured for card. In case of multiple benefit programs, each program is represented by a separate `plasticCode`.", "type": "string" }, "records": { "description":"Array containing details for each card in the order.", "type": "array", "items": { "type": "object", "properties": { "recordID": { "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" } } }, "thirdLineEmbossing": { "type": "string" }, "fourthLineEmbossing": { "type": "string" }, "tenantAttributes": { "type": "object", "properties": { "super_card_id": { "type": "string" } } } } } } }, "example": { "orderID": "testOrder103", "quantity": 1, "cardSkuID": "RUPAY_ABC_VBO_PHYSICAL", "plasticCode": "WHITEC", "records": [ { "recordID": 1, "deliveryAddress": { "name": "Atash", "addressLine1": "Line1", "addressLine2": "Line2", "addressLine3": "Line3", "addressLine4": "Line4", "city": "Mumbai", "state": "Maharastra", "country": "India", "postalCode": "220022", "contactNumber": "8147832540" }, "thirdLineEmbossing": "John Doe", "fourthLineEmbossing": "New Test Corp", "tenantAttributes": { "super_card_id": "6" } } ] } }, "PersonalizedOrderReceived": { "title": "PersonalizedOrderReceived", "description": "", "type": "object", "properties": { "orderID": { "type": "string" }, "quantity": { "format": "int32", "type": "integer" }, "cardSkuID": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "recordID": { "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" } } }, "thirdLineEmbossing": { "type": "string" }, "fourthLineEmbossing": { "type": "string" }, "tenantAttributes": { "type": "object", "properties": { "super_card_id": { "type": "string" } } } } } } }, "example": { "orderID": "testOrder103", "quantity": 1, "cardSkuID": "RUPAY_ABC_VBO_PHYSICAL", "records": [ { "recordID": 1, "deliveryAddress": { "name": "Atash", "addressLine1": "Line1", "addressLine2": "Line2", "addressLine3": "Line3", "addressLine4": "Line4", "city": "Mumbai", "state": "Maharastra", "country": "India", "postalCode": "220022", "contactNumber": "8147832540" }, "thirdLineEmbossing": "John Doe", "fourthLineEmbossing": "New Test Corp", "tenantAttributes": { "super_card_id": "6" } } ] } }, "ReplacementOrderRequest": { "title": "ReplacementOrderRequest", "description": "", "type": "object", "properties": { "orderID": { "type": "string", "description":"Unique identifier for the new card order." }, "oldCardReferenceNumber": { "type": "string", "description":"CRN of the the card to be replaced." }, "expiry": { "description":"Expiration date for the card. The date will be set according to the formula currentMonth + Month and current Year+Year.If not specified, then month and year from the old card will be considered and expiration date will be calculated according to the aforementioned formula.", "type": "object", "properties": { "month": { "format": "int32", "type": "integer" }, "year": { "format": "int32", "type": "integer" } } }, "thirdLineEmbossing": { "description":"Cardholder's name displayed on the card. If not specified, the replacement card will be printed with the same data as the old card.", "type": "string" }, "fourthLineEmbossing": { "description":"Additional cardholder details, like company name, displayed on the card. If not specified, the replacement card will be printed with the same data as the old card.", "type": "string" }, "deliveryAddress": { "description":"Address where the replacement card should be delivered to. If not specified, the replacement card will be delivered to the same address as the old card.", "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" } } }, "tenantAttributes": { "description":"IFI related information that VBO wants to communicate to the vendor. If not specified, same data as the old card will be sent to the vendor.", "type": "object", "properties": { "corporateName": { "type": "string" }, "corporateID": { "type": "string" }, "templateID": { "type": "string" } } }, "vendorAttributes": { "description":"Vendor related information like shipping partner, tracking ID, and welcome kit. If not specified, same data as the old card will be sent to the vendor.", "type": "object", "properties": { "consignmentID": { "type": "string" } } } }, }, "ReplaceOrderResponse": { "title": "ReplaceOrderResponse", "description": "", "type": "object", "properties": { "quantity": { "format": "int32", "type": "integer" }, "orderID": { "type": "string" }, "cardSkuID": { "type": "string" }, "plasticCode": { "type": "string" }, "expiry": { "type": "object", "properties": { "month": { "format": "int32", "type": "integer" }, "year": { "format": "int32", "type": "integer" } } }, "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" } } }, "tenantAttributes": { "type": "object", "properties": { "templateID": { "type": "string" }, "corporateID": { "type": "string" }, "corporateName": { "type": "string" } } }, "vendorAttributes": { "type": "object", "properties": { "consignmentID": { "type": "string" } } }, "additionalAttributes": { "type": "object", "properties": { "oldCrn": { "type": "string" } } }, "orderStatus": { "type": "string" }, "orderedAt": { "format": "date-time", "type": "string" } }, }, "dispatchCardEmbossingRequest": { "title": "dispatchCardEmbossingRequest", "description": "", "type": "object", "properties": { "plasticCode": { "description":"Unique identifier for the program configured for card. In case of multiple benefit programs, each program is represented by a separate `plasticCode`.", "type": "string" }, "thirdLineEmbossing": { "description":"Cardholder's name displayed on the card.", "type": "string" }, "fourthLineEmbossing": { "description":"Additional cardholder details, like company name, displayed on the card.", "type": "string" }, "deliveryAddress": { "description":"Address where the card should be delivered to.", "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" } } }, "vendorAttributes": { "description":"Vendor related information like shipping partner, tracking ID, and welcome kit.", "type": "object", "properties": { "shipping-partner.name": { "type": "string" }, "shipping-partner.trackingNumber": { "type": "string" }, "welcome-kit.fullName": { "type": "string" }, "welcome-kit.qrCode": { "type": "string" }, "welcome-kit.templateID": { "type": "string" } } } }, }, "DispatchCardResponse": { "title": "DispatchCardResponse", "description": "", "type": "object", "properties": { "quantity": { "format": "int32", "type": "integer" }, "orderID": { "type": "string" }, "cardSkuID": { "type": "string" }, "plasticCode": { "type": "string" }, "expiry": { "type": "object", "properties": { "month": { "format": "int32", "type": "integer" }, "year": { "format": "int32", "type": "integer" } } }, "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" } } }, "tenantAttributes": { "type": "object" }, "vendorAttributes": { "type": "object", "properties": { "welcome-kit.qrCode": { "type": "string" }, "welcome-kit.fullName": { "type": "string" }, "shipping-partner.name": { "type": "string" }, "welcome-kit.templateID": { "type": "string" }, "shipping-partner.trackingNumber": { "type": "string" } } }, "additionalAttributes": { "type": "object" }, "orderStatus": { "type": "string" }, "orderedAt": { "format": "date-time", "type": "string" } }, "example": { "quantity": 1, "orderID": "b43f7dc8-c4fe-4518-836c-eab9e62d8d25", "cardSkuID": "RUPAY_ABC_VBO_PHYSICAL", "plasticCode": "WHITEC", "expiry": { "month": 0, "year": 10 }, "thirdLineEmbossing": "Rohit", "fourthLineEmbossing": "Tondo", "deliveryAddress": { "name": "Atash Shaikh", "addressLine1": "Directiplex", "addressLine2": "Near Andheri Subway", "addressLine3": "Old Nagardas Road", "addressLine4": "Andheri East", "city": "Mumbai", "state": "Maharashtra", "country": "India", "postalCode": "400069", "contactNumber": 919090909090 }, "tenantAttributes": {}, "vendorAttributes": { "welcome-kit.qrCode": "c48tn73793cfh93cg24c872t478r4ft3ubdcy8g3cr", "welcome-kit.fullName": "Rohit Tondon", "shipping-partner.name": "BLUEDART", "welcome-kit.templateID": "template-id", "shipping-partner.trackingNumber": "098137643242412312414" }, "additionalAttributes": {}, "orderStatus": "EMBOSSING_FILE_PENDING", "orderedAt": "2020-03-19T19:25:26.513Z" } }, "cardType": { "enum": [ "PHYSICAL", "VIRTUAL" ], "type": "string" }, "featureType": { "enum": [ "EMV", "MAG_STRIPE", "HYBRID", "NFC", "PHOTO_ID", "USE_ORIGINAL_CARD_EXPIRY" ], "type": "string" }, "settlementImpact": { "enum": [ "DEBIT", "CREDIT", "NONE" ], "type": "string" }, "status": { "enum": [ "SUCCESS", "INACTIVE_CARD", "DISABLED_CARD", "BLOCKED_CARD", "INCORRECT_PIN", "INCORRECT_CVV", "EXPIRED_CARD", "INCORRECT_EXPIRY", "PIN_BLOCKED" ], "type": "string" }, "status1": { "type": "string" }, "listCardsRequest": { "title": "listCardsRequest", "description": "", "type": "object", "properties": { "filters": { "type": "object", "properties": { "panSHA": { "description":"SHA256 value of the card number", "type": "string" }, "cardID": { "description":"Unique identifier of the card. ", "type": "string" }, "crn": { "description":"Card Reference Number", "type": "string" } } } }, "example": { "filters": { "panSHA": "op5ahh1bPVAY4i7j67CADA8uspWEvpIAO2Ht9hQtQUs=", "cardID": "ef8673dc-079b-4d88-8928-c471996e4e7b", "crn": "137798489315" } } }, "listcardbyorderresponse": { "title": "listCardByOrderResponse", "description": "", "type": "object", "properties": { "resource": { "description":"Resource details including Resource ID", "type": "object", "properties": { "uri": { "type": "string" }, "attributes": { "type": "object" } } }, "cardID": { "description":"Unique identifier of the card. Same as CGUID or Form Factor ID.", "type": "string" }, "crn": { "description":"Card Reference Number", "type": "string" }, "cardType": { "description":"Type of card ordered. Allowed values:PHYSICAL,VIRTUAL.", "type": "string" }, "maskedPan": { "description":"PAN number of the cardholder with middle 6 digits hidden for security.", "type": "string" }, "cardStatus": { "description":"Current status of the card.", "type": "string" }, "orderDetails": { "type": "object", "properties": { "orderID": { "description":"Unique identifier of the order for which cards are listed.", "type": "string" }, "cardSkuID": { "description":"Unique identifier for card's configurational properties like card network, BIN, card-type, embossing vendor details.", "type": "string" }, "cardSku": { "description":"Card SKU defines your card's basic attributes like card network, BIN, card-type, embossing vendor details, and so on.", "type": "object", "properties": { "cardSkuId": { "description":"Card SKU defines your card's basic attributes like card network, BIN, card-type, embossing vendor details, and so on.", "type": "string" }, "productID": { "description":"Product ID associated with the card.", "type": "string" }, "ifi": { "description":"Unique identifier of the IFI.", "type": "string" }, "bin": { "description":"Bank Identificatin Number. The leading 6-digits of the card number. The value is defined in Card SKU. ", "type": "string" }, "plasticCode": { "description":"Unique identifier for the program configured for card. In case of multiple benefit programs, each program is represented by a separate `plasticCode`.", "type": "string" }, "vendorID": { "description":"Unique identifier of the embossing vendor", "type": "string" }, "tags": { "description":"Type of Resource used for authenticating any financial or non-financial transactions.", "type": "array", "items": { "type": "string" } }, "range": { "description":"card BIN range.", "type": "string" } } }, "plasticCode": { "description":"Unique identifier for the program configured for card. In case of multiple benefit programs, each program is represented by a separate `plasticCode`.", "type": "string" }, "thirdLineEmbossing": { "description":"Cardholder's name displayed on the card.", "type": "string" }, "fourthLineEmbossing": { "description":"Additional cardholder details, like company name, displayed on the card.", "type": "string" }, "expiry": { "description":"Expiration date for the card.", "type": "object", "properties": { "month": { "type": "string" }, "year": { "type": "string" } } }, "deliveryAddress": { "description":"Address where the card is delivered to", "type": "object", "properties": { "country": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "contactNumber": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "state": { "type": "string" }, "addressLine4": { "type": "string" } } }, "tenantAttributes": { "description":"IFI related information", "type": "object" }, "orderStatus": { "description":"Current status of the order.", "type": "string" } } }, "tenantAttributes": { "description":"IFI related information.", "type": "object" }, "binRange": { "description":"The next 2 digits after BIN. Defines if the card is virtual or physical.", "type": "object", "properties": { "bin": { "type": "string" }, "range": { "type": "string" } } } }, "example": [ { "resource": { "uri": "resource://a8e27abb-3490-4b4b-9a5f-82de543f8b96", "attributes": {} }, "cardID": "f0c1bb24-d800-4024-bd34-67a61aaab588", "crn": "167635292871", "cardType": "PHYSICAL", "maskedPan": "123456-xxxxxx-1234", "cardStatus": "ENABLED", "orderDetails": { "orderID": "e8f6e34f-1deb-4e28-84ee-5c4d73dd7364", "cardSkuID": "RUPAY_ABC_VBO_PHYSICAL", "cardSku": { "cardSkuId": "RUPAY_ABC_VBO_PHYSICAL", "productID": "201383917079881", "ifi": "140827", "bin": "508645", "plasticCode": "WHITEC", "vendorID": "SESHAASAI_VBO_FAMPAY", "tags": [ "tag://VBO/4fa18593-d2d9-4bf3-bea7-7f6deb9f2ca4" ], "range": "32" }, "plasticCode": "WHITEC", "thirdLineEmbossing": "", "fourthLineEmbossing": "", "expiry": { "month": "2", "year": "30" }, "deliveryAddress": { "country": "IN", "city": "dkwkr", "postalCode": "400050", "contactNumber": "9867962795", "addressLine1": "Test Line 1", "addressLine2": "Test2", "addressLine3": "Test Line 3", "state": "dfejhr", "addressLine4": "Test2" }, "tenantAttributes": {}, "orderStatus": "CARD_DATA_GENERATED" }, "tenantAttributes": {}, "binRange": { "bin": "508645", "range": "32" } } ] }, } }, }

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.