> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt
> Use this file to discover all available pages before exploring further.

# 入金シミュレーション API リファレンス

> サンドボックスで Treasury Account への入金をシミュレーションし、連携が入金を正しく受け取って計上することを確認します。

入金シミュレーションのエンドポイントは、[Treasury Account](/ja/platform-overview/clever-concepts/treasury-accounts) への銀行振込による入金を模擬します。実際の資金を動かすことなく、連携が入金を受け取り、正しいアカウントに計上し、Incoming 残高と Available 残高を更新することを確認できます。

<Note>
  これは**サンドボックス用のテストエンドポイント**です。サンドボックスのベース URL (`https://api.cleverhub.co/api`) で利用でき、本番環境には対応するエンドポイントはありません。サンドボックスと本番のベース URL は [v1 の概要](/ja/api/v1/introduction)を参照してください。
</Note>

<Tip>
  AUD の Treasury Account では、このエンドポイントを呼び出す代わりに **TestBank** シミュレーターで入金をシミュレーションできます。[入金の流れ](/ja/platform-overview/clever-concepts/treasury-accounts)を参照してください。
</Tip>

***

## 入金をシミュレーションする

<Note>
  `POST /v1/simulate_deposit`
</Note>

`account_number` に一致する Treasury Account に、模擬した入金を計上します。

### ヘッダー

<ParamField header="app-id" type="string" required>
  アプリケーションに割り当てられた一意の識別子です。[`app-id` と `secret-key` の確認場所](/ja/platform-overview/clever-concepts/treasury-accounts)を参照してください。
</ParamField>

<ParamField header="secret-key" type="string" required>
  `app-id` に紐づく秘密トークンです。
</ParamField>

### ボディのパラメーター

<ParamField body="account_number" type="string" required>
  入金先の Treasury Account の口座番号です。Merchant Portal のアカウントの **Account Details** タブで確認できます。
</ParamField>

<ParamField body="amount" type="string" required>
  入金額です。JPY のアカウントでは円単位の整数で指定します。
</ParamField>

<ParamField body="remitter_name" type="string">
  模擬する送金人の名前です。
</ParamField>

<ParamField body="remitter_bank_name" type="string">
  模擬する送金人の銀行名です。
</ParamField>

<ParamField body="remitter_branch_name" type="string">
  模擬する送金人の支店名です。
</ParamField>

<ParamField body="remarks" type="string">
  取引に対して表示される自由記述のメモです。
</ParamField>

<Info>
  JPY のアカウントでは、`remitter_name`、`remitter_bank_name`、`remitter_branch_name` を**半角カタカナ**で入力してください。全銀ネットワークの表記に合わせているため、模擬した取引が実際の取引と同じ形式で表示されます。
</Info>

### コード例

<CodeGroup>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.cleverhub.co/api/v1/simulate_deposit \
    --header 'app-id: YOUR_APP_ID' \
    --header 'secret-key: YOUR_SECRET_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "account_number": "3451385",
    "amount": "10000",
    "remitter_name": "ﾃｽﾄﾆﾕｳｷﾝﾅ",
    "remitter_bank_name": "ｼﾞ-ｴﾑｵ-ｱｵｿﾞﾗ",
    "remitter_branch_name": "ﾃｽﾄｼﾃﾝ",
    "remarks": "Testing deposit flow"
  }'
  ```
</CodeGroup>

呼び出しが成功すると、実際の入金と同じように、入金が Treasury Account の取引履歴に表示され、Incoming 残高と Available 残高が更新されます。

<Tip>
  Postman のコレクションをインポートして、このリクエストを直接実行できます。ベース URL には環境変数 `v1_url` を使用するため、送信前に設定してください。
</Tip>


## Related topics

- [送金フロー](/ja/platform-overview/clever-concepts/transfer-flow.md)
- [Treasury Account](/ja/platform-overview/clever-concepts/treasury-accounts.md)
- [多通貨 Payin API リファレンス (v2)](/ja/api/v2/payin.md)