Account（アカウント）

Accounts（アカウント）、あなたのOmiseアカウントを表現するオブジェクトです。このオブジェクトを使って、現在の登録済みメールアドレスやアカウントIDを確認することができます。

Attributes

Name	Type	Description
object	string	固定値 `account` 。
id	string	`/account(_test)?_[0-9a-z]+/`に一致する `ACCOUNT_ID`。
livemode	boolean	本番モード (`true`) あるいはテストモード(`false`)のアカウント
location	string	現在の`account`オブジェクトを取得するためのAPIパス。
api_version	string	Default API version for account. Note: this version can be overridden for a given request in the header.
auto_activate_recipients	boolean	作成時に追加振込先口座を自動的にアクティブにするかどうか。
chain_enabled	boolean	チェーンAPI機能が有効になっているかどうか。
chain_return_uri	string	チェーンAPIはURIを返します。
chaining_allowed	boolean	アカウントの連結を許可するかどうかを指定します。
country	string	2文字の国コードISO 3166。
created_at	string	ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`)でアカウントが作成されたUTC日時。
currency	string	小文字3桁の国際識別コードで、ISO 4217規格によって定義された通貨(サポート通貨コード一覧)。
email	string	アカウントに関連付けられたメールアドレス。
last_updated_api_version	string	最後に更新されたAPIのバージョンです。注: これはダッシュボードが使用する内部のAPIフィールドです。
metadata_export_keys	object	エクスポートに含めるメタデータを指定するオブジェクト。
supported_currencies	array	アカウントが登録された国に基づく、クレジットカードやデビットカードでの課金に使用される通貨。詳細については、[マルチカレンシー]（/multi-currency）を有効にしご確認ください。
team	string	アカウントチームの識別子は`/acct(_test)?_[0-9a-z]+/`と一致します。チームは第三者にアカウントへのアクセス許可、さらにはプロフィールを編集し、必要な管理上の、また技術的な役割を追加することができます。
transfer_config	object	振込の設定です。この設定は、各加盟店またはPSPの管理ダッシュボードで設定できます。
webhook_uri	string	URI to which account events are pushed. See /api-webhooks and Events.
zero_interest_installments	boolean	加盟店が分割払いの利子を負担するかどうか。

Example

JSON Response

{
  "object": "account",
  "id": "account_test_no1t4tnemucod0e51mo",
  "team": "acct_no1t4tnemucod0e51mo",
  "livemode": false,
  "location": "/account",
  "country": "TH",
  "currency": "THB",
  "email": "somchai.prasert@example.com",
  "created_at": "2019-12-31T12:59:59Z",
  "supported_currencies": [
    "THB",
    "JPY",
    "USD",
    "EUR",
    "GBP",
    "SGD",
    "AUD",
    "CHF",
    "CNY",
    "DKK",
    "HKD"
  ],
  "api_version": "2019-05-29",
  "auto_activate_recipients": true,
  "chain_enabled": false,
  "zero_interest_installments": true,
  "chain_return_uri": "https://dashboard.omise.co/test/settings",
  "webhook_uri": "https://omise-flask-example.herokuapp.com/webhook",
  "metadata_export_keys": {
    "charge": [
      "color",
      "order_id"
    ]
  },
  "chaining_allowed": true,
  "last_updated_api_version": "2019-06-06",
  "transfer_config": {
    "min_transfer_amount": "30.00",
    "max_transfer_amount": 2000000,
    "is_payout_enabled": false
  }
}

アカウント情報の取得

- GET https://api.omise.co/account/api_versions

テストキー、ライブキーともに同じアカウントを返します。

Example

アカウント情報の取得

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/account \
  -u $OMISE_SECRET_KEY:

<?php

$account = OmiseAccount::retrieve();

// After retrieving it, the account can be refreshed:
$account->reload();

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

const account = await omise.account.retrieve();
console.log(account);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

account = Omise::Account.retrieve

# After retrieving it, the account can be refreshed:
account.reload

var account = await Client.Account.Get();
Console.WriteLine($"account: {account.Email}");

Request<Account> request = new Account.GetRequestBuilder().build();
Account account = client().sendRequest(request);

System.out.printf("Account id: %s", account.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

account = omise.Account.retrieve()

# After retrieving it, the account can be refreshed:
account.reload()

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Account{}
err := client.Do(result, &operations.RetrieveAccount{})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Account.retrieve

Updates and returns the current account object.

- PATCH https://api.omise.co/account

Updates and returns information about the account.

Request Parameters

Name	Type	Description
chain_enabled	boolean	(任意, default: `false`, one of: `true`, `false`) チェーンAPI機能が有効になっているかどうか。
chain_return_uri	string	(任意) チェーンAPIはURIを返します。
metadata_export_keys	object	(任意) エクスポートに含めるメタデータを指定するオブジェクト。
webhook_uri	string	(任意) URI to which account events are pushed. See /api-webhooks and Events.
zero_interest_installments	boolean	(任意, default: `false`, one of: `true`, `false`) 加盟店が分割払いの利子を負担するかどうか。

Example

Updates the account

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/account \
  -X PATCH \
  -u $OMISE_SECRET_KEY: \
  -d "metadata_export_keys[charge][]=color" \
  -d "metadata_export_keys[charge][]=order_id" \
  -d "webhook_uri=https://omise-flask-example.herokuapp.com/webhook"

<?php

$account = OmiseAccount::retrieve();

$account->update(['webhook_uri' => 'https://www.omise.co']);

// After retrieving it, the account can be refreshed:
$account->reload();

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

const account = omise.account.UpdateAccount({ webhook_uri: 'https://webhook-url' });
console.log(account);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

Omise.webhook_uri = "https://webhook-url"

account = Omise::Account.update

# After updating it, the account can be refreshed:
account.reload

var account = await Client.Account.Update("https://webhook-url");
Console.WriteLine($"account: {account.Id}");

Account account = client.account().update("https://webhook-url");
System.out.printf("Updated account id: %s\n", account.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

omise.webhook_uri = "https://webhook-url"

account = omise.Account.update()

# After updating it, the account can be refreshed:
account.update()

account := &omise.UpdateAccount{
	webhook_uri: "https://webhook-url"
}

if e := client.Do(account, &operations.UpdateAccount{}); e != nil {
	log.Fatalln(e)
}

log.Println("Updated account:", account)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.configure(webhook_uri: 
"https://webhook-url")

Omise.Account.update

Update API version

- PATCH https://api.omise.co/account/api_version

PIのバージョンを最新版に更新します。（APIバージョンを参照します）