Transfer (送金)

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

Attribute

Name Type Description
object string

このJSONレスポンスがTransferオブジェクトであることを示す transfer が含まれます。

id object_id

TransferのID。

livemode boolean

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

location string

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

amount integer

指定された通貨において最小単位、かつ正の整数で表される金額。(例:100サターンは1タイバーツ) サポート通過コード一覧

bank_account bank_account

送金先の銀行口座。

created datetime

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

currency string

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨(サポート通貨コード一覧)。

fail_fast boolean

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

failure_code string

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

failure_message string

status == failed の場合の解読可能なメッセージ。

fee integer

送金手数料。

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) transfer。

paid boolean

true(送金済み)、false(未送金)。

paid_at datetime

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

recipient object_id

送金先のRecipient ID。

sendable boolean

Whether the transfer is able to be sent. For a transfer to be marked as sendable, the transfer amount must be less than the available amount, the recipient must be verified and active, the transfer must not have already been sent, and transfers must not be suspended for this account. Note: the transfer may still fail if any of the above requirements are not met at the time of transfer initiation.

sent boolean

true(送金済み)、false(未送金)。

sent_at datetime

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

transaction string

このTransferのTransaction ID。

Example

  • Json Response

送金情報リストの取得

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

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

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

Request Parameter

Name Type Description
amount integer

0以上の符号なし整数を金額として指定、通貨ごとのamountの最小・最大値

recipient object_id

送金先のRecipient ID。

fail_fast boolean

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

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) transfer。

Example

  • 新しい送金の作成

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

送金情報の取得

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

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

Example

  • 送金情報の取得

送金情報の更新

- PATCH https://api.omise.co/transfers/TRANSFER_ID

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

Request Parameter

Name Type Description
amount integer

0以上の符号なし整数を金額として指定、通貨ごとのamountの最小・最大値

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) transfer。

Example

  • 送金情報の更新

送金情報の削除

- DELETE https://api.omise.co/transfers/TRANSFER_ID

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

Example

  • 送金情報の削除

  • Response (JSON)

Mark a transfer as paid in test mode

- POST https://api.omise.co/transfers/TRANSFER_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/TRANSFER_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