Recipient(送金先)

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

Attribute

Name Type Description
object string

recipient と返ることで、このJSONレスポンスがRecipientの内容に関連することを示す。

id object_id

RecipientのID。

livemode boolean

本番モード (true) あるいはテストモード(false) recipient。

location string

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

active boolean

true(アクティブ)、false(非アクティブ)。

bank_account bank_account

Recipientの銀行口座。

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でrecipient作成の協定世界時(UTC)。

default boolean

Whether the recipient is the default.。

description string

解読可能なrecipientの説明。

email string

recipientに関連付けられたメールアドレス。

failure_code string

status == failed の場合の失敗コード。可能なコードについては、testing を参照してください。

name string

Recipientの氏名。

tax_id string

RecipientのTax ID。

type string

Recipientの種類、individual または corporation

verified boolean

true(承認済み)、false(未承認)。

Example

  • Json Response

送金先のリストを取得

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

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

Request Parameter

Name Type Description
offset integer

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

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

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

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

  • 送金先のリストを取得

新しい送金先を作成

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

Request Parameter

Name Type Description
name string

Recipientの名前。

type string

Recipientの種類、 individual または corporation

bank_account[name] string

(required) The bank account name。

bank_account[number] string

(required) The bank account number。

bank_account[brand] string

(optional) The bank account brand (required for banks in Thailand, Singapore, and Indonesia)。

See supported banks for allowed values。

bank_account[account_type] string

(optional) The type of account (required for banks in Japan)。 One of normal or current.

See supported banks for allowed values。

bank_account[bank_code] string

(optional) The bank code (required for banks in Japan)。

bank_account[branch_code] string

(optional) The branch code (required for banks in Japan)。

email string

任意:Recipientのメールアドレス。

description string

任意:Recipientの説明。

tax_id string

任意:RecipientのTax ID。

Example

  • 新しい送金先を作成

送金先情報を取得

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

Example

  • 送金先情報を取得

送金先情報を更新

- PATCH https://api.omise.co/recipients/RECIPIENT_ID

Request Parameter

Name Type Description
name string

任意:Recipientの名前。

email string

任意:Recipientのメールアドレス。

description string

任意:Recipientの説明。

type string

任意:Recipientの種類、 individual または corporation

tax_id string

任意:RecipientのTax ID。

bank_account bank_account

任意:存在する bank account オブジェクト。

Example

  • 送金先情報を更新

Mark a recipient as verified in test mode

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

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

送金先情報を削除

- DELETE https://api.omise.co/recipients/RECIPIENT_ID

Example

  • 送金先情報を削除