Skip to content

Commit

Permalink
Merge pull request #43 from pokepay/release/0.2.6
Browse files Browse the repository at this point in the history
refs/heads/release/0.2.6
  • Loading branch information
masatoi authored Jul 19, 2024
2 parents 691ddf4 + cdd6a90 commit 5b7e25f
Show file tree
Hide file tree
Showing 112 changed files with 12,160 additions and 5,927 deletions.
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {
}

group 'partner-java-sdk'
version '0.2.5'
version '0.2.6'

sourceCompatibility = 1.8

Expand Down
20 changes: 12 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ APIサーバがエラーレスポンスを返した場合に使われます。
- [ListTransfersV2](./transfer.md#list-transfers-v2):

### Check
- [CreateCheck](./check.md#create-check): チャージQRコードの発行
- [ListChecks](./check.md#list-checks): チャージQRコード一覧の取得
- [CreateCheck](./check.md#create-check): チャージQRコードの発行
- [GetCheck](./check.md#get-check): チャージQRコードの表示
- [UpdateCheck](./check.md#update-check): チャージQRコードの更新
- [CreateTopupTransactionWithCheck](./check.md#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
Expand All @@ -108,15 +108,16 @@ APIサーバがエラーレスポンスを返した場合に使われます。
- [UpdateBill](./bill.md#update-bill): 支払いQRコードの更新

### Cashtray
- [CreateTransactionWithCashtray](./cashtray.md#create-transaction-with-cashtray): CashtrayQRコードを読み取ることで取引する
- [CreateCashtray](./cashtray.md#create-cashtray): Cashtrayを作る
- [GetCashtray](./cashtray.md#get-cashtray): Cashtrayの情報を取得する
- [CancelCashtray](./cashtray.md#cancel-cashtray): Cashtrayを無効化する
- [GetCashtray](./cashtray.md#get-cashtray): Cashtrayの情報を取得する
- [UpdateCashtray](./cashtray.md#update-cashtray): Cashtrayの情報を更新する

### Customer
- [DeleteAccount](./customer.md#delete-account): ウォレットを退会する
- [GetAccount](./customer.md#get-account): ウォレット情報を表示する
- [UpdateAccount](./customer.md#update-account): ウォレット情報を更新する
- [DeleteAccount](./customer.md#delete-account): ウォレットを退会する
- [ListAccountBalances](./customer.md#list-account-balances): エンドユーザーの残高内訳を表示する
- [ListAccountExpiredBalances](./customer.md#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
- [UpdateCustomerAccount](./customer.md#update-customer-account): エンドユーザーのウォレット情報を更新する
Expand All @@ -137,7 +138,6 @@ APIサーバがエラーレスポンスを返した場合に使われます。
- [UpdateShop](./shop.md#update-shop): 店舗情報を更新する

### User
- [GetUser](./user.md#get-user):

### Account
- [ListUserAccounts](./account.md#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
Expand All @@ -154,18 +154,19 @@ APIサーバがエラーレスポンスを返した場合に使われます。
### Event
- [CreateExternalTransaction](./event.md#create-external-transaction): ポケペイ外部取引を作成する
- [RefundExternalTransaction](./event.md#refund-external-transaction): ポケペイ外部取引をキャンセルする
- [GetExternalTransactionByRequestId](./event.md#get-external-transaction-by-request-id): リクエストIDからポケペイ外部取引を取得する

### Campaign
- [CreateCampaign](./campaign.md#create-campaign): ポイント付与キャンペーンを作る
- [ListCampaigns](./campaign.md#list-campaigns): キャンペーン一覧を取得する
- [CreateCampaign](./campaign.md#create-campaign): ポイント付与キャンペーンを作る
- [GetCampaign](./campaign.md#get-campaign): キャンペーンを取得する
- [UpdateCampaign](./campaign.md#update-campaign): ポイント付与キャンペーンを更新する

### Webhook
- [CreateWebhook](./webhook.md#create-webhook): webhookの作成
- [ListWebhooks](./webhook.md#list-webhooks): 作成したWebhookの一覧を返す
- [UpdateWebhook](./webhook.md#update-webhook): Webhookの更新
- [CreateWebhook](./webhook.md#create-webhook): webhookの作成
- [DeleteWebhook](./webhook.md#delete-webhook): Webhookの削除
- [UpdateWebhook](./webhook.md#update-webhook): Webhookの更新

### Coupon
- [ListCoupons](./coupon.md#list-coupons): クーポン一覧の取得
Expand All @@ -179,7 +180,10 @@ APIサーバがエラーレスポンスを返した場合に使われます。
- [ActivateUserDevice](./user_device.md#activate-user-device): デバイスの有効化

### BankPay
- [CreateBank](./bank_pay.md#create-bank): 銀行口座の登録
- [ListBanks](./bank_pay.md#list-banks): 登録した銀行の一覧
- [CreateBank](./bank_pay.md#create-bank): 銀行口座の登録
- [CreateBankTopupTransaction](./bank_pay.md#create-bank-topup-transaction): 銀行からのチャージ

### SevenBankATMSession
- [GetSevenBankATMSession](./seven_bank_atm_session.md#get-seven-bank-atm-session): セブン銀行ATMセッションの取得

10 changes: 6 additions & 4 deletions docs/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
Request request = new ListUserAccounts(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // userId: ユーザーID
)
.page(9970) // ページ番号
.perPage(7800); // 1ページ分の取引数
.page(7596) // ページ番号
.perPage(8261); // 1ページ分の取引数

```

Expand Down Expand Up @@ -61,6 +61,7 @@ Request request = new ListUserAccounts(
を返します



---


Expand All @@ -73,8 +74,8 @@ Request request = new CreateUserAccount(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // userId: ユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // privateMoneyId: マネーID
)
.name("musaHN4dAo0kcMwrj6lsuth9pSzmqVAxW3BZh2UFG0NdobuyCqKAyF8XBloHn7nUM7l934bPMQ7DIwFMXGuPCrmdUDxKggDFfFvOJkxhc8IPvtQD4QxNm6tX3Guvbo2vDNfvQpElqxJKgNyOMeXS2rUoCJ5iHqor") // ウォレット名
.externalId("IswPc2cB") // 外部ID
.name("xIIOg9CcbCgtxt4qQAP06TDLYKBc2zPf6wToG8lTKcMPiFJX3LNKTomMc8wnROYRP673oHx5N3DOO7AdxANDE2ea2N2bsCqxQkk2AG5TTqX05IlCZ5tUdSwXVRIVCnl") // ウォレット名
.externalId("Zj6NtOwX2FI8Wr1369uaTF42") // 外部ID
.metadata("{\"key1\":\"foo\",\"key2\":\"bar\"}"); // ウォレットに付加するメタデータ

```
Expand Down Expand Up @@ -153,6 +154,7 @@ Request request = new CreateUserAccount(
を返します



---


Expand Down
99 changes: 51 additions & 48 deletions docs/bank_pay.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,54 @@
BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。


<a name="list-banks"></a>
## ListBanks: 登録した銀行の一覧
登録した銀行を一覧します

```JAVA
Request request = new ListBanks(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // userDeviceId: デバイスID
)
.privateMoneyId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

```



### Parameters
**`userDeviceId`**



```json
{
"type": "string",
"format": "uuid"
}
```

**`privateMoneyId`**



```json
{
"type": "string",
"format": "uuid"
}
```



成功したときは
[Banks](./responses.md#banks)
を返します



---


<a name="create-bank"></a>
## CreateBank: 銀行口座の登録
銀行口座の登録を始めるAPIです。レスポンスに含まれるredirect_urlをユーザーの端末で開き銀行を登録します。
Expand All @@ -17,7 +65,7 @@ Request request = new CreateBank(
"<Deep Link>", // callbackUrl: コールバックURL
"ポケペイタロウ" // kana: ユーザーの氏名 (片仮名で指定)
)
.email("qC15yVJZpc@8KVp.com") // ユーザーのメールアドレス
.email("NJhR9grzsE@T9HH.com") // ユーザーのメールアドレス
.birthdate("19901142"); // 生年月日

```
Expand Down Expand Up @@ -99,52 +147,6 @@ Request request = new CreateBank(
を返します


---


<a name="list-banks"></a>
## ListBanks: 登録した銀行の一覧
登録した銀行を一覧します

```JAVA
Request request = new ListBanks(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // userDeviceId: デバイスID
)
.privateMoneyId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

```



### Parameters
**`userDeviceId`**



```json
{
"type": "string",
"format": "uuid"
}
```

**`privateMoneyId`**



```json
{
"type": "string",
"format": "uuid"
}
```



成功したときは
[Banks](./responses.md#banks)
を返します


---

Expand All @@ -157,7 +159,7 @@ Request request = new ListBanks(
Request request = new CreateBankTopupTransaction(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // userDeviceId: デバイスID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // privateMoneyId: マネーID
7742, // amount: チャージ金額
6059, // amount: チャージ金額
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // bankId: 銀行ID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // requestId: リクエストID
);
Expand Down Expand Up @@ -229,6 +231,7 @@ Request request = new CreateBankTopupTransaction(
を返します



---


Expand Down
41 changes: 30 additions & 11 deletions docs/bill.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@

```JAVA
Request request = new ListBills()
.page(8308) // ページ番号
.perPage(5622) // 1ページの表示数
.billId("laKx") // 支払いQRコードのID
.page(8059) // ページ番号
.perPage(5147) // 1ページの表示数
.billId("zIdrHm6O") // 支払いQRコードのID
.privateMoneyId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") // マネーID
.organizationCode("CMf-9Tbr-uA-3dv2K1u-t2aU848H--") // 組織コード
.organizationCode("-23E-1evC3-m6V-ESLc-029-YOZ-UkK") // 組織コード
.description("test bill") // 取引説明文
.createdFrom("2020-01-14T03:21:13.000000Z") // 作成日時(起点)
.createdTo("2020-09-03T11:53:51.000000Z") // 作成日時(終点)
.createdFrom("2022-04-17T00:55:51.000000Z") // 作成日時(起点)
.createdTo("2020-04-15T22:23:38.000000Z") // 作成日時(終点)
.shopName("bill test shop1") // 店舗名
.shopId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") // 店舗ID
.lowerLimitAmount(3745) // 金額の範囲によるフィルタ(下限)
.upperLimitAmount(6172) // 金額の範囲によるフィルタ(上限)
.lowerLimitAmount(4503) // 金額の範囲によるフィルタ(下限)
.upperLimitAmount(605) // 金額の範囲によるフィルタ(上限)
.setDisabled(true); // 支払いQRコードが無効化されているかどうか

```
Expand Down Expand Up @@ -193,6 +193,12 @@ Request request = new ListBills()
[PaginatedBills](./responses.md#paginated-bills)
を返します

### Error Responses
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|



---

Expand All @@ -206,7 +212,7 @@ Request request = new CreateBill(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // privateMoneyId: 支払いマネーのマネーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // shopId: 支払い先(受け取り人)の店舗ID
)
.amount(6991.0) // 支払い額
.amount(5417.0) // 支払い額
.description("test bill"); // 説明文(アプリ上で取引の説明文として表示される)

```
Expand Down Expand Up @@ -266,6 +272,18 @@ Request request = new CreateBill(
[Bill](./responses.md#bill)
を返します

### Error Responses
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|shop_account_not_found||The shop account is not found|
|422|private_money_not_found||Private money not found|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
|422|account_closed|アカウントは退会しています|The account is closed|
|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
|422|account_suspended|アカウントは停止されています|The account is suspended|



---

Expand All @@ -278,9 +296,9 @@ Request request = new CreateBill(
Request request = new UpdateBill(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // billId: 支払いQRコードのID
)
.amount(3919.0) // 支払い額
.amount(232.0) // 支払い額
.description("test bill") // 説明文
.setDisabled(true); // 無効化されているかどうか
.setDisabled(false); // 無効化されているかどうか

```

Expand Down Expand Up @@ -342,6 +360,7 @@ Request request = new UpdateBill(
を返します



---


Expand Down
18 changes: 14 additions & 4 deletions docs/bulk.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ CSVファイルから一括取引をします。

```JAVA
Request request = new BulkCreateTransaction(
"skU0m8hSr1melepO9LnwIsUc", // name: 一括取引タスク名
"mvb4", // content: 取引する情報のCSV
"GOUqCz9cGDIhlPt52zP7YS2DWusWLcKpd2P3" // requestId: リクエストID
"mtEHAWzKVmwmqN4ax1Q1", // name: 一括取引タスク名
"Fha0", // content: 取引する情報のCSV
"o1JxRbdO7sJMkOiIt9zNKCX0VzisXLLiEpUL" // requestId: リクエストID
)
.description("35Nv6jpCTg7cI") // 一括取引の説明
.description("tiIsW57odiOHhS8DsZfAQRFK6oTTeP8tTTuInowX2TMHi2vDKbmu86aUF4jypKaAY4yQaiw0JpUpNfjrUKaUCU4cuncfOgZgC0vnz9vdHX") // 一括取引の説明
.privateMoneyId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"); // マネーID

```
Expand Down Expand Up @@ -105,6 +105,16 @@ Request request = new BulkCreateTransaction(
[BulkTransaction](./responses.md#bulk-transaction)
を返します

### Error Responses
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|403|organization_not_issuer|発行体以外に許可されていない操作です|Unpermitted operation except for issuer organizations.|
|409|NULL|NULL|NULL|
|422|private_money_not_found||Private money not found|
|422|bulk_transaction_invalid_csv_format|入力されたCSVデータに誤りがあります|Invalid csv format|



---

Expand Down
Loading

0 comments on commit 5b7e25f

Please sign in to comment.