💳
Malum
  • 👋Welcome to Malum
  • 💲Payment Methods Overview
  • 🤖Plugins
  • Transaction API
    • 📨Create Transaction
    • Malum Checkout Form
    • 💱Currency Exchange Rate
    • 📑Webhook / Callback
  • Account API
    • 💸Balance API
    • 🏧 Payout API
    • 🏦Currencies API
Powered by GitBook
On this page
  • Overview
  • HTTP Request
  • Success Response
  • Error Response
  • Additional Notes
  1. Transaction API

Currency Exchange Rate

Overview

This endpoint retrieves the current exchange rate between two specified currencies. This service supports all major currencies that conform to the ISO 4217 three-letter code standard.

HTTP Request

GET https://malum.co/api/v2/exchange/{FROM}-{TO}
OR
GET https://malum.co/api/v2/exchange/{FROM}{TO}

Path Parameters

Parameter
Description

{FROM}-{TO}

The currency pair to convert from and to. Format as FROM to TO using ISO 4217 codes (e.g., EUR-USD OR EURUSD).

Success Response

A successful request returns the current exchange rate between the specified currencies:

{
  "status": "success",
  "from": "EUR",
  "to": "USD",
  "rate": "1.0651",
  "pair": "EURUSD"
}

Response Fields

Field
Description

status

The status of the request (success).

from

The currency code of the source currency.

to

The currency code of the target currency.

rate

The exchange rate from from to to.

pair

The concatenated currency pair code.

Error Response

If the request fails, typically due to an invalid currency pair, the following JSON is returned:

{
  "status": "failed",
  "error": "Invalid exchange pair."
}

Error Response Fields

Field
Description

status

The status of the request (failed).

error

A message describing the nature of the error.

Additional Notes

  • Ensure that both currency codes are valid ISO 4217 codes.

  • This endpoint does not require authentication.

  • Rates are updated frequently, reflecting current market conditions.


PreviousMalum Checkout FormNextWebhook / Callback

Last updated 1 year ago

💱