PayPay Bank #

@mnie/provider-paypay-bank connects to PayPay Bank and exposes the shared provider interface.

Setup #

PAYPAY_BANK_BRANCH=123
PAYPAY_BANK_ACCOUNT=1234567
PAYPAY_BANK_PASSWORD=your-login-password
PAYPAY_BANK_BASE_URL=https://bank.example.com

The branch number must contain three digits and the account number seven digits. PAYPAY_BANK_BASE_URL must be an origin without a path, query, or fragment.

Login and balance retrieval #

import { login } from '@mnie/provider-paypay-bank'

const profile = await login()

try {
  const balance = await profile.getBalance()
  console.log(balance.amount)
} finally {
  await profile.logout()
}

Credentials can also be passed directly to login().

const profile = await login({
  branchNo: '123',
  accountNo: '1234567',
  password: process.env.PAYPAY_BANK_PASSWORD,
  baseURL: process.env.PAYPAY_BANK_BASE_URL,
})

Returned values #

getBalance() returns the following values.

The provider supports account, balance, and transaction-history reads. Transfers, term deposits, and other operations are not supported. Call logout() from a finally block after use to end the session.

Transaction history is available through the shared history.list operation. Pass from and to as YYYY-MM-DD values to request a date range. Only transaction history is supported.

Reusing a client #

Use createPayPayBankClient() when the endpoint is fixed and you need to log in multiple times.

import { createPayPayBankClient } from '@mnie/provider-paypay-bank'

const client = createPayPayBankClient({
  baseURL: process.env.PAYPAY_BANK_BASE_URL!,
})

const profile = await client.login({
  branchNo: '123',
  accountNo: '1234567',
  password: process.env.PAYPAY_BANK_PASSWORD,
})