https://github.com/viafintech/camt_parser

A basic parser for camt.052, camt.053 and camt.054 files
https://github.com/viafintech/camt_parser

camt parsing

Last synced: about 14 hours ago
JSON representation

A basic parser for camt.052, camt.053 and camt.054 files

• Host: GitHub
• URL: https://github.com/viafintech/camt_parser
• Owner: viafintech
• License: mit
• Created: 2015-09-03T08:24:46.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-01-10T09:54:13.000Z (13 days ago)
• Last Synced: 2025-01-15T12:58:06.592Z (8 days ago)
• Topics: camt, parsing
• Language: Ruby
• Homepage:
• Size: 162 KB
• Stars: 20
• Watchers: 12
• Forks: 26
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CamtParser

[![Ruby CI](https://github.com/viafintech/camt_parser/actions/workflows/test.yml/badge.svg)](https://github.com/viafintech/camt_parser/actions/workflows/test.yml)

CamtParser is a Ruby Gem which does some basic parsing of camt052, camt053, and camt054 files into an object

structure for easier usability instead of having to use an XML parser all the time.

Keep in mind that this might not include a complete parsing of camt specification.

Fields that we did not need for our use-cases are simply ignored for now.

**PLEASE CONSIDER SWITCHING TO [sepa_file_parser](https://github.com/viafintech/sepa_file_parser)**

`sepa_file_parser` is the followup project with broader support for other SEPA/iso20022 related file formats.

## Getting started

1. add the Gem to the Gemfile

```ruby

gem 'camt_parser'

```

2. Require the Gem at any point before using it

3. Use it!

## Example for camt053

```ruby

camt = CamtParser::File.parse path_to_file

puts camt.group_header.creation_date_time

camt.statements.each do |statement|

  puts statement.account.iban

  statement.entries.each do |entry|

    # Access individual entries/bank transfers

    puts entry.amount

    entry.transactions.each do |transaction|

      puts transaction.debitor

    end

  end

end

```

Please check the code for fields not mentioned here.

Also check the code for camt052 and camt054.

## Registering new namespaces

In case you have to parse a namespace which is generally compatible with any of the camt parsers, it is possible to register additional namespaces, without requiring a change to this gem.

```ruby

# Registering a new camt052 namespace

CamtParser::Xml.register('', :camt052)

# Registering a new camt053 namespace

CamtParser::Xml.register('', :camt053)

# Registering a new camt054 namespace

CamtParser::Xml.register('', :camt054)

```

## Bugs and Contribution

For bugs and feature requests open an issue on Github. For code contributions fork the repo, make your changes and create a pull request.

### License

[LICENSE](LICENSE)