Skip to content
Merged
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
17 changes: 17 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ while (true) {
- [GetCpmToken](./transaction.md#get-cpm-token): CPMトークンの状態取得
- [ListTransactions](./transaction.md#list-transactions): 【廃止】取引履歴を取得する
- [CreateTransaction](./transaction.md#create-transaction): 【廃止】チャージする
- [CreateTransactionGroup](./transaction.md#create-transaction-group): トランザクショングループを作成する
- [ShowTransactionGroup](./transaction.md#show-transaction-group): トランザクショングループを取得する
- [ListTransactionsV2](./transaction.md#list-transactions-v2): 取引履歴を取得する
- [ListBillTransactions](./transaction.md#list-bill-transactions): 支払い取引履歴を取得する
- [CreateTopupTransaction](./transaction.md#create-topup-transaction): チャージする
Expand Down Expand Up @@ -166,8 +168,23 @@ while (true) {
- [GetCustomerAccounts](./customer.md#get-customer-accounts): エンドユーザーのウォレット一覧を表示する
- [CreateCustomerAccount](./customer.md#create-customer-account): 新規エンドユーザーをウォレットと共に追加する
- [GetShopAccounts](./customer.md#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
- [GetCustomerCards](./customer.md#get-customer-cards): エンドユーザーのクレジットカード一覧を取得する
- [DeleteCustomerCard](./customer.md#delete-customer-card): エンドユーザーのクレジットカードを削除する
- [CreditCardTopupWithMembership](./customer.md#credit-card-topup-with-membership): 登録済みクレジットカードでチャージする(3Dセキュア)
- [CreditCardTopupWithMdkToken](./customer.md#credit-card-topup-with-mdk-token): 未登録クレジットカード(MDKトークン)でチャージする(3Dセキュア)
- [ListCustomerTransactions](./customer.md#list-customer-transactions): 取引履歴を取得する

### CreditSession
- [PostCreditSession](./credit_session.md#post-credit-session): Create credit session
- [CreateCreditSessionTransaction](./credit_session.md#create-credit-session-transaction): Create transaction with credit session
- [CaptureCreditSession](./credit_session.md#capture-credit-session): Capture credit session

### CVS
- [GetCvsAuthorizations](./cvs.md#get-cvs-authorizations): コンビニ決済の申し込み情報一覧取得
- [CreateCvsAuthorization](./cvs.md#create-cvs-authorization): コンビニ決済申込
- [CancelCvsAuthorization](./cvs.md#cancel-cvs-authorization): コンビニ決済の申し込みキャンセル
- [GetCvsAuthorization](./cvs.md#get-cvs-authorization): コンビニ決済の申し込み情報取得

### Organization
- [ListOrganizations](./organization.md#list-organizations): 加盟店組織の一覧を取得する
- [CreateOrganization](./organization.md#create-organization): 新規加盟店組織を追加する
Expand Down
75 changes: 53 additions & 22 deletions docs/account.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Account
ウォレットを表すデータです。
CustomerもMerchantも所有し、ウォレット間の送金は取引として記録されます。
Customerのウォレットはマネー残高(有償バリュー)、ポイント残高(無償バリュー)の2種類の残高をもちます。
また有効期限別で金額管理しており、有効期限はチャージ時のコンテキストによって決定されます。
ユーザはマネー別に複数のウォレットを保有することが可能です。
ただし1マネー1ウォレットのみであり、同一マネーのウォレットを複数所有することはできません。


<a name="list-user-accounts"></a>
## ListUserAccounts: エンドユーザー、店舗ユーザーのウォレット一覧を表示する
Expand All @@ -8,53 +15,62 @@
$request = new Request\ListUserAccounts(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // userId: ユーザーID
[
'page' => 3215, // ページ番号
'per_page' => 4705 // 1ページ分の取引数
'page' => 3029, // ページ番号
'per_page' => 9398 // 1ページ分の取引数
]
);
```



### Parameters
**`user_id`**


#### `user_id`
ユーザーIDです。

指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。

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

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

**`page`**

</details>

#### `page`
取得したいページ番号です。デフォルト値は1です。

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

```json
{
"type": "integer",
"minimum": 1
}
```

**`per_page`**

</details>

#### `per_page`
1ページ当たりのウォレット数です。デフォルト値は50です。

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

```json
{
"type": "integer",
"minimum": 1
}
```

</details>



成功したときは
Expand All @@ -75,8 +91,8 @@ $request = new Request\CreateUserAccount(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // userId: ユーザーID
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // privateMoneyId: マネーID
[
'name' => "r0sMpkdiHOOwl5xIQiAP4UplfuFUQK5yc0JqyEbk4xV1ElwOVpwOgCs3REJLXlOpH9qH3TntlxmPSv0sqeMHVeJGZnQaE4lp3S7TMyfZKpPybiZ1Lwce18e7Eq5OqWuTabdRaaHOyfGqVUncXzhjskeGyZxmbEy050Zlv3tzVr8aTPDqMKbxS0Vs3OlIrdnx7rU9Fte9Z959oBy13mtel3d8TfJ3Ol39Scas", // ウォレット名
'external_id' => "ZnA58jo0hnz", // 外部ID
'name' => "XIAxp1c5Q2vG7By91KC2xkwbMvROWfUAhh6XnZz0yJYgRGAM6oTzljbZYS9b6qmrSFaDiVxdn1z0TuA7dLQ8GnuuGnm3um0ZKYlqHYAPfacx4ba4pxXiFCicQd3QQrdtpp5IlW8KnTaroT8w3801ZxeZpTa0FFkkUFLVCDKp9TvCsVFg3Dy6t9FVfvRBKOl2QQeBI5NM6J7EhkzGk22yYle2ZOPXJOiEYcNwwBKhoxCdqw8S", // ウォレット名
'external_id' => "S6L7O", // 外部ID
'metadata' => "{\"key1\":\"foo\",\"key2\":\"bar\"}" // ウォレットに付加するメタデータ
]
);
Expand All @@ -85,35 +101,42 @@ $request = new Request\CreateUserAccount(


### Parameters
**`user_id`**


#### `user_id`
ユーザーIDです。

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

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

**`private_money_id`**

</details>

#### `private_money_id`
マネーIDです。

作成するウォレットのマネーを指定します。このパラメータは必須です。

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

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

**`name`**

</details>

#### `name`

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

```json
{
Expand All @@ -122,9 +145,12 @@ $request = new Request\CreateUserAccount(
}
```

**`external_id`**

</details>

#### `external_id`

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

```json
{
Expand All @@ -133,22 +159,27 @@ $request = new Request\CreateUserAccount(
}
```

**`metadata`**

</details>

#### `metadata`
ウォレットに付加するメタデータをJSON文字列で指定します。
指定できるJSON文字列には以下のような制約があります。
- フラットな構造のJSONを文字列化したものであること。
- keyは最大32文字の文字列(同じkeyを複数指定することはできません)
- valueには128文字以下の文字列が指定できます

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

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

</details>



成功したときは
Expand Down
Loading
Loading