Recipient(送金先)

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

Attributes

Name Type Description
object string

固定値recipient

id string

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

livemode boolean

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

location string

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

activated_at string

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

active boolean

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

bank_account bank_account

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

created_at string

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

default boolean

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

deleted boolean

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

description string

追加振込先口座の説明。

email string

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

failure_code string

追加振込先口座の作成に失敗した際のエラーコード。 name_mismatchaccount_not_found、または bank_not_foundのいずれかとなります。

metadata object

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

name string

追加振込先口座名。

schedule object_id_expandable

追加振込先口座に紐付けられた送金スケジュール。

tax_id string

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

type string

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

verified boolean

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

verified_at string

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

Example

  • JSON Response

新しい送金先を作成

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

Creates and returns a new recipient.

Request Parameters

Name Type Description
bank_account object

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

description string

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

email string

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

metadata object

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

name string

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

tax_id string

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

type string

(任意, one of: individual, corporation) 追加振込先口座の種類。

Example

  • Create a recipient (Thailand and Singapore)

  • Create a recipient (Japan)

送金先情報を削除

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

Destroys the recipient matching :id.

Example

  • 送金先情報を削除

送金先のリストを取得

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

recipientに属するすべての お客様のアカウントオブジェクトの 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

  • 送金先のリストを取得

送金先情報を取得

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

Returns the recipient matching :id.

Example

  • 送金先情報を取得

送金先情報を更新

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

Returns an updated recipient

Request Parameters

Name Type Description
bank_account object

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

description string

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

email string

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

metadata object

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

name string

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

tax_id string

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

type string

(任意, one of: individual, corporation) 追加振込先口座の種類。

Example

  • 送金先情報を更新

送金先情報を更新

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

This endpoint allows you to manually mark a recipient as verified. This can be useful for testing purposes.

Example

  • Verify a recipient

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