Jump to

• Request
• Response

Retrieves the account ID based on the provided account number and product processor code

post

/dmaccount-service/accounts/getAccountId

This endpoint retrieves the account ID based on the provided account number and product processor code

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  The application ID of the host service.
• branchCode(required): string
  The branch code of the requesting branch.
• contentType: string
  The content type of the request or response body.
• userId(required): string
  The user ID of the requesting user.

Body ()

Request body containing a list of account numbers and a product processor code to fetch the corresponding list of account IDs.

Root Schema : AccountNumberCollection

Type: object

Collection of account numbers along with product processor code.

Show Source

• accountNumberList: array accountNumberList
• prdProcessrCd: string
  Product Processor Code

{
    "description":"Collection of account numbers along with product processor code.",
    "type":"object",
    "properties":{
        "accountNumberList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/String"
            }
        },
        "prdProcessrCd":{
            "description":"Product Processor Code",
            "type":"string"
        }
    }
}

Nested Schema : accountNumberList

Type: array

Show Source

• Array of: string
  String

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the account ID of the specified account number.

Body ()

Root Schema : AcctNbrAcctIdDtoCollection

Type: object

Account numbers mapped with their respective account ids.

Show Source

• accountNumberList: array accountNumberList

{
    "description":"Account numbers mapped with their respective account ids.",
    "type":"object",
    "properties":{
        "accountNumberList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AcctNbrAcctIdDto"
            }
        }
    }
}

Nested Schema : accountNumberList

Type: array

Show Source

• Array of: object AcctNbrAcctIdDto
  Contains account numbers along with their respective account IDs.

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

Nested Schema : AcctNbrAcctIdDto

Type: object

Contains account numbers along with their respective account IDs.

Show Source

• accountId: string
• accountNumber: string

{
    "description":"Contains account numbers along with their respective account IDs.",
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string"
        },
        "accountId":{
            "type":"string"
        }
    }
}

201 Response

Returns a message indicating either success or failure.

Headers

• Location: string
  Returns the account ID of the specified account number.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

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

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
• id: string
• requestId: string
• status: 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: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: 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 sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error.

Back to Top