{ "swagger": "2.0",
"host": "api.stagepreprod.zeta.in", "basePath": "/", "tags": [ { "name": "Disbursement APIs", "description": "Delivering enterprise payout solutions" } ],
"consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/optima/corporates/{corpId}/companies/{compId}/programs/{programId}/disbursements": { "post": { "tags": [ "Disbursement APIs" ],
"summary": "Create a Payout", "operationId": "OptimaCorporatesCompaniesProgramsProgramIdDisbursementsByCorpIdAndCompIdPost", "produces": [ "application/json" ], "parameters": [ { "name": "Body", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/DisbursementRequest" } },
{ "name": "Authorization", "in": "header", "required": true, "type": "string", "description": "A bearer token shared by Zeta" }, { "name": "corpId", "in": "path", "required": true, "type": "string", "description": "A unique corporate identifier assigned to the client" }, { "name": "compId", "in": "path", "required": true, "type": "string", "description": "A unique company identifier assigned to the client" }, { "name": "programId", "in": "path", "required": true, "type": "string", "description": "A unique program identifier assigned to the client" } ], "responses": { "200": { "description": "Successful transaction shows SUCCESS or PENDING or FAILED or MOVED_TO_ESCROW post Zeta authorization" } }, "x-unitTests": [], "x-operation-settings": { "CollectParameters": false, "AllowDynamicQueryParameters": false, "AllowDynamicFormParameters": false, "IsMultiContentStreaming": false } } }, "/zeta/hasUser": { "get": { "tags": [ "Disbursement APIs" ], "summary": "Check a Beneficiary or User Existence", "operationId": "ZetaHasUserGet", "produces": [ "application/json" ], "parameters": [
{ "name": "Authorization", "in": "header", "required": true, "type": "string", "description": "A bearer token shared by Zeta" },
{ "name": "identityType", "in": "query", "required": true, "type": "string", "description": "PHONE_NUMBER or EMAIL" or crn or cardID or employeeID" }, { "name": "identity", "in": "query", "required": true, "type": "string", "description": "Phone number or email ofor thecard user"ID or employee ID or customer reference number associated with the user" } ], "responses": { "200": { "description": "Successful transaction displays TRUE or FALSE post Zeta authorization" } }, "x-unitTests": [ { "request": { "method": "GET", "uri": "/zeta/hasUser?identity_type=EMAIL&identity=test@zeta.in" }, "expectedResponse": { "x-allowExtraHeaders": true, "x-bodyMatchMode": "NONE", "x-arrayOrderedMatching": false, "x-arrayCheckCount": false, "x-matchResponseSchema": true, "headers": {} }, "x-testShouldPass": true, "x-testEnabled": true, "x-testName": "hasUser" } ], "x-operation-settings": { "CollectParameters": false, "AllowDynamicQueryParameters": false, "AllowDynamicFormParameters": false, "IsMultiContentStreaming": false } } } }, "definitions": { "DisbursementRequest": { "title": "disbursementRequest", "example": { "requestID": "requestId-test-4-9", "type": "to_wallet", "value": { "amount": in paise, "currency": "INR" }, "beneficiary": { "id": "beneficiary ID", "name": "beneficiary name", "email": "beneficiary email", "phoneNumber": "beneficiary phone number", "crn": "customer reference number", "cardID": "Card ID of the user", "panemployeeID": "beneficiary panemployee numberID", "aadhar"pan": "beneficiary aadharpan number" }, "description": "test payout", "scheduledAt": "now", "attributes": { "age": 10 } }, "type": "object", "properties": { "requestID": { "description": "", "example": "requestId-test-4-9", "type": "string" }, "type": { "description": "", "example": "to_wallet", "type": "string" }, "value": { "$ref": "#/definitions/Value" }, "beneficiary": { "$ref": "#/definitions/Beneficiary" }, "description": { "description": "", "example": "test payout", "type": "string" }, "scheduledAt": { "description": "", "example": "now", "type": "string" }, "attributes": { "$ref": "#/definitions/Attributes" } }, "required": [ "requestID", "type", "value", "beneficiary", "description", "scheduledAt", "attributes" ] }, "Value": { "title": "Value", "example": { "amount": 10000, "currency": "INR" }, "type": "object", "properties": { "amount": { "description": "", "example": 10000, "type": "integer", "format": "int32" }, "currency": { "description": "", "example": "INR", "type": "string" } }, "required": [ "amount", "currency" ] }, "Beneficiary": { "title": "Beneficiary", "example": { "id": "beneficiary ID", "name": "beneficiary name", "email": "", "phoneNumber": "beneficiary phone number", "pan"crn": "beneficiary namecustomer PANreference number", "cardID": "beneficiary Card ID", "employeeID": "beneficiary employee ID", "aadharpan": "beneficiary aadharPAN number" }, "type": "object", "properties": { "id": { "description": "", "example": "test-13", "type": "string" }, "name": { "description": "", "example": "Virat Kohli", "type": "string" }, "email": { "description": "", "type": "string" }, "phoneNumber": { "description": "", "example": "9999999999", "type": "string" }, "crn": { "description": "", "example": "4576932", "type": "string" }, "pan"cardID": { "description": "", "example": "zyej1234", "type": "string" }, "employeeID": { "description": "", "example": "IPTPT88N87emp101", "type": "string" }, "aadhar"pan": { "description": "", "example": "IPTPT88N87", "type": "string" } }, "required": [ "id", "name", "email", "phoneNumber", "crn", "pan"cardID", "employeeID", "aadhar"
]
"pan" ] }, "Attributes": { "title": "Attributes", "example": { "age": 10 }, "type": "object", "properties": { "age": { "description": "", "example": 10, "type": "integer", "format": "int32" } }, "required": [ "age" ] } } } |