ISO 8583 messaging library for Elixir. This library has utilities validate, encode and decode message between systems using ISO 8583 regadless of the language the other system is written in.

    message = %{ "0": "0800",  "11": "646465", "12": "160244", "13": "0818", "7": "0818160244","70": "001"}
    {:ok, encoded} = ISO8583.encode(message)
    # {:ok, <<0, 49, 48, 56, 48, 48, 130, 56, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 48, 49, 56, 49, 54, ...>>}
    {:ok, decoded} = ISO8583.decode(encoded)
    # {:ok, %{ "0": "0800",  "11": "646465", "12": "160244", "13": "0818", "7": "0818160244","70": "001"}}

Installation

  def deps do
    [
      {:iso_8583, "~> 0.1.2"}
    ]
  end

Customization and configuration

All exposed API functions take options with the following configurable options.

### TCP Length Indicator This is used to specify whether or not to include the 2 byte hexadecimal encoded byte length of the whole message whe encoding or to consider it when decoding. This value is set to true by default. Example:

  ISO8583.encode(some_message, tcp_len_header: false)

Bitmap encoding

Primary and SecondaryBitmap encoding bitmap for fields 0-127 is configurable like below.

Examples:

  ISO8583.encode(some_message, bitmap_encoding: :ascii) # will result in 32 byte length bitmap

  ISO8583.encode(some_message) # will default to :hex result in 16 byte length bitmap encoded hexadecimal

Custom formats

Custom formats for data type, data length and length type for all fields including special bitmaps like for 127.1 and 127.25.1 are configurable through custom formats. The default formats will be replaced by the custom one.

To see the default formats check here

Example:

Here we override field 2 to have maximum of 30 characters.

   custome_format = %{
        "2": %{
          content_type: "n",
          label: "Primary account number (PAN)",
          len_type: "llvar",
          max_len: 30,
          min_len: 1
        }
      }

   message = some_message |> Map.put(:"2", "444466668888888888888888")

   ISO8583.encode(message, formats: custome_format)

Custom Static Metadata

There is an option to configure static metadata to an iso message. Static metadata are info in like text format encoded at special locations in the message usually at the beginning of the message and agreed upon by the sender and receiver. This library considers the static metadata just after the MTI. In the example below BITCOIN-INTERCHANGE is encoded while encoding and extracted when decoding the message.

   {:ok, encoded} = message |> ISO8583.encode(static_meta: "BITCOIN-INTERCHANGE")
   {:ok, decoded} = encoded |> ISO8583.decode(static_meta: "BITCOIN-INTERCHANGE")