diff --git a/docs/README.md b/docs/README.md
index 9abf217..0cd04e3 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -178,6 +178,7 @@ try {
- [ListTransactions](./transaction.md#list-transactions): 【廃止】取引履歴を取得する
- [CreateTransaction](./transaction.md#create-transaction): 【廃止】チャージする
- [ListTransactionsV2](./transaction.md#list-transactions-v2): 取引履歴を取得する
+- [ListBillTransactions](./transaction.md#list-bill-transactions): 支払い取引履歴を取得する
- [CreateTopupTransaction](./transaction.md#create-topup-transaction): チャージする
- [CreatePaymentTransaction](./transaction.md#create-payment-transaction): 支払いする
- [CreateCpmTransaction](./transaction.md#create-cpm-transaction): CPMトークンによる取引作成
@@ -189,6 +190,7 @@ try {
- [GetBulkTransaction](./transaction.md#get-bulk-transaction): バルク取引ジョブの実行状況を取得する
- [ListBulkTransactionJobs](./transaction.md#list-bulk-transaction-jobs): バルク取引ジョブの詳細情報一覧を取得する
- [RequestUserStats](./transaction.md#request-user-stats): 指定期間内の顧客が行った取引の統計情報をCSVでダウンロードする
+- [TerminateUserStats](./transaction.md#terminate-user-stats): RequestUserStatsのタスクを強制終了する
### Transfer
- [GetAccountTransferSummary](./transfer.md#get-account-transfer-summary):
@@ -205,9 +207,12 @@ try {
### Bill
- [ListBills](./bill.md#list-bills): 支払いQRコード一覧を表示する
- [CreateBill](./bill.md#create-bill): 支払いQRコードの発行
+- [GetBill](./bill.md#get-bill): 支払いQRコードの表示
- [UpdateBill](./bill.md#update-bill): 支払いQRコードの更新
+- [CreatePaymentTransactionWithBill](./bill.md#create-payment-transaction-with-bill): 支払いQRコードを読み取ることで支払いをする
### Cashtray
+- [CreateTransactionWithCashtray](./cashtray.md#create-transaction-with-cashtray): CashtrayQRコードを読み取ることで取引する
- [CreateCashtray](./cashtray.md#create-cashtray): Cashtrayを作る
- [CancelCashtray](./cashtray.md#cancel-cashtray): Cashtrayを無効化する
- [GetCashtray](./cashtray.md#get-cashtray): Cashtrayの情報を取得する
@@ -237,7 +242,6 @@ try {
- [UpdateShop](./shop.md#update-shop): 店舗情報を更新する
### User
-- [GetUser](./user.md#get-user):
### Account
- [ListUserAccounts](./account.md#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
@@ -280,7 +284,11 @@ try {
- [ActivateUserDevice](./user_device.md#activate-user-device): デバイスの有効化
### BankPay
+- [DeleteBank](./bank_pay.md#delete-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セッションの取得
+
diff --git a/docs/account.md b/docs/account.md
index 71bc4fc..573749c 100644
--- 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 = 1564, // ページ番号
- PerPage = 5762, // 1ページ分の取引数
+ Page = 272, // ページ番号
+ PerPage = 710, // 1ページ分の取引数
};
Response.PaginatedAccountDetails response = await request.Send(client);
```
@@ -75,8 +75,8 @@ Request.CreateUserAccount request = new Request.CreateUserAccount(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
) {
- Name = "k24Ceen1NSjytDUp3byZcFEPnIDVyEjs1xIVAG7PJaXsPvnXy7JLPWT4POJKIKUBKfvAdAdVhR8qFWp5tCaOkj67zOOhzPjoLUnpes4zWmpVcy9ixDX4fCfbAE0AZjhFFPDiC5XgRDuJC7DFGXWJ1DsLyOnXTqwNlXWPSNst44xBM1tMMoOyWoAqWcD5ADFBSPh7o2MC5sMNAQhF0HCoj9D", // ウォレット名
- ExternalId = "4ZpJqp2buSHK5WKI86hTWo47qb9nSKNBR3LjzCdQo4G", // 外部ID
+ Name = "7OqefuC0zsB8aQbgel1VXLZNhM7VCGfzH0EqAidHGV4baZPNRUSJ9iQNhB3KMhlAuhO2DrrEN6v7h6DIeIXBVaS0Zi07XrJykFEWCqS7fIGsgSUetvzhcyY8O4aW8dVGclxW2nJI1LDT3BhMLUADblZz6ydgd6gveWK49xDzlQxtC3xLL1ERUl6NhqK", // ウォレット名
+ ExternalId = "kD", // 外部ID
Metadata = "{\"key1\":\"foo\",\"key2\":\"bar\"}", // ウォレットに付加するメタデータ
};
Response.AccountDetail response = await request.Send(client);
diff --git a/docs/bank_pay.md b/docs/bank_pay.md
index 1dec2e1..983ea87 100644
--- a/docs/bank_pay.md
+++ b/docs/bank_pay.md
@@ -2,6 +2,54 @@
BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。
+
+## DeleteBank: 銀行口座の削除
+銀行口座を削除します
+
+```csharp
+Request.DeleteBank request = new Request.DeleteBank(
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // デバイスID
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+);
+Response.BankDeleted response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`user_device_id`**
+
+
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`bank_id`**
+
+
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[BankDeleted](./responses.md#bank-deleted)
+を返します
+
+
+
+---
+
+
## ListBanks: 登録した銀行の一覧
登録した銀行を一覧します
@@ -66,7 +114,7 @@ Request.CreateBank request = new Request.CreateBank(
"", // コールバックURL
"ポケペイタロウ" // ユーザーの氏名 (片仮名で指定)
) {
- Email = "EeKe2EnvF9@kW30.com", // ユーザーのメールアドレス
+ Email = "bFWlBc9nMo@uBhD.com", // ユーザーのメールアドレス
Birthdate = "19901142", // 生年月日
};
Response.BankRegisteringInfo response = await request.Send(client);
@@ -161,10 +209,12 @@ Response.BankRegisteringInfo response = await request.Send(client);
Request.CreateBankTopupTransaction request = new Request.CreateBankTopupTransaction(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // デバイスID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- 2810, // チャージ金額
+ 9012, // チャージ金額
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 銀行ID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // リクエストID
-);
+) {
+ ReceiverUserId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 受け取りユーザーID (デフォルトは自身)
+};
Response.TransactionDetail response = await request.Send(client);
```
@@ -208,6 +258,17 @@ Response.TransactionDetail response = await request.Send(client);
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`receiver_user_id`**
+
+
+
```json
{
"type": "string",
diff --git a/docs/bill.md b/docs/bill.md
index a9d4342..b59b6c6 100644
--- a/docs/bill.md
+++ b/docs/bill.md
@@ -7,19 +7,19 @@
```csharp
Request.ListBills request = new Request.ListBills() {
- Page = 7384, // ページ番号
- PerPage = 6138, // 1ページの表示数
- BillId = "T", // 支払いQRコードのID
+ Page = 7446, // ページ番号
+ PerPage = 5421, // 1ページの表示数
+ BillId = "W0eFslSf8N", // 支払いQRコードのID
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- OrganizationCode = "xs6VNjs2Mf2--N-VxoE9n6N1iQ3v", // 組織コード
+ OrganizationCode = "--Ejp--E5m5j", // 組織コード
Description = "test bill", // 取引説明文
- CreatedFrom = "2024-02-06T00:24:19.000000Z", // 作成日時(起点)
- CreatedTo = "2020-07-28T20:51:25.000000Z", // 作成日時(終点)
+ CreatedFrom = "2023-02-20T20:48:36.000000Z", // 作成日時(起点)
+ CreatedTo = "2022-09-20T21:42:21.000000Z", // 作成日時(終点)
ShopName = "bill test shop1", // 店舗名
ShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
- LowerLimitAmount = 3980, // 金額の範囲によるフィルタ(下限)
- UpperLimitAmount = 6980, // 金額の範囲によるフィルタ(上限)
- IsDisabled = true, // 支払いQRコードが無効化されているかどうか
+ LowerLimitAmount = 134, // 金額の範囲によるフィルタ(下限)
+ UpperLimitAmount = 2440, // 金額の範囲によるフィルタ(上限)
+ IsDisabled = false, // 支払いQRコードが無効化されているかどうか
};
Response.PaginatedBills response = await request.Send(client);
```
@@ -213,7 +213,7 @@ Request.CreateBill request = new Request.CreateBill(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 支払いマネーのマネーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 支払い先(受け取り人)の店舗ID
) {
- Amount = 1684.0, // 支払い額
+ Amount = 5556.0, // 支払い額
Description = "test bill", // 説明文(アプリ上で取引の説明文として表示される)
};
Response.Bill response = await request.Send(client);
@@ -226,6 +226,8 @@ Response.Bill response = await request.Send(client);
支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+また、金額を指定する場合の上限額は支払いをするマネーの取引上限額です。
+
```json
{
@@ -277,9 +279,10 @@ Response.Bill response = await request.Send(client);
### 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_account_not_found||The shop account is not found|
-|422|private_money_not_found||Private money 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|
@@ -287,6 +290,43 @@ Response.Bill response = await request.Send(client);
+---
+
+
+
+## GetBill: 支払いQRコードの表示
+支払いQRコードの内容を表示します。
+
+```csharp
+Request.GetBill request = new Request.GetBill(
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 支払いQRコードのID
+);
+Response.Bill response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`bill_id`**
+
+
+表示する支払いQRコードのIDです。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[Bill](./responses.md#bill)
+を返します
+
+
+
---
@@ -298,9 +338,9 @@ Response.Bill response = await request.Send(client);
Request.UpdateBill request = new Request.UpdateBill(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 支払いQRコードのID
) {
- Amount = 9656.0, // 支払い額
+ Amount = 7306.0, // 支払い額
Description = "test bill", // 説明文
- IsDisabled = true, // 無効化されているかどうか
+ IsDisabled = false, // 無効化されているかどうか
};
Response.Bill response = await request.Send(client);
```
@@ -323,7 +363,7 @@ Response.Bill response = await request.Send(client);
**`amount`**
-支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。また、金額を指定する場合の上限額は支払いをするマネーの取引上限額です。
```json
{
@@ -367,4 +407,159 @@ Response.Bill response = await request.Send(client);
---
+
+## CreatePaymentTransactionWithBill: 支払いQRコードを読み取ることで支払いをする
+通常支払いQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバが支払いQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際の支払い取引をリクエストすることになります。
+
+エンドユーザーから受け取った支払いQRコードのIDをエンドユーザーIDと共に渡すことで支払い取引が作られます。
+支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
+
+
+```csharp
+Request.CreatePaymentTransactionWithBill request = new Request.CreatePaymentTransactionWithBill(
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 支払いQRコードのID
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // エンドユーザーのID
+) {
+ Metadata = "{\"key\":\"value\"}", // 取引メタデータ
+ RequestId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // リクエストID
+ Strategy = "point-preferred", // 支払い時の残高消費方式
+};
+Response.TransactionDetail response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`bill_id`**
+
+
+支払いQRコードのIDです。
+
+QRコード生成時に送金先店舗のウォレット情報や、支払い金額などが登録されています。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`customer_id`**
+
+
+エンドユーザーIDです。
+
+支払いを行うエンドユーザーを指定します。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`metadata`**
+
+
+取引作成時に指定されるメタデータです。
+
+任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
+
+```json
+{
+ "type": "string",
+ "format": "json"
+}
+```
+
+**`request_id`**
+
+
+取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`strategy`**
+
+
+支払い時に残高がどのように消費されるかを指定します。
+デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+- point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+- money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+
+```json
+{
+ "type": "string",
+ "enum": [
+ "point-preferred",
+ "money-only"
+ ]
+}
+```
+
+
+
+成功したときは
+[TransactionDetail](./responses.md#transaction-detail)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|422|disabled_bill|支払いQRコードが無効です|Bill is disabled|
+|422|customer_user_not_found||The customer user is not found|
+|422|bill_not_found|支払いQRコードが見つかりません|Bill not found|
+|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
+|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
+|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
+|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
+|422|c2c_transfer_not_allowed|このマネーではユーザ間マネー譲渡は利用できません|Customer to customer transfer is not available for this money|
+|422|account_transfer_limit_exceeded|取引金額が上限を超えました|Too much amount to transfer|
+|422|account_balance_exceeded|口座残高が上限を超えました|The account balance exceeded the limit|
+|422|account_money_topup_transfer_limit_exceeded|マネーチャージ金額が上限を超えました|Too much amount to money topup transfer|
+|422|account_total_topup_limit_range|期間内での合計チャージ額上限に達しました|Entire period topup limit reached|
+|422|account_total_topup_limit_entire_period|全期間での合計チャージ額上限に達しました|Entire period topup limit reached|
+|422|coupon_unavailable_shop|このクーポンはこの店舗では使用できません。|This coupon is unavailable for this shop.|
+|422|coupon_already_used|このクーポンは既に使用済みです。|This coupon is already used.|
+|422|coupon_not_received|このクーポンは受け取られていません。|This coupon is not received.|
+|422|coupon_not_sent|このウォレットに対して配信されていないクーポンです。|This coupon is not sent to this account yet.|
+|422|coupon_amount_not_enough|このクーポンを使用するには支払い額が足りません。|The payment amount not enough to use this coupon.|
+|422|coupon_not_payment|クーポンは支払いにのみ使用できます。|Coupons can only be used for payment.|
+|422|coupon_unavailable|このクーポンは使用できません。|This coupon is unavailable.|
+|422|account_suspended|アカウントは停止されています|The account is suspended|
+|422|account_closed|アカウントは退会しています|The account is closed|
+|422|customer_account_not_found||The customer account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
+|422|account_currency_mismatch|アカウント間で通貨が異なっています|Currency mismatch between accounts|
+|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
+|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
+|422|terminal_is_invalidated|端末は無効化されています|The terminal is already invalidated|
+|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
+|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
+|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
+|503|temporarily_unavailable||Service Unavailable|
+
+
+
+---
+
+
diff --git a/docs/bulk.md b/docs/bulk.md
index 3cea090..8e81634 100644
--- a/docs/bulk.md
+++ b/docs/bulk.md
@@ -6,11 +6,11 @@ CSVファイルから一括取引をします。
```csharp
Request.BulkCreateTransaction request = new Request.BulkCreateTransaction(
- "y2", // 一括取引タスク名
- "m8", // 取引する情報のCSV
- "ZcyGh3BczuQ1HmAT4U7cCHORIBupKF2LGLWl" // リクエストID
+ "b5", // 一括取引タスク名
+ "bsI", // 取引する情報のCSV
+ "mY7PcHPZH7mHIXsOqC2xcKBYhL1xCfnaEpDL" // リクエストID
) {
- Description = "WRqEU1R3HVfumJrkxA1RBhkJnrKn6T4UBYf7XzEp3cMOeoQItbJApNFNbizZqS", // 一括取引の説明
+ Description = "NgoBzsuiKajpcQf4nuECfdVUoATZ0pZ1FEusk3svdOIWNVHFftM1EZPsd7jOCTvYgQYDODNTX3YU3qGQBWGDfb1wlkuiN7kKWKFo", // 一括取引の説明
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
};
Response.BulkTransaction response = await request.Send(client);
@@ -112,7 +112,7 @@ Response.BulkTransaction response = await request.Send(client);
|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|private_money_not_found|マネーが見つかりません|Private money not found|
|422|bulk_transaction_invalid_csv_format|入力されたCSVデータに誤りがあります|Invalid csv format|
diff --git a/docs/campaign.md b/docs/campaign.md
index c303a75..06b6260 100644
--- a/docs/campaign.md
+++ b/docs/campaign.md
@@ -10,9 +10,9 @@
Request.ListCampaigns request = new Request.ListCampaigns(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
) {
- IsOngoing = false, // 現在適用可能なキャンペーンかどうか
- AvailableFrom = "2020-07-01T00:25:56.000000Z", // 指定された日時以降に適用可能期間が含まれているか
- AvailableTo = "2022-12-11T03:14:20.000000Z", // 指定された日時以前に適用可能期間が含まれているか
+ IsOngoing = true, // 現在適用可能なキャンペーンかどうか
+ AvailableFrom = "2022-11-12T15:47:17.000000Z", // 指定された日時以降に適用可能期間が含まれているか
+ AvailableTo = "2024-06-12T02:10:51.000000Z", // 指定された日時以前に適用可能期間が含まれているか
Page = 1, // ページ番号
PerPage = 20, // 1ページ分の取得数
};
@@ -110,6 +110,7 @@ Response.PaginatedCampaigns response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|503|temporarily_unavailable||Service Unavailable|
@@ -123,36 +124,37 @@ Response.PaginatedCampaigns response = await request.Send(client);
```csharp
Request.CreateCampaign request = new Request.CreateCampaign(
- "vNBs", // キャンペーン名
+ "9tuL5LH4EHPGJy8ZSoJ1krFHQyhzGXerHPOPDvrwRgeSOaGF6stofVWAQmmxPEjbZK4rVxAUW7FWHkKwdg6799FNaTUuVqVNtvvxMPy8uYVQrlAwBlTLDHylYVoU0Lud9b", // キャンペーン名
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- "2022-08-09T16:43:13.000000Z", // キャンペーン開始日時
- "2022-04-04T15:28:43.000000Z", // キャンペーン終了日時
- 6782, // キャンペーンの適用優先度
- "external-transaction" // イベント種別
+ "2023-06-17T01:53:57.000000Z", // キャンペーン開始日時
+ "2022-08-18T02:00:06.000000Z", // キャンペーン終了日時
+ 4685, // キャンペーンの適用優先度
+ "topup" // イベント種別
) {
BearPointShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント負担先店舗ID
- Description = "RsG1pcvzPfSNlMjgyCm3l36NNuyyweAXXanZiLS6lbj9JXoVWEOjNWcJ8Pqob8ZBDc2LIkAJFpX3tMiPvkskrBs7cZNQht6pUXt6QkeG9pRp1c5EcN6nLJcb0NEcuMnzKSDbJDSeKRyRniwPaN0afN8mRVY0r2kLaYAQQnNW", // キャンペーンの説明文
- Status = "disabled", // キャンペーン作成時の状態
- PointExpiresAt = "2021-11-18T01:45:25.000000Z", // ポイント有効期限(絶対日時指定)
- PointExpiresInDays = 1429, // ポイント有効期限(相対日数指定)
- IsExclusive = true, // キャンペーンの重複設定
- Subject = "all", // ポイント付与の対象金額の種別
+ Description = "M8UnuwQ7jNoaulXZjgrVDfW2ufNp0gAs9phyFh2aSmdruAKFNN9YCEWSULZdpylXeF6qvGwUl7ATMaf3NqLOcKmTPNREiEdfOxleMzyqb14XnQoYrg3WK0gxDGSVD8anN0", // キャンペーンの説明文
+ Status = "enabled", // キャンペーン作成時の状態
+ PointExpiresAt = "2020-10-09T18:35:24.000000Z", // ポイント有効期限(絶対日時指定)
+ PointExpiresInDays = 9305, // ポイント有効期限(相対日数指定)
+ IsExclusive = false, // キャンペーンの重複設定
+ Subject = "money", // ポイント付与の対象金額の種別
AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}}, // 取引金額ベースのポイント付与ルール
- ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}}, // 商品情報ベースのポイント付与ルール
- BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}}, // 商品情報ベースのキャンペーンで除外対象にする商品リスト
- ApplicableDaysOfWeek = new int[]{3, 2}, // キャンペーンを適用する曜日 (複数指定)
- ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}}, // キャンペーンを適用する時間帯 (複数指定)
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}}, // 商品情報ベースのポイント付与ルール
+ BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}}, // 商品情報ベースのキャンペーンで除外対象にする商品リスト
+ ApplicableDaysOfWeek = new int[]{6}, // キャンペーンを適用する曜日 (複数指定)
+ ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}}, // キャンペーンを適用する時間帯 (複数指定)
ApplicableShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // キャンペーン適用対象となる店舗IDのリスト
- MinimumNumberOfProducts = 4275, // キャンペーンを適用する1会計内の商品個数の下限
- MinimumNumberOfAmount = 6006, // キャンペーンを適用する1会計内の商品総額の下限
- MinimumNumberForCombinationPurchase = 417, // 複数種類の商品を同時購入するときの商品種別数の下限
- ExistInEachProductGroups = true, // 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
- MaxPointAmount = 7464, // キャンペーンによって付与されるポイントの上限
- MaxTotalPointAmount = 6181, // キャンペーンによって付与されるの1人当たりの累計ポイントの上限
+ BlacklistedShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // キャンペーン適用対象外となる店舗IDのリスト(ブラックリスト方式)
+ MinimumNumberOfProducts = 9011, // キャンペーンを適用する1会計内の商品個数の下限
+ MinimumNumberOfAmount = 3293, // キャンペーンを適用する1会計内の商品総額の下限
+ MinimumNumberForCombinationPurchase = 4688, // 複数種類の商品を同時購入するときの商品種別数の下限
+ ExistInEachProductGroups = false, // 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
+ MaxPointAmount = 4493, // キャンペーンによって付与されるポイントの上限
+ MaxTotalPointAmount = 2172, // キャンペーンによって付与されるの1人当たりの累計ポイントの上限
DestPrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント付与先となるマネーID
ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}}, // ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}}, // 取引時に指定するメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
- BudgetCapsAmount = 593459802, // キャンペーン予算上限
+ BudgetCapsAmount = 759867114, // キャンペーン予算上限
};
Response.Campaign response = await request.Send(client);
```
@@ -524,6 +526,23 @@ fromとtoは両方必要です。
}
```
+**`blacklisted_shop_ids`**
+
+
+キャンペーンの適用対象外となる店舗IDをブラックリスト方式で指定します (複数指定可)。
+このパラメータが指定されている場合、blacklisted_shop_idsに含まれていない店舗全てがキャンペーンの適用対象になります。
+blacklisted_shop_idsとapplicable_shop_idsは同時には指定できません。ホワイトリスト方式を使うときはapplicable_shop_idsを指定してください。
+
+```json
+{
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ }
+}
+```
+
**`minimum_number_of_products`**
@@ -866,11 +885,11 @@ exist_in_each_product_groupsが指定されているにも関わらず商品毎
|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|campaign_overlaps|同期間に開催されるキャンペーン間で優先度が重複してます|The campaign period overlaps under the same private-money / type / priority|
-|422|shop_account_not_found||The shop account is not found|
-|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
-|422|private_money_not_found||Private money not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
|422|campaign_period_overlaps|同期間に開催されるキャンペーン間で優先度が重複してます|The campaign period overlaps under the same private-money / type / priority|
|422|campaign_invalid_period||Invalid campaign period starts_at later than ends_at|
+|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
@@ -927,32 +946,33 @@ Response.Campaign response = await request.Send(client);
Request.UpdateCampaign request = new Request.UpdateCampaign(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // キャンペーンID
) {
- Name = "D0C3IXLL4lH8T3KxBkSfET7NeTYdPy8UjYc9OlslQQZIq7zSOEeSzczj6ObIBdQwmJP2q6udBME6WRlyybO27f", // キャンペーン名
- StartsAt = "2023-01-24T11:58:33.000000Z", // キャンペーン開始日時
- EndsAt = "2024-03-08T03:05:55.000000Z", // キャンペーン終了日時
- Priority = 1560, // キャンペーンの適用優先度
- Event = "payment", // イベント種別
- Description = "KPW8EbdfuKdbyfcjYNDVx4A2ovqPMZA8irXJ9E6ZcMzkLyAqgwSoddiujWTgn11mpxaVIYgQo", // キャンペーンの説明文
- Status = "disabled", // キャンペーン作成時の状態
- PointExpiresAt = "2021-06-13T14:31:35.000000Z", // ポイント有効期限(絶対日時指定)
- PointExpiresInDays = 3039, // ポイント有効期限(相対日数指定)
- IsExclusive = true, // キャンペーンの重複設定
+ Name = "1BcnwfTRLJa4uoIhpR40nORwuCknsFuOeDw3ETEoYbDEhr0AwKkiQOHCQCIIRDiJ5EWSps1CcPm4CujuDviyaRPbQTt1c2CSzS35RxVGrM7sDhsRor5EZrBgBnWdBpXW3vXZAsIGmxl3OdV3odlFFoKvu4lobeulXI7c3F9nyrjjR", // キャンペーン名
+ StartsAt = "2022-02-16T10:50:17.000000Z", // キャンペーン開始日時
+ EndsAt = "2024-06-02T18:31:36.000000Z", // キャンペーン終了日時
+ Priority = 1710, // キャンペーンの適用優先度
+ Event = "topup", // イベント種別
+ Description = "nDGe4yWdLtrR0H47hbbDvB2dkQWYC4RWqJwsq2yT7AWpCDkyLBkYzAxemZaKowuUfekyaJIsuHhxZpopNYyv6dLAyty2EMgPVlahlWYdbEevpLkzdUFCwG4QGOnpUXmwhMFkO9ufFPOzF9Lvv7JJIkMwpNGlwPY7w3AePumXzLvyF75pQ", // キャンペーンの説明文
+ Status = "enabled", // キャンペーン作成時の状態
+ PointExpiresAt = "2023-04-11T04:52:58.000000Z", // ポイント有効期限(絶対日時指定)
+ PointExpiresInDays = 9720, // ポイント有効期限(相対日数指定)
+ IsExclusive = false, // キャンペーンの重複設定
Subject = "money", // ポイント付与の対象金額の種別
- AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}}, // 取引金額ベースのポイント付与ルール
- ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}}, // 商品情報ベースのポイント付与ルール
- BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}}, // 商品情報ベースのキャンペーンで除外対象にする商品リスト
- ApplicableDaysOfWeek = new int[]{6, 0}, // キャンペーンを適用する曜日 (複数指定)
- ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}}, // キャンペーンを適用する時間帯 (複数指定)
- ApplicableShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // キャンペーン適用対象となる店舗IDのリスト
- MinimumNumberOfProducts = 2506, // キャンペーンを適用する1会計内の商品個数の下限
- MinimumNumberOfAmount = 2614, // キャンペーンを適用する1会計内の商品総額の下限
- MinimumNumberForCombinationPurchase = 1217, // 複数種類の商品を同時購入するときの商品種別数の下限
- ExistInEachProductGroups = false, // 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
- MaxPointAmount = 4152, // キャンペーンによって付与されるポイントの上限
- MaxTotalPointAmount = 8728, // キャンペーンによって付与されるの1人当たりの累計ポイントの上限
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}}, // 取引金額ベースのポイント付与ルール
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}}, // 商品情報ベースのポイント付与ルール
+ BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}}, // 商品情報ベースのキャンペーンで除外対象にする商品リスト
+ ApplicableDaysOfWeek = new int[]{4, 6}, // キャンペーンを適用する曜日 (複数指定)
+ ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}}, // キャンペーンを適用する時間帯 (複数指定)
+ ApplicableShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // キャンペーン適用対象となる店舗IDのリスト
+ BlacklistedShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // キャンペーン適用対象外となる店舗IDのリスト(ブラックリスト方式)
+ MinimumNumberOfProducts = 6153, // キャンペーンを適用する1会計内の商品個数の下限
+ MinimumNumberOfAmount = 9249, // キャンペーンを適用する1会計内の商品総額の下限
+ MinimumNumberForCombinationPurchase = 2948, // 複数種類の商品を同時購入するときの商品種別数の下限
+ ExistInEachProductGroups = true, // 複数の商品グループにつき1種類以上の商品購入によって発火するキャンペーンの指定フラグ
+ MaxPointAmount = 1012, // キャンペーンによって付与されるポイントの上限
+ MaxTotalPointAmount = 1450, // キャンペーンによって付与されるの1人当たりの累計ポイントの上限
ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}}, // ウォレットに紐付くメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}}, // 取引時に指定するメタデータが特定の値を持つときにのみ発火するキャンペーンを登録します。
- BudgetCapsAmount = 817773375, // キャンペーン予算上限
+ BudgetCapsAmount = 979442694, // キャンペーン予算上限
};
Response.Campaign response = await request.Send(client);
```
@@ -1313,6 +1333,23 @@ fromとtoは両方必要です。
}
```
+**`blacklisted_shop_ids`**
+
+
+キャンペーンの適用対象外となる店舗IDをブラックリスト方式で指定します (複数指定可)。
+このパラメータが指定されている場合、blacklisted_shop_idsに含まれていない店舗全てがキャンペーンの適用対象になります。
+blacklisted_shop_idsとapplicable_shop_idsは同時には指定できません。ホワイトリスト方式を使うときはapplicable_shop_idsを指定してください。
+
+```json
+{
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ }
+}
+```
+
**`minimum_number_of_products`**
diff --git a/docs/cashtray.md b/docs/cashtray.md
index 50f638a..cb9da42 100644
--- a/docs/cashtray.md
+++ b/docs/cashtray.md
@@ -5,6 +5,149 @@ Cashtrayはワンタイムで、一度読み取りに成功するか、取引エ
また、Cashtrayには有効期限があり、デフォルトでは30分で失効します。
+
+## CreateTransactionWithCashtray: CashtrayQRコードを読み取ることで取引する
+エンドユーザーから受け取ったCashtray用QRコードのIDをエンドユーザーIDと共に渡すことで支払いあるいはチャージ取引が作られます。
+
+通常CashtrayQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。
+もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがCashtrayQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
+
+
+```csharp
+Request.CreateTransactionWithCashtray request = new Request.CreateTransactionWithCashtray(
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // Cashtray用QRコードのID
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // エンドユーザーのID
+) {
+ Strategy = "point-preferred", // 支払い時の残高消費方式
+ RequestId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // リクエストID
+};
+Response.TransactionDetail response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`cashtray_id`**
+
+
+Cashtray用QRコードのIDです。
+
+QRコード生成時に送金元店舗のウォレット情報や、金額などが登録されています。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`customer_id`**
+
+
+エンドユーザーIDです。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`strategy`**
+
+
+支払い時に残高がどのように消費されるかを指定します。
+チャージの場合は無効です。
+デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+- point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+- money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+
+```json
+{
+ "type": "string",
+ "enum": [
+ "point-preferred",
+ "money-only"
+ ]
+}
+```
+
+**`request_id`**
+
+
+取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。
+指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。
+もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[TransactionDetail](./responses.md#transaction-detail)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|422|account_not_found|アカウントが見つかりません|The account is not found|
+|422|cashtray_not_found|決済QRコードが見つかりません|Cashtray is not found|
+|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
+|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
+|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
+|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
+|422|c2c_transfer_not_allowed|このマネーではユーザ間マネー譲渡は利用できません|Customer to customer transfer is not available for this money|
+|422|account_transfer_limit_exceeded|取引金額が上限を超えました|Too much amount to transfer|
+|422|account_balance_exceeded|口座残高が上限を超えました|The account balance exceeded the limit|
+|422|account_money_topup_transfer_limit_exceeded|マネーチャージ金額が上限を超えました|Too much amount to money topup transfer|
+|422|account_total_topup_limit_range|期間内での合計チャージ額上限に達しました|Entire period topup limit reached|
+|422|account_total_topup_limit_entire_period|全期間での合計チャージ額上限に達しました|Entire period topup limit reached|
+|422|coupon_unavailable_shop|このクーポンはこの店舗では使用できません。|This coupon is unavailable for this shop.|
+|422|coupon_already_used|このクーポンは既に使用済みです。|This coupon is already used.|
+|422|coupon_not_received|このクーポンは受け取られていません。|This coupon is not received.|
+|422|coupon_not_sent|このウォレットに対して配信されていないクーポンです。|This coupon is not sent to this account yet.|
+|422|coupon_amount_not_enough|このクーポンを使用するには支払い額が足りません。|The payment amount not enough to use this coupon.|
+|422|coupon_not_payment|クーポンは支払いにのみ使用できます。|Coupons can only be used for payment.|
+|422|coupon_unavailable|このクーポンは使用できません。|This coupon is unavailable.|
+|422|account_suspended|アカウントは停止されています|The account is suspended|
+|422|account_closed|アカウントは退会しています|The account is closed|
+|422|customer_account_not_found||The customer account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
+|422|account_currency_mismatch|アカウント間で通貨が異なっています|Currency mismatch between accounts|
+|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
+|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
+|422|terminal_is_invalidated|端末は無効化されています|The terminal is already invalidated|
+|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
+|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
+|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
+|422|cashtray_already_proceed|この決済QRコードは既に処理されています|Cashtray is already proceed|
+|422|cashtray_expired|この決済QRコードは有効期限が切れています|Cashtray is expired|
+|422|cashtray_already_canceled|この決済QRコードは既に無効化されています|Cashtray is already canceled|
+|503|temporarily_unavailable||Service Unavailable|
+
+
+
+---
+
+
## CreateCashtray: Cashtrayを作る
Cashtrayを作成します。
@@ -19,10 +162,10 @@ Cashtrayを作成します。
Request.CreateCashtray request = new Request.CreateCashtray(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ユーザーID
- 6869.0 // 金額
+ 6317.0 // 金額
) {
Description = "たい焼き(小倉)", // 取引履歴に表示する説明文
- ExpiresIn = 3655, // 失効時間(秒)
+ ExpiresIn = 8685, // 失効時間(秒)
};
Response.Cashtray response = await request.Send(client);
```
@@ -102,8 +245,6 @@ Cashtrayが失効するまでの時間を秒単位で指定します(任意項
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|account_not_found|アカウントが見つかりません|The account is not found|
-|422|account_transfer_limit_exceeded|取引金額が上限を超えました|Too much amount to transfer|
-|422|account_money_topup_transfer_limit_exceeded|マネーチャージ金額が上限を超えました|Too much amount to money topup transfer|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
@@ -253,9 +394,9 @@ Cashtrayの内容を更新します。bodyパラメーターは全て省略可
Request.UpdateCashtray request = new Request.UpdateCashtray(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // CashtrayのID
) {
- Amount = 5236.0, // 金額
+ Amount = 3942.0, // 金額
Description = "たい焼き(小倉)", // 取引履歴に表示する説明文
- ExpiresIn = 6303, // 失効時間(秒)
+ ExpiresIn = 7335, // 失効時間(秒)
};
Response.Cashtray response = await request.Send(client);
```
diff --git a/docs/check.md b/docs/check.md
index 982750e..b32d03f 100644
--- a/docs/check.md
+++ b/docs/check.md
@@ -13,16 +13,16 @@ QRコードを読み取る方法以外にも、このURLリンクを直接スマ
```csharp
Request.ListChecks request = new Request.ListChecks() {
- Page = 2744, // ページ番号
+ Page = 9728, // ページ番号
PerPage = 50, // 1ページの表示数
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- OrganizationCode = "L4kFCWrbFq", // 組織コード
- ExpiresFrom = "2021-09-09T15:13:43.000000Z", // 有効期限の期間によるフィルター(開始時点)
- ExpiresTo = "2021-11-02T10:10:04.000000Z", // 有効期限の期間によるフィルター(終了時点)
- CreatedFrom = "2021-08-03T06:23:31.000000Z", // 作成日時の期間によるフィルター(開始時点)
- CreatedTo = "2023-09-18T07:29:12.000000Z", // 作成日時の期間によるフィルター(終了時点)
+ OrganizationCode = "uYz7E9ZuYBAHz0vH45u4SHdXpfYeqMtc", // 組織コード
+ ExpiresFrom = "2023-07-25T17:23:39.000000Z", // 有効期限の期間によるフィルター(開始時点)
+ ExpiresTo = "2021-10-14T11:07:18.000000Z", // 有効期限の期間によるフィルター(終了時点)
+ CreatedFrom = "2024-08-31T15:49:15.000000Z", // 作成日時の期間によるフィルター(開始時点)
+ CreatedTo = "2020-04-17T06:28:31.000000Z", // 作成日時の期間によるフィルター(終了時点)
IssuerShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 発行店舗ID
- Description = "c", // チャージQRコードの説明文
+ Description = "8wxcy", // チャージQRコードの説明文
IsOnetime = false, // ワンタイムのチャージQRコードかどうか
IsDisabled = false, // 無効化されたチャージQRコードかどうか
};
@@ -206,7 +206,8 @@ Response.PaginatedChecks response = await request.Send(client);
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|organization_not_found||Organization not found|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
+|503|temporarily_unavailable||Service Unavailable|
@@ -220,13 +221,13 @@ Response.PaginatedChecks response = await request.Send(client);
Request.CreateCheck request = new Request.CreateCheck(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 送金元の店舗アカウントID
) {
- MoneyAmount = 530.0, // 付与マネー額
- PointAmount = 8713.0, // 付与ポイント額
+ MoneyAmount = 2249.0, // 付与マネー額
+ PointAmount = 4625.0, // 付与ポイント額
Description = "test check", // 説明文(アプリ上で取引の説明文として表示される)
- IsOnetime = true, // ワンタイムかどうかのフラグ
- UsageLimit = 318, // ワンタイムでない場合の最大読み取り回数
- ExpiresAt = "2020-05-18T06:49:05.000000Z", // チャージQRコード自体の失効日時
- PointExpiresAt = "2023-04-04T22:26:01.000000Z", // チャージQRコードによって付与されるポイント残高の有効期限
+ IsOnetime = false, // ワンタイムかどうかのフラグ
+ UsageLimit = 6664, // ワンタイムでない場合の最大読み取り回数
+ ExpiresAt = "2023-09-03T13:58:40.000000Z", // チャージQRコード自体の失効日時
+ PointExpiresAt = "2024-08-16T05:11:07.000000Z", // チャージQRコードによって付与されるポイント残高の有効期限
PointExpiresInDays = 60, // チャージQRコードによって付与されるポイント残高の有効期限(相対日数指定)
BearPointAccount = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント額を負担する店舗のウォレットID
};
@@ -390,14 +391,14 @@ NULLに設定すると無制限に読み取り可能なチャージQRコード
|---|---|---|---|
|400|invalid_parameter_both_point_and_money_are_zero||One of 'money_amount' or 'point_amount' must be a positive (>0) number|
|400|invalid_parameter_only_merchants_can_attach_points_to_check||Only merchants can attach points to check|
-|400|invalid_parameter_bear_point_account_identification_item_not_unique|ポイントを負担する店舗アカウントを指定するリクエストパラメータには、アカウントID、またはユーザIDのどちらかを含めることができます|Request parameters include either bear_point_account or bear_point_shop_id.|
|400|invalid_parameter_combination_usage_limit_and_is_onetime||'usage_limit' can not be specified if 'is_onetime' is true.|
-|400|invalid_parameters|項目が無効です|Invalid parameters|
|400|invalid_parameter_expires_at||'expires_at' must be in the future|
+|400|invalid_parameters|項目が無効です|Invalid parameters|
+|400|invalid_parameter_bear_point_account_identification_item_not_unique|ポイントを負担する店舗アカウントを指定するリクエストパラメータには、アカウントID、またはユーザIDのどちらかを含めることができます|Request parameters include either bear_point_account or bear_point_shop_id.|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
|422|account_private_money_is_not_issued_by_organization||The account's private money is not issued by this organization|
-|422|shop_account_not_found||The shop account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
|422|bear_point_account_not_found|ポイントを負担する店舗アカウントが見つかりません|Bear point account not found.|
|422|account_money_topup_transfer_limit_exceeded|マネーチャージ金額が上限を超えました|Too much amount to money topup transfer|
@@ -449,16 +450,16 @@ Response.Check response = await request.Send(client);
Request.UpdateCheck request = new Request.UpdateCheck(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // チャージQRコードのID
) {
- MoneyAmount = 6084.0, // 付与マネー額
- PointAmount = 7684.0, // 付与ポイント額
+ MoneyAmount = 1629.0, // 付与マネー額
+ PointAmount = 1473.0, // 付与ポイント額
Description = "test check", // チャージQRコードの説明文
IsOnetime = true, // ワンタイムかどうかのフラグ
- UsageLimit = 6450, // ワンタイムでない場合の最大読み取り回数
- ExpiresAt = "2022-06-07T12:39:06.000000Z", // チャージQRコード自体の失効日時
- PointExpiresAt = "2021-05-13T07:30:56.000000Z", // チャージQRコードによって付与されるポイント残高の有効期限
+ UsageLimit = 1345, // ワンタイムでない場合の最大読み取り回数
+ ExpiresAt = "2022-10-14T23:12:08.000000Z", // チャージQRコード自体の失効日時
+ PointExpiresAt = "2023-09-03T12:56:10.000000Z", // チャージQRコードによって付与されるポイント残高の有効期限
PointExpiresInDays = 60, // チャージQRコードによって付与されるポイント残高の有効期限(相対日数指定)
BearPointAccount = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント額を負担する店舗のウォレットID
- IsDisabled = true, // 無効化されているかどうかのフラグ
+ IsDisabled = false, // 無効化されているかどうかのフラグ
};
Response.Check response = await request.Send(client);
```
@@ -689,6 +690,7 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
```json
{
@@ -706,13 +708,11 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
### Error Responses
|status|type|ja|en|
|---|---|---|---|
-|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
|422|customer_user_not_found||The customer user is not found|
|422|check_not_found|これはチャージQRコードではありません|This is not a topup QR code|
-|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
@@ -732,7 +732,7 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|422|account_suspended|アカウントは停止されています|The account is suspended|
|422|account_closed|アカウントは退会しています|The account is closed|
|422|customer_account_not_found||The customer account is not found|
-|422|shop_account_not_found||The shop account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
|422|account_currency_mismatch|アカウント間で通貨が異なっています|Currency mismatch between accounts|
|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
@@ -740,6 +740,9 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|check_already_received|このチャージQRコードは既に受取済みの為、チャージ出来ませんでした|Check is already received|
|422|check_unavailable|このチャージQRコードは利用できません|The topup QR code is not available|
|503|temporarily_unavailable||Service Unavailable|
diff --git a/docs/coupon.md b/docs/coupon.md
index cbbc675..2bd0890 100644
--- a/docs/coupon.md
+++ b/docs/coupon.md
@@ -11,12 +11,12 @@ Couponは特定店舗で利用できるものや利用可能期間、配信条
Request.ListCoupons request = new Request.ListCoupons(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 対象クーポンのマネーID
) {
- CouponId = "x2jnlKrw0", // クーポンID
- CouponName = "dNS4VtkXCD", // クーポン名
- IssuedShopName = "t0L", // 発行店舗名
- AvailableShopName = "OE3Qg", // 利用可能店舗名
- AvailableFrom = "2021-02-12T04:03:43.000000Z", // 利用可能期間 (開始日時)
- AvailableTo = "2023-06-04T13:12:02.000000Z", // 利用可能期間 (終了日時)
+ CouponId = "iZ", // クーポンID
+ CouponName = "YSVIBpBUCC", // クーポン名
+ IssuedShopName = "gk4g", // 発行店舗名
+ AvailableShopName = "sP6E17lk", // 利用可能店舗名
+ AvailableFrom = "2020-06-26T22:20:27.000000Z", // 利用可能期間 (開始日時)
+ AvailableTo = "2020-05-25T04:04:55.000000Z", // 利用可能期間 (終了日時)
Page = 1, // ページ番号
PerPage = 50, // 1ページ分の取得数
};
@@ -150,7 +150,7 @@ Response.PaginatedCoupons response = await request.Send(client);
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
@@ -164,25 +164,25 @@ Response.PaginatedCoupons response = await request.Send(client);
```csharp
Request.CreateCoupon request = new Request.CreateCoupon(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "cszhfH09Y5OthVwPmvHXBFS5mnHJDaN7ByqCBViT8YJSc5gafw5E7JxTvjUc1aT5EbGp",
- "2022-01-15T18:09:07.000000Z",
- "2022-08-26T01:51:15.000000Z",
+ "rA88yuG2X4KRlpHewo2CgFQkdXPF4V9XHbL6zY6vqwgcI7YPEPHgGnEdzhGAMty3evJwcetItJxO93cN0l",
+ "2021-12-16T07:23:43.000000Z",
+ "2023-02-25T16:09:50.000000Z",
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 発行元の店舗ID
) {
- Description = "Qn8B7l65BYM",
- DiscountAmount = 4227,
- DiscountPercentage = 806.0,
- DiscountUpperLimit = 1270,
- DisplayStartsAt = "2020-02-09T15:09:11.000000Z", // クーポンの掲載期間(開始日時)
- DisplayEndsAt = "2023-11-04T13:46:54.000000Z", // クーポンの掲載期間(終了日時)
- IsDisabled = true, // 無効化フラグ
- IsHidden = false, // クーポン一覧に掲載されるかどうか
+ Description = "G0lwTGLR8ci2cIIE66fhj2n6iiZ64HpvFGkJr1uo4NLstnS7EAbDgQaYkUrDsQyk3kwOisNW9XsMHBVPsrsYBnLGXRYzu4noxPXNWpdUvBBp2JsuVIINCRpxja7me48LNXqpqJtjZwJILsuUBm8J0tu2v6zDKp9iO7Ari",
+ DiscountAmount = 9147,
+ DiscountPercentage = 8579.0,
+ DiscountUpperLimit = 2706,
+ DisplayStartsAt = "2020-08-25T11:57:15.000000Z", // クーポンの掲載期間(開始日時)
+ DisplayEndsAt = "2023-06-20T18:21:11.000000Z", // クーポンの掲載期間(終了日時)
+ IsDisabled = false, // 無効化フラグ
+ IsHidden = true, // クーポン一覧に掲載されるかどうか
IsPublic = false, // アプリ配信なしで受け取れるかどうか
- Code = "EwbRq7C0z", // クーポン受け取りコード
- UsageLimit = 1053, // ユーザごとの利用可能回数(NULLの場合は無制限)
- MinAmount = 7786, // クーポン適用可能な最小取引額
+ Code = "mo6XPE5Oq", // クーポン受け取りコード
+ UsageLimit = 2937, // ユーザごとの利用可能回数(NULLの場合は無制限)
+ MinAmount = 2737, // クーポン適用可能な最小取引額
IsShopSpecified = true, // 特定店舗限定のクーポンかどうか
- AvailableShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 利用可能店舗リスト
+ AvailableShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 利用可能店舗リスト
StorageId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ストレージID
};
Response.CouponDetail response = await request.Send(client);
@@ -425,7 +425,7 @@ Storage APIでアップロードしたクーポン画像のStorage IDを指定
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|404|partner_storage_not_found|指定したIDのデータは保存されていません|Not found by storage_id|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|coupon_image_storage_conflict|クーポン画像のストレージIDは既に存在します|The coupon image storage_id is already exists|
@@ -480,22 +480,22 @@ UUIDv4フォーマットである必要があり、フォーマットが異な
Request.UpdateCoupon request = new Request.UpdateCoupon(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // クーポンID
) {
- Name = "5JoEScisdzkhxnXFFT7CXS50vaovkRO",
- Description = "QbPFa2Q0QZFPxPWcwwu3uh9fDL3S3N",
- DiscountAmount = 2550,
- DiscountPercentage = 8586.0,
- DiscountUpperLimit = 2093,
- StartsAt = "2021-01-29T13:48:50.000000Z",
- EndsAt = "2022-04-03T12:59:15.000000Z",
- DisplayStartsAt = "2021-06-14T03:00:40.000000Z", // クーポンの掲載期間(開始日時)
- DisplayEndsAt = "2022-07-07T12:43:02.000000Z", // クーポンの掲載期間(終了日時)
- IsDisabled = false, // 無効化フラグ
+ Name = "jVh9nsqgzongKg5SFSpcaiWqMVEyXiabD2fPkrS1NvYbmwucdTPjBOMyHVeFGY5vB7gjE0J3rzoZQgeuXW4rw3Ob3VUIWbzDljJ6klDtciJUc",
+ Description = "1wir4yYsQVBNqeXloDbzzGADkOfMAKTboQcaiYXr4rnNnjCoeQHMuXiGNUysmU86lvAOTbcLzXO1sbMRuBNUlL6K0ReLv75kg6qcs3cEpI1m3wABqtL3bdaVTKdkTjUxGpAh3awQssfAXqJYYr4ARYbJcmLujs894lRg4qB30GRMkbzDn742v8m6fDAksXCcjSnMwkyUVD7CNlqSrG8bUcu2404OwW2YlKo3D8R7F9uqtTYDUe0c6WMB",
+ DiscountAmount = 6591,
+ DiscountPercentage = 9264.0,
+ DiscountUpperLimit = 2365,
+ StartsAt = "2023-12-22T10:14:14.000000Z",
+ EndsAt = "2021-12-13T08:29:01.000000Z",
+ DisplayStartsAt = "2020-06-07T13:39:20.000000Z", // クーポンの掲載期間(開始日時)
+ DisplayEndsAt = "2020-10-02T00:30:03.000000Z", // クーポンの掲載期間(終了日時)
+ IsDisabled = true, // 無効化フラグ
IsHidden = false, // クーポン一覧に掲載されるかどうか
IsPublic = true, // アプリ配信なしで受け取れるかどうか
- Code = "VO", // クーポン受け取りコード
- UsageLimit = 5609, // ユーザごとの利用可能回数(NULLの場合は無制限)
- MinAmount = 6829, // クーポン適用可能な最小取引額
- IsShopSpecified = false, // 特定店舗限定のクーポンかどうか
+ Code = "CtA", // クーポン受け取りコード
+ UsageLimit = 9635, // ユーザごとの利用可能回数(NULLの場合は無制限)
+ MinAmount = 9578, // クーポン適用可能な最小取引額
+ IsShopSpecified = true, // 特定店舗限定のクーポンかどうか
AvailableShopIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 利用可能店舗リスト
StorageId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ストレージID
};
diff --git a/docs/customer.md b/docs/customer.md
index 2c163de..be57d80 100644
--- a/docs/customer.md
+++ b/docs/customer.md
@@ -106,7 +106,7 @@ Request.UpdateAccount request = new Request.UpdateAccount(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ウォレットID
) {
IsSuspended = true, // ウォレットが凍結されているかどうか
- Status = "suspended", // ウォレット状態
+ Status = "active", // ウォレット状態
CanTransferTopup = false, // チャージ可能かどうか
};
Response.AccountDetail response = await request.Send(client);
@@ -186,11 +186,11 @@ Response.AccountDetail response = await request.Send(client);
Request.ListAccountBalances request = new Request.ListAccountBalances(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ウォレットID
) {
- Page = 6497, // ページ番号
- PerPage = 6466, // 1ページ分の取引数
- ExpiresAtFrom = "2021-03-29T13:19:12.000000Z", // 有効期限の期間によるフィルター(開始時点)
- ExpiresAtTo = "2021-05-16T03:24:38.000000Z", // 有効期限の期間によるフィルター(終了時点)
- Direction = "asc", // 有効期限によるソート順序
+ Page = 350, // ページ番号
+ PerPage = 1991, // 1ページ分の取引数
+ ExpiresAtFrom = "2022-03-28T16:15:32.000000Z", // 有効期限の期間によるフィルター(開始時点)
+ ExpiresAtTo = "2023-02-22T12:33:41.000000Z", // 有効期限の期間によるフィルター(終了時点)
+ Direction = "desc", // 有効期限によるソート順序
};
Response.PaginatedAccountBalance response = await request.Send(client);
```
@@ -294,11 +294,11 @@ Response.PaginatedAccountBalance response = await request.Send(client);
Request.ListAccountExpiredBalances request = new Request.ListAccountExpiredBalances(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ウォレットID
) {
- Page = 2277, // ページ番号
- PerPage = 1898, // 1ページ分の取引数
- ExpiresAtFrom = "2023-04-23T17:13:03.000000Z", // 有効期限の期間によるフィルター(開始時点)
- ExpiresAtTo = "2022-12-12T10:24:10.000000Z", // 有効期限の期間によるフィルター(終了時点)
- Direction = "asc", // 有効期限によるソート順序
+ Page = 318, // ページ番号
+ PerPage = 5324, // 1ページ分の取引数
+ ExpiresAtFrom = "2023-12-19T05:21:31.000000Z", // 有効期限の期間によるフィルター(開始時点)
+ ExpiresAtTo = "2020-12-21T05:07:13.000000Z", // 有効期限の期間によるフィルター(終了時点)
+ Direction = "desc", // 有効期限によるソート順序
};
Response.PaginatedAccountBalance response = await request.Send(client);
```
@@ -402,9 +402,9 @@ Response.PaginatedAccountBalance response = await request.Send(client);
Request.UpdateCustomerAccount request = new Request.UpdateCustomerAccount(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ウォレットID
) {
- Status = "pre-closed", // ウォレット状態
- AccountName = "dqAuTxyB0A3WX2EcUb892", // アカウント名
- ExternalId = "z3Nv10xFyFeM64iLpLDhctAZixWvzCjvZGuuLmpXAGJ", // 外部ID
+ Status = "suspended", // ウォレット状態
+ AccountName = "0JqyEbk4xV1ElwOVpwOgCs3REJLXlOpH9qH3TntlxmPSv0sqeMHVeJGZnQaE4lp3S7TMyfZKpPybiZ1Lwce18e7Eq5OqWuTabdRaaHOyfGqVUncXzhjskeGyZxmbEy050Zlv3tzVr8aTPDqMKbxS0Vs3OlIrdnx7rU9Fte9Z959oBy13mtel3d8TfJ3Ol39ScasZnA58jo0hnztlMdM7BVfn4iFYyJJXfrDU", // アカウント名
+ ExternalId = "2Z5dTBMhYMOaLFSQqsldJHk3l4cpZ7fJl29A3O6y0fQnXOg", // 外部ID
Metadata = "{\"key1\":\"foo\",\"key2\":\"bar\"}", // ウォレットに付加するメタデータ
};
Response.AccountWithUser response = await request.Send(client);
@@ -513,15 +513,15 @@ Response.AccountWithUser response = await request.Send(client);
Request.GetCustomerAccounts request = new Request.GetCustomerAccounts(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
) {
- Page = 1014, // ページ番号
- PerPage = 7219, // 1ページ分のウォレット数
- CreatedAtFrom = "2020-06-18T18:57:29.000000Z", // ウォレット作成日によるフィルター(開始時点)
- CreatedAtTo = "2022-05-19T03:42:55.000000Z", // ウォレット作成日によるフィルター(終了時点)
+ Page = 8211, // ページ番号
+ PerPage = 6776, // 1ページ分のウォレット数
+ CreatedAtFrom = "2021-09-10T05:49:31.000000Z", // ウォレット作成日によるフィルター(開始時点)
+ CreatedAtTo = "2022-09-03T21:35:58.000000Z", // ウォレット作成日によるフィルター(終了時点)
IsSuspended = false, // ウォレットが凍結状態かどうかでフィルターする
Status = "active", // ウォレット状態
- ExternalId = "aAAkUgzb5zEsMYGbxzOIV2r2JtDEGxgzX", // 外部ID
- Tel = "087-600118", // エンドユーザーの電話番号
- Email = "qEwnOjzBjM@dE2Z.com", // エンドユーザーのメールアドレス
+ ExternalId = "h5yMWiTVYzb9YasuIp7v4EzACicWq4Ul0bBBFnJwjrPufrwL", // 外部ID
+ Tel = "04153-7642", // エンドユーザーの電話番号
+ Email = "ZhJuNsCdqV@bAgL.com", // エンドユーザーのメールアドレス
};
Response.PaginatedAccountWithUsers response = await request.Send(client);
```
@@ -664,7 +664,7 @@ Response.PaginatedAccountWithUsers response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
@@ -684,7 +684,7 @@ Request.CreateCustomerAccount request = new Request.CreateCustomerAccount(
) {
UserName = "ポケペイ太郎", // ユーザー名
AccountName = "ポケペイ太郎のアカウント", // アカウント名
- ExternalId = "qC6g1ENWOPFMuygZod8nuff2bwE3RDjoGhPLmonz", // 外部ID
+ ExternalId = "QKQXblhvdQVC38rMOaKHSf5htPp", // 外部ID
};
Response.AccountWithUser response = await request.Send(client);
```
@@ -752,8 +752,8 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|422|user_not_found||The user is not found|
-|422|private_money_not_found||Private money not found|
+|422|user_not_found|ユーザーが見つかりません|The user is not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|user_attributes_external_id_not_match|ユーザー属性情報の外部IDが一致しません|Not match external id of user attributes|
|422|user_attributes_not_found|ユーザー属性情報が存在しません|Not found the user attrubtes|
@@ -773,11 +773,11 @@ PAPIクライアントシステムから利用するPokepayユーザーのIDで
Request.GetShopAccounts request = new Request.GetShopAccounts(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
) {
- Page = 7320, // ページ番号
- PerPage = 8993, // 1ページ分のウォレット数
- CreatedAtFrom = "2023-04-19T18:25:51.000000Z", // ウォレット作成日によるフィルター(開始時点)
- CreatedAtTo = "2020-03-30T19:22:03.000000Z", // ウォレット作成日によるフィルター(終了時点)
- IsSuspended = false, // ウォレットが凍結状態かどうかでフィルターする
+ Page = 7162, // ページ番号
+ PerPage = 4097, // 1ページ分のウォレット数
+ CreatedAtFrom = "2021-11-27T12:02:43.000000Z", // ウォレット作成日によるフィルター(開始時点)
+ CreatedAtTo = "2020-07-11T01:13:01.000000Z", // ウォレット作成日によるフィルター(終了時点)
+ IsSuspended = true, // ウォレットが凍結状態かどうかでフィルターする
};
Response.PaginatedAccountWithUsers response = await request.Send(client);
```
@@ -868,7 +868,7 @@ Response.PaginatedAccountWithUsers response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
@@ -885,10 +885,10 @@ Request.ListCustomerTransactions request = new Request.ListCustomerTransactions(
) {
SenderCustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 送金エンドユーザーID
ReceiverCustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 受取エンドユーザーID
- Type = "topup", // 取引種別
+ Type = "cashback", // 取引種別
IsModified = false, // キャンセル済みかどうか
- From = "2023-10-25T01:26:40.000000Z", // 開始日時
- To = "2022-05-07T07:54:42.000000Z", // 終了日時
+ From = "2021-07-30T00:07:51.000000Z", // 開始日時
+ To = "2021-08-16T03:11:59.000000Z", // 終了日時
Page = 1, // ページ番号
PerPage = 50, // 1ページ分の取引数
};
@@ -1051,7 +1051,8 @@ falseを指定するとキャンセルされていない取引のみ一覧に表
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|customer_user_not_found||The customer user is not found|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
+|503|temporarily_unavailable||Service Unavailable|
diff --git a/docs/error-response.csv b/docs/error-response.csv
index 9943e3a..17092a6 100644
--- a/docs/error-response.csv
+++ b/docs/error-response.csv
@@ -2,19 +2,26 @@ method,path,status_code,type,ja,en
GET,/user,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
GET,/dashboard,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/transfers,403,,,
+,,503,temporarily_unavailable,,Service Unavailable
GET,/transfers-v2,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,503,temporarily_unavailable,,Service Unavailable
GET,/transactions,403,,,
+,,503,temporarily_unavailable,,Service Unavailable
GET,/transactions-v2,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,503,temporarily_unavailable,,Service Unavailable
+GET,/transactions/bill,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,503,temporarily_unavailable,,Service Unavailable
POST,/transactions,400,invalid_parameter_both_point_and_money_are_zero,,One of 'money_amount' or 'point_amount' must be a positive (>0) number
,,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,,,
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
,,422,customer_user_not_found,,The customer user is not found
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -34,7 +41,7 @@ POST,/transactions,400,invalid_parameter_both_point_and_money_are_zero,,One of '
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_closed,"アカウントは退会しています",The account is closed
,,422,customer_account_not_found,,The customer account is not found
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
@@ -42,17 +49,21 @@ POST,/transactions,400,invalid_parameter_both_point_and_money_are_zero,,One of '
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
,,503,temporarily_unavailable,,Service Unavailable
GET,/transactions/:uuid,403,,,
,,404,,,
+,,503,temporarily_unavailable,,Service Unavailable
GET,/transactions/requests/:request-id,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,transaction_not_found,"取引が見つかりません",Transaction not found
+,,503,temporarily_unavailable,,Service Unavailable
POST,/transactions/:uuid/refund,400,invalid_mdk_token,,Invalid MDK token
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,card_not_found,"カードが見つかりません",
,,409,already_registered_veritrans_card,"このカードは既に登録されています",
,,409,already_registered_veritrans_account,"この会員は既に登録されています",
,,422,transaction_not_found,"取引が見つかりません",Transaction not found
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,can_not_refund_bank_transaction,"銀行取引はキャンセルできません",Bank transactions cannot be cancelled.
,,422,unavailable_card_error,"このクレジットカードはご利用になれません",The credit card is unavailable
,,422,veritrans_wrong_password_or_cancel,"本人認証に失敗しました。(パスワード間違い、キャンセル、カード会社判定)",Not complete authentication by cardholder.
@@ -68,9 +79,8 @@ POST,/transactions/:uuid/refund,400,invalid_mdk_token,,Invalid MDK token
POST,/transactions/topup,400,invalid_parameter_both_point_and_money_are_zero,,One of 'money_amount' or 'point_amount' must be a positive (>0) number
,,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
-,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -96,17 +106,18 @@ POST,/transactions/topup,400,invalid_parameter_both_point_and_money_are_zero,,On
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
+,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,customer_account_not_found,,The customer account 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_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,503,temporarily_unavailable,,Service Unavailable
-POST,/transactions/topup/check,400,invalid_parameters,"項目が無効です",Invalid parameters
-,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
+POST,/transactions/topup/check,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,customer_user_not_found,,The customer user is not found
,,422,check_not_found,"これはチャージQRコードではありません",This is not a topup QR code
-,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -126,7 +137,7 @@ POST,/transactions/topup/check,400,invalid_parameters,"項目が無効です",In
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_closed,"アカウントは退会しています",The account is closed
,,422,customer_account_not_found,,The customer account is not found
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
@@ -134,13 +145,16 @@ POST,/transactions/topup/check,400,invalid_parameters,"項目が無効です",In
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
+,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,check_already_received,"このチャージQRコードは既に受取済みの為、チャージ出来ませんでした",Check is already received
,,422,check_unavailable,"このチャージQRコードは利用できません",The topup QR code is not available
,,503,temporarily_unavailable,,Service Unavailable
POST,/transactions/topup/seven-bank-atm,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -148,6 +162,7 @@ POST,/transactions/topup/seven-bank-atm,403,unpermitted_admin_user,"この管理
,,422,account_transfer_limit_exceeded,"取引金額が上限を超えました",Too much amount to transfer
,,422,account_balance_exceeded,"口座残高が上限を超えました",The account balance exceeded the limit
,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
,,422,account_total_topup_limit_range,"期間内での合計チャージ額上限に達しました",Entire period topup limit reached
,,422,account_total_topup_limit_entire_period,"全期間での合計チャージ額上限に達しました",Entire period topup limit reached
,,422,coupon_unavailable_shop,"このクーポンはこの店舗では使用できません。",This coupon is unavailable for this shop.
@@ -160,7 +175,7 @@ POST,/transactions/topup/seven-bank-atm,403,unpermitted_admin_user,"この管理
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_closed,"アカウントは退会しています",The account is closed
,,422,customer_account_not_found,,The customer account is not found
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
@@ -169,11 +184,9 @@ POST,/transactions/topup/seven-bank-atm,403,unpermitted_admin_user,"この管理
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
,,503,temporarily_unavailable,,Service Unavailable
-POST,/transactions/payment,400,invalid_parameters,"項目が無効です",Invalid parameters
-,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
-,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
+POST,/transactions/payment,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -199,17 +212,55 @@ POST,/transactions/payment,400,invalid_parameters,"項目が無効です",Invali
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
+,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,customer_account_not_found,,The customer account 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_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,503,temporarily_unavailable,,Service Unavailable
-POST,/transactions/transfer,400,invalid_parameters,"項目が無効です",Invalid parameters
-,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
+POST,/transactions/payment/bill,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,422,disabled_bill,"支払いQRコードが無効です",Bill is disabled
,,422,customer_user_not_found,,The customer user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,bill_not_found,"支払いQRコードが見つかりません",Bill not found
+,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
+,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
+,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
+,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
+,,422,c2c_transfer_not_allowed,"このマネーではユーザ間マネー譲渡は利用できません",Customer to customer transfer is not available for this money
+,,422,account_transfer_limit_exceeded,"取引金額が上限を超えました",Too much amount to transfer
+,,422,account_balance_exceeded,"口座残高が上限を超えました",The account balance exceeded the limit
+,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
+,,422,account_total_topup_limit_range,"期間内での合計チャージ額上限に達しました",Entire period topup limit reached
+,,422,account_total_topup_limit_entire_period,"全期間での合計チャージ額上限に達しました",Entire period topup limit reached
+,,422,coupon_unavailable_shop,"このクーポンはこの店舗では使用できません。",This coupon is unavailable for this shop.
+,,422,coupon_already_used,"このクーポンは既に使用済みです。",This coupon is already used.
+,,422,coupon_not_received,"このクーポンは受け取られていません。",This coupon is not received.
+,,422,coupon_not_sent,"このウォレットに対して配信されていないクーポンです。",This coupon is not sent to this account yet.
+,,422,coupon_amount_not_enough,"このクーポンを使用するには支払い額が足りません。",The payment amount not enough to use this coupon.
+,,422,coupon_not_payment,"クーポンは支払いにのみ使用できます。",Coupons can only be used for payment.
+,,422,coupon_unavailable,"このクーポンは使用できません。",This coupon is unavailable.
+,,422,account_suspended,"アカウントは停止されています",The account is suspended
+,,422,account_closed,"アカウントは退会しています",The account is closed
+,,422,customer_account_not_found,,The customer account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
+,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
+,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
+,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
+,,422,terminal_is_invalidated,"端末は無効化されています",The terminal is already invalidated
+,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
+,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
+,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
+,,503,temporarily_unavailable,,Service Unavailable
+POST,/transactions/transfer,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,422,customer_user_not_found,,The customer user is not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -229,7 +280,7 @@ POST,/transactions/transfer,400,invalid_parameters,"項目が無効です",Inval
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_closed,"アカウントは退会しています",The account is closed
,,422,customer_account_not_found,,The customer account is not found
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
@@ -237,10 +288,11 @@ POST,/transactions/transfer,400,invalid_parameters,"項目が無効です",Inval
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
+,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,503,temporarily_unavailable,,Service Unavailable
-POST,/transactions/exchange,400,invalid_parameters,"項目が無効です",Invalid parameters
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
-,,422,account_not_found,"アカウントが見つかりません",The account is not found
+POST,/transactions/exchange,422,account_not_found,"アカウントが見つかりません",The account is not found
,,422,transaction_restricted,,Transaction is not allowed
,,422,can_not_exchange_between_same_private_money,"同じマネーとの交換はできません",
,,422,can_not_exchange_between_users,"異なるユーザー間での交換は出来ません",
@@ -249,6 +301,7 @@ POST,/transactions/exchange,400,invalid_parameters,"項目が無効です",Inval
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
,,422,terminal_is_invalidated,"端末は無効化されています",The terminal is already invalidated
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
@@ -258,6 +311,7 @@ POST,/transactions/exchange,400,invalid_parameters,"項目が無効です",Inval
,,422,account_transfer_limit_exceeded,"取引金額が上限を超えました",Too much amount to transfer
,,422,account_balance_exceeded,"口座残高が上限を超えました",The account balance exceeded the limit
,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
,,422,account_total_topup_limit_range,"期間内での合計チャージ額上限に達しました",Entire period topup limit reached
,,422,account_total_topup_limit_entire_period,"全期間での合計チャージ額上限に達しました",Entire period topup limit reached
,,422,coupon_unavailable_shop,"このクーポンはこの店舗では使用できません。",This coupon is unavailable for this shop.
@@ -270,18 +324,17 @@ POST,/transactions/exchange,400,invalid_parameters,"項目が無効です",Inval
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
,,422,account_closed,"アカウントは退会しています",The account is closed
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
,,503,temporarily_unavailable,,Service Unavailable
-POST,/transactions/cpm,400,invalid_parameters,"項目が無効です",Invalid parameters
-,,403,cpm_unacceptable_amount,"このCPMトークンに対して許可されていない金額です。",The amount is unacceptable for the CPM token
+POST,/transactions/cpm,403,cpm_unacceptable_amount,"このCPMトークンに対して許可されていない金額です。",The amount is unacceptable for the CPM token
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,cpm_token_already_proceed,"このCPMトークンは既に処理されています。",The CPM token is already proceed
,,422,cpm_token_already_expired,"このCPMトークンは既に失効しています。",The CPM token is already expired
,,422,cpm_token_not_found,"CPMトークンが見つかりませんでした。",The CPM token is not found.
-,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -301,7 +354,7 @@ POST,/transactions/cpm,400,invalid_parameters,"項目が無効です",Invalid pa
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_closed,"アカウントは退会しています",The account is closed
,,422,customer_account_not_found,,The customer account is not found
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
@@ -309,21 +362,61 @@ POST,/transactions/cpm,400,invalid_parameters,"項目が無効です",Invalid pa
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
+,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,503,temporarily_unavailable,,Service Unavailable
POST,/transactions/bulk,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,403,organization_not_issuer,"発行体以外に許可されていない操作です",Unpermitted operation except for issuer organizations.
,,409,,,
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,bulk_transaction_invalid_csv_format,"入力されたCSVデータに誤りがあります",Invalid csv format
+POST,/transactions/cashtray,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,422,account_not_found,"アカウントが見つかりません",The account is not found
+,,422,cashtray_not_found,"決済QRコードが見つかりません",Cashtray is not found
+,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
+,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
+,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
+,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
+,,422,c2c_transfer_not_allowed,"このマネーではユーザ間マネー譲渡は利用できません",Customer to customer transfer is not available for this money
+,,422,account_transfer_limit_exceeded,"取引金額が上限を超えました",Too much amount to transfer
+,,422,account_balance_exceeded,"口座残高が上限を超えました",The account balance exceeded the limit
+,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
+,,422,account_total_topup_limit_range,"期間内での合計チャージ額上限に達しました",Entire period topup limit reached
+,,422,account_total_topup_limit_entire_period,"全期間での合計チャージ額上限に達しました",Entire period topup limit reached
+,,422,coupon_unavailable_shop,"このクーポンはこの店舗では使用できません。",This coupon is unavailable for this shop.
+,,422,coupon_already_used,"このクーポンは既に使用済みです。",This coupon is already used.
+,,422,coupon_not_received,"このクーポンは受け取られていません。",This coupon is not received.
+,,422,coupon_not_sent,"このウォレットに対して配信されていないクーポンです。",This coupon is not sent to this account yet.
+,,422,coupon_amount_not_enough,"このクーポンを使用するには支払い額が足りません。",The payment amount not enough to use this coupon.
+,,422,coupon_not_payment,"クーポンは支払いにのみ使用できます。",Coupons can only be used for payment.
+,,422,coupon_unavailable,"このクーポンは使用できません。",This coupon is unavailable.
+,,422,account_suspended,"アカウントは停止されています",The account is suspended
+,,422,account_closed,"アカウントは退会しています",The account is closed
+,,422,customer_account_not_found,,The customer account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
+,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
+,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
+,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
+,,422,terminal_is_invalidated,"端末は無効化されています",The terminal is already invalidated
+,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
+,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
+,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
+,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
+,,422,cashtray_already_proceed,"この決済QRコードは既に処理されています",Cashtray is already proceed
+,,422,cashtray_expired,"この決済QRコードは有効期限が切れています",Cashtray is expired
+,,422,cashtray_already_canceled,"この決済QRコードは既に無効化されています",Cashtray is already canceled
+,,503,temporarily_unavailable,,Service Unavailable
POST,/external-transactions,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
,,422,customer_user_not_found,,The customer user is not found
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
-,,422,private_money_not_found,,Private money not found
-,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,customer_account_not_found,,The customer account is not found
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_closed,"アカウントは退会しています",The account is closed
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
@@ -332,6 +425,7 @@ POST,/external-transactions,400,invalid_parameters,"項目が無効です",Inval
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
,,422,terminal_is_invalidated,"端末は無効化されています",The terminal is already invalidated
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
@@ -350,6 +444,8 @@ POST,/external-transactions,400,invalid_parameters,"項目が無効です",Inval
,,422,coupon_amount_not_enough,"このクーポンを使用するには支払い額が足りません。",The payment amount not enough to use this coupon.
,,422,coupon_not_payment,"クーポンは支払いにのみ使用できます。",Coupons can only be used for payment.
,,422,coupon_unavailable,"このクーポンは使用できません。",This coupon is unavailable.
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
+,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,503,temporarily_unavailable,,Service Unavailable
POST,/external-transactions/:uuid/refund,400,invalid_mdk_token,,Invalid MDK token
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
@@ -357,6 +453,7 @@ POST,/external-transactions/:uuid/refund,400,invalid_mdk_token,,Invalid MDK toke
,,409,already_registered_veritrans_card,"このカードは既に登録されています",
,,409,already_registered_veritrans_account,"この会員は既に登録されています",
,,422,event_not_found,"イベントが見つかりません",Event not found
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,can_not_refund_bank_transaction,"銀行取引はキャンセルできません",Bank transactions cannot be cancelled.
,,422,unavailable_card_error,"このクレジットカードはご利用になれません",The credit card is unavailable
,,422,veritrans_wrong_password_or_cancel,"本人認証に失敗しました。(パスワード間違い、キャンセル、カード会社判定)",Not complete authentication by cardholder.
@@ -375,42 +472,48 @@ GET,/bulk-transactions/:uuid,404,notfound,,Not found
GET,/bulk-transactions/:uuid/jobs,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,bulk_transaction_not_found,"Bulk取引が見つかりません",Bulk transaction not found
GET,/bills,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-POST,/bills,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
+GET,/bills/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,422,bill_not_found,"支払いQRコードが見つかりません",Bill not found
+POST,/bills,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_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
-PATCH,/bills/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+PATCH,/bills/:uuid,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
,,404,notfound,,Not found
GET,/checks,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,organization_not_found,,Organization not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
+,,503,temporarily_unavailable,,Service Unavailable
POST,/checks,400,invalid_parameter_both_point_and_money_are_zero,,One of 'money_amount' or 'point_amount' must be a positive (>0) number
,,400,invalid_parameter_only_merchants_can_attach_points_to_check,,Only merchants can attach points to check
-,,400,invalid_parameter_bear_point_account_identification_item_not_unique,"ポイントを負担する店舗アカウントを指定するリクエストパラメータには、アカウントID、またはユーザIDのどちらかを含めることができます",Request parameters include either bear_point_account or bear_point_shop_id.
,,400,invalid_parameter_combination_usage_limit_and_is_onetime,,'usage_limit' can not be specified if 'is_onetime' is true.
-,,400,invalid_parameters,"項目が無効です",Invalid parameters
,,400,invalid_parameter_expires_at,,'expires_at' must be in the future
+,,400,invalid_parameters,"項目が無効です",Invalid parameters
+,,400,invalid_parameter_bear_point_account_identification_item_not_unique,"ポイントを負担する店舗アカウントを指定するリクエストパラメータには、アカウントID、またはユーザIDのどちらかを含めることができます",Request parameters include either bear_point_account or bear_point_shop_id.
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
,,422,account_private_money_is_not_issued_by_organization,,The account's private money is not issued by this organization
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,bear_point_account_not_found,"ポイントを負担する店舗アカウントが見つかりません",Bear point account not found.
,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
GET,/checks/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
,,422,account_private_money_is_not_issued_by_organization,,The account's private money is not issued by this organization
+,,503,temporarily_unavailable,,Service Unavailable
PATCH,/checks/:uuid,400,invalid_parameter_combination_usage_limit_and_is_onetime,,'usage_limit' can not be specified if 'is_onetime' is true.
,,400,invalid_parameters,"項目が無効です",Invalid parameters
,,400,invalid_parameter_expires_at,,'expires_at' must be in the future
,,400,invalid_parameter_both_point_and_money_are_zero,,One of 'money_amount' or 'point_amount' must be a positive (>0) number
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
+,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
,,422,onetime_check_cannot_reenabled,"使用済みのワンタイムチャージQRコードは再度有効化できません",One-time check already used and disabled cannot be re-enabled
,,422,account_private_money_is_not_issued_by_organization,,The account's private money is not issued by this organization
-,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
GET,/users,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
POST,/users,400,user_invalid_email,"入力されたメールアドレスが間違っています。入力内容をご確認ください",
,,400,not_shop_admin_user_must_not_be_linked_to_any_shops,,Admin user who does not have shop-authority must not be linked to any shops
@@ -428,8 +531,8 @@ PATCH,/users/invitations/:uuid,403,,,
,,409,admin_user_conflict,,The Admin-user is already registered
,,503,failed_to_send_email,,Failed to send an E-mail.
POST,/users/:uuid/accounts,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,user_not_found,,The user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,user_not_found,"ユーザーが見つかりません",The user is not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,user_attributes_external_id_not_match,"ユーザー属性情報の外部IDが一致しません",Not match external id of user attributes
,,422,user_attributes_not_found,"ユーザー属性情報が存在しません",Not found the user attrubtes
@@ -448,12 +551,14 @@ DELETE,/users/:uuid,403,,,
GET,/private-moneys,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,organization_not_found,,Organization not found
GET,/private-moneys/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
GET,/private-moneys/:uuid/summary,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,,,
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/private-moneys/:uuid/clearings,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/private-moneys/:uuid/organization-summaries,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,,,
,,404,,,
@@ -466,7 +571,7 @@ POST,/private-moneys,400,invalid_parameters,"項目が無効です",Invalid para
GET,/terminals,403,,,
GET,/organizations,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
POST,/organizations,403,,,
,,409,organization_conflict,,The organization code is already used
,,409,shop_name_conflict,,The shop name is already used
@@ -484,8 +589,9 @@ PUT,/organizations/:code,403,,,
,,503,temporarily_unavailable,,Service Unavailable
GET,/organizations/:code/shops,403,,,
GET,/shops,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,organization_not_found,,Organization not found
+,,503,temporarily_unavailable,,Service Unavailable
POST,/shops,403,,,
,,409,email_conflict,"このメールアドレスは既に使われています",The E-mail address is already registered
,,409,shop_name_conflict,,The shop name is already used
@@ -504,32 +610,37 @@ GET,/shops/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限
PATCH,/shops/:uuid,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,409,shop_name_conflict,,The shop name is already used
+,,422,head_office_can_not_be_disabled,,Head office can not be disabled
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
,,422,unavailable_private_money,,Given private money(s) is/are not available
,,422,organization_not_member_organization,,The specified organization is not a member organization of the organization accessing this API
,,503,temporarily_unavailable,,Service Unavailable
GET,/customers,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,503,temporarily_unavailable,,Service Unavailable
GET,/customers/transactions,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,customer_user_not_found,,The customer user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/customers/:uuid,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
,,422,account_not_found,"アカウントが見つかりません",The account is not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
PATCH,/clearings/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,clearing_not_found,"精算が見つかりません",Clearing not found
,,503,temporarily_unavailable,,Service Unavailable
GET,/clearings,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,503,temporarily_unavailable,,Service Unavailable
GET,/clearings/preview,400,clearing_to_should_be_past_date,"締め日は過去の日付を指定してください",Should set past date for 'closing_date'
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
POST,/clearings,400,clearing_to_should_be_past_date,"締め日は過去の日付を指定してください",Should set past date for 'closing_date'
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
GET,/clearings/flico,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
GET,/clearings/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,clearing_not_found,"精算が見つかりません",Clearing not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/messaging-operations,403,,,
POST,/messaging-operations,400,messaging_operation_over_transfer_limit,,The messaging operation's amount is over transfer limit
,,400,messaging_operation_sender_account_not_exist,,The account of sender user does not exist
@@ -538,7 +649,7 @@ POST,/messaging-operations,400,messaging_operation_over_transfer_limit,,The mess
,,403,,,
,,409,messaging_operation_already_done,,The messaging operation is already done
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,503,temporarily_unavailable,,Service Unavailable
GET,/messaging-operations/receivers,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,,,
@@ -560,6 +671,10 @@ POST,/user-stats,400,invalid_parameters,"項目が無効です",Invalid paramete
,,422,invalid_promotional_operation_user,"ユーザーの指定に不正な値が含まれています",Invalid user data is specified
,,422,invalid_promotional_operation_status,"不正な処理ステータスです",Invalid operation status is specified
,,503,user_stats_operation_service_unavailable,"一時的にユーザー統計サービスが利用不能です",User stats service is temporarily unavailable
+POST,/user-stats/terminate,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,422,user_stats_operation_already_done,"指定されたIDの集計処理タスクは既に完了しています",The specified user stats operation is already done
+,,422,user_stats_operation_not_found,"指定されたIDの集計処理タスクが見つかりません",User stats task not found for the operation ID
+,,503,temporarily_unavailable,,Service Unavailable
POST,/device/pokeregis,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,,,
,,409,hardware_id_conflict,,Hardware id is already registered
@@ -583,13 +698,13 @@ POST,/device/pokeregis/:serial-number,400,terminal_is_already_invalidated,,The t
,,500,,,
GET,/device/kiosks,400,,,
,,403,,,
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,organization_not_found,,Organization not found
GET,/device/kiosk-maintenances,403,,,
GET,/device/kiosks/:kiosk-id,400,,,
,,403,,,
,,404,,,
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,organization_not_found,,Organization not found
POST,/merchandise-tag,403,,,
,,503,temporarily_unavailable,,Service Unavailable
@@ -599,14 +714,15 @@ POST,/tokens,403,unpermitted_admin_user,"この管理ユーザには権限があ
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
,,422,organization_not_found,,Organization not found
GET,/tokens,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,503,temporarily_unavailable,,Service Unavailable
DELETE,/tokens/:token,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
,,503,temporarily_unavailable,,Service Unavailable
GET,/accounts/customers,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
POST,/accounts/customers,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,user_not_found,,The user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,user_not_found,"ユーザーが見つかりません",The user is not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,user_attributes_external_id_not_match,"ユーザー属性情報の外部IDが一致しません",Not match external id of user attributes
,,422,user_attributes_not_found,"ユーザー属性情報が存在しません",Not found the user attrubtes
@@ -616,17 +732,16 @@ PATCH,/accounts/:uuid/customers,403,unpermitted_admin_user,"この管理ユー
,,422,invalid_metadata,"メタデータの形式が不正です",Invalid metadata format
,,422,account_not_found,"アカウントが見つかりません",The account is not found
,,422,user_attributes_not_found,"ユーザー属性情報が存在しません",Not found the user attrubtes
-,,422,account_closed,"アカウントは退会しています",The account is closed
,,503,temporarily_unavailable,,Service Unavailable
GET,/accounts/shops,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
GET,/accounts/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
+,,503,temporarily_unavailable,,Service Unavailable
PATCH,/accounts/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
,,503,temporarily_unavailable,,Service Unavailable
DELETE,/accounts/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
,,422,account_not_found,"アカウントが見つかりません",The account is not found
,,422,account_not_pre_closed,"アカウントが退会準備中ではありません",The account is not pre-closed
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
@@ -634,6 +749,7 @@ DELETE,/accounts/:uuid,403,unpermitted_admin_user,"この管理ユーザには
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
,,422,terminal_is_invalidated,"端末は無効化されています",The terminal is already invalidated
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
@@ -643,6 +759,7 @@ DELETE,/accounts/:uuid,403,unpermitted_admin_user,"この管理ユーザには
,,422,account_transfer_limit_exceeded,"取引金額が上限を超えました",Too much amount to transfer
,,422,account_balance_exceeded,"口座残高が上限を超えました",The account balance exceeded the limit
,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
,,422,account_total_topup_limit_range,"期間内での合計チャージ額上限に達しました",Entire period topup limit reached
,,422,account_total_topup_limit_entire_period,"全期間での合計チャージ額上限に達しました",Entire period topup limit reached
,,422,coupon_unavailable_shop,"このクーポンはこの店舗では使用できません。",This coupon is unavailable for this shop.
@@ -659,12 +776,15 @@ DELETE,/accounts/:uuid,403,unpermitted_admin_user,"この管理ユーザには
,,503,temporarily_unavailable,,Service Unavailable
GET,/accounts/:uuid/balances,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/accounts/:uuid/expired-balances,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/accounts/:uuid/transfers/summary,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
GET,/users/:uuid/accounts,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
+,,503,temporarily_unavailable,,Service Unavailable
GET,/cashtrays/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
@@ -676,19 +796,16 @@ DELETE,/cashtrays/:uuid,403,unpermitted_admin_user,"この管理ユーザには
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
POST,/cashtrays,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,account_not_found,"アカウントが見つかりません",The account is not found
-,,422,account_transfer_limit_exceeded,"取引金額が上限を超えました",Too much amount to transfer
-,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
PATCH,/cashtrays/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
,,422,cashtray_already_proceed,"この決済QRコードは既に処理されています",Cashtray is already proceed
,,422,cashtray_expired,"この決済QRコードは有効期限が切れています",Cashtray is expired
,,422,cashtray_already_canceled,"この決済QRコードは既に無効化されています",Cashtray is already canceled
-,,422,account_transfer_limit_exceeded,"取引金額が上限を超えました",Too much amount to transfer
-,,422,account_money_topup_transfer_limit_exceeded,"マネーチャージ金額が上限を超えました",Too much amount to money topup transfer
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
GET,/cpm/:cpm-token,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,cpm_token_not_found,"CPMトークンが見つかりませんでした。",The CPM token is not found.
+,,503,temporarily_unavailable,,Service Unavailable
GET,/seven-bank-atm-sessions/:qr-info,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
PATCH,/seven-bank-atm-sessions/:qr-info,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
@@ -696,19 +813,20 @@ PATCH,/seven-bank-atm-sessions/:qr-info,403,unpermitted_admin_user,"この管理
POST,/campaigns,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,campaign_overlaps,"同期間に開催されるキャンペーン間で優先度が重複してます",The campaign period overlaps under the same private-money / type / priority
-,,422,shop_account_not_found,,The shop account is not found
-,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,campaign_period_overlaps,"同期間に開催されるキャンペーン間で優先度が重複してます",The campaign period overlaps under the same private-money / type / priority
,,422,campaign_invalid_period,,Invalid campaign period starts_at later than ends_at
+,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
GET,/campaigns,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,503,temporarily_unavailable,,Service Unavailable
PATCH,/campaigns/:uuid,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
-,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
,,422,campaign_budget_caps_exceeded,"キャンペーン予算上限額を越えています",The campaign budget caps exceeded
GET,/campaigns/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,notfound,,Not found
+,,503,temporarily_unavailable,,Service Unavailable
POST,/webhooks,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,409,organization_worker_task_finish_webhook_conflict,"そのwebhookは既に登録されています",The webhook is already registered
GET,/webhooks,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
@@ -721,12 +839,12 @@ DELETE,/webhooks/:uuid,403,unpermitted_admin_user,"この管理ユーザには
,,503,temporarily_unavailable,,Service Unavailable
GET,/coupons,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
POST,/coupons,400,invalid_parameters,"項目が無効です",Invalid parameters
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,404,partner_storage_not_found,"指定したIDのデータは保存されていません",Not found by storage_id
,,422,shop_user_not_found,"店舗が見つかりません",The shop user is not found
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,coupon_image_storage_conflict,"クーポン画像のストレージIDは既に存在します",The coupon image storage_id is already exists
GET,/coupons/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,coupon_not_found,"クーポンが見つかりませんでした。",The coupon is not found.
@@ -740,7 +858,7 @@ POST,/storage/v1,400,partner_decryption_failed,"リクエスト中の暗号デ
,,400,partner_client_not_found,"partner_clientが見つかりません。",The partner client is not found.
,,422,formats_not_supported_by_storage,"このフォーマットは対応していません",This format is not supported
POST,/user-devices,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
-,,422,user_not_found,,The user is not found
+,,422,user_not_found,"ユーザーが見つかりません",The user is not found
GET,/user-devices/:uuid,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,422,user_device_not_found,,The user-device not found
POST,/user-devices/:uuid/activate,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
@@ -750,25 +868,27 @@ POST,/user-devices/:uuid/banks,403,unpermitted_admin_user,"この管理ユーザ
,,422,user_device_is_disabled,"このデバイスは無効化されています",The user-device is disabled
,,422,user_device_not_found,,The user-device not found
,,422,bank_registration_limit_error,"8口座を越えて登録できません",Can not register more than 8 accounts.
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,paytree_disabled_private_money,"このマネーは銀行から引き落とし出来ません",This money cannot be charged from the bank
,,422,unpermitted_private_money,"このマネーは使えません",This money is not available
,,503,incomplete_configration_for_organization_bank,"現状、このマネーは銀行からのチャージを行えません。システム管理者へお問合せ下さい","Currently, this money cannot be topup from this bank. Please contact your system administrator."
GET,/user-devices/:uuid/banks,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,403,forbidden,,Forbidden
-,,422,private_money_not_found,,Private money not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,user_device_not_found,,The user-device not found
POST,/user-devices/:uuid/banks/topup,400,paytree_request_failure,"銀行の外部サービス起因により、チャージに失敗しました",Failure to topup due to external services of the bank
,,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
,,403,forbidden,,Forbidden
,,403,user_bank_disabled_error,"現在、このユーザーは銀行からのチャージは利用できません",Topup from this user's bank have now been stopped.
,,404,user_bank_not_found,"登録された銀行が見つかりません",Bank not found
-,,410,transaction_canceled,"取引がキャンセルされました",Transaction was canceled
-,,422,private_money_not_found,,Private money not found
+,,422,user_not_found,"ユーザーが見つかりません",The user is not found
+,,422,private_money_not_found,"マネーが見つかりません",Private money not found
,,422,user_device_is_disabled,"このデバイスは無効化されています",The user-device is disabled
,,422,user_device_not_found,,The user-device not found
+,,422,request_id_conflict,"このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。",The request_id is already used by another transaction. Try again with new request id
,,422,account_not_found,"アカウントが見つかりません",The account is not found
,,422,account_can_not_topup,"この店舗からはチャージできません",account can not topup
+,,422,private_money_closed,"このマネーは解約されています",This money was closed
,,422,transaction_has_done,"取引は完了しており、キャンセルすることはできません",Transaction has been copmpleted and cannot be canceled
,,422,account_restricted,"特定のアカウントの支払いに制限されています",The account is restricted to pay for a specific account
,,422,account_balance_not_enough,"口座残高が不足してます",The account balance is not enough
@@ -788,7 +908,7 @@ POST,/user-devices/:uuid/banks/topup,400,paytree_request_failure,"銀行の外
,,422,account_suspended,"アカウントは停止されています",The account is suspended
,,422,account_closed,"アカウントは退会しています",The account is closed
,,422,customer_account_not_found,,The customer account is not found
-,,422,shop_account_not_found,,The shop account is not found
+,,422,shop_account_not_found,"店舗アカウントが見つかりません",The shop account is not found
,,422,account_currency_mismatch,"アカウント間で通貨が異なっています",Currency mismatch between accounts
,,422,account_pre_closed,"アカウントは退会準備中です",The account is pre-closed
,,422,account_not_accessible,"アカウントにアクセスできません",The account is not accessible by this user
@@ -796,10 +916,15 @@ POST,/user-devices/:uuid/banks/topup,400,paytree_request_failure,"銀行の外
,,422,same_account_transaction,"同じアカウントに送信しています",Sending to the same account
,,422,transaction_invalid_done_at,"取引完了日が無効です",Transaction completion date is invalid
,,422,transaction_invalid_amount,"取引金額が数値ではないか、受け入れられない桁数です",Transaction amount is not a number or cannot be accepted for this currency
+,,422,reserved_word_can_not_specify_to_metadata,"取引メタデータに予約語は指定出来ません",Reserved word can not specify to metadata
,,422,paytree_disabled_private_money,"このマネーは銀行から引き落とし出来ません",This money cannot be charged from the bank
,,422,unpermitted_private_money,"このマネーは使えません",This money is not available
,,503,temporarily_unavailable,,Service Unavailable
,,503,incomplete_configration_for_organization_bank,"現状、このマネーは銀行からのチャージを行えません。システム管理者へお問合せ下さい","Currently, this money cannot be topup from this bank. Please contact your system administrator."
+DELETE,/user-devices/:uuid/banks,403,unpermitted_admin_user,"この管理ユーザには権限がありません",Admin does not have permission
+,,403,forbidden,,Forbidden
+,,404,user_bank_not_found,"登録された銀行が見つかりません",Bank not found
+,,422,user_device_not_found,,The user-device not found
POST,/paytree/charge-entry-result,400,partner_decryption_failed,"リクエスト中の暗号データを復号化することができませんでした。",Could not decrypt the data.
,,400,partner_client_not_found,"partner_clientが見つかりません。",The partner client is not found.
POST,/paytree/reconcile,400,invalid_parameters,"項目が無効です",Invalid parameters
diff --git a/docs/event.md b/docs/event.md
index 3d25015..02c0f41 100644
--- a/docs/event.md
+++ b/docs/event.md
@@ -12,12 +12,13 @@ Request.CreateExternalTransaction request = new Request.CreateExternalTransactio
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- 5317 // 取引額
+ 8568 // 取引額
) {
Description = "たい焼き(小倉)", // 取引説明文
Metadata = "{\"key\":\"value\"}", // ポケペイ外部取引メタデータ
- Products = new object[]{new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}}, // 商品情報データ
+ Products = new object[]{new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}, new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}}, // 商品情報データ
RequestId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // リクエストID
+ DoneAt = "2023-06-15T00:28:28.000000Z", // ポケペイ外部取引の実施時間
};
Response.ExternalTransactionDetail response = await request.Send(client);
```
@@ -146,6 +147,20 @@ Response.ExternalTransactionDetail response = await request.Send(client);
}
```
+**`done_at`**
+
+
+ポケペイ外部取引が実際に起こった時間です。
+時間帯指定のポイント付与キャンペーンでの取引時間の計算に使われます。
+デフォルトではCreateExternalTransactionがリクエストされた時間になります。
+
+```json
+{
+ "type": "string",
+ "format": "date-time"
+}
+```
+
成功したときは
@@ -157,13 +172,11 @@ Response.ExternalTransactionDetail response = await request.Send(client);
|---|---|---|---|
|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
|422|customer_user_not_found||The customer user is not found|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
-|422|private_money_not_found||Private money not found|
-|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|customer_account_not_found||The customer account is not found|
-|422|shop_account_not_found||The shop account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
|422|account_suspended|アカウントは停止されています|The account is suspended|
|422|account_closed|アカウントは退会しています|The account is closed|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
@@ -172,6 +185,7 @@ Response.ExternalTransactionDetail response = await request.Send(client);
|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
|422|terminal_is_invalidated|端末は無効化されています|The terminal is already invalidated|
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
@@ -190,6 +204,8 @@ Response.ExternalTransactionDetail response = await request.Send(client);
|422|coupon_amount_not_enough|このクーポンを使用するには支払い額が足りません。|The payment amount not enough to use this coupon.|
|422|coupon_not_payment|クーポンは支払いにのみ使用できます。|Coupons can only be used for payment.|
|422|coupon_unavailable|このクーポンは使用できません。|This coupon is unavailable.|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|503|temporarily_unavailable||Service Unavailable|
diff --git a/docs/organization.md b/docs/organization.md
index 3b0f6e1..5bafe07 100644
--- a/docs/organization.md
+++ b/docs/organization.md
@@ -9,8 +9,8 @@ Request.ListOrganizations request = new Request.ListOrganizations(
) {
Page = 1, // ページ番号
PerPage = 50, // 1ページ分の取引数
- Name = "4", // 組織名
- Code = "10", // 組織コード
+ Name = "dWsbduWBx", // 組織名
+ Code = "fg1Kl", // 組織コード
};
Response.PaginatedOrganizations response = await request.Send(client);
```
@@ -86,7 +86,7 @@ Response.PaginatedOrganizations response = await request.Send(client);
|---|---|---|---|
|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
@@ -100,9 +100,9 @@ Response.PaginatedOrganizations response = await request.Send(client);
Request.CreateOrganization request = new Request.CreateOrganization(
"ox-supermarket", // 新規組織コード
"oxスーパー", // 新規組織名
- new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 加盟店組織で有効にするマネーIDの配列
- "GLPQCeC7jS@6W3D.com", // 発行体担当者メールアドレス
- "ftZcdyglmN@XEpp.com" // 新規組織担当者メールアドレス
+ new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 加盟店組織で有効にするマネーIDの配列
+ "u47KITpvwb@o61t.com", // 発行体担当者メールアドレス
+ "0xPHohZAfX@S5WA.com" // 新規組織担当者メールアドレス
) {
BankName = "XYZ銀行", // 銀行名
BankCode = "1234", // 銀行金融機関コード
diff --git a/docs/private_money.md b/docs/private_money.md
index 22904d4..8279870 100644
--- a/docs/private_money.md
+++ b/docs/private_money.md
@@ -77,8 +77,8 @@ Response.PaginatedPrivateMoneys response = await request.Send(client);
Request.GetPrivateMoneyOrganizationSummaries request = new Request.GetPrivateMoneyOrganizationSummaries(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
) {
- From = "2020-09-01T07:38:37.000000Z", // 開始日時(toと同時に指定する必要有)
- To = "2024-03-21T02:25:01.000000Z", // 終了日時(fromと同時に指定する必要有)
+ From = "2021-06-11T14:25:36.000000Z", // 開始日時(toと同時に指定する必要有)
+ To = "2023-07-23T08:58:59.000000Z", // 終了日時(fromと同時に指定する必要有)
Page = 1, // ページ番号
PerPage = 50, // 1ページ分の取引数
};
@@ -162,8 +162,8 @@ Response.PaginatedPrivateMoneyOrganizationSummaries response = await request.Sen
Request.GetPrivateMoneySummary request = new Request.GetPrivateMoneySummary(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
) {
- From = "2023-10-27T19:24:09.000000Z", // 開始日時
- To = "2020-01-28T06:46:15.000000Z", // 終了日時
+ From = "2021-03-17T01:31:19.000000Z", // 開始日時
+ To = "2022-09-13T03:45:44.000000Z", // 終了日時
};
Response.PrivateMoneySummary response = await request.Send(client);
```
diff --git a/docs/responses.md b/docs/responses.md
index 0191f14..4d6c794 100644
--- a/docs/responses.md
+++ b/docs/responses.md
@@ -1,21 +1,4 @@
# Responses
-
-## AdminUserWithShopsAndPrivateMoneys
-* `Id (string)`:
-* `Role (string)`:
-* `Email (string)`:
-* `Name (string)`:
-* `IsActive (bool)`:
-* `Organization (Organization)`:
-* `Shops (User[])`:
-* `PrivateMoneys (PrivateMoney[])`:
-
-`organization`は [Organization](#organization) オブジェクトを返します。
-
-`shops`は [User](#user) オブジェクトの配列を返します。
-
-`private-moneys`は [PrivateMoney](#private-money) オブジェクトの配列を返します。
-
## AccountWithUser
* `Id (string)`:
@@ -290,6 +273,9 @@
`rows`は [Bank](#bank) オブジェクトの配列を返します。
+
+## BankDeleted
+
## PaginatedTransaction
* `Rows (Transaction[])`:
@@ -310,6 +296,16 @@
`rows`は [Transaction](#transaction) オブジェクトの配列を返します。
+
+## PaginatedBillTransaction
+* `Rows (BillTransaction[])`:
+* `PerPage (int)`:
+* `Count (int)`:
+* `NextPageCursorId (string)`:
+* `PrevPageCursorId (string)`:
+
+`rows`は [BillTransaction](#bill-transaction) オブジェクトの配列を返します。
+
## PaginatedTransfers
* `Rows (Transfer[])`:
@@ -505,6 +501,23 @@
`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+## SevenBankATMSession
+* `QrInfo (string)`:
+* `Account (AccountDetail)`:
+* `Amount (int)`:
+* `Transaction (Transaction)`:
+* `SevenBankCustomerNumber (string)`:
+* `AtmId (string)`:
+* `AudiId (string)`:
+* `IssuerCode (string)`:
+* `IssuerName (string)`:
+* `MoneyName (string)`:
+
+`account`は [AccountDetail](#account-detail) オブジェクトを返します。
+
+`transaction`は [Transaction](#transaction) オブジェクトを返します。
+
## PrivateMoney
* `Id (string)`: マネーID
@@ -657,6 +670,15 @@
`private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
+
+## BillTransaction
+* `Transaction (Transaction)`:
+* `Bill (Bill)`:
+
+`transaction`は [Transaction](#transaction) オブジェクトを返します。
+
+`bill`は [Bill](#bill) オブジェクトを返します。
+
## AccountBalance
* `ExpiresAt (string)`:
diff --git a/docs/seven_bank_atm_session.md b/docs/seven_bank_atm_session.md
new file mode 100644
index 0000000..7bc50a6
--- /dev/null
+++ b/docs/seven_bank_atm_session.md
@@ -0,0 +1,41 @@
+# SevenBankATMSession
+セブンATMチャージの取引内容を照会するAPIを提供しています。
+
+
+
+## GetSevenBankATMSession: セブン銀行ATMセッションの取得
+セブン銀行ATMセッションを取得します
+
+```csharp
+Request.GetSevenBankAtmSession request = new Request.GetSevenBankAtmSession(
+ "x" // QRコードの情報
+);
+Response.SevenBankATMSession response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`qr_info`**
+
+
+取得するセブン銀行ATMチャージのQRコードの情報です。
+
+```json
+{
+ "type": "string"
+}
+```
+
+
+
+成功したときは
+[SevenBankATMSession](./responses.md#seven-bank-atm-session)
+を返します
+
+
+
+---
+
+
+
diff --git a/docs/shop.md b/docs/shop.md
index 475a11e..06573a1 100644
--- a/docs/shop.md
+++ b/docs/shop.md
@@ -8,11 +8,11 @@ Request.ListShops request = new Request.ListShops() {
OrganizationCode = "pocketchange", // 組織コード
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
Name = "oxスーパー三田店", // 店舗名
- PostalCode = "5801175", // 店舗の郵便番号
+ PostalCode = "629-6586", // 店舗の郵便番号
Address = "東京都港区芝...", // 店舗の住所
- Tel = "016-580-990", // 店舗の電話番号
- Email = "Sm0jLeVc0I@IOPv.com", // 店舗のメールアドレス
- ExternalId = "o", // 店舗の外部ID
+ Tel = "030-5979-102", // 店舗の電話番号
+ Email = "KqhRSKyv4a@eUNi.com", // 店舗のメールアドレス
+ ExternalId = "5kIXisF2lvLdWFAH9CECfmZyv", // 店舗の外部ID
WithDisabled = false, // 無効な店舗を含める
Page = 1, // ページ番号
PerPage = 50, // 1ページ分の取引数
@@ -176,8 +176,9 @@ Response.PaginatedShops response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|organization_not_found||Organization not found|
+|503|temporarily_unavailable||Service Unavailable|
@@ -192,11 +193,11 @@ Response.PaginatedShops response = await request.Send(client);
Request.CreateShop request = new Request.CreateShop(
"oxスーパー三田店" // 店舗名
) {
- ShopPostalCode = "3332833", // 店舗の郵便番号
+ ShopPostalCode = "708-1722", // 店舗の郵便番号
ShopAddress = "東京都港区芝...", // 店舗の住所
- ShopTel = "069-584-5953", // 店舗の電話番号
- ShopEmail = "sXeAgeVmz0@XdBq.com", // 店舗のメールアドレス
- ShopExternalId = "vz2LZqSb1Cr9Gv", // 店舗の外部ID
+ ShopTel = "09532-409", // 店舗の電話番号
+ ShopEmail = "EBsOM5mHn7@CA1S.com", // 店舗のメールアドレス
+ ShopExternalId = "M3xNEFCgQheyCbSnP7P0SqnjQ", // 店舗の外部ID
OrganizationCode = "ox-supermarket", // 組織コード
};
Response.User response = await request.Send(client);
@@ -313,14 +314,14 @@ Response.User response = await request.Send(client);
Request.CreateShopV2 request = new Request.CreateShopV2(
"oxスーパー三田店" // 店舗名
) {
- PostalCode = "841-8626", // 店舗の郵便番号
+ PostalCode = "7260579", // 店舗の郵便番号
Address = "東京都港区芝...", // 店舗の住所
- Tel = "07801932450", // 店舗の電話番号
- Email = "nk93ttYPJh@OiPC.com", // 店舗のメールアドレス
- ExternalId = "hnxitPJhteZ9v4lYIFrYpnV35p", // 店舗の外部ID
+ Tel = "00-912-0892", // 店舗の電話番号
+ Email = "AdXU9fbl4B@ElEf.com", // 店舗のメールアドレス
+ ExternalId = "JcTmiRof0lbldCRsSSTgoxqh3a", // 店舗の外部ID
OrganizationCode = "ox-supermarket", // 組織コード
- PrivateMoneyIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 店舗で有効にするマネーIDの配列
- CanTopupPrivateMoneyIds = new string[]{}, // 店舗でチャージ可能にするマネーIDの配列
+ PrivateMoneyIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 店舗で有効にするマネーIDの配列
+ CanTopupPrivateMoneyIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 店舗でチャージ可能にするマネーIDの配列
};
Response.ShopWithAccounts response = await request.Send(client);
```
@@ -518,14 +519,14 @@ Request.UpdateShop request = new Request.UpdateShop(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 店舗ユーザーID
) {
Name = "oxスーパー三田店", // 店舗名
- PostalCode = "3202721", // 店舗の郵便番号
+ PostalCode = "394-8815", // 店舗の郵便番号
Address = "東京都港区芝...", // 店舗の住所
- Tel = "089-0671-673", // 店舗の電話番号
- Email = "r99tmpLoTF@QeHI.com", // 店舗のメールアドレス
- ExternalId = "sIBBDhi4oQ1t1s3zE", // 店舗の外部ID
- PrivateMoneyIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 店舗で有効にするマネーIDの配列
- CanTopupPrivateMoneyIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 店舗でチャージ可能にするマネーIDの配列
- Status = "active", // 店舗の状態
+ Tel = "03708-3473", // 店舗の電話番号
+ Email = "gaH3XPjunt@8Ngf.com", // 店舗のメールアドレス
+ ExternalId = "fostplBJ13qPcX", // 店舗の外部ID
+ PrivateMoneyIds = new string[]{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}, // 店舗で有効にするマネーIDの配列
+ CanTopupPrivateMoneyIds = new string[]{}, // 店舗でチャージ可能にするマネーIDの配列
+ Status = "disabled", // 店舗の状態
};
Response.ShopWithAccounts response = await request.Send(client);
```
diff --git a/docs/transaction.md b/docs/transaction.md
index 030ac70..17b05cf 100644
--- a/docs/transaction.md
+++ b/docs/transaction.md
@@ -6,7 +6,7 @@ CPMトークンの現在の状態を取得します。CPMトークンの有効
```csharp
Request.GetCpmToken request = new Request.GetCpmToken(
- "2Vt3kMgTzAxm3nuCtm4tM4" // CPMトークン
+ "tXGZ9lfp9TwgYPOmismihX" // CPMトークン
);
Response.CpmToken response = await request.Send(client);
```
@@ -44,18 +44,18 @@ CPM取引時にエンドユーザーが店舗に提示するバーコードを
```csharp
Request.ListTransactions request = new Request.ListTransactions() {
- From = "2020-03-02T10:23:33.000000Z", // 開始日時
- To = "2022-04-21T10:38:47.000000Z", // 終了日時
+ From = "2023-02-05T17:24:39.000000Z", // 開始日時
+ To = "2024-03-11T23:36:57.000000Z", // 終了日時
Page = 1, // ページ番号
PerPage = 50, // 1ページ分の取引数
ShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
CustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザーID
CustomerName = "太郎", // エンドユーザー名
TerminalId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 端末ID
- TransactionId = "TMWwQQegA", // 取引ID
+ TransactionId = "dh", // 取引ID
OrganizationCode = "pocketchange", // 組織コード
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- IsModified = true, // キャンセルフラグ
+ IsModified = false, // キャンセルフラグ
Types = new string[]{"topup", "payment"}, // 取引種別 (複数指定可)、チャージ=topup、支払い=payment
Description = "店頭QRコードによる支払い", // 取引説明文
};
@@ -295,6 +295,7 @@ Response.PaginatedTransaction response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|NULL|NULL|NULL|
+|503|temporarily_unavailable||Service Unavailable|
@@ -311,10 +312,10 @@ Request.CreateTransaction request = new Request.CreateTransaction(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
) {
- MoneyAmount = 6249,
- PointAmount = 9585,
- PointExpiresAt = "2023-09-27T06:12:39.000000Z", // ポイント有効期限
- Description = "5Gh3EedIVkoAN4R",
+ MoneyAmount = 134,
+ PointAmount = 9403,
+ PointExpiresAt = "2020-12-01T09:26:04.000000Z", // ポイント有効期限
+ Description = "6oAdT5yPsPRTmUYdZdYDDGZDuZn0XgqQIqTu14tSh13qLZDYdRTWbMgZiB4q5yXIKvcyeytZUeCOzn479Q7",
};
Response.TransactionDetail response = await request.Send(client);
```
@@ -415,11 +416,11 @@ Response.TransactionDetail response = await request.Send(client);
|400|invalid_parameter_both_point_and_money_are_zero||One of 'money_amount' or 'point_amount' must be a positive (>0) number|
|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|NULL|NULL|NULL|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
|422|customer_user_not_found||The customer user is not found|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
@@ -439,7 +440,7 @@ Response.TransactionDetail response = await request.Send(client);
|422|account_suspended|アカウントは停止されています|The account is suspended|
|422|account_closed|アカウントは退会しています|The account is closed|
|422|customer_account_not_found||The customer account is not found|
-|422|shop_account_not_found||The shop account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
|422|account_currency_mismatch|アカウント間で通貨が異なっています|Currency mismatch between accounts|
|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
@@ -447,6 +448,7 @@ Response.TransactionDetail response = await request.Send(client);
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
|503|temporarily_unavailable||Service Unavailable|
@@ -467,11 +469,11 @@ Request.ListTransactionsV2 request = new Request.ListTransactionsV2() {
CustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザーID
CustomerName = "太郎", // エンドユーザー名
Description = "店頭QRコードによる支払い", // 取引説明文
- TransactionId = "6PB", // 取引ID
- IsModified = true, // キャンセルフラグ
+ TransactionId = "7CQ6mo", // 取引ID
+ IsModified = false, // キャンセルフラグ
Types = new string[]{"topup", "payment"}, // 取引種別 (複数指定可)、チャージ=topup、支払い=payment
- From = "2024-03-12T09:24:55.000000Z", // 開始日時
- To = "2020-05-09T22:11:54.000000Z", // 終了日時
+ From = "2020-07-30T15:17:39.000000Z", // 開始日時
+ To = "2020-03-02T11:01:28.000000Z", // 終了日時
NextPageCursorId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 次ページへ遷移する際に起点となるtransactionのID
PrevPageCursorId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 前ページへ遷移する際に起点となるtransactionのID
PerPage = 50, // 1ページ分の取引数
@@ -740,6 +742,268 @@ prev_page_cursor_idのtransaction自体は前のページには含まれませ
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|503|temporarily_unavailable||Service Unavailable|
+
+
+
+---
+
+
+
+## ListBillTransactions: 支払い取引履歴を取得する
+支払いによって発生した取引を支払いのデータとともに一覧で返します。
+
+```csharp
+Request.ListBillTransactions request = new Request.ListBillTransactions() {
+ PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
+ OrganizationCode = "pocketchange", // 組織コード
+ ShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
+ CustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザーID
+ CustomerName = "太郎", // エンドユーザー名
+ TerminalId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザー端末ID
+ Description = "店頭QRコードによる支払い", // 取引説明文
+ TransactionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 取引ID
+ BillId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 支払いQRコードのID
+ IsModified = false, // キャンセルフラグ
+ From = "2021-06-07T17:24:57.000000Z", // 開始日時
+ To = "2020-07-02T10:00:20.000000Z", // 終了日時
+ NextPageCursorId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 次ページへ遷移する際に起点となるtransactionのID
+ PrevPageCursorId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 前ページへ遷移する際に起点となるtransactionのID
+ PerPage = 50, // 1ページ分の取引数
+};
+Response.PaginatedBillTransaction response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`private_money_id`**
+
+
+マネーIDです。
+
+指定したマネーでの取引が一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`organization_code`**
+
+
+組織コードです。
+
+フィルターとして使われ、指定された組織の店舗での取引のみ一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "maxLength": 32,
+ "pattern": "^[a-zA-Z0-9-]*$"
+}
+```
+
+**`shop_id`**
+
+
+店舗IDです。
+
+フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`customer_id`**
+
+
+エンドユーザーIDです。
+
+フィルターとして使われ、指定されたエンドユーザーの取引のみ一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`customer_name`**
+
+
+エンドユーザー名です。
+
+フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "maxLength": 256
+}
+```
+
+**`terminal_id`**
+
+
+エンドユーザーの端末IDです。
+フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`description`**
+
+
+取引を指定の取引説明文でフィルターします。
+
+取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
+
+```json
+{
+ "type": "string",
+ "maxLength": 200
+}
+```
+
+**`transaction_id`**
+
+
+取引IDです。
+
+フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`bill_id`**
+
+
+支払いQRコードのIDです。
+
+フィルターとして使われ、指定された支払いQRコードIDに部分一致(前方一致)する取引のみが一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`is_modified`**
+
+
+キャンセルフラグです。
+
+これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
+デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
+
+```json
+{
+ "type": "boolean"
+}
+```
+
+**`from`**
+
+
+抽出期間の開始日時です。
+
+フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "date-time"
+}
+```
+
+**`to`**
+
+
+抽出期間の終了日時です。
+
+フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
+
+```json
+{
+ "type": "string",
+ "format": "date-time"
+}
+```
+
+**`next_page_cursor_id`**
+
+
+次ページへ遷移する際に起点となるtransactionのID(前ページの末尾要素のID)です。
+本APIのレスポンスにもnext_page_cursor_idが含まれており、これがnull値の場合は最後のページであることを意味します。
+UUIDである場合は次のページが存在することを意味し、このnext_page_cursor_idをリクエストパラメータに含めることで次ページに遷移します。
+
+next_page_cursor_idのtransaction自体は次のページには含まれません。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`prev_page_cursor_id`**
+
+
+前ページへ遷移する際に起点となるtransactionのID(次ページの先頭要素のID)です。
+
+本APIのレスポンスにもprev_page_cursor_idが含まれており、これがnull値の場合は先頭のページであることを意味します。
+UUIDである場合は前のページが存在することを意味し、このprev_page_cursor_idをリクエストパラメータに含めることで前ページに遷移します。
+
+prev_page_cursor_idのtransaction自体は前のページには含まれません。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+**`per_page`**
+
+
+1ページ分の取引数です。
+
+デフォルト値は50です。
+
+```json
+{
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 1000
+}
+```
+
+
+
+成功したときは
+[PaginatedBillTransaction](./responses.md#paginated-bill-transaction)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|503|temporarily_unavailable||Service Unavailable|
@@ -757,9 +1021,9 @@ Request.CreateTopupTransaction request = new Request.CreateTopupTransaction(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
) {
BearPointShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント支払時の負担店舗ID
- MoneyAmount = 9307, // マネー額
- PointAmount = 2855, // ポイント額
- PointExpiresAt = "2020-03-08T01:49:37.000000Z", // ポイント有効期限
+ MoneyAmount = 1789, // マネー額
+ PointAmount = 4484, // ポイント額
+ PointExpiresAt = "2023-01-14T15:33:35.000000Z", // ポイント有効期限
Description = "初夏のチャージキャンペーン", // 取引履歴に表示する説明文
Metadata = "{\"key\":\"value\"}", // 取引メタデータ
RequestId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // リクエストID
@@ -905,6 +1169,7 @@ Response.TransactionDetail response = await request.Send(client);
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
```json
{
@@ -925,9 +1190,8 @@ Response.TransactionDetail response = await request.Send(client);
|400|invalid_parameter_both_point_and_money_are_zero||One of 'money_amount' or 'point_amount' must be a positive (>0) number|
|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
-|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
@@ -953,9 +1217,12 @@ Response.TransactionDetail response = await request.Send(client);
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|customer_account_not_found||The customer account 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_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|503|temporarily_unavailable||Service Unavailable|
@@ -974,12 +1241,13 @@ Request.CreatePaymentTransaction request = new Request.CreatePaymentTransaction(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- 4544 // 支払い額
+ 7889 // 支払い額
) {
Description = "たい焼き(小倉)", // 取引履歴に表示する説明文
Metadata = "{\"key\":\"value\"}", // 取引メタデータ
- Products = new object[]{new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}}, // 商品情報データ
+ Products = new object[]{new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}, new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}}, // 商品情報データ
RequestId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // リクエストID
+ Strategy = "point-preferred", // 支払い時の残高消費方式
};
Response.TransactionDetail response = await request.Send(client);
```
@@ -1102,6 +1370,7 @@ Response.TransactionDetail response = await request.Send(client);
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
```json
{
@@ -1110,6 +1379,27 @@ Response.TransactionDetail response = await request.Send(client);
}
```
+**`strategy`**
+
+
+支払い時に残高がどのように消費されるかを指定します。
+デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+- point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+- money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+
+```json
+{
+ "type": "string",
+ "enum": [
+ "point-preferred",
+ "money-only"
+ ]
+}
+```
+
成功したときは
@@ -1119,11 +1409,9 @@ Response.TransactionDetail response = await request.Send(client);
### Error Responses
|status|type|ja|en|
|---|---|---|---|
-|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
-|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
@@ -1149,9 +1437,12 @@ Response.TransactionDetail response = await request.Send(client);
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|customer_account_not_found||The customer account 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_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|503|temporarily_unavailable||Service Unavailable|
@@ -1167,14 +1458,15 @@ CPMトークンに設定されたスコープの取引を作ることができ
```csharp
Request.CreateCpmTransaction request = new Request.CreateCpmTransaction(
- "bgbkQVRY8MuhwDykulFo5m", // CPMトークン
+ "6jQwMdVQzET3CTZR3naadm", // CPMトークン
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
- 8996.0 // 取引金額
+ 7535.0 // 取引金額
) {
Description = "たい焼き(小倉)", // 取引説明文
Metadata = "{\"key\":\"value\"}", // 店舗側メタデータ
- Products = new object[]{new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}, new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}}, // 商品情報データ
+ Products = new object[]{new Dictionary(){{"jan_code","abc"}, {"name","name1"}, {"unit_price",100}, {"price",100}, {"quantity",1}, {"is_discounted",false}, {"other","{}"}}}, // 商品情報データ
RequestId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // リクエストID
+ Strategy = "point-preferred", // 支払い時の残高消費方式
};
Response.TransactionDetail response = await request.Send(client);
```
@@ -1283,6 +1575,7 @@ Response.TransactionDetail response = await request.Send(client);
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
```json
{
@@ -1291,6 +1584,27 @@ Response.TransactionDetail response = await request.Send(client);
}
```
+**`strategy`**
+
+
+支払い時に残高がどのように消費されるかを指定します。
+デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+- point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+- money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+
+```json
+{
+ "type": "string",
+ "enum": [
+ "point-preferred",
+ "money-only"
+ ]
+}
+```
+
成功したときは
@@ -1300,17 +1614,15 @@ Response.TransactionDetail response = await request.Send(client);
### Error Responses
|status|type|ja|en|
|---|---|---|---|
-|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|cpm_unacceptable_amount|このCPMトークンに対して許可されていない金額です。|The amount is unacceptable for the CPM token|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
-|422|private_money_not_found||Private money not found|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|cpm_token_already_proceed|このCPMトークンは既に処理されています。|The CPM token is already proceed|
|422|cpm_token_already_expired|このCPMトークンは既に失効しています。|The CPM token is already expired|
|422|cpm_token_not_found|CPMトークンが見つかりませんでした。|The CPM token is not found.|
-|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
@@ -1330,7 +1642,7 @@ Response.TransactionDetail response = await request.Send(client);
|422|account_suspended|アカウントは停止されています|The account is suspended|
|422|account_closed|アカウントは退会しています|The account is closed|
|422|customer_account_not_found||The customer account is not found|
-|422|shop_account_not_found||The shop account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
|422|account_currency_mismatch|アカウント間で通貨が異なっています|Currency mismatch between accounts|
|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
@@ -1338,6 +1650,9 @@ Response.TransactionDetail response = await request.Send(client);
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|503|temporarily_unavailable||Service Unavailable|
@@ -1356,7 +1671,7 @@ Request.CreateTransferTransaction request = new Request.CreateTransferTransactio
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 送金元ユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 受取ユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
- 7876.0 // 送金額
+ 1615.0 // 送金額
) {
Metadata = "{\"key\":\"value\"}", // 取引メタデータ
Description = "たい焼き(小倉)", // 取引履歴に表示する説明文
@@ -1460,6 +1775,7 @@ Response.TransactionDetail response = await request.Send(client);
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
```json
{
@@ -1477,13 +1793,11 @@ Response.TransactionDetail response = await request.Send(client);
### Error Responses
|status|type|ja|en|
|---|---|---|---|
-|400|invalid_parameters|項目が無効です|Invalid parameters|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
|422|customer_user_not_found||The customer user is not found|
-|422|private_money_not_found||Private money not found|
-|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
+|422|private_money_not_found|マネーが見つかりません|Private money not found|
|422|account_can_not_topup|この店舗からはチャージできません|account can not topup|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|account_restricted|特定のアカウントの支払いに制限されています|The account is restricted to pay for a specific account|
|422|account_balance_not_enough|口座残高が不足してます|The account balance is not enough|
@@ -1503,7 +1817,7 @@ Response.TransactionDetail response = await request.Send(client);
|422|account_suspended|アカウントは停止されています|The account is suspended|
|422|account_closed|アカウントは退会しています|The account is closed|
|422|customer_account_not_found||The customer account is not found|
-|422|shop_account_not_found||The shop account is not found|
+|422|shop_account_not_found|店舗アカウントが見つかりません|The shop account is not found|
|422|account_currency_mismatch|アカウント間で通貨が異なっています|Currency mismatch between accounts|
|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
@@ -1511,6 +1825,9 @@ Response.TransactionDetail response = await request.Send(client);
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
+|422|invalid_metadata|メタデータの形式が不正です|Invalid metadata format|
|503|temporarily_unavailable||Service Unavailable|
@@ -1526,9 +1843,9 @@ Request.CreateExchangeTransaction request = new Request.CreateExchangeTransactio
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- 9419
+ 2693
) {
- Description = "V3XaTOkFDFDXkJRYuzmNrD0IPFMYcPpoEqcZqYNWKYupHW3vkZPbupwOmpLyfcnvR24ekndSEuijqLz34cJjz9WzSXV2waIpnDEjnPuGDOLqsy43AtWyT6hyzJkPIxdv4Vr2ADhNnBQ2AhJrtrRhEmEhncAz9T8Jn6tKv842hmKtJWGe0W2JoBVxO",
+ Description = "37wRncWgLEMvwuXtyGneCNJhR9grzsET9HHziGJ2iqEYWh5QfKEnNvZa51B6RuNHWw3kkEIImb7878ag0GpEoXRZP9Tuo6ihkLtNpmjVgJl2arbhJouxWQ6FlBm7k1iTzlm9ILQGKVJoUCSY35cdkgvsbAYCbaEHjTHUmx8bpMxYByLz0xsJRhRVsB",
RequestId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // リクエストID
};
Response.TransactionDetail response = await request.Send(client);
@@ -1600,6 +1917,7 @@ Response.TransactionDetail response = await request.Send(client);
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
```json
{
@@ -1617,8 +1935,6 @@ Response.TransactionDetail response = await request.Send(client);
### Error Responses
|status|type|ja|en|
|---|---|---|---|
-|400|invalid_parameters|項目が無効です|Invalid parameters|
-|410|transaction_canceled|取引がキャンセルされました|Transaction was canceled|
|422|account_not_found|アカウントが見つかりません|The account is not found|
|422|transaction_restricted||Transaction is not allowed|
|422|can_not_exchange_between_same_private_money|同じマネーとの交換はできません||
@@ -1628,6 +1944,7 @@ Response.TransactionDetail response = await request.Send(client);
|422|account_not_accessible|アカウントにアクセスできません|The account is not accessible by this user|
|422|terminal_is_invalidated|端末は無効化されています|The terminal is already invalidated|
|422|same_account_transaction|同じアカウントに送信しています|Sending to the same account|
+|422|private_money_closed|このマネーは解約されています|This money was closed|
|422|transaction_has_done|取引は完了しており、キャンセルすることはできません|Transaction has been copmpleted and cannot be canceled|
|422|transaction_invalid_done_at|取引完了日が無効です|Transaction completion date is invalid|
|422|transaction_invalid_amount|取引金額が数値ではないか、受け入れられない桁数です|Transaction amount is not a number or cannot be accepted for this currency|
@@ -1637,6 +1954,7 @@ Response.TransactionDetail response = await request.Send(client);
|422|account_transfer_limit_exceeded|取引金額が上限を超えました|Too much amount to transfer|
|422|account_balance_exceeded|口座残高が上限を超えました|The account balance exceeded the limit|
|422|account_money_topup_transfer_limit_exceeded|マネーチャージ金額が上限を超えました|Too much amount to money topup transfer|
+|422|reserved_word_can_not_specify_to_metadata|取引メタデータに予約語は指定出来ません|Reserved word can not specify to metadata|
|422|account_total_topup_limit_range|期間内での合計チャージ額上限に達しました|Entire period topup limit reached|
|422|account_total_topup_limit_entire_period|全期間での合計チャージ額上限に達しました|Entire period topup limit reached|
|422|coupon_unavailable_shop|このクーポンはこの店舗では使用できません。|This coupon is unavailable for this shop.|
@@ -1649,6 +1967,7 @@ Response.TransactionDetail response = await request.Send(client);
|422|account_suspended|アカウントは停止されています|The account is suspended|
|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
|422|account_closed|アカウントは退会しています|The account is closed|
+|422|request_id_conflict|このリクエストIDは他の取引ですでに使用されています。お手数ですが、別のリクエストIDで最初からやり直してください。|The request_id is already used by another transaction. Try again with new request id|
|503|temporarily_unavailable||Service Unavailable|
@@ -1710,7 +2029,7 @@ Request.RefundTransaction request = new Request.RefundTransaction(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 取引ID
) {
Description = "返品対応のため", // 取引履歴に表示する返金事由
- ReturningPointExpiresAt = "2021-02-10T20:54:53.000000Z", // 返却ポイントの有効期限
+ ReturningPointExpiresAt = "2023-08-16T16:39:07.000000Z", // 返却ポイントの有効期限
};
Response.TransactionDetail response = await request.Send(client);
```
@@ -1979,4 +2298,57 @@ Response.UserStatsOperation response = await request.Send(client);
---
+
+## TerminateUserStats: RequestUserStatsのタスクを強制終了する
+RequestUserStatsによるファイル生成のタスクを強制終了するためのAPIです。
+RequestUserStatsのレスポンス中の `operation_id` をキーにして強制終了リクエストを送ります。
+既に集計タスクが終了している場合は何も行いません。
+発行体に対して結果通知用のWebhook URLが設定されている場合、強制終了成功時には以下のような内容のPOSTリクエストが送られます。
+
+- task: "process_user_stats_operation"
+- operation_id: 強制終了対象のタスクID
+- status: "terminated"
+
+```csharp
+Request.TerminateUserStats request = new Request.TerminateUserStats(
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // 集計タスクID
+);
+Response.UserStatsOperation response = await request.Send(client);
+```
+
+
+
+### Parameters
+**`operation_id`**
+
+
+強制終了対象の集計タスクIDです。
+必須パラメータであり、指定されたタスクIDが存在しない場合は `user_stats_operation_not_found`エラー(422)が返ります。
+
+```json
+{
+ "type": "string",
+ "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[UserStatsOperation](./responses.md#user-stats-operation)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|422|user_stats_operation_already_done|指定されたIDの集計処理タスクは既に完了しています|The specified user stats operation is already done|
+|422|user_stats_operation_not_found|指定されたIDの集計処理タスクが見つかりません|User stats task not found for the operation ID|
+|503|temporarily_unavailable||Service Unavailable|
+
+
+
+---
+
+
diff --git a/docs/transfer.md b/docs/transfer.md
index f1d8e5f..9fdb23d 100644
--- a/docs/transfer.md
+++ b/docs/transfer.md
@@ -8,8 +8,8 @@
Request.GetAccountTransferSummary request = new Request.GetAccountTransferSummary(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ウォレットID
) {
- From = "2020-11-04T16:34:17.000000Z", // 集計期間の開始時刻
- To = "2021-03-23T02:43:19.000000Z", // 集計期間の終了時刻
+ From = "2020-11-02T03:49:28.000000Z", // 集計期間の開始時刻
+ To = "2020-05-16T18:29:14.000000Z", // 集計期間の終了時刻
TransferTypes = new string[]{"topup", "payment"}, // 取引明細種別 (複数指定可)
};
Response.AccountTransferSummary response = await request.Send(client);
@@ -124,19 +124,19 @@ Response.AccountTransferSummary response = await request.Send(client);
```csharp
Request.ListTransfers request = new Request.ListTransfers() {
- From = "2024-03-12T16:53:53.000000Z",
- To = "2022-04-14T08:54:52.000000Z",
- Page = 6738,
- PerPage = 8532,
+ From = "2023-05-06T00:13:31.000000Z",
+ To = "2021-03-26T13:47:58.000000Z",
+ Page = 4874,
+ PerPage = 6887,
ShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- ShopName = "aMM6DcJjfAtdrmKAg3KBKDu0vlbYdVC6n9nVLo43cE33CQPF6kxIlI0uguDnziraNYM7VX",
+ ShopName = "WzO75yHWR5FLMa9CO3GmqQepv7doxpRjgZI2VSDvLJkkZMMdEANfWVavAje3PJg4zkA5dwRQrAEDCEBzCTk0pNAGkxkj3y6QjLE9oTv9S3Zg4O5dK9OBTn3gY0HIwJr5Xn6R9PIw5eC52tvIBnMyMg4CnT2dj7ORUTt4jEgn4792da7QYy7V605lzcBixe",
CustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- CustomerName = "YLnlD8HOOCDlP4GZ7jbmXMO5zVMwfk3fyCehTHNb57OPgysrQCIrNbKg5EGtS1CRG8HTOfVnvp3qGXZFBsOSpPHbliv7UIdhUMzObVJcG5btiH5rur7GsubMGTjIcOXKD9o8Kba3zToGBURahT5P9DvE8UV0j2YqC15yVJZpc8KVpHARBDgg1G",
+ CustomerName = "rwgOsZo2yFQXiifPwyEPkMTjwK5UmBamQcUvvHD25XYGaGoRmlkWpVKSQYACWhdJgT5oXIAxp1c5Q2vG7By91KC2xkwbMvROWfUAhh6XnZz0yJYgRGAM6oTzljbZYS",
TransactionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- IsModified = true,
- TransactionTypes = new string[]{"exchange"},
- TransferTypes = new string[]{"expire", "topup"}, // 取引明細の種類でフィルターします。
+ IsModified = false,
+ TransactionTypes = new string[]{"payment", "exchange"},
+ TransferTypes = new string[]{"exchange", "cashback", "expire", "campaign", "topup", "payment", "transfer"}, // 取引明細の種類でフィルターします。
Description = "店頭QRコードによる支払い", // 取引詳細説明文
};
Response.PaginatedTransfers response = await request.Send(client);
@@ -357,6 +357,7 @@ Response.PaginatedTransfers response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|NULL|NULL|NULL|
+|503|temporarily_unavailable||Service Unavailable|
@@ -369,20 +370,20 @@ Response.PaginatedTransfers response = await request.Send(client);
```csharp
Request.ListTransfersV2 request = new Request.ListTransfersV2() {
ShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
- ShopName = "vS6JUWIFuWHifSCeHqDX4OovF1kPsfFAfUD6hedBMnO5c5siBhPS0PdEUgltcrxJuLRpPyEyLzg5USUF0acnAYj9bCB7rUqwv3jfmweeo8gmjkrVbM4yoFbYRleO", // 店舗名
+ ShopName = "DiVxdn1z0TuA7dLQ8GnuuGnm3um0ZKYlqHYAPfacx4ba4pxXiFCicQd3QQrdtpp5IlW8KnTaroT8w3801ZxeZpTa0FFkkUFLVC", // 店舗名
CustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // エンドユーザーID
- CustomerName = "9KOkq0RFzjJHwRArvOU8komJ1Atk5RVlui7mGRMrDuzhgMwi2QEwxvEfxvbfoaYN92mmS964bSnGq9n7PpIOomMWW66P3IlH0kXmsTM", // エンドユーザー名
+ CustomerName = "Kp9TvCsVFg3Dy6t9FVfvRBKOl2QQeBI5NM6J7EhkzGk22yYle2ZOPXJOiEYcNwwBKhoxC", // エンドユーザー名
TransactionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 取引ID
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
IsModified = true, // キャンセルフラグ
- TransactionTypes = new string[]{"expire", "topup", "transfer", "exchange", "payment"}, // 取引種別 (複数指定可)、チャージ=topup、支払い=payment
+ TransactionTypes = new string[]{"payment", "topup", "cashback", "exchange"}, // 取引種別 (複数指定可)、チャージ=topup、支払い=payment
NextPageCursorId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 次ページへ遷移する際に起点となるtransferのID
PrevPageCursorId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 前ページへ遷移する際に起点となるtransferのID
PerPage = 50, // 1ページ分の取引数
- TransferTypes = new string[]{"expire"}, // 取引明細種別 (複数指定可)
+ TransferTypes = new string[]{"cashback"}, // 取引明細種別 (複数指定可)
Description = "店頭QRコードによる支払い", // 取引詳細説明文
- From = "2023-04-20T11:19:57.000000Z", // 開始日時
- To = "2023-07-26T09:32:54.000000Z", // 終了日時
+ From = "2023-05-13T00:11:05.000000Z", // 開始日時
+ To = "2022-05-27T13:59:30.000000Z", // 終了日時
};
Response.PaginatedTransfersV2 response = await request.Send(client);
```
@@ -681,6 +682,7 @@ prev_page_cursor_idのtransfer自体は前のページには含まれません
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|503|temporarily_unavailable||Service Unavailable|
diff --git a/docs/user.md b/docs/user.md
index 98384e9..aa9b25e 100644
--- a/docs/user.md
+++ b/docs/user.md
@@ -1,30 +1,3 @@
# User
-
-## GetUser
-
-```csharp
-Request.GetUser request = new Request.GetUser();
-Response.AdminUserWithShopsAndPrivateMoneys response = await request.Send(client);
-```
-
-
-
-
-
-
-成功したときは
-[AdminUserWithShopsAndPrivateMoneys](./responses.md#admin-user-with-shops-and-private-moneys)
-を返します
-
-### Error Responses
-|status|type|ja|en|
-|---|---|---|---|
-|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-
-
-
----
-
-
diff --git a/docs/user_device.md b/docs/user_device.md
index f1bcf28..e1a38b1 100644
--- a/docs/user_device.md
+++ b/docs/user_device.md
@@ -55,7 +55,7 @@ Response.UserDevice response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
-|422|user_not_found||The user is not found|
+|422|user_not_found|ユーザーが見つかりません|The user is not found|
diff --git a/docs/webhook.md b/docs/webhook.md
index 0bbf894..c9cf009 100644
--- a/docs/webhook.md
+++ b/docs/webhook.md
@@ -67,7 +67,7 @@ Response.PaginatedOrganizationWorkerTaskWebhook response = await request.Send(cl
```csharp
Request.CreateWebhook request = new Request.CreateWebhook(
"bulk_shops", // タスク名
- "FE45d3P2" // URL
+ "GgnfI" // URL
);
Response.OrganizationWorkerTaskWebhook response = await request.Send(client);
```
@@ -163,8 +163,8 @@ Response.OrganizationWorkerTaskWebhook response = await request.Send(client);
Request.UpdateWebhook request = new Request.UpdateWebhook(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // Webhook ID
) {
- Url = "Pz", // URL
- IsActive = false, // 有効/無効
+ Url = "tlICoQDp", // URL
+ IsActive = true, // 有効/無効
Task = "bulk_shops", // タスク名
};
Response.OrganizationWorkerTaskWebhook response = await request.Send(client);
diff --git a/partner.yaml b/partner.yaml
index 2435b32..8a48e22 100644
--- a/partner.yaml
+++ b/partner.yaml
@@ -7,6 +7,7 @@ openapi: '3.0.1'
info:
description: >-
Partner APIs
+
title: Partner APIs
version: 24.3.26
@@ -57,6 +58,9 @@ tags:
- name: BankPay
description: |
BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。
+ - name: SevenBankATMSession
+ description: |
+ セブンATMチャージの取引内容を照会するAPIを提供しています。
components:
schemas:
@@ -692,6 +696,13 @@ components:
type: array
items:
$ref: '#/components/schemas/Transfer'
+ BillTransaction:
+ x-pokepay-schema-type: "response"
+ properties:
+ transaction:
+ $ref: '#/components/schemas/Transaction'
+ bill:
+ $ref: '#/components/schemas/Bill'
ShopWithMetadata:
x-pokepay-schema-type: "response"
properties:
@@ -1279,6 +1290,10 @@ components:
type: integer
minimum: 0
+ BankDeleted:
+ x-pokepay-schema-type: "response"
+ properties: {}
+
PaginatedTransaction:
x-pokepay-schema-type: "response"
properties:
@@ -1318,6 +1333,32 @@ components:
前ページ取得するためのID。
実際にはrows先頭
+ PaginatedBillTransaction:
+ x-pokepay-schema-type: "response"
+ properties:
+ rows:
+ type: array
+ items:
+ $ref: '#/components/schemas/BillTransaction'
+ per_page:
+ type: integer
+ count:
+ type: integer
+ next_page_cursor_id:
+ type: string
+ format: uuid
+ nullable: true
+ description: |-
+ 次ページ取得するためのID。次ページ取得するためのID。
+ 実際にはrows末尾
+ prev_page_cursor_id:
+ type: string
+ format: uuid
+ nullable: true
+ description: |-
+ 前ページ取得するためのID。
+
+ 実際にはrows先頭
PaginatedTransfers:
x-pokepay-schema-type: "response"
properties:
@@ -1774,6 +1815,39 @@ components:
pagination:
$ref: '#/components/schemas/Pagination'
+ SevenBankATMSession:
+ x-pokepay-schema-type: "response"
+ properties:
+ qr_info:
+ type: string
+ maxLength: 23
+ account:
+ $ref: '#/components/schemas/AccountDetail'
+ amount:
+ type: integer
+ transaction:
+ $ref: '#/components/schemas/Transaction'
+ nullable: true
+ seven_bank_customer_number:
+ type: string
+ atm_id:
+ type: string
+ maxLength: 7
+ nullable: true
+ audi_id:
+ type: string
+ maxLength: 4
+ nullable: true
+ issuer_code:
+ type: string
+ nullable: true
+ issuer_name:
+ type: string
+ nullable: true
+ money_name:
+ type: string
+ nullable: true
+
BadRequest:
x-pokepay-schema-type: "response"
oneOf:
@@ -2856,7 +2930,9 @@ paths:
nullable: true
format: decimal
title: '支払い額'
- description: 支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+ description: |
+ 支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+ また、金額を指定する場合の上限額は支払いをするマネーの取引上限額です。
private_money_id:
type: string
format: uuid
@@ -2885,6 +2961,38 @@ paths:
$ref: '#/components/responses/UnprocessableEntity'
/bills/{bill_id}:
+ get:
+ tags:
+ - Bill
+ summary: '支払いQRコードの表示'
+ description: 支払いQRコードの内容を表示します。
+ x-pokepay-operator-name: "GetBill"
+ x-pokepay-allow-server-side: true
+ parameters:
+ - in: path
+ name: bill_id
+ required: true
+ schema:
+ type: string
+ format: uuid
+ title: '支払いQRコードのID'
+ description: |-
+ 表示する支払いQRコードのIDです。
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Bill'
+ '400':
+ $ref: '#/components/responses/InvalidParameters'
+ '403':
+ $ref: '#/components/responses/UnpermittedAdminUser'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '422':
+ $ref: '#/components/responses/UnprocessableEntity'
patch:
tags:
- Bill
@@ -2914,7 +3022,7 @@ paths:
nullable: true
format: decimal
title: '支払い額'
- description: 支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+ description: 支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。また、金額を指定する場合の上限額は支払いをするマネーの取引上限額です。
description:
type: string
maxLength: 200
@@ -3713,6 +3821,164 @@ paths:
$ref: '#/components/schemas/PaginatedTransactionV2'
'400':
$ref: '#/components/responses/InvalidParameters'
+ '403':
+ $ref: '#/components/responses/Forbidden'
+ /transactions/bill:
+ get:
+ tags:
+ - Transaction
+ summary: '支払い取引履歴を取得する'
+ description: 支払いによって発生した取引を支払いのデータとともに一覧で返します。
+ x-pokepay-operator-name: "ListBillTransactions"
+ x-pokepay-allow-server-side: true
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ properties:
+ private_money_id:
+ type: string
+ format: uuid
+ title: 'マネーID'
+ description: |-
+ マネーIDです。
+
+ 指定したマネーでの取引が一覧に表示されます。
+ organization_code:
+ type: string
+ pattern: '^[a-zA-Z0-9-]*$'
+ maxLength: 32
+ title: '組織コード'
+ description: |-
+ 組織コードです。
+
+ フィルターとして使われ、指定された組織の店舗での取引のみ一覧に表示されます。
+ example: 'pocketchange'
+ shop_id:
+ type: string
+ format: uuid
+ title: '店舗ID'
+ description: |-
+ 店舗IDです。
+
+ フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
+ customer_id:
+ type: string
+ format: uuid
+ title: 'エンドユーザーID'
+ description: |-
+ エンドユーザーIDです。
+
+ フィルターとして使われ、指定されたエンドユーザーの取引のみ一覧に表示されます。
+ customer_name:
+ type: string
+ maxLength: 256
+ title: 'エンドユーザー名'
+ description: |-
+ エンドユーザー名です。
+
+ フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
+ example: 太郎
+ terminal_id:
+ type: string
+ format: uuid
+ title: 'エンドユーザー端末ID'
+ description: |-
+ エンドユーザーの端末IDです。
+ フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
+ description:
+ type: string
+ maxLength: 200
+ title: '取引説明文'
+ description: |-
+ 取引を指定の取引説明文でフィルターします。
+
+ 取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
+ example: 店頭QRコードによる支払い
+ transaction_id:
+ type: string
+ format: uuid
+ title: '取引ID'
+ description: |-
+ 取引IDです。
+
+ フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
+ bill_id:
+ type: string
+ format: uuid
+ title: '支払いQRコードのID'
+ description: |-
+ 支払いQRコードのIDです。
+
+ フィルターとして使われ、指定された支払いQRコードIDに部分一致(前方一致)する取引のみが一覧に表示されます。
+ is_modified:
+ type: boolean
+ title: 'キャンセルフラグ'
+ description: |-
+ キャンセルフラグです。
+
+ これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
+ デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
+ from:
+ type: string
+ format: date-time
+ title: '開始日時'
+ description: |-
+ 抽出期間の開始日時です。
+
+ フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
+ to:
+ type: string
+ format: date-time
+ title: '終了日時'
+ description: |-
+ 抽出期間の終了日時です。
+
+ フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
+ next_page_cursor_id:
+ type: string
+ format: uuid
+ title: '次ページへ遷移する際に起点となるtransactionのID'
+ description: |-
+ 次ページへ遷移する際に起点となるtransactionのID(前ページの末尾要素のID)です。
+ 本APIのレスポンスにもnext_page_cursor_idが含まれており、これがnull値の場合は最後のページであることを意味します。
+ UUIDである場合は次のページが存在することを意味し、このnext_page_cursor_idをリクエストパラメータに含めることで次ページに遷移します。
+
+ next_page_cursor_idのtransaction自体は次のページには含まれません。
+ prev_page_cursor_id:
+ type: string
+ format: uuid
+ title: '前ページへ遷移する際に起点となるtransactionのID'
+ description: |-
+ 前ページへ遷移する際に起点となるtransactionのID(次ページの先頭要素のID)です。
+
+ 本APIのレスポンスにもprev_page_cursor_idが含まれており、これがnull値の場合は先頭のページであることを意味します。
+ UUIDである場合は前のページが存在することを意味し、このprev_page_cursor_idをリクエストパラメータに含めることで前ページに遷移します。
+
+ prev_page_cursor_idのtransaction自体は前のページには含まれません。
+ per_page:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ default: 50
+ title: '1ページ分の取引数'
+ description: |-
+ 1ページ分の取引数です。
+
+ デフォルト値は50です。
+ example: 50
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaginatedBillTransaction'
+ '400':
+ $ref: '#/components/responses/InvalidParameters'
+ '403':
+ $ref: '#/components/responses/Forbidden'
/transactions/topup:
post:
tags:
@@ -3814,6 +4080,7 @@ paths:
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
responses:
'200':
@@ -3872,6 +4139,7 @@ paths:
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
responses:
'200':
@@ -3968,7 +4236,105 @@ paths:
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
+ example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
+ strategy:
+ type: string
+ enum: [point-preferred, money-only]
+ title: '支払い時の残高消費方式'
+ description: |-
+ 支払い時に残高がどのように消費されるかを指定します。
+ デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+ - point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+ - money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+ マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+ example: 'point-preferred'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TransactionDetail'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '403':
+ $ref: '#/components/responses/Forbidden'
+ '422':
+ $ref: '#/components/responses/UnprocessableEntity'
+ /transactions/payment/bill:
+ post:
+ tags:
+ - Bill
+ summary: '支払いQRコードを読み取ることで支払いをする'
+ description: |
+ 通常支払いQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。 もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバが支払いQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際の支払い取引をリクエストすることになります。
+
+ エンドユーザーから受け取った支払いQRコードのIDをエンドユーザーIDと共に渡すことで支払い取引が作られます。
+ 支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
+ x-pokepay-operator-name: "CreatePaymentTransactionWithBill"
+ x-pokepay-allow-server-side: true
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ required: ["bill_id", "customer_id"]
+ properties:
+ bill_id:
+ type: string
+ format: uuid
+ title: '支払いQRコードのID'
+ description: |-
+ 支払いQRコードのIDです。
+
+ QRコード生成時に送金先店舗のウォレット情報や、支払い金額などが登録されています。
+ customer_id:
+ type: string
+ format: uuid
+ title: 'エンドユーザーのID'
+ description: |-
+ エンドユーザーIDです。
+
+ 支払いを行うエンドユーザーを指定します。
+ metadata:
+ type: string
+ format: json
+ title: '取引メタデータ'
+ description: |-
+ 取引作成時に指定されるメタデータです。
+
+ 任意入力で、全てのkeyとvalueが文字列であるようなフラットな構造のJSON文字列で指定します。
+ example: |-
+ {"key":"value"}
+ request_id:
+ type: string
+ format: uuid
+ title: 'リクエストID'
+ description: |-
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
+ strategy:
+ type: string
+ enum: [point-preferred, money-only]
+ default: 'point-preferred'
+ title: '支払い時の残高消費方式'
+ description: |-
+ 支払い時に残高がどのように消費されるかを指定します。
+ デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+ - point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+ - money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+ マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+ example: 'point-preferred'
responses:
'200':
description: OK
@@ -3980,6 +4346,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
+ '404':
+ $ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/transactions/cpm:
@@ -4054,7 +4422,21 @@ paths:
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
+ strategy:
+ type: string
+ enum: [point-preferred, money-only]
+ title: '支払い時の残高消費方式'
+ description: |-
+ 支払い時に残高がどのように消費されるかを指定します。
+ デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+ - point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+ - money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+ マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+ example: 'point-preferred'
responses:
'200':
description: OK
@@ -4125,6 +4507,88 @@ paths:
$ref: '#/components/responses/Forbidden'
'422':
$ref: '#/components/responses/UnprocessableEntity'
+
+ /transactions/cashtray:
+ post:
+ tags:
+ - Cashtray
+ summary: 'CashtrayQRコードを読み取ることで取引する'
+ description: |
+ エンドユーザーから受け取ったCashtray用QRコードのIDをエンドユーザーIDと共に渡すことで支払いあるいはチャージ取引が作られます。
+
+ 通常CashtrayQRコードはエンドユーザーのアプリによって読み取られ、アプリとポケペイサーバとの直接通信によって取引が作られます。
+ もしエンドユーザーとの通信をパートナーのサーバのみに限定したい場合、パートナーのサーバがCashtrayQRの情報をエンドユーザーから代理受けして、サーバ間連携APIによって実際のチャージ取引をリクエストすることになります。
+
+ x-pokepay-operator-name: "CreateTransactionWithCashtray"
+ x-pokepay-allow-server-side: true
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ required: ["cashtray_id", "customer_id"]
+ properties:
+ cashtray_id:
+ type: string
+ format: uuid
+ title: 'Cashtray用QRコードのID'
+ description: |-
+ Cashtray用QRコードのIDです。
+
+ QRコード生成時に送金元店舗のウォレット情報や、金額などが登録されています。
+
+ customer_id:
+ type: string
+ format: uuid
+ title: 'エンドユーザーのID'
+ description: |-
+ エンドユーザーIDです。
+
+ strategy:
+ type: string
+ enum: [point-preferred, money-only]
+ default: 'point-preferred'
+ title: '支払い時の残高消費方式'
+ description: |-
+ 支払い時に残高がどのように消費されるかを指定します。
+ チャージの場合は無効です。
+ デフォルトでは point-preferred (ポイント優先)が採用されます。
+
+ - point-preferred: ポイント残高が優先的に消費され、ポイントがなくなり次第マネー残高から消費されていきます(デフォルト動作)
+ - money-only: マネー残高のみから消費され、ポイント残高は使われません
+
+ マネー設定でポイント残高のみの利用に設定されている場合(display_money_and_point が point-only の場合)、 strategy の指定に関わらずポイント優先になります。
+
+ request_id:
+ type: string
+ format: uuid
+ title: 'リクエストID'
+ description: |-
+ 取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+ 取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。
+ 指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+ リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。
+ もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
+ example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TransactionDetail'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '403':
+ $ref: '#/components/responses/Forbidden'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '422':
+ $ref: '#/components/responses/UnprocessableEntity'
+
/transactions/transfer:
post:
tags:
@@ -4203,6 +4667,7 @@ paths:
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
responses:
'200':
@@ -4255,6 +4720,7 @@ paths:
取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+ 既に存在する、別のユーザによる取引とリクエストIDが衝突した場合、request_id_conflictが返ります。
example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
responses:
'200':
@@ -4549,6 +5015,14 @@ paths:
リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
example: 9dbfd997-b948-40d3-a3bf-6bc1a01368d2
+ done_at:
+ type: string
+ format: date-time
+ title: 'ポケペイ外部取引の実施時間'
+ description: |-
+ ポケペイ外部取引が実際に起こった時間です。
+ 時間帯指定のポイント付与キャンペーンでの取引時間の計算に使われます。
+ デフォルトではCreateExternalTransactionがリクエストされた時間になります。
responses:
'200':
description: OK
@@ -6086,6 +6560,8 @@ paths:
application/json:
schema:
required: ["name", "private_money_id", "starts_at", "ends_at","priority", "event"]
+ x-pokepay-conditional-parameters:
+ xor: [applicable_shop_ids, blacklisted_shop_ids]
properties:
name:
title: 'キャンペーン名'
@@ -6358,6 +6834,13 @@ paths:
description: |-
キャンペーン対象の商品を複数個購入したときに、個数に応じてポイント付与額を増やすかどうかのフラグです。
デフォルト値は false です。
+ is_floor_after_multiply:
+ type: boolean
+ title: '小数点以下切り捨てを個数を掛けた後に行うかどうか'
+ description: |-
+ is_multiply_by_countが指定されたとき、デフォルトでは商品ごとに付与ポイントが計算された後、少数点以下切り捨てが行なわれ、その後商品個数が掛けられます。
+ このフラグを有効にすると、商品ごとに付与ポイントが計算された後、商品個数が掛けられ、その後に少数点以下切り捨てが行なわれるようになります。
+ デフォルト値は false です。
starts_at:
type: string
format: date-time
@@ -6520,6 +7003,16 @@ paths:
description: |-
キャンペーンを適用する店舗IDを指定します (複数指定)。
指定しなかった場合は全店舗が対象になります。
+ blacklisted_shop_ids:
+ type: array
+ items:
+ type: string
+ format: uuid
+ title: 'キャンペーン適用対象外となる店舗IDのリスト(ブラックリスト方式)'
+ description: |-
+ キャンペーンの適用対象外となる店舗IDをブラックリスト方式で指定します (複数指定可)。
+ このパラメータが指定されている場合、blacklisted_shop_idsに含まれていない店舗全てがキャンペーンの適用対象になります。
+ blacklisted_shop_idsとapplicable_shop_idsは同時には指定できません。ホワイトリスト方式を使うときはapplicable_shop_idsを指定してください。
minimum_number_of_products:
type: integer
minimum: 1
@@ -6893,12 +7386,14 @@ paths:
デフォルトでは未指定(フィルターなし)です。
page:
type: integer
+ default: 1
minimum: 1
title: 'ページ番号'
description: 取得したいページ番号です。
example: 1
per_page:
type: integer
+ default: 20
minimum: 1
maximum: 50
title: '1ページ分の取得数'
@@ -6976,6 +7471,8 @@ paths:
content:
application/json:
schema:
+ x-pokepay-conditional-parameters:
+ xor: [applicable_shop_ids, blacklisted_shop_ids]
properties:
name:
title: 'キャンペーン名'
@@ -7238,6 +7735,13 @@ paths:
description: |-
キャンペーン対象の商品を複数個購入したときに、個数に応じてポイント付与額を増やすかどうかのフラグです。
デフォルト値は false です。
+ is_floor_after_multiply:
+ type: boolean
+ title: '小数点以下切り捨てを個数を掛けた後に行うかどうか'
+ description: |-
+ is_multiply_by_countが指定されたとき、デフォルトでは商品ごとに付与ポイントが計算された後、少数点以下切り捨てが行なわれ、その後商品個数が掛けられます。
+ このフラグを有効にすると、商品ごとに付与ポイントが計算された後、商品個数が掛けられ、その後に少数点以下切り捨てが行なわれるようになります。
+ デフォルト値は false です。
starts_at:
type: string
format: date-time
@@ -7404,6 +7908,17 @@ paths:
description: |-
キャンペーンを適用する店舗IDを指定します (複数指定)。
指定しなかった場合は全店舗が対象になります。
+ blacklisted_shop_ids:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ title: 'キャンペーン適用対象外となる店舗IDのリスト(ブラックリスト方式)'
+ description: |-
+ キャンペーンの適用対象外となる店舗IDをブラックリスト方式で指定します (複数指定可)。
+ このパラメータが指定されている場合、blacklisted_shop_idsに含まれていない店舗全てがキャンペーンの適用対象になります。
+ blacklisted_shop_idsとapplicable_shop_idsは同時には指定できません。ホワイトリスト方式を使うときはapplicable_shop_idsを指定してください。
minimum_number_of_products:
type: integer
minimum: 1
@@ -7789,6 +8304,50 @@ paths:
'503':
$ref: '#/components/responses/UserStatsOperationServiceUnavailable'
+ /user-stats/terminate:
+ post:
+ tags:
+ - Transaction
+ summary: 'RequestUserStatsのタスクを強制終了する'
+ description: |-
+ RequestUserStatsによるファイル生成のタスクを強制終了するためのAPIです。
+ RequestUserStatsのレスポンス中の `operation_id` をキーにして強制終了リクエストを送ります。
+ 既に集計タスクが終了している場合は何も行いません。
+ 発行体に対して結果通知用のWebhook URLが設定されている場合、強制終了成功時には以下のような内容のPOSTリクエストが送られます。
+
+ - task: "process_user_stats_operation"
+ - operation_id: 強制終了対象のタスクID
+ - status: "terminated"
+ x-pokepay-operator-name: "TerminateUserStats"
+ x-pokepay-allow-server-side: true
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ required: ["operation_id"]
+ properties:
+ operation_id:
+ type: string
+ format: uuid
+ title: '集計タスクID'
+ description: |-
+ 強制終了対象の集計タスクIDです。
+ 必須パラメータであり、指定されたタスクIDが存在しない場合は `user_stats_operation_not_found`エラー(422)が返ります。
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserStatsOperation'
+ '400':
+ $ref: '#/components/responses/InvalidParameters'
+ '403':
+ $ref: '#/components/responses/UnpermittedAdminUser'
+ '422':
+ $ref: '#/components/responses/UnprocessableEntity'
+
/webhooks:
post:
x-pokepay-operator-name: "CreateWebhook"
@@ -8167,6 +8726,46 @@ paths:
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
+ delete:
+ x-pokepay-operator-name: "DeleteBank"
+ x-pokepay-allow-server-side: true
+ tags:
+ - BankPay
+ summary: 銀行口座の削除
+ description: 銀行口座を削除します
+ parameters:
+ - in: path
+ name: user_device_id
+ required: true
+ schema:
+ type: string
+ format: uuid
+ title: "デバイスID"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ required: [bank_id]
+ properties:
+ bank_id:
+ type: string
+ format: uuid
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/BankDeleted'
+ '400':
+ $ref: '#/components/responses/InvalidParameters'
+ '403':
+ $ref: '#/components/responses/UnpermittedAdminUser'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '422':
+ $ref: '#/components/responses/UnprocessableEntity'
/user-devices/{user_device_id}/banks/topup:
post:
@@ -8203,6 +8802,10 @@ paths:
type: string
format: uuid
title: '銀行ID'
+ receiver_user_id:
+ type: string
+ format: uuid
+ title: '受け取りユーザーID (デフォルトは自身)'
request_id:
type: string
format: uuid
@@ -8552,3 +9155,36 @@ paths:
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
+
+ /seven-bank-atm-sessions/{qr_info}:
+ get:
+ x-pokepay-operator-name: "GetSevenBankATMSession"
+ x-pokepay-allow-server-side: true
+ tags:
+ - SevenBankATMSession
+ summary: セブン銀行ATMセッションの取得
+ description: セブン銀行ATMセッションを取得します
+ parameters:
+ - in: path
+ name: qr_info
+ required: true
+ schema:
+ type: string
+ title: 'QRコードの情報'
+ description: |-
+ 取得するセブン銀行ATMチャージのQRコードの情報です。
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SevenBankATMSession'
+ '400':
+ $ref: '#/components/responses/InvalidParameters'
+ '403':
+ $ref: '#/components/responses/UnpermittedAdminUser'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '422':
+ $ref: '#/components/responses/UnprocessableEntity'
diff --git a/src/PokepayPartnerCsharpSdk.Test/TestActivateUserDevice.cs b/src/PokepayPartnerCsharpSdk.Test/TestActivateUserDevice.cs
index 8f66bde..6987ece 100644
--- a/src/PokepayPartnerCsharpSdk.Test/TestActivateUserDevice.cs
+++ b/src/PokepayPartnerCsharpSdk.Test/TestActivateUserDevice.cs
@@ -25,7 +25,7 @@ public async Task ActivateUserDevice0()
{
try {
Request.ActivateUserDevice request = new Request.ActivateUserDevice(
- "70a2385f-fc45-4f42-a969-9bdc1f34dacf"
+ "fe44ae73-fc89-4b5b-9bf3-11ba6b9651e9"
);
Response.UserDevice response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
diff --git a/src/PokepayPartnerCsharpSdk.Test/TestBulkCreateTransaction.cs b/src/PokepayPartnerCsharpSdk.Test/TestBulkCreateTransaction.cs
index 09144a8..ab03a09 100644
--- a/src/PokepayPartnerCsharpSdk.Test/TestBulkCreateTransaction.cs
+++ b/src/PokepayPartnerCsharpSdk.Test/TestBulkCreateTransaction.cs
@@ -25,9 +25,9 @@ public async Task BulkCreateTransaction0()
{
try {
Request.BulkCreateTransaction request = new Request.BulkCreateTransaction(
- "SJ9o4hVc0u6tzaZ3sbYKC",
- "bmAlkaNJiO",
- "vuRswwQSmiJco3KwhjqpMqyENnnotJKNM2Dv"
+ "fQBXbwG5FfObbKUS2w",
+ "JUS6TcMNw",
+ "fudd0OcDN26kEZNJtfvLzUTMMVxGv3INa5f5"
);
Response.BulkTransaction response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -42,11 +42,11 @@ public async Task BulkCreateTransaction1()
{
try {
Request.BulkCreateTransaction request = new Request.BulkCreateTransaction(
- "SJ9o4hVc0u6tzaZ3sbYKC",
- "bmAlkaNJiO",
- "vuRswwQSmiJco3KwhjqpMqyENnnotJKNM2Dv"
+ "fQBXbwG5FfObbKUS2w",
+ "JUS6TcMNw",
+ "fudd0OcDN26kEZNJtfvLzUTMMVxGv3INa5f5"
) {
- PrivateMoneyId = "703c377c-3ed1-428b-a827-9c18a076be05",
+ PrivateMoneyId = "63a8a7b4-39bb-4259-89b1-e2ab2db53250",
};
Response.BulkTransaction response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -61,12 +61,12 @@ public async Task BulkCreateTransaction2()
{
try {
Request.BulkCreateTransaction request = new Request.BulkCreateTransaction(
- "SJ9o4hVc0u6tzaZ3sbYKC",
- "bmAlkaNJiO",
- "vuRswwQSmiJco3KwhjqpMqyENnnotJKNM2Dv"
+ "fQBXbwG5FfObbKUS2w",
+ "JUS6TcMNw",
+ "fudd0OcDN26kEZNJtfvLzUTMMVxGv3INa5f5"
) {
- Description = "u06FE8juzeNINZktFZU0JpHpSrpNbF8O3WzYFSGY9bWV5jbNBEz14f9BIpTXI2luGWaGy1CoCYoYmaLr1BLY",
- PrivateMoneyId = "db01c22d-6011-4ce4-a38d-62e775c56e73",
+ Description = "h3OUBAsVaG6TxK3slQw2Vv1qEnKcaw1pz9vX015UD9qqTdXnkHVwtuWRPDBo28vDsYr2EOFyjAKpCpIzZXmsoGSwaJTi7OUK0vKQ13gfO1QSAIUcA7AjSSLuHYzu",
+ PrivateMoneyId = "74593e12-ee02-4102-b252-fbbc1377d4e1",
};
Response.BulkTransaction response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
diff --git a/src/PokepayPartnerCsharpSdk.Test/TestCancelCashtray.cs b/src/PokepayPartnerCsharpSdk.Test/TestCancelCashtray.cs
index 84d750c..f287c07 100644
--- a/src/PokepayPartnerCsharpSdk.Test/TestCancelCashtray.cs
+++ b/src/PokepayPartnerCsharpSdk.Test/TestCancelCashtray.cs
@@ -25,7 +25,7 @@ public async Task CancelCashtray0()
{
try {
Request.CancelCashtray request = new Request.CancelCashtray(
- "920f1f56-382f-4ffb-b1cb-0ded173cc53f"
+ "a1e90ffa-b03a-4e8f-bc92-8264659cbd0d"
);
Response.Cashtray response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
diff --git a/src/PokepayPartnerCsharpSdk.Test/TestCreateBank.cs b/src/PokepayPartnerCsharpSdk.Test/TestCreateBank.cs
index 5f4fa99..0894eb1 100644
--- a/src/PokepayPartnerCsharpSdk.Test/TestCreateBank.cs
+++ b/src/PokepayPartnerCsharpSdk.Test/TestCreateBank.cs
@@ -25,10 +25,10 @@ public async Task CreateBank0()
{
try {
Request.CreateBank request = new Request.CreateBank(
- "097df35b-8508-4795-88d4-22af0a58a115",
- "6c048fe6-2757-43c8-b116-a8f021e802f1",
- "lIhFKkOnPRe3g3OqYMD6Y7flopJpL06wROQZ33dSb51CrQZVorM80jAnbL9pF2AijYf8ydTws4HIQ4AniWPzD9CM0oL6ak44VafBlkQEtaE8xbTpd0",
- "PiIwS5"
+ "bc3236d1-364e-4d73-b566-8fe156af8d1c",
+ "6bbb59d3-c97d-4a0e-882d-72995dc59778",
+ "VVAwQqeQUNQCi45yyQTl9wTWmjZWPblWstjkwC6ll5fjzCHapR04ADVEFmUehgiDu605XKZkJCbVsNuqqVdUDyaVdHFVHz0uIFKJoDWeoZQYdDyUkA8HMjkxTYcusA1RKieQ1ldipC3qoQ4XwLIDsqZ3ZF38hv2ikQGfIfeAIGZfO7OrSr8",
+ "B2Q"
);
Response.BankRegisteringInfo response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -43,12 +43,12 @@ public async Task CreateBank1()
{
try {
Request.CreateBank request = new Request.CreateBank(
- "097df35b-8508-4795-88d4-22af0a58a115",
- "6c048fe6-2757-43c8-b116-a8f021e802f1",
- "lIhFKkOnPRe3g3OqYMD6Y7flopJpL06wROQZ33dSb51CrQZVorM80jAnbL9pF2AijYf8ydTws4HIQ4AniWPzD9CM0oL6ak44VafBlkQEtaE8xbTpd0",
- "PiIwS5"
+ "bc3236d1-364e-4d73-b566-8fe156af8d1c",
+ "6bbb59d3-c97d-4a0e-882d-72995dc59778",
+ "VVAwQqeQUNQCi45yyQTl9wTWmjZWPblWstjkwC6ll5fjzCHapR04ADVEFmUehgiDu605XKZkJCbVsNuqqVdUDyaVdHFVHz0uIFKJoDWeoZQYdDyUkA8HMjkxTYcusA1RKieQ1ldipC3qoQ4XwLIDsqZ3ZF38hv2ikQGfIfeAIGZfO7OrSr8",
+ "B2Q"
) {
- Birthdate = "4q66i2nX",
+ Birthdate = "PQ9Y2Rps",
};
Response.BankRegisteringInfo response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -63,13 +63,13 @@ public async Task CreateBank2()
{
try {
Request.CreateBank request = new Request.CreateBank(
- "097df35b-8508-4795-88d4-22af0a58a115",
- "6c048fe6-2757-43c8-b116-a8f021e802f1",
- "lIhFKkOnPRe3g3OqYMD6Y7flopJpL06wROQZ33dSb51CrQZVorM80jAnbL9pF2AijYf8ydTws4HIQ4AniWPzD9CM0oL6ak44VafBlkQEtaE8xbTpd0",
- "PiIwS5"
+ "bc3236d1-364e-4d73-b566-8fe156af8d1c",
+ "6bbb59d3-c97d-4a0e-882d-72995dc59778",
+ "VVAwQqeQUNQCi45yyQTl9wTWmjZWPblWstjkwC6ll5fjzCHapR04ADVEFmUehgiDu605XKZkJCbVsNuqqVdUDyaVdHFVHz0uIFKJoDWeoZQYdDyUkA8HMjkxTYcusA1RKieQ1ldipC3qoQ4XwLIDsqZ3ZF38hv2ikQGfIfeAIGZfO7OrSr8",
+ "B2Q"
) {
- Email = "WkvfusE3ma@gRZX.com",
- Birthdate = "vYQ",
+ Email = "j0heI1pcWB@x1T3.com",
+ Birthdate = "cQ",
};
Response.BankRegisteringInfo response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
diff --git a/src/PokepayPartnerCsharpSdk.Test/TestCreateBankTopupTransaction.cs b/src/PokepayPartnerCsharpSdk.Test/TestCreateBankTopupTransaction.cs
index 41a210a..0b266fd 100644
--- a/src/PokepayPartnerCsharpSdk.Test/TestCreateBankTopupTransaction.cs
+++ b/src/PokepayPartnerCsharpSdk.Test/TestCreateBankTopupTransaction.cs
@@ -25,11 +25,11 @@ public async Task CreateBankTopupTransaction0()
{
try {
Request.CreateBankTopupTransaction request = new Request.CreateBankTopupTransaction(
- "d5ad334e-9489-4b31-b1a5-bde4851ff77f",
- "02e1a069-d9a4-4c54-8950-1f19d585254d",
- 9384,
- "2b325e79-2bfc-47a3-a61c-658a3c1808ec",
- "87b8caaf-ed24-47d0-b738-fbd858d3214a"
+ "03874ca0-ce1a-4d74-9c66-f36298d257ab",
+ "25d6f295-1f7c-4ad0-8399-4f4044d29f41",
+ 3541,
+ "c79a218e-3a62-4766-9145-2754bb8e09df",
+ "6b985367-ca5f-459d-9d4d-4a9d3d23773c"
);
Response.TransactionDetail response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -39,5 +39,26 @@ public async Task CreateBankTopupTransaction0()
}
}
+ [Test]
+ public async Task CreateBankTopupTransaction1()
+ {
+ try {
+ Request.CreateBankTopupTransaction request = new Request.CreateBankTopupTransaction(
+ "03874ca0-ce1a-4d74-9c66-f36298d257ab",
+ "25d6f295-1f7c-4ad0-8399-4f4044d29f41",
+ 3541,
+ "c79a218e-3a62-4766-9145-2754bb8e09df",
+ "6b985367-ca5f-459d-9d4d-4a9d3d23773c"
+ ) {
+ ReceiverUserId = "c9416c5b-4f83-4805-a48c-2885ea5f9338",
+ };
+ Response.TransactionDetail response = await request.Send(client);
+ Assert.NotNull(response, "Shouldn't be null at least");
+ } catch (HttpRequestException e) {
+ Assert.AreNotEqual((int) e.Data["StatusCode"], (int) HttpStatusCode.BadRequest, "Shouldn't be BadRequest");
+ Assert.True((int) e.Data["StatusCode"] >= 300, "Should be larger than 300");
+ }
+ }
+
}
}
diff --git a/src/PokepayPartnerCsharpSdk.Test/TestCreateBill.cs b/src/PokepayPartnerCsharpSdk.Test/TestCreateBill.cs
index b46152a..68f7587 100644
--- a/src/PokepayPartnerCsharpSdk.Test/TestCreateBill.cs
+++ b/src/PokepayPartnerCsharpSdk.Test/TestCreateBill.cs
@@ -25,8 +25,8 @@ public async Task CreateBill0()
{
try {
Request.CreateBill request = new Request.CreateBill(
- "9a5387ae-5073-455d-b2b6-f5c50f9210c4",
- "f41d19fb-7d26-4d80-abfa-9dc49d937f4c"
+ "c404cacf-f9c6-4b71-8977-32134cce0494",
+ "887fe62c-62c0-4078-b276-e6f80b19b3eb"
);
Response.Bill response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -41,10 +41,10 @@ public async Task CreateBill1()
{
try {
Request.CreateBill request = new Request.CreateBill(
- "9a5387ae-5073-455d-b2b6-f5c50f9210c4",
- "f41d19fb-7d26-4d80-abfa-9dc49d937f4c"
+ "c404cacf-f9c6-4b71-8977-32134cce0494",
+ "887fe62c-62c0-4078-b276-e6f80b19b3eb"
) {
- Description = "nAr7NHvMDZLOk3Kn6N9IKA2DQ0UDl0RkGXqQRpkGArTGUPugetKJLdESdgB4DMlPhuAgx6J23S5a4KJH2dJnXOeAy8xYgmSSWd6nFdHza9f0TF30iljDxgSpyfoekUtY",
+ Description = "wVYBDQiRCyVTR3czNdwQ9LziqjK5MdQ1lZMyARXVB9A32ESqVUKE1GN9JqLEvyRdA5j20ws4Z1pnjZ8xWKeN3WKGyHXCKDfS0S9olxtCG8sS34enFyHhIbteE1tQOMttUhD0OiwEvovxL7L6kZ3KaNub1zwaCdHgj",
};
Response.Bill response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -59,11 +59,11 @@ public async Task CreateBill2()
{
try {
Request.CreateBill request = new Request.CreateBill(
- "9a5387ae-5073-455d-b2b6-f5c50f9210c4",
- "f41d19fb-7d26-4d80-abfa-9dc49d937f4c"
+ "c404cacf-f9c6-4b71-8977-32134cce0494",
+ "887fe62c-62c0-4078-b276-e6f80b19b3eb"
) {
- Amount = 1581.0,
- Description = "6dyRqDXbojqilSXXfgL13rI1kMYSkzLYWcqyBEPqq6jXoMPoI5dYhtAEAC8MN1MIRbysguh0xXqdkQK8VG",
+ Amount = 3754.0,
+ Description = "k3dmsSURUNaSg6OcHEmOeQFO3Ox8qDzSQ0YVNC6SfrLsEgbwDrafzykU4qQWw",
};
Response.Bill response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
diff --git a/src/PokepayPartnerCsharpSdk.Test/TestCreateCampaign.cs b/src/PokepayPartnerCsharpSdk.Test/TestCreateCampaign.cs
index e5d06a7..c98f55c 100644
--- a/src/PokepayPartnerCsharpSdk.Test/TestCreateCampaign.cs
+++ b/src/PokepayPartnerCsharpSdk.Test/TestCreateCampaign.cs
@@ -25,13 +25,15 @@ public async Task CreateCampaign0()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
- );
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
+ ) {
+ ApplicableShopIds = new string[]{"29dda31b-b43f-4939-83cd-5730eea9c2af", "8c61658d-d0de-493c-886f-f5cc155a950c", "f88eda2f-f491-4613-9f36-f461f57277bf", "a3fdb404-ea20-44bb-beeb-54b4480d0db4", "05fc9ba6-23d6-4fbd-9d61-6d06d5ed2fe6"},
+ };
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
} catch (HttpRequestException e) {
@@ -45,14 +47,15 @@ public async Task CreateCampaign1()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- BudgetCapsAmount = 2106640707,
+ ApplicableShopIds = new string[]{"7317227d-aa42-4300-ac6b-f05188d36c45", "63d1f095-52bd-41f4-a1c5-6087b3248d0e", "45f542b8-c4f8-412e-8f62-4f19e93ceb54", "dcd5eb70-bbe4-473f-8530-c925fccedad0", "32bd9f29-8fe9-4849-a42f-b5de593018de"},
+ BearPointShopId = "028f3a0f-900c-4877-9d9e-649b8b392453",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -67,15 +70,16 @@ public async Task CreateCampaign2()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1194054230,
+ ApplicableShopIds = new string[]{"450fcb3f-f834-47a1-97f1-a23611042d13", "4c53e1bc-2e36-4da9-a93f-871423cc2a0f", "69593e29-cb05-4c32-805c-ffeeade8d65d", "8944cf58-62d7-4dbf-bfeb-ef7cb219baf6", "66d24ce6-33a1-4a16-b580-cd73cec38da9", "b36f5521-4545-4bb3-8613-d985f663f4ed"},
+ Description = "agRZXBvYQN11diTIPMylP78XJI2fkoYuaeWPZ92K6Zt1zTkBm5QsUJIx79pUjuQLW3JQAlc0mxfIBEGWMOeqgVzvGmf46VZC1gROo7yDwwPoswLPrFl08abqydMndg7MmFs",
+ BearPointShopId = "f1a22544-d9ac-4a32-979a-83ad45f163e2",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -90,16 +94,17 @@ public async Task CreateCampaign3()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 169004663,
+ ApplicableShopIds = new string[]{"7939dda5-f381-499d-b05a-fd3f8a67b088", "05722098-5966-4839-ab4b-fd0f9b7054ed", "52ff85fa-a9f8-4e16-b2e3-ea533703e2f6", "35841963-fc12-4e73-a766-a070c2e5c332"},
+ Status = "enabled",
+ Description = "NPWqo6XqlqrR9lgptmz4nyVSUDS2rGPI8RxpE3teEPiaYEeN8ncoL5boSBHerEtGhFgJdxHlskgg6LM7DHhWIQ2aljg7pW5tLDSL3EPYXvMXdIXxGA8eOtdDg4emZxxvv3UzyZmkPPeL3QSeHsz",
+ BearPointShopId = "ef7a2d4b-ce61-4b9c-acb8-5455a314714a",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -114,17 +119,18 @@ public async Task CreateCampaign4()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- DestPrivateMoneyId = "15adc634-3e15-4f07-862c-71388aa40edf",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1717432031,
+ ApplicableShopIds = new string[]{"6704b400-a16d-4e5f-b6ea-9b89404b4554", "d44effc6-43bb-4755-b077-6ad72abb12fc", "ace5ccc1-8dcd-4505-bff5-66a86e5b1db8", "8be34139-750a-496d-84b0-acbfd026f388", "bbeeaea8-de54-4af0-8abd-c6f849e70e5c", "71a724ae-3c25-43d7-a203-26e3c45d7efa", "e01e42a1-f5d1-4c80-9593-9d79f5dd6c98", "cb700fd7-9461-4256-a7c2-980bc083f061"},
+ PointExpiresAt = "2023-02-16T18:18:56.000000Z",
+ Status = "enabled",
+ Description = "Wptjgf0FiZZDEEO2PZA9bioQMPG1E81jCARXbk7MR17C6RF6LyMxBAxNrASDj9VGr6rQWfEP7s2f7f5rT4gnJZ2Cz81XNoucyBbEpxFX7PDggrznNWBV0p9BBTTp6AGpMMO3btHYGiB4Qalu6chDV2Pcj2ctvmZzuG53qZWTYzG",
+ BearPointShopId = "721dbb21-b113-4eef-a015-5b9836a6f82a",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -139,18 +145,19 @@ public async Task CreateCampaign5()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- MaxTotalPointAmount = 4100,
- DestPrivateMoneyId = "837e0a0b-3bff-42ca-9d22-59372920f655",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1751213744,
+ ApplicableShopIds = new string[]{"526c1175-ed40-4075-82dd-da586c6bb3b6", "d47621a1-cdcc-41fd-9cd5-4ad576f04b5f", "9abc1f8c-01a0-4cd5-82c5-f8ce1e9bd1fa", "b844e8bf-fdb9-4d52-a631-380a5aef2538"},
+ PointExpiresInDays = 8349,
+ PointExpiresAt = "2023-03-25T06:39:11.000000Z",
+ Status = "disabled",
+ Description = "jTA",
+ BearPointShopId = "f2b3f3bb-fbd2-4f78-a3cb-d75fe35ee889",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -165,19 +172,20 @@ public async Task CreateCampaign6()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- MaxPointAmount = 3322,
- MaxTotalPointAmount = 4499,
- DestPrivateMoneyId = "2f8ee6bc-4e0f-4ddb-849e-b33b51788907",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 270788988,
+ ApplicableShopIds = new string[]{"c943f0e3-1d24-42e2-8809-7c20bbd74a31", "932f18ee-8379-4fcc-8cd6-fd88f39230c9", "160693ad-d6a7-403b-a6a4-0a401901d837", "0e6e46d0-dfca-420f-9ab4-644004a7ab50", "c064f2cb-38db-45c9-9997-f1d251891cc1", "8365136c-a331-485d-9543-7a75dff90ddc", "9ccdf993-e5d1-417b-b9e3-ddd70105ab67", "177cc918-8646-4f6c-9b51-dcf27275bb94"},
+ IsExclusive = true,
+ PointExpiresInDays = 1992,
+ PointExpiresAt = "2021-11-01T20:38:51.000000Z",
+ Status = "enabled",
+ Description = "qVd3CIlE3dO8Hdi7PJayBT5IgAK5b9hyZhcZh8MuSlVRKgCSpIL13YYuGN17rfT9nOtCiuSxp7i1rcacR4EWmJRYE0vgLGn2OdxgxwF29eViuwKtjsRjzvb8XUneGNN0gcbjHE0ykOW2yVlH",
+ BearPointShopId = "d4141dee-d7af-4de4-884d-601b7488f382",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -192,20 +200,21 @@ public async Task CreateCampaign7()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- ExistInEachProductGroups = false,
- MaxPointAmount = 5190,
- MaxTotalPointAmount = 2679,
- DestPrivateMoneyId = "fcbb40dc-fb27-4329-b7e2-c1632b871690",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1923542005,
+ ApplicableShopIds = new string[]{"60cb620b-9ebf-428b-a01b-e34112a2d964", "7864fc7d-f457-4f0a-99df-e480cce1e83c", "674cf45e-68b9-4512-8890-5beadfc6f007", "9c0a304e-4108-4cc1-accf-6b463b441ed7", "036c135f-2d23-4c44-b0e6-5f320ef05c22", "9f271a38-2f23-4006-8e0c-92a61c68f293", "a0d1e2f2-1a6c-47f7-8c8e-96bba3f614a0", "7e1bc6e2-ae39-451a-ba8c-be2b2eb117d9"},
+ Subject = "all",
+ IsExclusive = true,
+ PointExpiresInDays = 7726,
+ PointExpiresAt = "2021-01-22T09:10:08.000000Z",
+ Status = "enabled",
+ Description = "mMET9MPbipC8utokXPq016coqfiAUWXxFRzN5EfouqVIJLmWFeGJqYbyf9xqeV9Lg6T4ooRxK5KRr3h8egFMYUCN7QJ0QWlqwtDL88aLfgCd3mseL",
+ BearPointShopId = "50b56751-f3fd-4d28-822c-d12473b9a058",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -220,21 +229,22 @@ public async Task CreateCampaign8()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- MinimumNumberForCombinationPurchase = 9136,
- ExistInEachProductGroups = false,
- MaxPointAmount = 6254,
- MaxTotalPointAmount = 6602,
- DestPrivateMoneyId = "b4264571-cfe4-4ba7-98ed-69c0cc3e3976",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 76742688,
+ ApplicableShopIds = new string[]{"d748e101-7a1e-46d5-a985-4bbfa40aed59", "19392e08-56f0-4292-8d5e-e595a37ce39f", "0d6e24d4-0d5b-4680-b6a5-de4e02376599", "10eb3411-5a06-47e7-a6a0-c3e11427f64b", "4808c611-8e7c-4ebf-94b3-80dccedee150", "f1b7616f-976f-4598-b7f0-6d4bced650c1", "866495f8-3725-4e33-8f1f-f56b953adf0f", "f6aa8c24-c966-4d87-8133-13b1fc03b5f7", "effa4c58-a964-4ab0-b49a-d7df9b291ca7", "54506e92-dba7-4a53-9931-d18794111321"},
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}},
+ Subject = "all",
+ IsExclusive = true,
+ PointExpiresInDays = 9534,
+ PointExpiresAt = "2024-12-14T16:22:19.000000Z",
+ Status = "enabled",
+ Description = "GOF1kRrye61uzmBIXdnENFs3jBlwZrD72DB37CRt8PxiPIwClGZ1KOGgE2sj7Hu6WK5M7npguch6s2J670P8hn4WhIeMSn521mnmeh5QEBdCZJtrUa6Fgp7ym0hYqDUAWMYxWfGNC0wV3",
+ BearPointShopId = "350e8986-7f06-47a0-a18d-6d8890081d42",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -249,22 +259,23 @@ public async Task CreateCampaign9()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- MinimumNumberOfAmount = 725,
- MinimumNumberForCombinationPurchase = 5949,
- ExistInEachProductGroups = true,
- MaxPointAmount = 2617,
- MaxTotalPointAmount = 2463,
- DestPrivateMoneyId = "f669e4d2-c042-48fa-a399-9d1ab8d5425f",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 2053889393,
+ ApplicableShopIds = new string[]{"71155acf-7d58-4731-89a8-2820ce88dc67", "32c3ce2d-b3fd-4838-a8bf-14d212d6884f", "47e0de25-39db-4a98-8642-e033140389a5", "9a79642c-a3cd-41de-81aa-8b6c4fcef8ea", "25884148-2147-4658-b289-b1f03bdf1d0a", "8f59bfd6-b09d-4582-acd3-56ebccabd753", "2b65a0e4-c02d-490c-9189-80af9d6f1a42"},
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}},
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}},
+ Subject = "all",
+ IsExclusive = true,
+ PointExpiresInDays = 1234,
+ PointExpiresAt = "2024-05-30T03:38:02.000000Z",
+ Status = "enabled",
+ Description = "XHWCk88yAdkNbUUlXp2sT5T809AbvtJaUy0K5oRI2Afv57nsS8pT7iwNl9CKN5yCsDMuuaWg6vjoZFJU5quwxFBXnJ5Eq6GcNPCEVPq46GdIPJm8ac",
+ BearPointShopId = "d411de9d-5c28-4459-aae2-519dbc35ca97",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -279,23 +290,24 @@ public async Task CreateCampaign10()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- MinimumNumberOfProducts = 9951,
- MinimumNumberOfAmount = 1768,
- MinimumNumberForCombinationPurchase = 1963,
- ExistInEachProductGroups = false,
- MaxPointAmount = 8579,
- MaxTotalPointAmount = 2970,
- DestPrivateMoneyId = "385cb24b-845a-4510-976f-21551532afab",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1356945300,
+ ApplicableShopIds = new string[]{"bec20b4b-5a33-4cc9-8138-5cca6836ba82", "dc3ab37d-baac-4826-8059-bad5851924e0", "166ea7c9-32a7-46cc-9ef7-e3c493cd0592", "f494a059-9420-4a08-8811-09d7b38f9671", "1ae547bc-2d39-4d07-a814-28b3c6c0f2be"},
+ BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}},
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}},
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}},
+ Subject = "all",
+ IsExclusive = true,
+ PointExpiresInDays = 1785,
+ PointExpiresAt = "2024-07-20T19:00:30.000000Z",
+ Status = "disabled",
+ Description = "OJ9lz7HMs7r8Mwpfor2g0yfZY1uTlDfXz0uDeov2GaxLjZM7ftEliKPQLWJArPq3tph1c8gKwadNnw5eCqfZdksVLOzbmWJa8YkV10V05hf8WtQGHpv3xPQzPNZMa3cTmTslTDHzq00PkzT3rjRscSaTDEUxwAJXNLOLD",
+ BearPointShopId = "4142d955-316a-4cc1-a7c5-30209692b555",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -310,24 +322,25 @@ public async Task CreateCampaign11()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- ApplicableShopIds = new string[]{"5129d44f-0152-4a3a-8cb9-abffe94f0714", "70b32f38-20a3-46ad-919f-1e3efd957d44", "26219476-e939-405b-940e-5dd7316295b3", "ed4fd8df-5c04-462f-b4ef-92979752f56e", "ecab59f2-f216-4bf5-b5c4-883d7c71ac01", "59bd5f2e-aef8-4e78-9b52-b7a78d10f78d"},
- MinimumNumberOfProducts = 7576,
- MinimumNumberOfAmount = 414,
- MinimumNumberForCombinationPurchase = 5411,
- ExistInEachProductGroups = true,
- MaxPointAmount = 7730,
- MaxTotalPointAmount = 4655,
- DestPrivateMoneyId = "ff86566b-9d96-4f22-bd08-09e97547aa52",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 12818869,
+ ApplicableShopIds = new string[]{"24b3a15c-5bfc-4acb-95a0-ba938443f8d3", "64c8420d-e647-48ff-ba62-3b10aaa61011", "87e3fdd3-3452-4c9d-aded-739ff76d79fc", "92e28b83-82e4-4581-a3e0-70e145e769a4", "5220ff36-f0b6-4629-88bc-ad7fd4d1d10d", "230302f8-e695-42a6-9663-c6b4bf7af291", "02ffe477-c340-422d-a630-885682fe3699", "23e49ef3-ae63-402f-a9da-0e9cce204771", "6c6db698-aa56-4e0f-9a67-5cb9256f5cc3", "442c10a3-ead9-4c7f-9b2a-938dbfe00434"},
+ ApplicableDaysOfWeek = new int[]{2, 3, 0, 4, 5, 1, 1, 5, 1, 1},
+ BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}},
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}},
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}},
+ Subject = "money",
+ IsExclusive = false,
+ PointExpiresInDays = 9504,
+ PointExpiresAt = "2024-12-01T16:29:25.000000Z",
+ Status = "disabled",
+ Description = "R0RPX1REGDLSjexe42N6h2JPSKXOz8JwoXWD3OcRqlTHYwOestfQFumGQVfUsw4hfYXr8Tws7k48pGfLa44NJMCeJ8jlsCf1ZGfe6gS6x1DqMOxCGU3f6AMPJnByO8IAY8ZIAKOHAMaB7ZxbhLpAG3vIRMVqbJVgHdPhvPKwzwzrbVYcpu84LTKQxDT",
+ BearPointShopId = "ff8cb07a-e37d-4ecd-9c6e-7c4d8ab47a8b",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -342,25 +355,26 @@ public async Task CreateCampaign12()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
- ApplicableShopIds = new string[]{"675c04d4-00d3-4304-94b4-759f580cb13f", "94d14830-0631-41fb-935e-4280dca915fa"},
- MinimumNumberOfProducts = 8666,
- MinimumNumberOfAmount = 3771,
- MinimumNumberForCombinationPurchase = 4922,
- ExistInEachProductGroups = false,
- MaxPointAmount = 336,
- MaxTotalPointAmount = 694,
- DestPrivateMoneyId = "ca3f3f3b-3821-40e2-adf8-c5bd24c1648b",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1339082278,
+ ApplicableShopIds = new string[]{"2312bf52-aac4-42f0-8993-450b2a098cb6", "b8d2aa20-0b1e-459b-953e-224498e0005a", "40c59251-7390-4754-aad0-e8e6b17a7ec9", "2732d161-38ea-4025-a3c0-67d397c58799", "ce6e3dc2-71ed-4120-9557-c509a839dcfa", "66ed7f46-ce2e-4f26-a4bd-a402ee16998d", "8c40bde2-0dd6-4be6-a1fe-e1cc82f12735", "c928f0ae-4bbd-49ae-8c54-4b0b9f91bab2"},
+ ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
+ ApplicableDaysOfWeek = new int[]{6, 0, 2, 3},
+ BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}},
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}},
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}},
+ Subject = "money",
+ IsExclusive = false,
+ PointExpiresInDays = 4755,
+ PointExpiresAt = "2024-11-06T11:04:30.000000Z",
+ Status = "disabled",
+ Description = "A5QzauCKeqrCHLOb6c1NzcpMx2l8O1vhN74ziDPGC2ST6zTd6xVdSlQkj4Z4gR5YjMfLJAECo2gNDDCrV3PxozvlpngWpA6xbZMfc0uwppINu3aeeMh7M",
+ BearPointShopId = "b821bbbd-5877-4d71-b13f-febaab2c88a6",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -375,26 +389,27 @@ public async Task CreateCampaign13()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- ApplicableDaysOfWeek = new int[]{1, 4, 5, 3, 4, 0, 4},
- ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
- ApplicableShopIds = new string[]{"8e418c25-5a94-4c92-885b-1c2b1e7339c4", "e36d7965-c721-4549-b2e7-cd33d973ea08", "dcb12cb8-2a3b-4f14-a955-307b2ca06944", "33fe05dc-eb69-40f8-a1de-7f52d65cf7fb", "4e375d82-c05e-4ed1-a09f-6d1f9e88ef95", "d5ed1593-36a1-414f-9960-c3f3028ece1f", "7bcee882-74cf-42f8-8a79-5c0ebe431d28", "a9dba53a-8a69-4c75-8a91-e3a15ce9d506", "2a2ca774-8733-43de-84b0-b36f81ec445f"},
- MinimumNumberOfProducts = 83,
- MinimumNumberOfAmount = 6057,
- MinimumNumberForCombinationPurchase = 1524,
- ExistInEachProductGroups = false,
- MaxPointAmount = 1108,
- MaxTotalPointAmount = 205,
- DestPrivateMoneyId = "ce9c2a23-8611-4b5f-a0e9-9d2620d945a8",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1110367029,
+ ApplicableShopIds = new string[]{"5e3eea03-b0df-460b-85e0-4d86aff129af"},
+ MinimumNumberOfProducts = 5957,
+ ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
+ ApplicableDaysOfWeek = new int[]{1},
+ BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}},
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}},
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}},
+ Subject = "money",
+ IsExclusive = false,
+ PointExpiresInDays = 5769,
+ PointExpiresAt = "2023-01-30T18:25:11.000000Z",
+ Status = "enabled",
+ Description = "6TParuulg11gUrgWq51AuUounyHv57rDbvmuL7BqYd28Ylq4PTRllx603bU9utxlgE1LKaCgZViz",
+ BearPointShopId = "c29b50a4-2201-410f-996e-0b5c85ed83f6",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -409,27 +424,28 @@ public async Task CreateCampaign14()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}},
- ApplicableDaysOfWeek = new int[]{4, 1, 6, 2, 6, 2, 3},
- ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
- ApplicableShopIds = new string[]{"79e8a56c-c102-4cfd-8d84-85a9dc1fcc47", "ffd9c668-871b-4acf-8037-b0cdc78f776a", "57527f0a-d005-4fef-8d9f-45ae768bb684", "cc5754a9-a046-48e9-884c-6ca252efadf4", "0a61a44e-620d-4739-99bb-43f1a5f9db79", "fbc3dfb7-0fa0-418d-92de-2ab5ad53f953", "090a782d-dbe5-4c98-ae7b-b36c936e8fb4"},
- MinimumNumberOfProducts = 5099,
- MinimumNumberOfAmount = 9330,
- MinimumNumberForCombinationPurchase = 6981,
- ExistInEachProductGroups = true,
- MaxPointAmount = 3054,
- MaxTotalPointAmount = 6430,
- DestPrivateMoneyId = "68f75742-ff32-4a67-beab-d3a9432d107a",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 1196444844,
+ ApplicableShopIds = new string[]{"26e0c7fd-66da-4290-b665-55b60657858e", "91ab0154-2e55-4057-9ca3-5bc6002ffedf", "3e425120-5657-4e0f-8824-76a5d7359bf9", "7147ebbe-e4a7-401b-b2e2-96352fd22d56", "bab93b2b-a5f3-4eb5-a750-75755c5b6010", "df28fb9e-01f6-450d-90c8-c0954d239b75", "e310c47b-d95d-4885-8135-9148624ca7d7"},
+ MinimumNumberOfAmount = 3420,
+ MinimumNumberOfProducts = 7713,
+ ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
+ ApplicableDaysOfWeek = new int[]{1, 0},
+ BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}},
+ ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}},
+ AmountBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"subject_more_than_or_equal",1000}, {"subject_less_than",5000}}},
+ Subject = "money",
+ IsExclusive = false,
+ PointExpiresInDays = 1200,
+ PointExpiresAt = "2020-07-25T03:35:11.000000Z",
+ Status = "disabled",
+ Description = "i9wNIa",
+ BearPointShopId = "0f7a155d-a83b-4fca-afdb-69f988de0249",
};
Response.Campaign response = await request.Send(client);
Assert.NotNull(response, "Shouldn't be null at least");
@@ -444,28 +460,29 @@ public async Task CreateCampaign15()
{
try {
Request.CreateCampaign request = new Request.CreateCampaign(
- "fjKkp3QkI11kPUOWIOCC9XRXSkWvgwMdC6YsQVBM615BSLRTB4phpjbt6QHeDKxXdEg3OxGlsZaVSpjoQ6ffYAe6kpXiCTiSBUIe5iqIMOcjyqBKlSFGLuqDn2oMYRFh8cqnV2spFoKb7jYgx3gTJKy6dBb3ykYYVRZ4jdyfDGYQa0QPCC60HT399N8hkxoSQFYDUU0HuG332kYdREQC",
- "fb061e0f-ffb3-48dd-b901-616061cffda2",
- "2022-05-26T07:26:51.000000Z",
- "2023-09-29T11:09:34.000000Z",
- 218,
- "topup"
+ "jAnbL9pF2AijYf8ydTws4HIQ4An",
+ "4bcf0869-a700-4112-9780-a7d006c7411f",
+ "2021-04-27T11:39:38.000000Z",
+ "2020-08-13T06:58:54.000000Z",
+ 529,
+ "external-transaction"
) {
- ProductBasedPointRules = new object[]{new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}, new Dictionary(){{"point_amount",5}, {"point_amount_unit","percent"}, {"product_code","4912345678904"}, {"is_multiply_by_count",true}, {"required_count",2}}},
- BlacklistedProductRules = new object[]{new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}, new Dictionary(){{"product_code","4912345678904"}, {"classification_code","c123"}}},
- ApplicableDaysOfWeek = new int[]{0, 6, 1, 4, 6, 3, 1, 0, 2},
- ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
- ApplicableShopIds = new string[]{"059617f2-4c2c-47d8-8f42-3b2ce6591e1e"},
- MinimumNumberOfProducts = 1631,
- MinimumNumberOfAmount = 4298,
- MinimumNumberForCombinationPurchase = 2698,
- ExistInEachProductGroups = false,
- MaxPointAmount = 1249,
- MaxTotalPointAmount = 4716,
- DestPrivateMoneyId = "79f486cc-f242-4a84-93b5-ad99c15443f6",
- ApplicableAccountMetadata = new Dictionary(){{"key","sex"}, {"value","male"}},
- ApplicableTransactionMetadata = new Dictionary(){{"key","rank"}, {"value","bronze"}},
- BudgetCapsAmount = 176533366,
+ ApplicableShopIds = new string[]{"b3867cf0-bbc1-4c97-a0c4-2012a64f83f3", "9dfadc32-18c0-4d42-b45e-7891cc16a5f9", "6ce7b016-6742-4fb1-87a9-0b1192468b5a"},
+ MinimumNumberForCombinationPurchase = 3604,
+ MinimumNumberOfAmount = 3948,
+ MinimumNumberOfProducts = 2863,
+ ApplicableTimeRanges = new object[]{new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}, new Dictionary(){{"from","12:00"}, {"to","23:59"}}},
+ ApplicableDaysOfWeek = new int[]{4, 2, 1, 2, 0},
+ BlacklistedProductRules = new object[]{new Dictionary