Chain API

Retrieve and revoke chains. Chains represent sub-merchant accounts which have authorized another account to create charges and perform other actions on their behalf. When performing these actions, merchants use the sub-merchant chain key when interacting with the API.

Attributes

Name Type Description
object string

固定値chain

id string

/acch(_test)?_[0-9a-z]+/に一致するCHAIN_ID

livemode boolean

本番モード (true) あるいはテストモード(false) チェーンか。

location string

現在の chainオブジェクトを取得するためのAPIパス。

created_at string

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でチェーンが作成されたUTC日時。

email string

chain(チェーン)に関連付けられたメールアドレス。

key string

チェーンキー

revoked boolean

このチェーンがすでに無効になっているかどうか。

Example

  • JSON Response

List chains

- GET https://api.omise.co/chains

chainに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameters

Name Type Description
from string

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological, one of: chronological, reverse_chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to string

(任意) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • List all chains

Retrieve a chain

- GET https://api.omise.co/chains/{id}

Returns the chain matching :id.

Example

  • Retrieve a chain

Revoke a chain

- POST https://api.omise.co/chains/{id}/revoke

Revokes the chain matching :id.

Example

  • Revoke a chain

Related

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら