{
"openapi": "3.0.1",
"info": {
"version": "",
"title": ""
},
"tags": [
{
"name": "Beneficiary"
},
{
"name": "Beneficiary Account"
},
{
"name": "Beneficiary Transfers"
}
],
"paths": {
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaries": {
"post": {
"tags": [
"Beneficiary"
],
"summary": "Create Beneficiary for RAH",
"description": "Create a Beneficiary for a Real Account Holder (RAH). Response returns a unique `requestID` for the request and `id` for the Beneficiary. </br></br><i>Important: </i> Do not call the API multiple times for the same Beneficiary. Each request creates a new Beneficiary.",
"operationId": "createBeneficiary",
"parameters": [
{
"in": "path",
"name": "ifiID",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 14082,
"type": "integer"
}
},
{
"in": "path",
"name": "individualID",
"description": "ID of the Account Holder for whom the Beneficiary is created. Same as `accountHolderID`.",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/AddBeneficiaryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/AddBeneficiaryResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Beneficiary"
],
"summary": "Get all Beneficiaries for RAH",
"description": "Get the details of all the Beneficiaries added for a Real Account Holder(RAH). The response returns an array, with each Beneficiary identified by unique `id` respectively.",
"operationId": "getBeneficiaries",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI.",
"in": "path",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"in": "path",
"name": "individualID",
"description": "ID of the Account Holder whose Beneficiaries are retrieved. Same as `accountHolderID`.",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllBeneficiariesResponse"
}
}
}
}
}
}
}
},
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaries/{beneficiaryID}": {
"get": {
"tags": [
"Beneficiary"
],
"summary": "Get Beneficiary by ID",
"description": "Get details of a particular Beneficiary for a Real Account Holder (RAH) .",
"operationId": "getBeneficiary",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder whose Beneficiary details are retrieved. Same as `accountHolderID`.",
"required": true,
"schema": {
"type": "string",
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary whose details are retrieved.",
"required": true,
"schema": {
"type": "string",
"example": "d64cec61-838b-410f-9b8b-5f8a32b444d1"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetBeneficiaryByIDResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Beneficiary"
],
"summary": "Update Beneficiary by ID",
"description": "Update details of a particular Beneficiary for an Account Holder. You can change Beneficiary's personal details, enable or disable status, change the Beneficiary type, and so on. ",
"operationId": "updateBeneficiary",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder whose Beneficiary details are updated. Same as `accountHolderID`.",
"required": true,
"schema": {
"example": "ebc49dda-f664-4280-9bb7-52e62a379a26",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary whose details are updated.",
"required": true,
"schema": {
"example": "f8f77c78-1053-4bf4-9a6c-1a03a78d739a",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/UpdateBeneficiaryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/UpdateBeneficiaryResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Beneficiary"
],
"summary": "Delete Beneficiary by ID",
"description": "Delete a particular Beneficiary for a Real Account Holder (RAH).</br></br><i>Important:</i> Deleting a Beneficiary is is irreversible and hence proceed with caution.",
"operationId": "deleteBeneficiary",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder whose Beneficiary is deleted. Same as `accountHolderID`.",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary being deleted.",
"required": true,
"schema": {
"example": "31f3ee14-dbcc-42ca-9f5b-c9fd469fe9f7",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/deleteBeneficiaryResponse"
}
}
}
}
}
}
},
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaries/{beneficiaryID}/accounts": {
"post": {
"tags": [
"Beneficiary Account"
],
"summary": "Add Beneficiary Account",
"description": "Add an Account for a Beneficiary. The Account is where the Account Holder transfers funds to. You can create multiple Accounts for a Beneficiary.</br></br><i>Note</i>: Before adding an Account, create Beneficiary using the `/beneficiaries` API.</br><i>Important</i>: Do not call the API multiple times for the same Beneficiary Account. Each request creates a new Account.",
"operationId": "addBeneficiaryAccount",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID`.",
"in": "path",
"required": true,
"schema": {
"example": "ebc49dda-f664-4280-9bb7-52e62a379a26",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary for whom the Account is added.",
"required": true,
"schema": {
"example": "f8f77c78-1053-4bf4-9a6c-1a03a78d739a",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/AddAccountToBeneficiaryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/AddAccountToBeneficiaryResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Beneficiary Account"
],
"summary": "Get all Accounts for Beneficiary",
"description": "Get the details of all the Accounts added for a Beneficiary. The response returns an array, with each Beneficiary Account identified by a unique `id`.",
"operationId": "getBeneficiaryAccounts",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID`.",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary for whom Account details are retrieved.",
"required": true,
"schema": {
"example": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetAllBeneficiaryAccountsResponse"
}
}
}
}
}
}
},
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaries/{beneficiaryID}/accounts/{beneficiaryAccountID}": {
"get": {
"tags": [
"Beneficiary Account"
],
"summary": "Get Beneficiary Account by Account ID",
"description": "Get the details of a particular Account added for a Beneficiary.",
"operationId": "getBeneficiaryAccount",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID`.",
"in": "path",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary whose Account details are retrieved.",
"required": true,
"schema": {
"example": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"type": "string"
}
},
{
"name": "beneficiaryAccountID",
"in": "path",
"description": "ID of the Beneficiary Account being retrieved.",
"required": true,
"schema": {
"example": "138a76aa-47fe-4e06-9c1a-31dee7bc35c9",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/AddAccountToBeneficiaryResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Beneficiary Account"
],
"summary": "Update Beneficiary Account by Account ID",
"description": "Update details of a particular Account for a Beneficiary. You can update verification status, parent Beneficiary ID, mark the Account as default, and so on.",
"operationId": "updateBeneficiaryAccount",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID`.",
"in": "path",
"required": true,
"schema": {
"example": "ebc49dda-f664-4280-9bb7-52e62a379a26",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary whose Account details are updated.",
"required": true,
"schema": {
"example": "f8f77c78-1053-4bf4-9a6c-1a03a78d739a",
"type": "string"
}
},
{
"name": "beneficiaryAccountID",
"in": "path",
"description": "ID of the Beneficiary Account being updated.",
"required": true,
"schema": {
"example": "41c02be5-60ec-4439-afb2-310948e89707",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/UpdatedBeneficiaryAccountRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/UpdatedBeneficiaryAccountResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Beneficiary Account"
],
"summary": "Delete Beneficiary Account by Account ID",
"description": "Delete a particular Account for a Beneficiary.</br></br><i>Important:</i> Deleting a Beneficiary Account is is an irreversible action and hence proceed with caution.",
"operationId": "deleteBeneficiaryAccount",
"parameters": [
{
"name": "ifiID",
"description": "ID of the IFI.",
"in": "path",
"required": true,
"schema": {
"example": 140827,
"type": "integer"
}
},
{
"name": "individualID",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID`.",
"in": "path",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary whose Account is deleted.",
"required": true,
"schema": {
"example": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"type": "string"
}
},
{
"name": "beneficiaryAccountID",
"in": "path",
"description": "ID of the Beneficiary Account being deleted.",
"required": true,
"schema": {
"example": "972f7cc2-cbe3-4974-ab3b-8b5d63e2c2d7",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/deleteBeneficiaryAccountResponse"
}
}
}
}
}
}
},
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaries/{beneficiaryID}/transfers": {
"post": {
"tags": [
"Beneficiary Transfers"
],
"summary": "Transfer funds to default Beneficiary Account",
"description": "If the Account Holder has marked any of Beneficiary's Accounts as default, this API will transfer funds to that Account automatically.</br></br><i>Note: </i>Fusion supports IMPS, NEFT, and UPI fund transfer modes. Each mode is identified by a unique `transactionCode`. Contact <a href='mailto:fusion-support@zeta.tech'>Zeta</a> to get the transaction code for your transfer mode.",
"operationId": "transferToDefaultBeneficiaryAccountUsingPOST",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"example": 140827
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder who is transferring the funds. Same as `accountHolderID` and `debitAccountHolderID`.",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the beneficiary to whom the funds are transferred.",
"required": true,
"schema": {
"type": "string",
"example": "cefaf90f-066c-4fc2-a181-93cccc24184b"
}
}
],
"requestBody": {
"description": "request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferDefaultRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BeneficiaryTransactionResponse"
}
}
}
}
},
"deprecated": true,
"x-codegen-request-body-name": "request"
}
},
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaries/{beneficiaryID}/accounts/{accountID}/transfers": {
"post": {
"tags": [
"Beneficiary Transfers"
],
"summary": "Transfer Funds by Beneficiary Account ID",
"description": "Transfer funds to a particular Beneficiary Account. Response returns unique identifiers `requestID` and `transactionID` for each transfer. </br></br><i>Note: </i>Fusion supports IMPS, NEFT, and UPI fund transfer modes. Each mode is identified by a unique `transactionCode`. Contact <a href='mailto:fusion-support@zeta.tech'>Zeta</a> to get the transaction code for your transfer mode.",
"operationId": "transferToBeneficiaryAccount",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer",
"format": "int64"
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder who is transferring the funds. Same as `accountHolderID` and `debitAccountHolderID`.",
"required": true,
"schema": {
"example": "ebc49dda-f664-4280-9bb7-52e62a379a26",
"type": "string"
}
},
{
"name": "beneficiaryID",
"in": "path",
"description": "ID of the Beneficiary to whom funds are transferred.",
"required": true,
"schema": {
"example": "f8f77c78-1053-4bf4-9a6c-1a03a78d739a",
"type": "string"
}
},
{
"name": "accountID",
"in": "path",
"description": "ID of the Beneficiary Account to which the funds are transferred.",
"required": true,
"schema": {
"example": "41c02be5-60ec-4439-afb2-310948e89707",
"type": "string"
}
}
],
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BeneficiaryAccountTransferRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BeneficiaryTransactionResponse"
}
}
}
}
}
}
},
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaryTransfers": {
"get": {
"tags": [
"Beneficiary Transfers"
],
"summary": "Get all Beneficiary transfers for Account Holder",
"description": "Get the details of all the Beneficiary transfers for an Account Holder. The response returns an array, with each transfer identified by a unique `id`.</br></br><i>Note: </i>Use the `pageSize` and `pageNumber` query parameters for a paginated view.",
"operationId": "getAllBeneficiaryTransfers",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer",
"format": "int64"
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder whose Beneficiary fund transfer details are retrieved. Same as `accountHolderID`.",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Maximum number of results to be returned per request.",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"example": 13
}
},
{
"name": "pageNumber",
"description": "Index of the page requested.",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"example": 1
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GetBeneficiaryTransactionListResponse"
}
}
}
}
}
}
},
"/api/v1/ifi/{ifiID}/individuals/{individualID}/beneficiaryTransfers/{transferID}": {
"get": {
"tags": [
"Beneficiary Transfers"
],
"summary": "Get beneficiary transfer by ID",
"description": "Get the details of a particular Beneficiary transfer for an Account Holder.",
"operationId": "getBeneficiaryTransferByID",
"parameters": [
{
"name": "ifiID",
"in": "path",
"description": "ID of the IFI.",
"required": true,
"schema": {
"example": 140827,
"type": "integer",
"format": "int64"
}
},
{
"name": "individualID",
"in": "path",
"description": "ID of the Account Holder whose Beneficiary fund transfer details are retrieved. Same as `accountHolderID`.",
"required": true,
"schema": {
"example": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"type": "string"
}
},
{
"name": "transferID",
"description": "ID of the Beneficiary fund transfer. Same as `transactionID`.",
"in": "path",
"required": true,
"schema": {
"example": "299397001183",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BeneficiaryTransferByIDResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Vector": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"verified": {
"type": "boolean"
}
}
},
"AddAccountToBeneficiaryRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"isVerified": {
"type": "boolean",
"description": "Specify if the Beneficiary's Vectors are verified or not."
},
"status": {
"type": "string",
"description": "Operational status of the Account. Example: ENABLED, DISABLED."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary for whom the Account is added."
},
"parentAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID` and `individualID`."
},
"nickname": {
"type": "string",
"description": "Short title or description to identify the Account."
},
"type": {
"type": "string"
},
"accountInfo": {
"$ref": "#/components/schemas/BeneficiaryAccountInfo"
},
"isDefault": {
"description": "Specify if this Account should be the default Account for Beneficiary. If set to `true`, funds will be transferred to this Account when <i>Transfer Funds to default Beneficiary Account </i> API is used.",
"type": "boolean"
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the Beneficiary Account.",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"ifiID": 140827,
"isVerified": true,
"status": "ENABLED",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"parentAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"nickname": "New Beneficiary Account",
"type": "ZETA",
"accountInfo": {
"accountNumber": "f35f88dd-481c-4b0f-84b5-8be991c008ae",
"accountProvider": "fampay",
"nameAtAccountProvider": "140827",
"routingCode": "internal",
"accountType": "SAVINGS",
"attributes": {
"additionalProp1": "M G Road",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"isDefault": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
},
"AddAccountToBeneficiaryResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the Beneficiary Account."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"isVerified": {
"type": "boolean",
"description": "Denotes if the Beneficiary's Vectors are verified or not."
},
"status": {
"type": "string",
"description": "Operational status of the Account. Example: ENABLED, DISABLED."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary for whom the Account is added."
},
"parentAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID` and `individualID`."
},
"nickname": {
"type": "string",
"description": "Short title or description to identify the Account."
},
"type": {
"type": "string"
},
"accountInfo": {
"$ref": "#/components/schemas/BeneficiaryAccountInfo"
},
"isDefault": {
"type": "boolean",
"description": " Denotes if this Account is the default Account for the Beneficiary. If `true`, funds are transferred to this Account when <i>Transfer funds to default Beneficiary Account </i> API is used."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the Beneficiary Account.",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary Account is created."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary Account is updated."
}
},
"example": {
"id": "fdcfb2dc-9cb9-4a76-99d9-41187907d8f8",
"ifiID": 140827,
"isVerified": true,
"status": "ENABLED",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"parentAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"nickname": "New Beneficiary Account",
"type": "ZETA",
"accountInfo": {
"accountNumber": "f35f88dd-481c-4b0f-84b5-8be991c008ae",
"accountProvider": "fampay",
"nameAtAccountProvider": "140827",
"routingCode": "internal",
"accountType": "SAVINGS",
"attributes": {
"additionalProp1": "M G Road",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"isDefault": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"createdAt": "Jul 27, 2020 3:55:26 PM",
"updatedAt": "Jul 27, 2020 3:55:26 PM",
"headers": {}
}
},
"GetAllBeneficiariesResponse": {
"type": "object",
"properties": {
"beneficiaryList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BeneficiaryListResponse"
}
},
"totalElements": {
"description": "Total number of entries in the array.",
"type": "integer",
"format": "int64"
}
},
"example": {
"beneficiaryList": [
{
"requestID": "FUSION-140827-8d3f52a6-c546-40bd-b810-e610b26ec1d7-1595597219905",
"id": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"ifiID": 140827,
"accountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"salutation": "Ms",
"firstName": "Jane",
"middleName": "Mary",
"lastName": "Doe",
"gender": "Female",
"profilePicURL": "https://s3.amazonaws.com/uifaces/faces/twitter/darylws/77628.jpg",
"relationship": "Sister",
"status": "ENABLED",
"type": "REAL",
"vectors": [
{
"id": "02c75dfb-9de1-41f5-ab19-a383652fc2d2",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"type": "p",
"value": "+919945643114"
}
],
"customFields": {},
"createdAt": "Jul 24, 2020 1:27:00 PM",
"updatedAt": "Jul 24, 2020 1:27:00 PM",
"headers": {}
},
{
"requestID": "FUSION-140827-8d3f52a6-c546-40bd-b810-e610b26ec1d7-1595599552814",
"id": "60b532e6-487a-414c-8eb1-48519c78710c",
"ifiID": 140827,
"accountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"salutation": "Mr",
"firstName": "Bill",
"middleName": "",
"lastName": "Johnson",
"gender": "Male",
"profilePicURL": "https://s3.amazonaws.com/uifaces/faces/twitter/darylws/77628.jpg",
"relationship": "Friend",
"status": "ENABLED",
"type": "REAL",
"vectors": [
{
"id": "e13f1b75-6c8a-4693-8d66-6d534846ffd2",
"beneficiaryID": "60b532e6-487a-414c-8eb1-48519c78710c",
"type": "p",
"value": "+918745675859"
}
],
"customFields": {},
"createdAt": "Jul 24, 2020 2:05:52 PM",
"updatedAt": "Jul 24, 2020 2:05:52 PM",
"headers": {}
}
],
"totalElements": 2,
"headers": {}
}
},
"GetBeneficiaryByIDResponse": {
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "ID generated for the request."
},
"id": {
"type": "string",
"description": "ID generated for the Beneficiary. Same as `BeneficiaryID`."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"accountHolderID": {
"type": "string",
"description": "ID of the Account Holder for whom the Beneficiaries are retrieved. Same as `individualID`."
},
"salutation": {
"type": "string",
"description": "Salutation using which the Beneficiary is addressed. Example: Mr., Mrs., Ms."
},
"firstName": {
"type": "string",
"description": "Beneficiary's first name."
},
"middleName": {
"type": "string",
"description": "Beneficiary's middle name."
},
"lastName": {
"type": "string",
"description": "Beneficiary's last name."
},
"gender": {
"type": "string",
"description": "Beneficiary's gender. Example: male, female."
},
"profilePicURL": {
"type": "string",
"description": "Link to Beneficiary’s profile image."
},
"relationship": {
"type": "string",
"description": "Beneficiary's relationship with the Account Holder. Example: sister, friend, colleague."
},
"status": {
"type": "string",
"description": "Beneficiary's operational status. Example: ENABLED, DISABLED."
},
"type": {
"type": "string",
"description": "Beneficiary type.",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"description": "Vectors are unique identifiers used to identify the Beneficiary. Example: phone, email.",
"type": "array",
"items": {
"properties": {
"id": {
"type": "string"
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary."
},
"type": {
"type": "string",
"description": "Vector type. phone is identified as `p`, email is identified as `e`."
},
"value": {
"type": "string",
"description": "Value of the Vector based on the Vector `type`. Example: If Vector type is phone (`p`), Beneficiary's phone number is returned."
}
}
}
},
"customFields": {
"type": "object",
"description": "Custom parameters passed for the Beneficiary.",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is created."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is updated."
}
},
"example": {
"requestID": "FUSION-140827-8d3f52a6-c546-40bd-b810-e610b26ec1d7-1595597219905",
"id": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"ifiID": 140827,
"accountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"salutation": "Mr",
"firstName": "Bill",
"middleName": "Murray",
"lastName": "Johnson",
"gender": "Male",
"profilePicURL": "https://s3.amazonaws.com/uifaces/faces/twitter/darylws/77628.jpg",
"relationship": "Father",
"status": "ENABLED",
"type": "REAL",
"vectors": [
{
"id": "02c75dfb-9de1-41f5-ab19-a383652fc2d2",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"type": "p",
"value": "+919945643114"
}
],
"customFields": {},
"createdAt": "Jul 24, 2020 1:27:00 PM",
"updatedAt": "Jul 27, 2020 2:58:22 PM",
"headers": {}
}
},
"BeneficiaryListResponse": {
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "ID generated for the request."
},
"id": {
"type": "string",
"description": "ID generated for the Beneficiary. Same as `BeneficiaryID`."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"accountHolderID": {
"type": "string",
"description": "ID of the Account Holder for whom the Beneficiaries are retrieved. Same as `individualID`."
},
"salutation": {
"type": "string",
"description": "Salutation using which the Beneficiary is addressed. Example: Mr., Mrs., Ms."
},
"firstName": {
"type": "string",
"description": "Beneficiary's first name."
},
"middleName": {
"type": "string",
"description": "Beneficiary's middle name."
},
"lastName": {
"type": "string",
"description": "Beneficiary's last name."
},
"gender": {
"type": "string",
"description": "Beneficiary's gender. Example: male, female."
},
"profilePicURL": {
"type": "string",
"description": "Link to Beneficiary’s profile image."
},
"relationship": {
"type": "string",
"description": "Beneficiary's relationship with the Account Holder. Example: sister, friend, colleague."
},
"status": {
"type": "string",
"description": "Beneficiary's operational status. Example: ENABLED, DISABLED."
},
"type": {
"type": "string",
"description": "Beneficiary type.",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"description": "Vectors are unique identifiers used to identify the Beneficiary. Example: phone, email.",
"type": "array",
"items": {
"properties": {
"id": {
"type": "string"
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary."
},
"type": {
"type": "string",
"description": "Vector type. phone is identified as `p`, email is identified as `e`."
},
"value": {
"type": "string",
"description": "Value of the Vector based on the Vector `type`. Example: If Vector type is phone (`p`), Beneficiary's phone number is returned."
}
}
}
},
"customFields": {
"type": "object",
"description": "Custom parameters passed for the Beneficiary.",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is created."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is updated."
}
}
},
"AddBeneficiaryRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"individualID": {
"type": "string",
"description": "ID of the Account Holder for whom the Beneficiary is created. Same as `accountHolderID`."
},
"salutation": {
"type": "string",
"description": "Salutation using which the Beneficiary is addressed. Example: Mr., Mrs., Ms."
},
"firstName": {
"type": "string",
"description": "Beneficiary's first name."
},
"middleName": {
"type": "string",
"description": "Beneficiary's middle name."
},
"lastName": {
"type": "string",
"description": "Beneficiary's last name."
},
"gender": {
"type": "string",
"description": "Beneficiary's gender. Example: male, female."
},
"relationship": {
"type": "string",
"description": "Beneficiary's relationship with the Account Holder. Example: sister, friend, colleague."
},
"profilePicURL": {
"type": "string",
"description": "Link to Beneficiary’s profile image."
},
"dob": {
"type": "string",
"format": "date",
"description": "Beneficiary's date of birth."
},
"type": {
"type": "string",
"description": "Type of Beneficiary being created.",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"description": "Vectors are unique identifiers used to identify the Beneficiary. Example: phone, email.",
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BeneficiaryVector"
}
}
},
"customFields": {
"type": "object",
"description": "Custom parameters passed for the Beneficiary.",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"ifiID": 140827,
"individualID": "be118eb4-4519-4bd5-9a7f-aa8fe8b2ffc4",
"salutation": "Mr",
"firstName": "Bill",
"middleName": "",
"lastName": "Johnson",
"gender": "Male",
"relationship": "Friend",
"profilePicURL": "https://s3.amazonaws.com/uifaces/faces/twitter/darylws/77628.jpg",
"type": "REAL",
"vectors": [
{
"type": "p",
"value": "+918745675859",
"attributes": {}
}
],
"customFields": {}
}
},
"AddBeneficiaryResponse": {
"title": "",
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "ID generated for the request."
},
"id": {
"type": "string",
"description": "ID generated for the Beneficiary. Same as `BeneficiaryID`."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"accountHolderID": {
"type": "string",
"description": "ID of the Account Holder for whom the Beneficiary is created. Same as `individualID`."
},
"salutation": {
"type": "string",
"description": "Salutation using which the Beneficiary is addressed. Example: Mr., Mrs., Ms."
},
"firstName": {
"type": "string",
"description": "Beneficiary's first name."
},
"middleName": {
"type": "string",
"description": "Beneficiary's middle name."
},
"lastName": {
"type": "string",
"description": "Beneficiary's last name."
},
"gender": {
"type": "string",
"description": "Beneficiary's gender. Example: male, female."
},
"profilePicURL": {
"type": "string",
"description": "Link to Beneficiary’s profile image."
},
"relationship": {
"type": "string",
"description": "Beneficiary's relationship with the Account Holder. Example: sister, friend, colleague."
},
"status": {
"type": "string",
"description": "Beneficiary's operational status. Example: ENABLED, DISABLED."
},
"type": {
"type": "string",
"description": "Type of Beneficiary being created.",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"description": "Vectors are unique identifiers used to identify the Beneficiary. Example: phone, email.",
"type": "array",
"items": {
"properties": {
"id": {
"type": "string"
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary to whom the Vector is mapped."
},
"type": {
"type": "string",
"description": "Vector type. phone is identified by `p`, email is identified by `e`."
},
"value": {
"type": "string",
"description": "Value of the Vector based on the Vector `type`. Example: If Vector type is phone (`p`), Beneficiary's phone number is returned."
}
}
}
},
"customFields": {
"type": "object",
"description": "Custom parameters passed for the Beneficiary.",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is created."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is updated."
}
},
"example": {
"requestID": "FUSION-140827-be118eb4-4519-4bd5-9a7f-aa8fe8b2ffc4-1595857397783",
"id": "bf2f7acf-ccab-42bb-8d21-70a2a0a435e1",
"ifiID": 140827,
"accountHolderID": "be118eb4-4519-4bd5-9a7f-aa8fe8b2ffc4",
"salutation": "Mr",
"firstName": "Bill",
"middleName": "",
"lastName": "Johnson",
"gender": "Male",
"profilePicURL": "https://s3.amazonaws.com/uifaces/faces/twitter/darylws/77628.jpg",
"relationship": "Friend",
"status": "ENABLED",
"type": "REAL",
"vectors": [
{
"id": "b31decd3-6b86-407b-b7e1-d2f1edfc1012",
"beneficiaryID": "bf2f7acf-ccab-42bb-8d21-70a2a0a435e1",
"type": "p",
"value": "+918745675859"
}
],
"customFields": {},
"createdAt": "Jul 27, 2020 1:43:17 PM",
"updatedAt": "Jul 27, 2020 1:43:17 PM",
"headers": {}
}
},
"UpdateBeneficiaryRequest": {
"type": "object",
"properties": {
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"individualID": {
"type": "string",
"description": "ID of the Account Holder whose Beneficiary details are updated. Same as `accountHolderID`."
},
"id": {
"type": "string",
"description": "ID of the Beneficiary whose details are updated."
},
"salutation": {
"type": "string",
"description": "Salutation using which the Beneficiary is addressed. Example: Mr., Mrs., Ms."
},
"firstName": {
"type": "string",
"description": "Beneficiary's first name."
},
"middleName": {
"type": "string",
"description": "Beneficiary's middle name."
},
"lastName": {
"type": "string",
"description": "Beneficiary's last name."
},
"gender": {
"type": "string",
"description": "Beneficiary's gender. Example: male, female."
},
"dob": {
"type": "string",
"format": "date",
"description": "Beneficiary's date of birth."
},
"relationship": {
"type": "string",
"description": "Beneficiary's relationship with the Account Holder. Example: sister, friend, colleague"
},
"status": {
"type": "string",
"description": "Beneficiary's operational status. Example: ENABLED, DISABLED."
},
"type": {
"type": "string",
"description": "Type of Beneficiary being updated.",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"profilePicURL": {
"type": "string",
"description": "Link to Beneficiary’s profile image."
},
"customFields": {
"type": "object",
"description": "Custom parameters passed for the Beneficiary.",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"ifiID": 140827,
"individualID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"id": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"salutation": "Mr",
"firstName": "Bill",
"middleName": "Murray",
"lastName": "Johnson",
"gender": "Male",
"relationship": "Father",
"status": "ENABLED",
"type": "REAL",
"profilePicURL": "https://s3.amazonaws.com/uifaces/faces/twitter/darylws/77628.jpg",
"customFields": {},
"headers": {}
}
},
"UpdateBeneficiaryResponse": {
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "Unique ID generated for the request."
},
"id": {
"type": "string",
"description": "ID of the Beneficiary. Same as `BeneficiaryID`."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI"
},
"accountHolderID": {
"type": "string",
"description": "ID of the Account Holder for whom the Beneficiary is updated. Same as `individualID`."
},
"salutation": {
"type": "string",
"description": "Salutation using which the Beneficiary is addressed. Example: Mr., Mrs., Ms."
},
"firstName": {
"type": "string",
"description": "Beneficiary's first name."
},
"middleName": {
"type": "string",
"description": "Beneficiary's middle name."
},
"lastName": {
"type": "string",
"description": "Beneficiary's last name."
},
"gender": {
"type": "string",
"description": "Beneficiary's gender. Example: male, female."
},
"profilePicURL": {
"type": "string",
"description": "Link to Beneficiary’s profile image."
},
"relationship": {
"type": "string",
"description": "Beneficiary's relationship with the Account Holder. Example: sister, friend, colleague."
},
"status": {
"type": "string",
"description": "Beneficiary's operational status. Example: ENABLED, DISABLED."
},
"type": {
"type": "string",
"description": "Type of Beneficiary being created.",
"enum": [
"REAL",
"LEGAL",
"HEADLESS"
]
},
"vectors": {
"description": "Vectors are unique identifiers used to identify the Beneficiary. Example: phone, email.",
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "ID generated for the vector."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary to whom the Vector is mapped."
},
"type": {
"type": "string",
"description": "Vector type. Phone is identified as `p`, email is identified as `e`."
},
"value": {
"type": "string",
"description": "Value of the Vector based on the Vector `type`. Example: If Vector type is phone (`p`), Beneficiary's phone number is returned."
}
}
}
},
"customFields": {
"type": "object",
"description": "Custom parameters passed for the Beneficiary.",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is updated."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary is updated."
}
},
"example": {
"requestID": "FUSION-140827-8d3f52a6-c546-40bd-b810-e610b26ec1d7-1595597219905",
"id": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"ifiID": 140827,
"accountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"salutation": "Mr",
"firstName": "Bill",
"middleName": "Murray",
"lastName": "Johnson",
"gender": "Male",
"profilePicURL": "https://s3.amazonaws.com/uifaces/faces/twitter/darylws/77628.jpg",
"relationship": "Father",
"status": "ENABLED",
"type": "REAL",
"vectors": [
{
"id": "02c75dfb-9de1-41f5-ab19-a383652fc2d2",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"type": "p",
"value": "+919945643114"
}
],
"customFields": {},
"createdAt": "Jul 24, 2020 1:27:00 PM",
"updatedAt": "Jul 27, 2020 2:16:38 PM",
"headers": {}
}
},
"deleteBeneficiaryResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Operational status of the Beneficiary. To delete the Beneficiary, specify the value as 'DELETED."
},
"vectors": {
"type": "array",
"description": "Beneficiary's Vector details.",
"items": {
"$ref": "#/components/schemas/Vector"
}
}
},
"example": {
"status": "DELETED",
"vectors": [],
"headers": {}
}
},
"deleteBeneficiaryAccountResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Operational status of the Beneficiary. To delete the Account, set the value to `DELETED`."
}
},
"example": {
"status": "DELETED",
"headers": {}
}
},
"BeneficiaryAccountInfo": {
"type": "object",
"properties": {
"accountNumber": {
"type": "string",
"description": "Account number generated for the Beneficiary Account. This is similar to a standard bank account number."
},
"accountProvider": {
"type": "string"
},
"nameAtAccountProvider": {
"type": "string"
},
"routingCode": {
"type": "string",
"description": "IFSC Code."
},
"accountType": {
"type": "string",
"description": "Account type.",
"enum": [
"SAVINGS",
"CURRENT"
]
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"BeneficiaryVector": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Vector type. Specify `p` for phone, `e` for email."
},
"value": {
"type": "string",
"description": "Value of the Vector based on the Vector `type`. Example: If Vector type is phone (`p`), specify Beneficiary's phone number."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the Beneficiary's Vectors.",
"additionalProperties": {
"type": "string"
}
}
}
},
"GetAllBeneficiaryAccountsResponse": {
"type": "object",
"properties": {
"beneficiaryAccountList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddAccountToBeneficiaryResponse"
}
},
"totalElements": {
"description": "Total number of Accounts created for the Beneficiary.",
"type": "integer",
"format": "int64"
}
},
"example": {
"beneficiaryAccountList": [
{
"id": "138a76aa-47fe-4e06-9c1a-31dee7bc35c9",
"ifiID": 140827,
"isVerified": true,
"status": "ENABLED",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"parentAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"nickname": "New Beneficiary Account",
"type": "ZETA",
"accountInfo": {
"accountProvider": "fampay",
"nameAtAccountProvider": "140827",
"routingCode": "internal",
"accountType": "SAVINGS",
"attributes": {
"additionalProp1": "INDIRANAGAR",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"isDefault": false,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"createdAt": "Jul 24, 2020 3:19:24 PM",
"updatedAt": "Jul 24, 2020 3:21:12 PM",
"headers": {}
},
{
"id": "4cebaab8-862f-4c39-90ca-5043beda04bd",
"ifiID": 140827,
"isVerified": true,
"status": "ENABLED",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"parentAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"nickname": "New Beneficiary Account 2",
"type": "ZETA",
"accountInfo": {
"accountProvider": "fampay",
"nameAtAccountProvider": "140827",
"routingCode": "internal",
"accountType": "SAVINGS",
"attributes": {
"additionalProp1": "M G Road",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"isDefault": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"createdAt": "Jul 24, 2020 3:21:12 PM",
"updatedAt": "Jul 24, 2020 3:21:12 PM",
"headers": {}
}
],
"totalElements": 2,
"headers": {}
}
},
"UpdatedBeneficiaryAccountRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of Beneficiary Account. "
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"isVerified": {
"type": "boolean",
"description": "Specify if the Beneficiary's Vectors are verified or not."
},
"status": {
"type": "string",
"description": "Operational status of the Account. Example: ENABLED, DISABLED."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary for whom the Account is updated."
},
"parentAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID` and `individualID`."
},
"nickname": {
"type": "string",
"description": "Short title or description to identify the Account."
},
"type": {
"type": "string"
},
"accountInfo": {
"$ref": "#/components/schemas/BeneficiaryAccountInfo"
},
"isDefault": {
"description": "Specify if this Account should be the default Account for Beneficiary. If set to `true`, funds will be transferred to this Account when <i>Transfer Funds to default Beneficiary Account </i> API is used.",
"type": "boolean"
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the Beneficiary Account.",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"id": "138a76aa-47fe-4e06-9c1a-31dee7bc35c9",
"ifiID": 140827,
"isVerified": false,
"status": "DISABLED",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"parentAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"nickname": "New Beneficiary Account 2",
"type": "ZETA",
"accountInfo": {
"accountNumber": "f35f88dd-481c-4b0f-84b5-8be991c008ae",
"accountProvider": "fampay",
"nameAtAccountProvider": "140827",
"routingCode": "internal",
"accountType": "SAVINGS",
"attributes": {
"additionalProp1": "Domlur",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"isDefault": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
},
"UpdatedBeneficiaryAccountResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the Beneficiary Account."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"isVerified": {
"type": "boolean",
"description": "Specify if the Beneficiary's Vectors are verified or not."
},
"status": {
"type": "string",
"description": "Operational status of the Account. Example: ENABLED, DISABLED."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary for whom the Account is updated."
},
"parentAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder that the Beneficiary belongs to. Same as `accountHolderID` and `individualID`."
},
"nickname": {
"type": "string",
"description": "Short title or description to identify the Account."
},
"type": {
"type": "string"
},
"accountInfo": {
"$ref": "#/components/schemas/BeneficiaryAccountInfo"
},
"isDefault": {
"type": "boolean",
"description": "Specify if this Account should be the default Account for Beneficiary. If set to `true`, funds will be transferred to this Account when <i>Transfer Funds to default Beneficiary Account </i> API is used."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the Beneficiary Account.",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary Account is created."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of when the Beneficiary Account is updated."
}
},
"example": {
"id": "138a76aa-47fe-4e06-9c1a-31dee7bc35c9",
"ifiID": 140827,
"isVerified": false,
"status": "DISABLED",
"beneficiaryID": "d64cec61-838b-410f-9b8b-5f8a32b444d1",
"parentAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"nickname": "New Beneficiary Account 2",
"type": "ZETA",
"accountInfo": {
"accountProvider": "fampay",
"nameAtAccountProvider": "140827",
"routingCode": "internal",
"accountType": "SAVINGS",
"attributes": {
"additionalProp1": "INDIRANAGAR",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"isDefault": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"createdAt": "Jul 24, 2020 3:19:24 PM",
"updatedAt": "Jul 28, 2020 9:50:32 AM",
"headers": {}
}
},
"TransferDefaultRequest": {
"required": [
"transactionTime"
],
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "ID of the request."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Fund amount to be transferred."
},
"currency": {
"type": "string",
"description": "Currency of the funds being transferred. Example: INR"
},
"transactionCode": {
"type": "string",
"description": "Code specifying the fund transfer mode. IMPS, NEFT, and UPI are currently suppported modes."
},
"debitAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder transferring the funds. Same as `individualID` and `accountHolderID`."
},
"debitAccountID": {
"type": "string",
"description": "ID of the Account Holder's Account from where the funds are transferred."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary receiving the funds."
},
"transactionTime": {
"minimum": 1,
"type": "integer",
"format": "int64",
"description": "Timestamp of when funds are transferred."
},
"remarks": {
"type": "string",
"description": "Description for the transfer."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the fund transfer.",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"requestID": "BeneficiaryTransactio234nasdef_lah1",
"ifiID": 140827,
"amount": 101,
"currency": "INR",
"transactionCode": "ATLAS_P2M_AUTH",
"debitAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"debitAccountID": "0e3ba859-1d1e-4682-a0a9-1e82986d2dcb",
"beneficiaryID": "cefaf90f-066c-4fc2-a181-93cccc24184b",
"transactionTime": 12322334234489,
"remarks": "TEST",
"attributes": {}
}
},
"BeneficiaryAccountTransferRequest": {
"required": [
"transactionTime"
],
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "ID of the request."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"currency": {
"type": "string",
"description": "Currency of the funds being transferred. Example: INR."
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Fund amount to be transferred."
},
"transactionCode": {
"type": "string",
"description": "Code specifying the fund transfer mode. IMPS, NEFT, and UPI are currently suppported modes."
},
"debitAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder transferring the funds. Same as `individualID` and `accountHolderID`."
},
"debitAccountID": {
"type": "string",
"description": "ID of the Account Holder's Account from where the funds are transferred."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary receiving the funds."
},
"beneficiaryAccountID": {
"type": "string",
"description": "ID of the Beneficiary Account where the funds are transferred to."
},
"transactionTime": {
"minimum": 1,
"type": "integer",
"format": "int64",
"description": "Timestamp of when funds are transferred."
},
"remarks": {
"type": "string",
"description": "Description for the transfer."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the fund transfer.",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"requestID": "505a12cb-76e1-4f04-8d84-63eca07187d6",
"ifiID": 140827,
"currency": "INR",
"amount": 1,
"transactionCode": "ATLAS_P2M_AUTH",
"debitAccountHolderID": "f893ba42-9956-441d-a10d-945567f8c9ae",
"debitAccountID": "1d7b859f-5c71-42a6-bc82-1d7a6baaa778",
"beneficiaryID": "5b027336-0481-4b68-b1f0-d9619450b4bd",
"beneficiaryAccountID": "099e244b-f989-4ca1-8182-0c71316f06c4",
"transactionTime": 1232425483242,
"remarks": "TEST",
"attributes": {}
}
},
"BeneficiaryTransferByIDResponse": {
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "ID of the request."
},
"transactionID": {
"type": "string",
"description": "ID of the Beneficiary fund transfer. Same as `transferID`."
},
"paymentID": {
"type": "string",
"description": ""
},
"receiptID": {
"type": "string",
"description": "ID of the receipt. Same as `transferID` and `transactionID`."
},
"transactionCode": {
"type": "string",
"description": "Code specifying the fund transfer mode. IMPS, NEFT and UPI are currently suppported modes."
},
"debits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostingID"
}
},
"time": {
"type": "integer",
"format": "int64",
"description": "Timestamp of fund transfer."
},
"towards": {
"type": "string",
"description": "Description for the transfer. Same as `remarks` in the request."
},
"transferAmount": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency of the funds transferred. Example: INR"
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Fund amount transferred."
}
}
},
"payerInfo": {
"description": "Payer details",
"type": "object",
"properties": {
"targetURI": {
"type": "string",
"description": "ID of the Account to which the Account Holder's payment instrument (card) is mapped to."
},
"debitAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder transferring the funds. Same as `individualID` and `accountHolderID`."
}
}
},
"payeeInfo": {
"description": "Payee details",
"type": "object",
"properties": {
"creditAccountHolderID": {
"type": "string",
"description": "ID of the Beneficiary receiving the funds. Same as `beneficiaryID` in the request."
}
}
},
"status": {
"type": "string",
"description": "Status of fund transfer."
},
"transferType": {
"type": "string",
"description": "Type of fund transfer."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the fund transfer.",
"additionalProperties": {
"type": "string"
}
},
"statusDetails": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"requestID": "FUSION-140827-cefaf90f-066c-4fc2-a181-93cccc24184b-1593511936216",
"transactionID": "299397001183",
"paymentID": "6fc9456a-91f7-4048-8d94-dc534cbecd54",
"receiptID": "299397001183",
"transactionCode": "102530",
"debits": [
{
"postingID": "554609",
"ifi": 140827,
"value": {
"currency": "INR",
"amount": 101
},
"newBalance": {
"currency": "INR",
"amount": 399
},
"instrumentType": "MCC_VOUCHER_RECIPIENT",
"attributes": {},
"coupons": [
{
"value": {
"amount": 101,
"currency": "INR"
},
"couponID": "4048a1b7-08f4-4ad3-b2a9-8cc0e772970a"
}
]
}
],
"time": 1593511937138,
"towards": "TEST",
"transferAmount": {
"currency": "INR",
"amount": 101
},
"payerInfo": {
"type": "RESOURCE",
"targetURI": "account://0e3ba859-1d1e-4682-a0a9-1e82986d2dcb",
"resourceID": "29157c06-ce97-433e-a61d-3c588b724495",
"debitAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7"
},
"payeeInfo": {
"name": "MOYONKO",
"type": "FINANCIAL_INSTITUTION",
"mobileNumber": "",
"creditAccountHolderID": "cefaf90f-066c-4fc2-a181-93cccc24184b"
},
"status": "AUTHORIZED",
"transferType": "IMPS",
"attributes": {
"channel": "IMPS",
"sourceURI": "account://0e3ba859-1d1e-4682-a0a9-1e82986d2dcb",
"paymentCode": "PMCINZZ0201",
"banker.version": "2.0",
"challenge.type": "X509Cert",
"destinationURI": "ba://038801588319?ifsc=ICIC0000431",
"bankTransfer.mode": "IMPS",
"challenge.response": "-----BEGIN CERTIFICATE-----\nMIIBtTCCAVygAwIBAgIUI2Tyw+MNMxOaUyt3FRjRo2XkhY8wCgYIKoZIzj0EAwIw\nOTE3MDUGA1UEAwwuM2lmRHBfOEFrR1NTVHlyVk1tek9QZz09QGFjY291bnQuaWRm\nYy5yZXNvdXJjZTAeFw0yMDA2MzAxMDEyMTZaFw0yMDA2MzAxMDE0MTZaMDkxNzA1\nBgNVBAMMLjNpZkRwXzhBa0dTU1R5clZNbXpPUGc9PUBhY2NvdW50LmlkZmMucmVz\nb3VyY2UwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATeiQnXSGawq+QnXoW0tUIq\nvii8LAxePs38bqyG2+A+5Nz0MKTGHD5nR+QE+a7mgCZ4VsKIFO8KNAnlVy2gAs8C\no0IwQDAdBgNVHQ4EFgQUXhRdz/qnCtfWuOpaPt1JEbHcPrYwDgYDVR0PAQH/BAQD\nAgEGMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDRwAwRAIgetGBVUrHT284\ny9ByQa/EvOalW/Q6LS07VyeDS4u9lcICIArCIE6qHk8sbyBpWpT/WCSrMfAW9Y+Q\nWF2QNs7UkZbM\n-----END CERTIFICATE-----\n",
"journal.voucherCode": "ATLAS_P2M_AUTH",
"payment.channelType": "IMPS",
"authenticationResourceId": "9ba1f200-6340-4f28-9951-6150e0908462",
"bankTransfer.remitterName": "null Test Contract change null",
"bankTransfer.remitterMobile": "+919890034500",
"bankTransfer.beneficiaryName": "MOYONKO",
"payment.overridden-payer-vector": "account://0e3ba859-1d1e-4682-a0a9-1e82986d2dcb"
},
"statusDetails": {},
"headers": {}
}
},
"BeneficiaryTransactionResponse": {
"type": "object",
"properties": {
"requestID": {
"type": "string",
"description": "ID of the request."
},
"transactionID": {
"type": "string",
"description": "ID of the fund transfer."
},
"transactionCode": {
"type": "string",
"description": "Code specifying the fund transfer mode. IMPS, NEFT, and UPI are currently suppported modes."
},
"debits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Posting"
}
},
"time": {
"type": "integer",
"format": "int64",
"description": "Timestamp of fund transfer."
},
"towards": {
"type": "string",
"description": "Description for the transfer. Same as `remarks` in the request."
},
"transferAmount": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency of the funds transferred. Example: INR"
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Fund amount transferred."
}
}
},
"payerInfo": {
"description": "Payer details",
"type": "object",
"properties": {
"targetURI": {
"type": "string",
"description": "ID of the Account to which the Account Holder's payment instrument (card) is mapped to."
},
"debitAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder transferring the funds. Same as `individualID` and `accountHolderID`."
}
}
},
"payeeInfo": {
"description": "Payee details",
"type": "object",
"properties": {
"creditAccountHolderID": {
"type": "string",
"description": "ID of the Beneficiary receiving the funds. Same as `beneficiaryID` in the request."
}
}
},
"status": {
"type": "string",
"description": "Status of fund transfer."
},
"transferType": {
"type": "string",
"description": "Type of fund transfer."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the fund transfer.",
"additionalProperties": {
"type": "string"
}
},
"statusDetails": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"requestID": "FUSION-140827-5b027336-0481-4b68-b1f0-d9619450b4bd-1595940807597",
"transactionID": "20200728125327702_38039_FUSION-140827-5b027336-0481-4b68-b1f0-d9619450b4bd-1595940807597",
"transactionCode": "ATLAS_P2M_AUTH",
"debits": [
{
"postingID": "171901",
"ifi": 140827,
"value": {
"currency": "INR",
"amount": 1
},
"instrumentType": "MCC_VOUCHER_RECIPIENT",
"attributes": {},
"coupons": [
{
"couponID": "1084fb93-b95c-4406-abb5-33b1923ee53c",
"redeemedValue": 1
}
]
}
],
"time": 1232425483242,
"towards": "TEST",
"transferAmount": {
"currency": "INR",
"amount": 1
},
"payerInfo": {
"targetURI": "account://69791c78-80fd-418c-923b-8efbaab19357",
"debitAccountHolderID": "f893ba42-9956-441d-a10d-945567f8c9ae"
},
"payeeInfo": {
"creditAccountHolderID": "5b027336-0481-4b68-b1f0-d9619450b4bd"
},
"status": "SUCCESS",
"transferType": "INTERNAL",
"attributes": {},
"statusDetails": {},
"headers": {}
}
},
"GetBeneficiaryTransactionListResponse": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/transactionResponse"
},
"totalElements": {
"type": "integer",
"format": "int64",
"description": "Total number of Beneficiary fund transfers made by the Account Holder."
}
},
"example": {
"transactions": [
{
"id": "e6119a9f-041c-4f46-abf5-27dbd919ddec",
"requestID": "FUSION-140827-cefaf90f-066c-4fc2-a181-93cccc24184b-1593511936216",
"ifiID": 140827,
"amount": 101,
"currency": "INR",
"transactionCode": "ATLAS_P2M_AUTH",
"debitAccountID": "0e3ba859-1d1e-4682-a0a9-1e82986d2dcb",
"debitAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"beneficiaryID": "cefaf90f-066c-4fc2-a181-93cccc24184b",
"beneficiaryAccountID": "094dd0d1-457c-410d-bf4b-8b6ff910a937",
"transactionTime": 12322334234489,
"transferType": "IMPS",
"status": "AUTHORIZED",
"transactionID": "299397001183",
"remarks": "TEST",
"attributes": {},
"createdAt": {
"date": {
"year": 2020,
"month": 6,
"day": 30
},
"time": {
"hour": 10,
"minute": 12,
"second": 17,
"nano": 215060000
}
},
"headers": {}
},
{
"id": "f44b2805-c039-4dd9-b97a-7b294d03096a",
"requestID": "FUSION-140827-cefaf90f-066c-4fc2-a181-93cccc24184b-1593516684636",
"ifiID": 140827,
"amount": 101,
"currency": "INR",
"transactionCode": "ATLAS_P2M_AUTH",
"debitAccountID": "0e3ba859-1d1e-4682-a0a9-1e82986d2dcb",
"debitAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"beneficiaryID": "cefaf90f-066c-4fc2-a181-93cccc24184b",
"beneficiaryAccountID": "6e348f49-6a7e-4522-a861-c55019e006e9",
"transactionTime": 14322334234489,
"transferType": "ZETA",
"status": "SUCCESS",
"transactionID": "20200630113124774_24588_FUSION-140827-cefaf90f-066c-4fc2-a181-93cccc24184b-1593516684636",
"remarks": "TEST",
"attributes": {},
"createdAt": {
"date": {
"year": 2020,
"month": 6,
"day": 30
},
"time": {
"hour": 11,
"minute": 31,
"second": 25,
"nano": 230196000
}
},
"headers": {}
},
{
"id": "acff5a52-d663-4943-9543-16e98a9e779a",
"requestID": "FUSION-140827-cefaf90f-066c-4fc2-a181-93cccc24184b-1595577951967",
"ifiID": 140827,
"amount": 101,
"currency": "INR",
"transactionCode": "ATLAS_P2M_AUTH",
"debitAccountID": "0e3ba859-1d1e-4682-a0a9-1e82986d2dcb",
"debitAccountHolderID": "8d3f52a6-c546-40bd-b810-e610b26ec1d7",
"beneficiaryID": "cefaf90f-066c-4fc2-a181-93cccc24184b",
"beneficiaryAccountID": "094dd0d1-457c-410d-bf4b-8b6ff910a937",
"transactionTime": 12322334234489,
"transferType": "IMPS",
"status": "AUTHORIZED",
"transactionID": "301955000979",
"remarks": "TEST",
"attributes": {},
"createdAt": {
"date": {
"year": 2020,
"month": 7,
"day": 24
},
"time": {
"hour": 8,
"minute": 5,
"second": 56,
"nano": 66906000
}
},
"headers": {}
}
],
"totalElements": 3,
"headers": {}
}
},
"transactionResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"requestID": {
"type": "string",
"description": "ID of the request."
},
"ifiID": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Fund amount transferred."
},
"currency": {
"type": "string",
"description": "Currency of the transferred funds. Example: INR."
},
"transactionCode": {
"type": "string",
"description": "Code specifying the fund transfer mode. IMPS, NEFT, and UPI are currently suppported modes."
},
"debitAccountID": {
"type": "string",
"description": "ID of the Account Holder's Account from where the funds are transferred."
},
"debitAccountHolderID": {
"type": "string",
"description": "ID of the Account Holder transferring the funds. Same as `individualID` and `accountHolderID`."
},
"beneficiaryID": {
"type": "string",
"description": "ID of the Beneficiary receiving the funds."
},
"beneficiaryAccountID": {
"type": "string",
"description": "ID of the Beneficiary Account where the funds are transferred to."
},
"transactionTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of when the funds are transferred."
},
"transferType": {
"type": "string",
"description": "Type of fund transfer."
},
"status": {
"type": "string",
"description": "Status of fund transfer."
},
"transactionID": {
"type": "string",
"description": "ID of the Beneficiary fund transfer. Same as `transferID`."
},
"remarks": {
"type": "string",
"description": "Description for the transfer."
},
"attributes": {
"type": "object",
"description": "Additional parameters passed for the fund transfer.",
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the funds are transferred."
}
}
}
},
"JsonArray": {
"type": "object",
"properties": {
"asBoolean": {
"type": "boolean"
},
"asNumber": {
"$ref": "#/components/schemas/Number"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asByte": {
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string",
"format": "byte"
},
"asCharacter": {
"type": "string"
},
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"asJsonNull": {
"$ref": "#/components/schemas/JsonNull"
},
"asJsonArray": {
"$ref": "#/components/schemas/JsonArray"
},
"asJsonPrimitive": {
"$ref": "#/components/schemas/JsonPrimitive"
},
"asJsonObject": {
"$ref": "#/components/schemas/JsonObject"
},
"jsonArray": {
"type": "boolean"
}
}
},
"JsonNull": {
"type": "object",
"properties": {
"asBoolean": {
"type": "boolean"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"asJsonNull": {
"$ref": "#/components/schemas/JsonNull"
},
"asNumber": {
"$ref": "#/components/schemas/Number"
},
"asJsonArray": {
"$ref": "#/components/schemas/JsonArray"
},
"asJsonPrimitive": {
"$ref": "#/components/schemas/JsonPrimitive"
},
"asJsonObject": {
"$ref": "#/components/schemas/JsonObject"
},
"jsonArray": {
"type": "boolean"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asByte": {
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string",
"format": "byte"
},
"asCharacter": {
"type": "string"
},
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
}
}
},
"JsonObject": {
"type": "object",
"properties": {
"asBoolean": {
"type": "boolean"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"asJsonNull": {
"$ref": "#/components/schemas/JsonNull"
},
"asNumber": {
"$ref": "#/components/schemas/Number"
},
"asJsonArray": {
"$ref": "#/components/schemas/JsonArray"
},
"asJsonPrimitive": {
"$ref": "#/components/schemas/JsonPrimitive"
},
"asJsonObject": {
"$ref": "#/components/schemas/JsonObject"
},
"jsonArray": {
"type": "boolean"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asByte": {
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string",
"format": "byte"
},
"asCharacter": {
"type": "string"
},
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
}
}
},
"JsonPrimitive": {
"type": "object",
"properties": {
"number": {
"type": "boolean"
},
"boolean": {
"type": "boolean"
},
"asBoolean": {
"type": "boolean"
},
"string": {
"type": "boolean"
},
"asNumber": {
"$ref": "#/components/schemas/Number"
},
"asFloat": {
"type": "number",
"format": "float"
},
"asLong": {
"type": "integer",
"format": "int64"
},
"asDouble": {
"type": "number",
"format": "double"
},
"asInt": {
"type": "integer",
"format": "int32"
},
"asByte": {
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string",
"format": "byte"
},
"asCharacter": {
"type": "string"
},
"asBigDecimal": {
"type": "number"
},
"asBigInteger": {
"type": "integer"
},
"asShort": {
"type": "integer",
"format": "int32"
},
"asString": {
"type": "string"
},
"jsonObject": {
"type": "boolean"
},
"jsonPrimitive": {
"type": "boolean"
},
"jsonNull": {
"type": "boolean"
},
"asJsonNull": {
"$ref": "#/components/schemas/JsonNull"
},
"asJsonArray": {
"$ref": "#/components/schemas/JsonArray"
},
"asJsonPrimitive": {
"$ref": "#/components/schemas/JsonPrimitive"
},
"asJsonObject": {
"$ref": "#/components/schemas/JsonObject"
},
"jsonArray": {
"type": "boolean"
}
}
},
"Number": {
"type": "object"
},
"Posting": {
"type": "object",
"properties": {
"postingID": {
"type": "string",
"description": "ID of the ledger posting."
},
"ifi": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"value": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency of the funds transferred. Example :INR"
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Fund amount transferred."
}
}
},
"instrumentType": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"coupons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"couponID": {
"type": "string"
},
"redeeemedValue": {
"type": "integer",
"format": "int64"
}
}
}
}
}
},
"PostingID": {
"type": "object",
"properties": {
"postingID": {
"type": "string",
"description": "ID of the ledger posting."
},
"ifi": {
"type": "integer",
"format": "int64",
"description": "ID of the IFI."
},
"value": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency of the funds transferred. Example :INR"
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Fund amount transferred."
}
}
},
"newBalance": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency of the Beneficiary's new balance. Example :INR"
},
"amount": {
"type": "integer",
"format": "int64",
"description": "Updated balance of the Beneficiary Account after the fund transfer."
}
}
},
"instrumentType": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"coupons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"couponID": {
"type": "string"
},
"redeeemedValue": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
} |