Transfer (送金)

Transfers (送金) API リファレンス

Attributes

Name Type Description
object string

固定値transfer

id object_id

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

livemode boolean

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

location string

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

amount integer

最小通貨単位での振込金額。

bank_account bank_account

振込先の銀行口座。

created_at datetime

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

currency currency

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨

deleted boolean

送金が削除されたかどうか。

fail_fast boolean

送金が失敗した場合に再試行を回避するかどうか。送金を再試行しない場合はtrue、再試行する場合はfalseとなります。

failure_code string

振込のエラーコード。insufficient_balance(残高不足),invalid_recipient(受取人が無効)、transfer_suspended'(振込が一時停止)、transferdeleted(振込削除)、transfersent(振込済み)、または transfer_failed`(振込エラー)のいずれか

failure_message string

failure_codeが存在する場合、エラーを説明するメッセージ。

fee integer

送金手数料。

fee_vat integer

「手数料」にかかる付加価値税。

metadata object

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

net integer

amount- 手数料(total_fee)を送金する

paid boolean

振込が行われたかどうか。

paid_at datetime

この課金がISO8601形式(YYYY-MM-DDThh:mm:ssZ)で決済されたUTC日時。

recipient object_id

送金が行われた追加振込先口座のID。

schedule object_id

Schedule associated with transfer.

sendable boolean

送金できるかどうか。送金の際に「送金可能」を確認するため、送金額は利用可能な金額以下であること、受取口座は検証され、かつアクティブの状態であること、そして未送信の振込であることが必要です。送金は一時停止しないでください。送金の開始時に上記要件のいずれかが満たされない場合は、送金が失敗することがあります。

sent boolean

振込が送金されたかどうか。

sent_at datetime

この課金がISO8601形式(YYYY-MM-DDThh:mm:ssZ)で送金されたUTC日時。

total_fee integer

総手数料(fee + fee_vat)

transactions array

送金に関連した TRANSACTION_IDの配列。

Example

  • JSON Response

新しい送金の作成

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

新しい送金の作成をします。

Request Parameters

Name Type Description
amount integer

(任意) 最小通貨単位での振込金額。

fail_fast boolean

(任意) 送金が失敗した場合に再試行を回避するかどうか。送金を再試行しない場合はtrue、再試行する場合はfalseとなります。

metadata object

(任意) 振込用のカスタムメタデータ(例:{"customer-id": 42})。

recipient object_id

(任意) 送金が行われた追加振込先口座のID。

Example

  • 新しい送金の作成

  • 指定したRecipientへ新しい送金を作成

  • Create a transfer while adding metadata

送金情報の取得

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

Transfer IDで指定した送金情報を返します。

Example

  • 送金情報の取得

送金情報の更新

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

Transfer IDで指定した、送金情報の更新。

Request Parameters

Name Type Description
amount integer

(任意) 最小通貨単位での振込金額。

metadata object

(任意) 振込用のカスタムメタデータ(例:{"customer-id": 42})。

Example

  • 送金情報の更新

  • Update transfer metadata

送金情報の削除

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

Transfer IDで指定した送金情報の削除。

Example

  • 送金情報の削除

  • レスポンス (JSON)

送金情報リストの取得

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

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

  • 送金情報リストの取得

Mark a transfer as paid in test mode

- POST https://api.omise.co/transfers/{id}/mark_as_paid

This endpoint allows you to manually mark a test transfer as paid. This can be useful for testing purposes.

Example

  • Mark a test transfer as paid

Mark a transfer as sent in test mode

- POST https://api.omise.co/transfers/{id}/mark_as_sent

This endpoint allows you to manually mark a test transfer as sent. This can be useful for testing purposes.

Example

  • Mark a test transfer as sent