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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

refs/heads/release/0.3.6 #55

Merged
merged 3 commits into from
May 10, 2024
Merged

refs/heads/release/0.3.6 #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ca7927
generate
May 9, 2024
d886d30
update error-response.csv
May 9, 2024
2cc9506
0.3.6
May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
pokepay_partner_ruby_sdk (0.3.5)
pokepay_partner_ruby_sdk (0.3.6)
inifile (~> 3.0.0)
json (~> 2.3.0)
openssl (>= 2.1.2)
Expand Down
17 changes: 9 additions & 8 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,12 @@ response.body
- [ListTransfersV2](./transfer.md#list-transfers-v2):

### Check
- [CreateCheck](./check.md#create-check): チャージQRコードの発行
- [ListChecks](./check.md#list-checks): チャージQRコード一覧の取得
- [CreateCheck](./check.md#create-check): チャージQRコードの発行
- [GetCheck](./check.md#get-check): チャージQRコードの表示
- [UpdateCheck](./check.md#update-check): チャージQRコードの更新
- [CreateTopupTransactionWithCheck](./check.md#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
- [CreateTransactionWithCashtray](./check.md#create-transaction-with-cashtray): CashtrayQRコードを読み取ることで取引する

### Bill
- [ListBills](./bill.md#list-bills): 支払いQRコード一覧を表示する
Expand All @@ -192,14 +193,14 @@ response.body

### Cashtray
- [CreateCashtray](./cashtray.md#create-cashtray): Cashtrayを作る
- [GetCashtray](./cashtray.md#get-cashtray): Cashtrayの情報を取得する
- [CancelCashtray](./cashtray.md#cancel-cashtray): Cashtrayを無効化する
- [GetCashtray](./cashtray.md#get-cashtray): Cashtrayの情報を取得する
- [UpdateCashtray](./cashtray.md#update-cashtray): Cashtrayの情報を更新する

### Customer
- [DeleteAccount](./customer.md#delete-account): ウォレットを退会する
- [GetAccount](./customer.md#get-account): ウォレット情報を表示する
- [UpdateAccount](./customer.md#update-account): ウォレット情報を更新する
- [DeleteAccount](./customer.md#delete-account): ウォレットを退会する
- [ListAccountBalances](./customer.md#list-account-balances): エンドユーザーの残高内訳を表示する
- [ListAccountExpiredBalances](./customer.md#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
- [UpdateCustomerAccount](./customer.md#update-customer-account): エンドユーザーのウォレット情報を更新する
Expand All @@ -220,7 +221,6 @@ response.body
- [UpdateShop](./shop.md#update-shop): 店舗情報を更新する

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

### Account
- [ListUserAccounts](./account.md#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
Expand All @@ -237,18 +237,19 @@ response.body
### Event
- [CreateExternalTransaction](./event.md#create-external-transaction): ポケペイ外部取引を作成する
- [RefundExternalTransaction](./event.md#refund-external-transaction): ポケペイ外部取引をキャンセルする
- [GetExternalTransactionByRequestId](./event.md#get-external-transaction-by-request-id): リクエストIDからポケペイ外部取引を取得する

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

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

### Coupon
- [ListCoupons](./coupon.md#list-coupons): クーポン一覧の取得
Expand All @@ -262,7 +263,7 @@ response.body
- [ActivateUserDevice](./user_device.md#activate-user-device): デバイスの有効化

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

10 changes: 6 additions & 4 deletions docs/account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
```RUBY
response = $client.send(Pokepay::Request::ListUserAccounts.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
page: 9970, # ページ番号
per_page: 7800 # 1ページ分の取引数
page: 3778, # ページ番号
per_page: 7882 # 1ページ分の取引数
))
```

Expand Down Expand Up @@ -60,6 +60,7 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
を返します



---


Expand All @@ -71,8 +72,8 @@ response = $client.send(Pokepay::Request::ListUserAccounts.new(
response = $client.send(Pokepay::Request::CreateUserAccount.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_id: ユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
name: "musaHN4dAo0kcMwrj6lsuth9pSzmqVAxW3BZh2UFG0NdobuyCqKAyF8XBloHn7nUM7l934bPMQ7DIwFMXGuPCrmdUDxKggDFfFvOJkxhc8IPvtQD4QxNm6tX3Guvbo2vDNfvQpElqxJKgNyOMeXS2rUoCJ5iHqor", # ウォレット名
external_id: "IswPc2cB", # 外部ID
name: "CSoLJdEVZoJB0H5I2jNmYRtpCMs9TezTj3A085y5hWQ3gdeDOWFExGORRYNLJdsZ6n3IGoF44i0499bTqwmusaHN4dAo0kcMwrj6lsuth9pSzmqVAxW3BZh2UFG0NdobuyCqKAyF8XBloHn7nUM7l934bPMQ7DIwFMXGuP", # ウォレット名
external_id: "CrmdUDxKggDF", # 外部ID
metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}" # ウォレットに付加するメタデータ
))
```
Expand Down Expand Up @@ -151,6 +152,7 @@ response = $client.send(Pokepay::Request::CreateUserAccount.new(
を返します



---


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


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

```RUBY
response = $client.send(Pokepay::Request::ListBanks.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_device_id: デバイスID
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
))
```



### Parameters
**`user_device_id`**



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

**`private_money_id`**



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



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



---


<a name="create-bank"></a>
## CreateBank: 銀行口座の登録
銀行口座の登録を始めるAPIです。レスポンスに含まれるredirect_urlをユーザーの端末で開き銀行を登録します。
Expand All @@ -16,7 +63,7 @@ response = $client.send(Pokepay::Request::CreateBank.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
"<Deep Link>", # callback_url: コールバックURL
"ポケペイタロウ", # kana: ユーザーの氏名 (片仮名で指定)
email: "qC15yVJZpc@8KVp.com", # ユーザーのメールアドレス
email: "7GsubMGTjI@cOXK.com", # ユーザーのメールアドレス
birthdate: "19901142" # 生年月日
))
```
Expand Down Expand Up @@ -98,51 +145,6 @@ response = $client.send(Pokepay::Request::CreateBank.new(
を返します


---


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

```RUBY
response = $client.send(Pokepay::Request::ListBanks.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_device_id: デバイスID
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
))
```



### Parameters
**`user_device_id`**



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

**`private_money_id`**



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



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


---

Expand All @@ -155,7 +157,7 @@ response = $client.send(Pokepay::Request::ListBanks.new(
response = $client.send(Pokepay::Request::CreateBankTopupTransaction.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # user_device_id: デバイスID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
7742, # amount: チャージ金額
3269, # amount: チャージ金額
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bank_id: 銀行ID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # request_id: リクエストID
))
Expand Down Expand Up @@ -226,6 +228,7 @@ response = $client.send(Pokepay::Request::CreateBankTopupTransaction.new(
を返します



---


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

```RUBY
response = $client.send(Pokepay::Request::ListBills.new(
page: 8308, # ページ番号
per_page: 5622, # 1ページの表示数
bill_id: "laKx", # 支払いQRコードのID
page: 6224, # ページ番号
per_page: 8406, # 1ページの表示数
bill_id: "0zGq4PpZBc", # 支払いQRコードのID
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
organization_code: "CMf-9Tbr-uA-3dv2K1u-t2aU848H--", # 組織コード
organization_code: "V-ld6at5-L7-g-FnGpUsttbam6-RlUA", # 組織コード
description: "test bill", # 取引説明文
created_from: "2020-01-14T03:21:13.000000Z", # 作成日時(起点)
created_to: "2020-09-03T11:53:51.000000Z", # 作成日時(終点)
created_from: "2023-04-03T07:59:20.000000Z", # 作成日時(起点)
created_to: "2020-07-16T05:37:27.000000Z", # 作成日時(終点)
shop_name: "bill test shop1", # 店舗名
shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # 店舗ID
lower_limit_amount: 3745, # 金額の範囲によるフィルタ(下限)
upper_limit_amount: 6172, # 金額の範囲によるフィルタ(上限)
lower_limit_amount: 2765, # 金額の範囲によるフィルタ(下限)
upper_limit_amount: 5851, # 金額の範囲によるフィルタ(上限)
is_disabled: true # 支払いQRコードが無効化されているかどうか
))
```
Expand Down Expand Up @@ -193,6 +193,12 @@ response = $client.send(Pokepay::Request::ListBills.new(
[PaginatedBills](./responses.md#paginated-bills)
を返します

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



---

Expand All @@ -205,7 +211,7 @@ response = $client.send(Pokepay::Request::ListBills.new(
response = $client.send(Pokepay::Request::CreateBill.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 支払いマネーのマネーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # shop_id: 支払い先(受け取り人)の店舗ID
amount: 6991.0, # 支払い額
amount: 8753.0, # 支払い額
description: "test bill" # 説明文(アプリ上で取引の説明文として表示される)
))
```
Expand Down Expand Up @@ -265,6 +271,18 @@ response = $client.send(Pokepay::Request::CreateBill.new(
[Bill](./responses.md#bill)
を返します

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



---

Expand All @@ -276,9 +294,9 @@ response = $client.send(Pokepay::Request::CreateBill.new(
```RUBY
response = $client.send(Pokepay::Request::UpdateBill.new(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # bill_id: 支払いQRコードのID
amount: 3919.0, # 支払い額
amount: 3844.0, # 支払い額
description: "test bill", # 説明文
is_disabled: true # 無効化されているかどうか
is_disabled: false # 無効化されているかどうか
))
```

Expand Down Expand Up @@ -340,6 +358,7 @@ response = $client.send(Pokepay::Request::UpdateBill.new(
を返します



---


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

```RUBY
response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
"skU0m8hSr1melepO9LnwIsUc", # name: 一括取引タスク名
"mvb4", # content: 取引する情報のCSV
"GOUqCz9cGDIhlPt52zP7YS2DWusWLcKpd2P3", # request_id: リクエストID
description: "35Nv6jpCTg7cI", # 一括取引の説明
"vOJkxhc8IPvtQD4QxNm6tX", # name: 一括取引タスク名
"3Guvbo", # content: 取引する情報のCSV
"2vDNfvQpElqxJKgNyOMeXS2rUoCJ5iHqorIs", # request_id: リクエストID
description: "Pc2cBsLEwskU0m8hSr1melepO9LnwIsUcSmvb4GOUqCz9cGDIhlPt52zP7YS2DWusWLcKpd2P335Nv6jpCTg7cImjgcPmkAEumRe3ajMg8VGC0KZL7VMaMEG", # 一括取引の説明
private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # マネーID
))
```
Expand Down Expand Up @@ -104,6 +104,16 @@ response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
[BulkTransaction](./responses.md#bulk-transaction)
を返します

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



---

Expand Down
Loading
Loading