Merge pull request #17 from pokepay/release/1.3.8

refs/heads/release/1.3.8
pokepay · Apr 9, 2024 · 9d4681e · 9d4681e
2 parents 63976c8 + 7139688
commit 9d4681e
Show file tree

Hide file tree

Showing 101 changed files with 5,098 additions and 4,176 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -196,8 +196,8 @@ try {
 - [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コードを読み取ることでチャージする
@@ -209,14 +209,14 @@ try {
 
 ### Cashtray
 - [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): エンドユーザーのウォレット情報を更新する
@@ -254,18 +254,19 @@ try {
 ### 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): クーポン一覧の取得
@@ -279,7 +280,7 @@ try {
 - [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): 銀行からのチャージ
 
diff --git a/docs/account.md b/docs/account.md
@@ -8,8 +8,8 @@
 Request.ListUserAccounts request = new Request.ListUserAccounts(
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ユーザーID
 ) {
-    Page = 5690,  // ページ番号
-    PerPage = 3320,  // 1ページ分の取引数
+    Page = 4737,  // ページ番号
+    PerPage = 7029,  // 1ページ分の取引数
 };
 Response.PaginatedAccountDetails response = await request.Send(client);
 ```
@@ -62,6 +62,7 @@ Response.PaginatedAccountDetails response = await request.Send(client);
 を返します
 
 
+
 ---
 
 
@@ -74,8 +75,8 @@ Request.CreateUserAccount request = new Request.CreateUserAccount(
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ユーザーID
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
 ) {
-    Name = "BiPR32MXZafz3jffpT8lgGERnFdcWhSdaJfJ60D0H2T0aKhnL3FlnAD82QrpYaKuslNraOesyAiawWiyWkSV3bs4OkWhHFx3P67yxFmxWAZtUSoiVrIFnb7w6ZClkoqVajvuG5cGcBP5wA9",  // ウォレット名
-    ExternalId = "GwSB8bfxMId7hFKERGvYa7vbD1",  // 外部ID
+    Name = "RhEmEhncAz9T8Jn6tKv842hmKtJWGe0W2JoBVxOBG6QSEaMM6DcJjfAtdrmKAg3KBKDu0vlbYdVC6n9nVLo43cE33CQPF6kxIlI0uguDnziraNYM7VX5YLnlD8HOOCDlP4GZ7jbmXMO5zVMwfk3fyCehTHNb57OPgysrQCIrNbKg5EGtS1CRG8HTOfVnvp3qGXZFBsOSpPHbliv7UIdhUMzObVJcG5btiH5rur7GsubMGTjIcOX",  // ウォレット名
+    ExternalId = "KD9o8Kba3zToGBU",  // 外部ID
     Metadata = "{\"key1\":\"foo\",\"key2\":\"bar\"}",  // ウォレットに付加するメタデータ
 };
 Response.AccountDetail response = await request.Send(client);
@@ -155,6 +156,7 @@ Response.AccountDetail response = await request.Send(client);
 を返します
 
 
+
 ---
 
 

diff --git a/docs/bank_pay.md b/docs/bank_pay.md
@@ -2,6 +2,55 @@
 BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。
 
 
+<a name="list-banks"></a>
+## ListBanks: 登録した銀行の一覧
+登録した銀行を一覧します
+
+```csharp
+Request.ListBanks request = new Request.ListBanks(
+    "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // デバイスID
+) {
+    PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+};
+Response.Banks response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`user_device_id`** 
+
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`private_money_id`** 
+
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[Banks](./responses.md#banks)
+を返します
+
+
+
+---
+
+
 <a name="create-bank"></a>
 ## CreateBank: 銀行口座の登録
 銀行口座の登録を始めるAPIです。レスポンスに含まれるredirect_urlをユーザーの端末で開き銀行を登録します。
@@ -17,7 +66,7 @@ Request.CreateBank request = new Request.CreateBank(
     "<Deep Link>", // コールバックURL
     "ポケペイタロウ" // ユーザーの氏名 (片仮名で指定)
 ) {
-    Email = "HNb57OPgys@rQCI.com",  // ユーザーのメールアドレス
+    Email = "x2jnlKrw0L@dNS4.com",  // ユーザーのメールアドレス
     Birthdate = "19901142",  // 生年月日
 };
 Response.BankRegisteringInfo response = await request.Send(client);
@@ -100,53 +149,6 @@ Response.BankRegisteringInfo response = await request.Send(client);
 を返します
 
 
----
-
-
-<a name="list-banks"></a>
-## ListBanks: 登録した銀行の一覧
-登録した銀行を一覧します
-
-```csharp
-Request.ListBanks request = new Request.ListBanks(
-    "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // デバイスID
-) {
-    PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
-};
-Response.Banks response = await request.Send(client);
-```
-
-
-
-### Parameters
-**`user_device_id`** 
-
-
-
-```json
-{
-  "type": "string",
-  "format": "uuid"
-}
-```
-
-**`private_money_id`** 
-
-
-
-```json
-{
-  "type": "string",
-  "format": "uuid"
-}
-```
-
-
-
-成功したときは
-[Banks](./responses.md#banks)
-を返します
-
 
 ---
 
@@ -159,7 +161,7 @@ Response.Banks response = await request.Send(client);
 Request.CreateBankTopupTransaction request = new Request.CreateBankTopupTransaction(
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // デバイスID
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
-    2895, // チャージ金額
+    8102, // チャージ金額
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 銀行ID
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // リクエストID
 );
@@ -231,6 +233,7 @@ Response.TransactionDetail response = await request.Send(client);
 を返します
 
 
+
 ---
 
 

diff --git a/docs/bill.md b/docs/bill.md
@@ -7,19 +7,19 @@
 
 ```csharp
 Request.ListBills request = new Request.ListBills() {
-    Page = 3989,  // ページ番号
-    PerPage = 3402,  // 1ページの表示数
-    BillId = "atpE7508L",  // 支払いQRコードのID
+    Page = 231,  // ページ番号
+    PerPage = 1828,  // 1ページの表示数
+    BillId = "h7IyYB",  // 支払いQRコードのID
     PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  // マネーID
-    OrganizationCode = "-1-XK--g-",  // 組織コード
+    OrganizationCode = "-k-----Yq2hrn5-RcDh",  // 組織コード
     Description = "test bill",  // 取引説明文
-    CreatedFrom = "2020-02-22T21:37:01.000000+09:00",  // 作成日時(起点)
-    CreatedTo = "2021-08-12T03:19:42.000000+09:00",  // 作成日時(終点)
+    CreatedFrom = "2021-08-04T01:59:13.000000Z",  // 作成日時(起点)
+    CreatedTo = "2023-02-25T23:26:35.000000Z",  // 作成日時(終点)
     ShopName = "bill test shop1",  // 店舗名
     ShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  // 店舗ID
-    LowerLimitAmount = 2989,  // 金額の範囲によるフィルタ(下限)
-    UpperLimitAmount = 3813,  // 金額の範囲によるフィルタ(上限)
-    IsDisabled = false,  // 支払いQRコードが無効化されているかどうか
+    LowerLimitAmount = 5821,  // 金額の範囲によるフィルタ(下限)
+    UpperLimitAmount = 4653,  // 金額の範囲によるフィルタ(上限)
+    IsDisabled = true,  // 支払いQRコードが無効化されているかどうか
 };
 Response.PaginatedBills response = await request.Send(client);
 ```
@@ -194,6 +194,12 @@ Response.PaginatedBills response = await request.Send(client);
 [PaginatedBills](./responses.md#paginated-bills)
 を返します
 
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+
+
 
 ---
 
@@ -207,7 +213,7 @@ Request.CreateBill request = new Request.CreateBill(
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 支払いマネーのマネーID
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 支払い先(受け取り人)の店舗ID
 ) {
-    Amount = 3055.0,  // 支払い額
+    Amount = 2631.0,  // 支払い額
     Description = "test bill",  // 説明文(アプリ上で取引の説明文として表示される)
 };
 Response.Bill response = await request.Send(client);
@@ -268,6 +274,18 @@ Response.Bill response = await request.Send(client);
 [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|
+
+
 
 ---
 
@@ -280,7 +298,7 @@ Response.Bill response = await request.Send(client);
 Request.UpdateBill request = new Request.UpdateBill(
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 支払いQRコードのID
 ) {
-    Amount = 9988.0,  // 支払い額
+    Amount = 1596.0,  // 支払い額
     Description = "test bill",  // 説明文
     IsDisabled = true,  // 無効化されているかどうか
 };
@@ -345,6 +363,7 @@ Response.Bill response = await request.Send(client);
 を返します
 
 
+
 ---
 
 

diff --git a/docs/bulk.md b/docs/bulk.md
@@ -6,11 +6,11 @@ CSVファイルから一括取引をします。
 
 ```csharp
 Request.BulkCreateTransaction request = new Request.BulkCreateTransaction(
-    "pXocQ5N98CAVKuKRC5FLAIR", // 一括取引タスク名
-    "iGKuI", // 取引する情報のCSV
-    "8CNBTqLCZ99AjVbK3l31NeAICSoLJdEVZoJB" // リクエストID
+    "P9DvE8UV0j2YqC15yVJZpc8KVpHARBD", // 一括取引タスク名
+    "gg1Gn2X", // 取引する情報のCSV
+    "cmC1vS6JUWIFuWHifSCeHqDX4OovF1kPsfFA" // リクエストID
 ) {
-    Description = "0H",  // 一括取引の説明
+    Description = "UD6hedBMnO5c5siBhPS0PdEUgltcrxJuLRpPyEyLzg5USUF0acnAYj9bCB7rUqwv3jfmweeo8gmjkrVbM4yoFbYRleOf9KOkq0RFzjJ",  // 一括取引の説明
     PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  // マネーID
 };
 Response.BulkTransaction response = await request.Send(client);
@@ -106,6 +106,16 @@ Response.BulkTransaction response = await request.Send(client);
 [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|
+
+
 
 ---