Recipient(送金先)

Recipient(送金先) API リファレンス

Attributes

Name Type Description
object string

固定値recipient

id object_id

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

livemode boolean

本番モード (true) あるいはテストモード(false) 追加振込先口座。

location string

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

activated_at datetime

追加振込先口座がアクティベートされたISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)でのUTC日時。

active boolean

追加振込先口座がアクティブかどうか。

bank_account bank_account

追加振込先口座の銀行口座。

created_at datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)で追加振込先口座が作成されたUTC日時。

default boolean

追加振込先口座がデフォルトのアカウントかどうか。

deleted boolean

追加振込先口座が削除されたかどうか。

description string

追加振込先口座の説明。

email string

追加振込先口座に紐づけられたメールアドレス。

failure_code string

Recipient creation failure code. One of name_mismatch, account_not_found, or bank_not_found.

metadata object

追加振込先口座用のカスタムメタデータ(例:{"customer-id": 42}) 。

name string

追加振込先口座名。

schedule transfer_schedule

Transfer schedule associated with recipient.

tax_id string

追加振込先口座先のTax ID。

type string

追加振込先口座の種類。individualまたはcorporation

verified boolean

追加受取口座が検証されたかどうか。

verified_at datetime

追加振込先口座が検証されたISO 8601形式(YYYY-MM-DDThh:mm:ssZ)でのUTC日時。

Example

  • JSON Response

送金先のリストを取得

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

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

Request Parameters

Name Type Description
from datetime

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

limit integer

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

offset integer

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

order string

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

to datetime

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

Example

  • 送金先のリストを取得

新しい送金先を作成

- POST https://api.omise.co/recipients

Request Parameters

Name Type Description
bank_account[name] string

(必須) 銀行口座名義人の名前。

bank_account[number] string

(必須) 銀行口座番号。

name string

(必須) 追加振込先口座名。

type string

(必須) 追加振込先口座の種類。individualまたはcorporation

bank_account[bank_code] string

(任意) Bank code. Valid values depend on the country (see: supported banks).

bank_account[branch_code] string

(任意) 支店コード(日本のみ)。

bank_account[brand] string

(任意) Bank account name.

bank_account[type] string

(任意) 銀行口座の種類 。「普通」もしくは「当座」のいずれか(日本のみ)。

description string

(任意) 追加振込先口座の説明。

email string

(任意) 追加振込先口座に紐づけられたメールアドレス。

tax_id string

(任意) 追加振込先口座先のTax ID。

Example

  • Create a recipient (Thailand and Singapore)

  • Create a recipient (Japan)

送金先情報を取得

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

Example

  • 送金先情報を取得

送金先情報を更新

- PATCH https://api.omise.co/recipients/{id}

Request Parameters

Name Type Description
name string

(任意) 追加振込先口座名。

type string

(任意) 追加振込先口座の種類。individualまたはcorporation

bank_account bank_account

(任意) 追加振込先口座の銀行口座。

description string

(任意) 追加振込先口座の説明。

email string

(任意) 追加振込先口座に紐づけられたメールアドレス。

tax_id string

(任意) 追加振込先口座先のTax ID。

Example

  • 送金先情報を更新

送金先情報を更新

- PATCH https://api.omise.co/recipients/{id}/verify

Example

  • Verify a recipient

送金先情報を削除

- DELETE https://api.omise.co/recipients/{id}

Example

  • 送金先情報を削除

  • レスポンス (JSON)