アカウントの更新

PATCHhttps://api.omise.co/account

アカウント情報を更新して返します。このエンドポイントを使用して、webhookエンドポイント、metadataエクスポート設定、マーケットプレイスパラメータを設定できます。

---

🔑API認証情報

▼

---

リクエストパラメータ

Recommended - 4 fieldsRecommended Parameters

▼

`webhook_uri`STRING(optional)

イベント通知を受信するためのプライマリwebhookエンドポイントURL。ライブモードではHTTPSである必要があります。

Example:"https://example.com/webhooks/omise"

`chain_enabled`BOOLEAN(optional)

アカウントチェーン（マーケットプレイス機能）が有効かどうか。

Example:false

Default:false

`chain_return_uri`STRING(optional)

顧客の承認後のマーケットプレイス取引のデフォルトリターンURI。

Example:"https://marketplace.example.com/return"

`zero_interest_installments`BOOLEAN(optional)

加盟店が分割払いの利息コストを負担するかどうか（顧客にとって0%分割払い）。

Example:false

Default:false

Additional - 1 fieldAdditional Parameters

▼

---

レスポンス

200

更新成功

すべての設定情報を含む更新されたアカウントオブジェクトを返します。

更新されたアカウントオブジェクトに含まれる内容:

• id - アカウント識別子
• webhook_uri - 更新されたwebhook URL
• chain_enabled - 更新されたマーケットプレイス有効化状態
• chain_return_uri - 更新されたマーケットプレイスリターンURI
• zero_interest_installments - 更新された分割払い設定
• metadata_export_keys - 更新されたmetadataエクスポート設定
• その他すべてのアカウントフィールド（email、country、currencyなど）

400

不正なリクエスト

リクエストの検証に失敗しました。詳細についてはエラーメッセージを確認してください。

一般的な原因:

• 無効なwebhook URL形式
• ライブモードでのHTTP webhook URL（HTTPSである必要があります）
• 無効なmetadata_export_keys構造
• 無効なパラメータタイプ

401

認証エラー

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーがない
• 無効なsecret key
• secret keyの代わりにpublic keyを使用している
• HTTP Basic Auth形式が正しくない

---

Code samples

cURL

curl https://api.omise.co/account \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "webhook_uri=https://example.com/webhooks/omise"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = Omise::Account.update(
  webhook_uri: 'https://example.com/webhooks/omise'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = omise.Account.update(
    webhook_uri='https://example.com/webhooks/omise'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const account = await omise.account.update({
  webhook_uri: 'https://example.com/webhooks/omise'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$account = OmiseAccount::update([
    'webhook_uri' => 'https://example.com/webhooks/omise'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Account account = client.account().update()
    .webhookUri("https://example.com/webhooks/omise")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var account = await client.Account.Update(new UpdateAccountRequest
{
    WebhookUri = "https://example.com/webhooks/omise"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

account, _ := client.Account().Update(&operations.UpdateAccount{
    WebhookURI: "https://example.com/webhooks/omise",
})

---

Try it out

推奨 - 4項目

▼

追加 - 1項目

▼