Exchange (v1)

https://github.com/folio-org/mod-finance

Table of contents

Exchange API

This documents the API calls that can be made to get exchange operations

Calculate exchange

Calculate exchange API

GET /finance/calculate-exchange

Get exchange calculation

GET /finance/calculate-exchange
Query Parameters
  • from: required (string)

    Source currency code

    Example:

    USD
  • to: required (string)

    Target currency code

    Example:

    EUR
  • amount: required (number)

    The amount of money to calculate exchange

    Example:

    100
  • rate: (number)

    The User defined exchange rate

    Example:

    1.08

Response 200

Exchange calculation successfully retrieved

Body

Media type: application/json

Type: number

Example:

200

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Example:

{
  "message": "may not be null",
  "type": "1",
  "code": "-1",
  "parameters": [
    {
      "key": "moduleTo",
      "value": "null"
    }
  ]
}

Response 404

Exchange rate is not available

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Example:

{
  "message": "may not be null",
  "type": "1",
  "code": "-1",
  "parameters": [
    {
      "key": "moduleTo",
      "value": "null"
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Example:

{
  "message": "may not be null",
  "type": "1",
  "code": "-1",
  "parameters": [
    {
      "key": "moduleTo",
      "value": "null"
    }
  ]
}

Exchange rate

Exchange rate API

GET /finance/exchange-rate

Get exchange rate

GET /finance/exchange-rate
Query Parameters
  • from: required (string)

    From currency code

    Example:

    USD
  • to: required (string)

    To currency code

    Example:

    EUR

Response 200

Exchange rate successfully retrieved

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Exchange rate schema",
  "type": "object",
  "properties": {
    "from": {
      "description": "From currency code",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[A-Z]{3}$"
    },
    "to": {
      "description": "To currency code",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[A-Z]{3}$"
    },
    "exchangeRate": {
      "description": "Exchange rate value",
      "type": "number"
    },
    "operationMode": {
      "description": "Operation mode performed on the exchange rate",
      "type": "string",
      "enum": [
        "MULTIPLY",
        "DIVIDE"
      ],
      "default": "MULTIPLY"
    }
  },
  "additionalProperties": false,
  "required": [
    "from",
    "to",
    "exchangeRate",
    "operationMode"
  ]
}

Example:

sample

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Example:

{
  "message": "may not be null",
  "type": "1",
  "code": "-1",
  "parameters": [
    {
      "key": "moduleTo",
      "value": "null"
    }
  ]
}

Response 404

Exchange rate is not available

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Example:

{
  "message": "may not be null",
  "type": "1",
  "code": "-1",
  "parameters": [
    {
      "key": "moduleTo",
      "value": "null"
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Example:

{
  "message": "may not be null",
  "type": "1",
  "code": "-1",
  "parameters": [
    {
      "key": "moduleTo",
      "value": "null"
    }
  ]
}