Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

refs/heads/release/1.3.10 #21

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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トークンによる取引作成
Expand All @@ -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):
Expand All @@ -208,6 +210,7 @@ try {
- [UpdateBill](./bill.md#update-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の情報を取得する
Expand Down Expand Up @@ -237,7 +240,6 @@ try {
- [UpdateShop](./shop.md#update-shop): 店舗情報を更新する

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

### Account
- [ListUserAccounts](./account.md#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
Expand Down Expand Up @@ -280,7 +282,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セッションの取得

8 changes: 4 additions & 4 deletions docs/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
Request.ListUserAccounts request = new Request.ListUserAccounts(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ユーザーID
) {
Page = 1564, // ページ番号
PerPage = 5762, // 1ページ分の取引数
Page = 2119, // ページ番号
PerPage = 9474, // 1ページ分の取引数
};
Response.PaginatedAccountDetails response = await request.Send(client);
```
Expand Down Expand Up @@ -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 = "g2EP1IMpzVlOR0ZjHbJ4pIYeH1mIjK91BovJNiyan2Rg9xEgMUhIRyB0Lq7z8Ljil9JSMA7rA7mkLLtmKfguDK2IgQjODYIDOJbPEulQIvNSkQALktsxpQNr6y6a28m0nRuldHpSuEUpdPie9qQ2GFfC0at9jn8D", // ウォレット名
ExternalId = "wInc5YWbNc2E2NkkI", // 外部ID
Metadata = "{\"key1\":\"foo\",\"key2\":\"bar\"}", // ウォレットに付加するメタデータ
};
Response.AccountDetail response = await request.Send(client);
Expand Down
67 changes: 64 additions & 3 deletions docs/bank_pay.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,54 @@
BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。


<a name="delete-bank"></a>
## 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)
を返します



---


<a name="list-banks"></a>
## ListBanks: 登録した銀行の一覧
登録した銀行を一覧します
Expand Down Expand Up @@ -66,7 +114,7 @@ Request.CreateBank request = new Request.CreateBank(
"<Deep Link>", // コールバックURL
"ポケペイタロウ" // ユーザーの氏名 (片仮名で指定)
) {
Email = "EeKe2EnvF9@kW30.com", // ユーザーのメールアドレス
Email = "DHI0zWcr0s@Mpkd.com", // ユーザーのメールアドレス
Birthdate = "19901142", // 生年月日
};
Response.BankRegisteringInfo response = await request.Send(client);
Expand Down Expand Up @@ -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, // チャージ金額
4365, // チャージ金額
"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);
```

Expand Down Expand Up @@ -208,6 +258,17 @@ Response.TransactionDetail response = await request.Send(client);



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

**`receiver_user_id`**



```json
{
"type": "string",
Expand Down
28 changes: 14 additions & 14 deletions docs/bill.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@

```csharp
Request.ListBills request = new Request.ListBills() {
Page = 7384, // ページ番号
PerPage = 6138, // 1ページの表示数
BillId = "T", // 支払いQRコードのID
Page = 4136, // ページ番号
PerPage = 2402, // 1ページの表示数
BillId = "bkgSmtEHA", // 支払いQRコードのID
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
OrganizationCode = "xs6VNjs2Mf2--N-VxoE9n6N1iQ3v", // 組織コード
OrganizationCode = "85C4-F--0NJ--4p9UJ6O3-q", // 組織コード
Description = "test bill", // 取引説明文
CreatedFrom = "2024-02-06T00:24:19.000000Z", // 作成日時(起点)
CreatedTo = "2020-07-28T20:51:25.000000Z", // 作成日時(終点)
CreatedFrom = "2021-12-20T22:14:46.000000Z", // 作成日時(起点)
CreatedTo = "2022-03-14T08:36:55.000000Z", // 作成日時(終点)
ShopName = "bill test shop1", // 店舗名
ShopId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
LowerLimitAmount = 3980, // 金額の範囲によるフィルタ(下限)
UpperLimitAmount = 6980, // 金額の範囲によるフィルタ(上限)
IsDisabled = true, // 支払いQRコードが無効化されているかどうか
LowerLimitAmount = 2052, // 金額の範囲によるフィルタ(下限)
UpperLimitAmount = 3834, // 金額の範囲によるフィルタ(上限)
IsDisabled = false, // 支払いQRコードが無効化されているかどうか
};
Response.PaginatedBills response = await request.Send(client);
```
Expand Down Expand Up @@ -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 = 115.0, // 支払い額
Description = "test bill", // 説明文(アプリ上で取引の説明文として表示される)
};
Response.Bill response = await request.Send(client);
Expand Down Expand Up @@ -278,8 +278,8 @@ Response.Bill response = await request.Send(client);
|status|type|ja|en|
|---|---|---|---|
|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
|422|shop_account_not_found||The shop account is not found|
|422|private_money_not_found||Private money not found|
|422|shop_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|
Expand All @@ -298,9 +298,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 = 4541.0, // 支払い額
Description = "test bill", // 説明文
IsDisabled = true, // 無効化されているかどうか
IsDisabled = false, // 無効化されているかどうか
};
Response.Bill response = await request.Send(client);
```
Expand Down
10 changes: 5 additions & 5 deletions docs/bulk.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ CSVファイルから一括取引をします。

```csharp
Request.BulkCreateTransaction request = new Request.BulkCreateTransaction(
"y2", // 一括取引タスク名
"m8", // 取引する情報のCSV
"ZcyGh3BczuQ1HmAT4U7cCHORIBupKF2LGLWl" // リクエストID
"5byBGxSlhAbqrppUqGdxMolEMce2", // 一括取引タスク名
"Wkzh6xh3kO", // 取引する情報のCSV
"5wXHuEli1NcEVyTrbdyJqmh3WRfGT9d54NzU" // リクエストID
) {
Description = "WRqEU1R3HVfumJrkxA1RBhkJnrKn6T4UBYf7XzEp3cMOeoQItbJApNFNbizZqS", // 一括取引の説明
Description = "ibZax1gbEqwtEhHNUjZJEl7H6aHeFVmJSAKrLNuNDUQhJfNq76RxAuxSVrnur4Ju4ayidm5BuCe0yTSEIanUYTV2eUYL", // 一括取引の説明
PrivateMoneyId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
};
Response.BulkTransaction response = await request.Send(client);
Expand Down Expand Up @@ -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|


Expand Down
Loading
Loading