Jump to

• Request
• Response

Convert Currency by customer Id

post

/api/v1/CcyConvertAdapters/convertCcyByCustomerId/{customerId}

This endpoint is used for retrieving the list of existing currency after conversion based on Online rate.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• customeId: string
  currency that needs to be conver based on customeId

Header Parameters

• appId: string
• branchCode: string
• contentType(optional): string
• tenantId(optional): string
• userId: string

Body ()

Request Body that contains data required for fetching a converted amount monitor

Root Schema : ExchangeRateRequestDto

Type: object

Show Source

• amount(optional): number
• branch(optional): string
• customerId(optional): string
• fromCurrency(optional): string
• rateIndicator(optional): string
• rateType(optional): string
• roundingRequired(optional): string
• toCurrency(optional): string
• valueDate(optional): string

{
    "type":"object",
    "properties":{
        "branch":{
            "type":"string",
            "description":""
        },
        "fromCurrency":{
            "type":"string",
            "description":""
        },
        "toCurrency":{
            "type":"string",
            "description":""
        },
        "amount":{
            "type":"number",
            "description":""
        },
        "customerId":{
            "type":"string",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "description":""
        },
        "rateType":{
            "type":"string",
            "description":""
        },
        "rateIndicator":{
            "type":"string",
            "description":""
        },
        "roundingRequired":{
            "type":"string",
            "description":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ExchangeRateResponseDto

Type: object

Show Source

• amount(optional): number
• buyRate(optional): string
• codes(optional): array codes
• fromCurrency(optional): string
• midRate(optional): string
• rateType(optional): string
• requestId(optional): string
• sellRate(optional): string
• toCurrency(optional): string
• valueDate(optional): string

{
    "type":"object",
    "properties":{
        "buyRate":{
            "type":"string"
        },
        "sellRate":{
            "type":"string"
        },
        "midRate":{
            "type":"string"
        },
        "rateType":{
            "type":"string"
        },
        "fromCurrency":{
            "type":"string"
        },
        "toCurrency":{
            "type":"string"
        },
        "amount":{
            "type":"number"
        },
        "valueDate":{
            "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 sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top