Skip to content

refs/heads/release/0.4.29 #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 3 commits into
base: master
Choose a base branch
from
Open

refs/heads/release/0.4.29 #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4019823
generate
Aug 13, 2026
a85c282
update error-response.csv
Aug 13, 2026
24ab3b9
0.4.29
Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ while (true) {
- [GetTransactionByRequestId](./transaction.md#get-transaction-by-request-id): リクエストIDから取引情報を取得する
- [GetBulkTransaction](./transaction.md#get-bulk-transaction): バルク取引ジョブの実行状況を取得する
- [ListBulkTransactionJobs](./transaction.md#list-bulk-transaction-jobs): バルク取引ジョブの詳細情報一覧を取得する
- [CancelBulkTransaction](./transaction.md#cancel-bulk-transaction): バルク取引をキャンセルする
- [ResumeBulkTransaction](./transaction.md#resume-bulk-transaction): バルク取引を再開する
- [RequestUserStats](./transaction.md#request-user-stats): 指定期間内の顧客が行った取引の統計情報をCSVでダウンロードする
- [TerminateUserStats](./transaction.md#terminate-user-stats): RequestUserStatsのタスクを強制終了する

Expand Down
8 changes: 4 additions & 4 deletions docs/account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Customerのウォレットはマネー残高(有償バリュー)、ポイント
$request = new Request\ListUserAccounts(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // userId: ユーザーID
[
'page' => 3029, // ページ番号
'per_page' => 9398 // 1ページ分の取引数
'page' => 6426, // ページ番号
'per_page' => 8632 // 1ページ分の取引数
]
);
```
Expand Down Expand Up @@ -91,8 +91,8 @@ $request = new Request\CreateUserAccount(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // userId: ユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // privateMoneyId: マネーID
[
'name' => "XIAxp1c5Q2vG7By91KC2xkwbMvROWfUAhh6XnZz0yJYgRGAM6oTzljbZYS9b6qmrSFaDiVxdn1z0TuA7dLQ8GnuuGnm3um0ZKYlqHYAPfacx4ba4pxXiFCicQd3QQrdtpp5IlW8KnTaroT8w3801ZxeZpTa0FFkkUFLVCDKp9TvCsVFg3Dy6t9FVfvRBKOl2QQeBI5NM6J7EhkzGk22yYle2ZOPXJOiEYcNwwBKhoxCdqw8S", // ウォレット名
'external_id' => "S6L7O", // 外部ID
'name' => "jeLeg5dXfz8LlL819MpDMdbxSiedHtUdWqjwNZ6SqXcjRYXWjjppT0r9xvCuvBOfsidrDI9VlsfxLxW5axZvNGABU1Kq4dKF1", // ウォレット名
'external_id' => "CFldqrEeXCX83UsZSPbix6b1Za3ly7V1xEB", // 外部ID
'metadata' => "{\"key1\":\"foo\",\"key2\":\"bar\"}" // ウォレットに付加するメタデータ
]
);
Expand Down
4 changes: 2 additions & 2 deletions docs/bank_pay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ $request = new Request\CreateBank(
"<Deep Link>", // callbackUrl: コールバックURL
"ポケペイタロウ", // kana: ユーザーの氏名 (片仮名で指定)
[
'email' => "TvYgQYDODN@TX3Y.com", // ユーザーのメールアドレス
'email' => "Q97NziA5jL@yP8d.com", // ユーザーのメールアドレス
'birthdate' => "19901142" // 生年月日
]
);
Expand Down Expand Up @@ -236,7 +236,7 @@ $request = new Request\CreateBank(
$request = new Request\CreateBankTopupTransaction(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // userDeviceId: デバイスID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // privateMoneyId: マネーID
6708, // amount: チャージ金額
4271, // amount: チャージ金額
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // bankId: 銀行ID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // requestId: リクエストID
[
Expand Down
81 changes: 65 additions & 16 deletions docs/bill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ amountが空の場合は、ユーザによる自由入力で受け付けた金
```PHP
$request = new Request\ListBills(
[
'page' => 3385, // ページ番号
'per_page' => 9515, // 1ページの表示数
'bill_id' => "ow", // 支払いQRコードのID
'page' => 1792, // ページ番号
'per_page' => 520, // 1ページの表示数
'bill_id' => "V", // 支払いQRコードのID
'private_money_id' => "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
'organization_code' => "I-67J-T", // 組織コード
'organization_code' => "g-A-CSQXW5gv3k4TW", // 組織コード
'description' => "test bill", // 取引説明文
'created_from' => "2020-10-17T02:26:13.000000Z", // 作成日時(起点)
'created_to' => "2024-03-23T16:45:49.000000Z", // 作成日時(終点)
'created_from' => "2021-02-01T23:40:37.000000Z", // 作成日時(起点)
'created_to' => "2025-08-13T03:13:00.000000Z", // 作成日時(終点)
'shop_name' => "bill test shop1", // 店舗名
'shop_id' => "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
'lower_limit_amount' => 3641, // 金額の範囲によるフィルタ(下限)
'upper_limit_amount' => 2814, // 金額の範囲によるフィルタ(上限)
'lower_limit_amount' => 8719, // 金額の範囲によるフィルタ(下限)
'upper_limit_amount' => 6955, // 金額の範囲によるフィルタ(上限)
'is_disabled' => TRUE // 支払いQRコードが無効化されているかどうか
]
);
Expand Down Expand Up @@ -257,14 +257,15 @@ $request = new Request\ListBills(

<a name="create-bill"></a>
## CreateBill: 支払いQRコードの発行
支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
支払いQRコードを作成します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。

```PHP
$request = new Request\CreateBill(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // privateMoneyId: 支払いマネーのマネーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // shopId: 支払い先(受け取り人)の店舗ID
[
'amount' => 5879.0, // 支払い額
'amount' => 5792.0, // 支払い額
'additional_private_money_ids' => ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], // 追加の支払いマネーのマネーID
'description' => "test bill" // 説明文(アプリ上で取引の説明文として表示される)
]
);
Expand Down Expand Up @@ -304,6 +305,29 @@ $request = new Request\CreateBill(

</details>

#### `additional_private_money_ids`
複数マネー対応支払いQRコードにするために、`private_money_id` 以外に支払いに使えるマネーのマネーIDを指定します。
エンドユーザはアプリでの読み取り時に、ここで指定したマネーを含む中から支払うマネーを選択できます。
マネーを明示的に選択しなかった場合は `private_money_id` で指定したマネーによる支払いになります。

支払い先の店舗ユーザは、ここで指定した全てのマネーのウォレットを持っている必要があります。
また `amount` を指定する場合の上限額は、`private_money_id` と合わせた全マネーの取引上限額のうち最小のものです。

<details>
<summary>スキーマ</summary>

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

</details>

#### `shop_id`

<details>
Expand Down Expand Up @@ -335,17 +359,17 @@ $request = new Request\CreateBill(


成功したときは
[Bill](./responses.md#bill)
[BillWithAdditionalPrivateMoneys](./responses.md#bill-with-additional-private-moneys)
を返します

### Error Responses
|status|type|ja|en|
|---|---|---|---|
|400|invalid_parameter_bill_amount_or_range_exceeding_transfer_limit|支払いQRコードの金額がマネーの取引可能金額の上限を超えています|The input amount is exceeding the private money's limit for transfer|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
|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 Down Expand Up @@ -386,7 +410,7 @@ $request = new Request\GetBill(


成功したときは
[Bill](./responses.md#bill)
[BillWithAdditionalPrivateMoneys](./responses.md#bill-with-additional-private-moneys)
を返します


Expand All @@ -402,9 +426,10 @@ $request = new Request\GetBill(
$request = new Request\UpdateBill(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // billId: 支払いQRコードのID
[
'amount' => 6264.0, // 支払い額
'amount' => 8497.0, // 支払い額
'description' => "test bill", // 説明文
'is_disabled' => TRUE // 無効化されているかどうか
'is_disabled' => FALSE, // 無効化されているかどうか
'additional_private_money_ids' => ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] // 追加の支払いマネーのマネーID
]
);
```
Expand Down Expand Up @@ -472,10 +497,34 @@ $request = new Request\UpdateBill(

</details>

#### `additional_private_money_ids`
複数マネー対応支払いQRコードの、デフォルトマネー以外に支払いに使えるマネーを指定し直します。
ここで渡した内容で置き換えられるため、既存の追加マネーを残したい場合は残したいマネーIDも含めて渡してください。
空配列を渡すと追加マネーが全て外れ、デフォルトマネーのみの支払いQRコードになります。
このパラメータ自体を省略した場合、追加マネーの設定は変更されません。

支払い先の店舗ユーザは、ここで指定した全てのマネーのウォレットを持っている必要があります。
デフォルトマネーは変更できません。

<details>
<summary>スキーマ</summary>

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

</details>



成功したときは
[Bill](./responses.md#bill)
[BillWithAdditionalPrivateMoneys](./responses.md#bill-with-additional-private-moneys)
を返します


Expand Down
13 changes: 7 additions & 6 deletions docs/bulk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Bulk
一括取引処理を表すデータです。
CSVファイルのアップロードにより、複数件の取引をバッチ処理する非同期APIを提供します。
一括処理のステータス（submitted, examining, queued, processing, error, done）を監視できます。
一括処理のステータス（submitted, examining, queued, processing, error, done, scheduled, canceled）を監視できます。
処理完了時にコールバックURLへの通知も可能です。
また、スケジュール実行時刻を指定して将来の時点で処理を実行することもできます。

Expand All @@ -12,13 +12,13 @@ CSVファイルから一括取引をします。

```PHP
$request = new Request\BulkCreateTransaction(
"Lm8H", // name: 一括取引タスク名
"uYz", // content: 取引する情報のCSV
"7E9ZuYBAHz0vH45u4SHdXpfYeqMtcfd8wxcy", // requestId: リクエストID
"k2ABcz8aQVQ46LR", // name: 一括取引タスク名
"ceMuSvImdD", // content: 取引する情報のCSV
"q9y3aEus7kZPbP6pY7uTyJAbvra0dcpr2XBa", // requestId: リクエストID
[
'description' => "IW1kAzyAHjkW0eFslSf8NaBTyV6GBT8tDHI0zWcr0sMpkdiHOOwl5xIQiAP4UplfuFUQK5yc0JqyEbk4xV1ElwOVpwOgCs3REJLXlOpH", // 一括取引の説明
'description' => "BtLUqtpR4s1JU0lVQ2OypewcGn6EYrIoiJUtnz4tPDjzGeH1vMI9teS2D85S1UHA16vfzALVhDfzoJqhsy99eYUXwCEgrx3b6fZBGl5iNgWbOvie519sB5ATf", // 一括取引の説明
'private_money_id' => "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
'callback_url' => "https://9qH3Tntl.example.com" // コールバックURL
'callback_url' => "https://DwJwr3eQ.example.com" // コールバックURL
]
);
```
Expand Down Expand Up @@ -175,6 +175,7 @@ $request = new Request\BulkCreateTransaction(
|409|NULL|NULL|NULL|
|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|bulk_transaction_invalid_csv_format|入力されたCSVデータに誤りがあります|Invalid csv format|
|503|temporarily_unavailable||Service Unavailable|



Expand Down
Loading
Loading