Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aurimasniekis/gmo-aozora-client

A PSR-18/17 based client for accessing your bank information from https://gmo-aozora.com/
https://github.com/aurimasniekis/gmo-aozora-client

Last synced: about 2 months ago
JSON representation

A PSR-18/17 based client for accessing your bank information from https://gmo-aozora.com/

Host: GitHub
URL: https://github.com/aurimasniekis/gmo-aozora-client
Owner: aurimasniekis
License: mit
Created: 2020-03-20T13:02:39.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2020-03-20T13:13:22.000Z (almost 5 years ago)
Last Synced: 2024-05-12T21:20:37.356Z (8 months ago)
Language: PHP
Size: 14.6 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # GMO Aozora Client

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE)

[![Build Status][ico-travis]][link-travis]

[![Total Downloads][ico-downloads]][link-downloads]

[![Email][ico-email]][link-email]

A PSR-18/17 based client for accessing your bank information from https://gmo-aozora.com/

## Install

Via Composer

```bash

$ composer require aurimasniekis/gmo-aozora-client

```

**This package depends on PSR-17 and PSR-18 packages to be able use this package. For simpler version please use [aurimasniekis/gmo-aozora-simple-client](https://github.com/aurimasniekis/gmo-aozora-simple-client).**

## Configuration

There are two ways to define a configuration, one is statically defining values and another is loading from JSON config file

which will be updated with authentication token and device token. Device token is required to be preserved to prevent

giving notification from a new login.

#### Static Configuration:

```php

accountDetails();

```

```php

^ AurimasNiekis\GmoAozoraClient\Model\AccountDetails^ {#9

  -raw: array:27 [

   ...

  ]

  -customerName: null

  -customerType: null

  -lastLoginDatetime: DateTimeImmutable @1584736703 {#10

    date: 2020-03-20 20:38:23.626 UTC (+00:00)

  }

  -queryDatetime: DateTimeImmutable @1584738476 {#11

    date: 2020-03-20 21:07:56.664 UTC (+00:00)

  }

  -isLock: null

  -rankName: "１テックま君"

  -rankLogoUrl: null

  -atmFeeFreeCount: 2

  -transferFeeFreeCount: 1

  -transferLimitAmount: "500000000000"

  -oneDayTransferLimitAmount: "500000000000"

  -lastDayTotalBalance: "9999999"

  -totalBalance: "9999999"

  -ordinaryDepositTotalBalance: "9999999"

  -sweepTotalBalance: ""

  -lastDaySweepTotalBalance: ""

  -termDepositTotalBalance: ""

  -fcyOrdinaryDepositTotalJpyBalance: ""

  -uncollectedAmount: "0"

  -uncollectedDeducationBalance: null

  -branchCode: "123"

  -branchName: "..."

  -accountNumber: "1234567"

  -debitPlanList: []

  -rateList: array:8 [

    0 => array:16 [

      "customerRateId" => "1212321"

      "currency" => "USD"

      "ttb" => "110.07"

      "tts" => "110.11"

      "ttbRiseOrFall" => "1"

      "ttmRiseOrFall" => "1"

      "ttsRiseOrFall" => "1"

      "isServiceTime" => "1"

      "isValidRate" => "1"

      "currencyName" => "米ドル"

      "displayFractionLength" => 2

      "orderFractionLength" => 2

      "currencyServiceStatus" => "1"

      "validSeconds" => 10

      "generatedAt" => "20200320210755456"

      "ttm" => "110.09"

    ]

    ...

  ]

  -authorityList: []

  -statementList: array:5 [

    0 => AurimasNiekis\GmoAozoraClient\Model\PaymentStatementEntry^ {#14

      -raw: array:7 [

        ...

      ]

      -data: DateTimeImmutable @1584706076 {#13

        date: 2020-03-20 12:07:56.0 UTC (+00:00)

      }

      -remark: "Visa"

      -memo: null

      -amount: "400"

      -balance: "123456789"

      -accountEntryNumber: "123456"

      -creditDebitType: "2"

    }

    1 => AurimasNiekis\GmoAozoraClient\Model\IncomeStatementEntry^ {#14

      -raw: array:7 [

        ...

      ]

      -data: DateTimeImmutable @1584706076 {#13

        date: 2020-03-20 12:07:56.0 UTC (+00:00)

      }

      -remark: "Visa"

      -memo: null

      -amount: "123456789"

      -balance: "123456789"

      -accountEntryNumber: "123456"

      -creditDebitType: "1"

    }

    ...

  ]

}

```

### Statements

Ordinary Deposit Statements:

```php

$statements = $client->ordinaryDepositStatement(

   DateTimeInterface $toDate = null,

   DateTimeInterface $fromDate = null,

   int $perPage = 2000

)

```

Foreign Currency Ordinary Deposit Statements:

```php

$statements = $client->foreignOrdinaryDepositStatement(

   DateTimeInterface $toDate = null,

   DateTimeInterface $fromDate = null,

   int $perPage = 2000

)

```

Term Deposit Statements:

```php

$statements = $client->termDepositStatement(

   DateTimeInterface $toDate = null,

   DateTimeInterface $fromDate = null,

   int $perPage = 2000

)

```

Sweep Account Statements:

```php

$statements = $client->sweepAccountStatement(

   DateTimeInterface $toDate = null,

   DateTimeInterface $fromDate = null,

   int $perPage = 2000

)

```

Raw statement:

```php

$statements = $client->rawStatement(

    string $type,

    array $options,

    DateTimeInterface $toDate = null,

    DateTimeInterface $fromDate = null,

    int $offset = 0,

    int $limit = 20

)

```

Raw statements with all pages fetched:

```php

$statements = $client->rawStatementAll(

   string $type,

   array $options,

   DateTimeInterface $toDate = null,

   DateTimeInterface $fromDate = null,

   int $perPage = 2000

)

```

Results for these functions are the same:

```php

array:100 [

    0 => AurimasNiekis\GmoAozoraClient\Model\PaymentStatementEntry^ {#14

      -raw: array:7 [

        ...

      ]

      -data: DateTimeImmutable @1584706076 {#13

        date: 2020-03-20 12:07:56.0 UTC (+00:00)

      }

      -remark: "Visa"

      -memo: null

      -amount: "400"

      -balance: "123456789"

      -accountEntryNumber: "123456"

      -creditDebitType: "2"

    },

    ...

]

```

Visa Statements:

```php

$statements = $client->visaStatement(

   DateTimeInterface $toDate = null,

   DateTimeInterface $fromDate = null,

   int $perPage = 2000

)

```

```php

array:100 [

   0 => AurimasNiekis\GmoAozoraClient\Model\VisaStatementEntry^ {#21

    -raw: array:9 [

      ...

    ]

    -date: DateTimeImmutable @1584274771 {#22

      date: 2020-03-15 12:19:31.0 UTC (+00:00)

    }

    -usage: "ＡＭＡＺＯＮ．ＣＯ．ＪＰ"

    -amount: "1234"

    -status: "1"

    -localCurrencyAmount: "0.0"

    -atmUseFee: null

    -currency: null

    -conversionRate: null

    -approvalNumber: "12345"

  }

  ...

]

```

## Testing

Run PHP style checker

```bash

$ composer cs-check

```

Run PHP style fixer

```bash

$ composer cs-fix

```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

## License

Please see [License File](LICENSE) for more information.

[ico-version]: https://img.shields.io/packagist/v/aurimasniekis/gmo-aozora-client.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-travis]: https://img.shields.io/travis/com/aurimasniekis/gmo-aozora-client/master.svg?style=flat-square

[ico-downloads]: https://img.shields.io/packagist/dt/aurimasniekis/gmo-aozora-client.svg?style=flat-square

[ico-email]: https://img.shields.io/badge/[email protected]?style=flat-square

[link-travis]: https://travis-ci.org/aurimasniekis/gmo-aozora-client

[link-packagist]: https://packagist.org/packages/aurimasniekis/gmo-aozora-client

[link-downloads]: https://packagist.org/packages/aurimasniekis/gmo-aozora-client/stats

[link-email]: mailto:[email protected]