Jump to

• Request
• Response

URL for virtual account check from external systems

post

/service/eac

This endpoint is used to validate the given list of virtual accounts.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request Body contains data that is required to create a validate list of accounts.

Root Schema : EACRequestMastDTO

Type: object

Show Source

• eacRequestDetDTO: array eacRequestDetDTO
• sourceReferenceNo: string

{
    "type":"object",
    "properties":{
        "sourceReferenceNo":{
            "type":"string"
        },
        "eacRequestDetDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EACRequestDetDTO"
            }
        }
    },
    "required":[
        "sourceReferenceNo",
        "eacRequestDetDTO"
    ]
}

Nested Schema : eacRequestDetDTO

Type: array

Show Source

• Array of: object EACRequestDetDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/EACRequestDetDTO"
    }
}

Nested Schema : EACRequestDetDTO

Type: object

Show Source

• drCrInd: string
  Maximum Length: 1

  Pattern: [D,C]
• txnAccount: string
• txnAccountBrn(optional): string
  Maximum Length: 3
• txnAmount: number
• txnCcy: string
  Maximum Length: 3

{
    "type":"object",
    "properties":{
        "drCrInd":{
            "type":"string",
            "maxLength":1,
            "pattern":"[D,C]"
        },
        "txnAccount":{
            "type":"string"
        },
        "txnAccountBrn":{
            "type":"string",
            "maxLength":3
        },
        "txnCcy":{
            "type":"string",
            "maxLength":3
        },
        "txnAmount":{
            "type":"number"
        }
    },
    "required":[
        "drCrInd",
        "txnAccount",
        "txnCcy",
        "txnAmount"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of success and data containing request body or failure with messages.

Headers

• Location: string
  URL of the External Account Check

Body ()

Root Schema : EACServiceResponseDTO

Type: object

Show Source

• eacdata(optional): object EACResponseMastDTO
• response(optional): object ResponseDtoWrapper

{
    "type":"object",
    "properties":{
        "response":{
            "$ref":"#/definitions/ResponseDtoWrapper"
        },
        "eacdata":{
            "$ref":"#/definitions/EACResponseMastDTO"
        }
    }
}

Nested Schema : EACResponseMastDTO

Type: object

Show Source

• eacResponseDetDTO: array eacResponseDetDTO
• sourceReferenceNo: string

{
    "type":"object",
    "properties":{
        "sourceReferenceNo":{
            "type":"string"
        },
        "eacResponseDetDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EACResponseDetDTO"
            }
        }
    },
    "required":[
        "sourceReferenceNo",
        "eacResponseDetDTO"
    ]
}

Nested Schema : ResponseDtoWrapper

Type: object

Show Source

• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : eacResponseDetDTO

Type: array

Show Source

• Array of: object EACResponseDetDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/EACResponseDetDTO"
    }
}

Nested Schema : EACResponseDetDTO

Type: object

Show Source

• accBranch(optional): string
  Maximum Length: 3

  For Virtual Account it will be Virtual Account Branch and for Virtual Identifier it will be the Identifier branch
• accCcy(optional): string
  Maximum Length: 3

  For Virtual Account it will be Virtual Account Currency and for Virtual Identifier it will be Real Account Currency
• accName(optional): string
  Maximum Length: 105

  For Virtual Account, it will be Virtual Account Name and for Virtual Identifier it will be Identifier Description
• drCrInd: string
  Maximum Length: 1

  Pattern: [D,C]

  Debit or a credit transaction
• txnAccount: string
  Transaction Account
• txnAccountBrn: string
  Maximum Length: 3

  For Virtual Account, it will be Virtual Account Branch and for Virtual Identifier, it will be Transaction branch
• txnAmount: number
  Transaction Amount
• txnCcy: string
  Maximum Length: 3

  Transaction currency

{
    "type":"object",
    "properties":{
        "drCrInd":{
            "type":"string",
            "maxLength":1,
            "pattern":"[D,C]",
            "description":"Debit or a credit transaction"
        },
        "txnAccount":{
            "type":"string",
            "description":"Transaction Account"
        },
        "txnAccountBrn":{
            "type":"string",
            "maxLength":3,
            "description":"For Virtual Account, it will be Virtual Account Branch and for Virtual Identifier, it will be Transaction branch"
        },
        "txnCcy":{
            "type":"string",
            "maxLength":3,
            "description":"Transaction currency"
        },
        "txnAmount":{
            "type":"number",
            "description":"Transaction Amount"
        },
        "accName":{
            "type":"string",
            "maxLength":105,
            "description":"For Virtual Account, it will be Virtual Account Name and for Virtual Identifier it will be Identifier Description"
        },
        "accCcy":{
            "type":"string",
            "maxLength":3,
            "description":"For Virtual Account it will be Virtual Account Currency and for Virtual Identifier it will be Real Account Currency"
        },
        "accBranch":{
            "type":"string",
            "maxLength":3,
            "description":"For Virtual Account it will be Virtual Account Branch and for Virtual Identifier it will be the Identifier branch"
        }
    },
    "required":[
        "drCrInd",
        "txnAccount",
        "txnAccountBrn",
        "txnCcy",
        "txnAmount"
    ]
}

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have adequate credentials

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top