Transfer (送金)

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

Attributes

Name Type Description
object string

固定値transfer

id string

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

livemode boolean

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

location string

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

amount integer

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

bank_account bank_account

振込先の銀行口座。

created string

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

currency string

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

deleted boolean

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

fail_fast boolean

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

failure_code string

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

failure_message string

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

fee integer

Opn Payments 送金手数料。

merchant_name string

振込を実行したサブマーチャントの名前です。

注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、Opn サポートまでお問い合わせください。

merchant_uid string

振込を実行したサブマーチャントのIDです。

注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、Opn サポートまでお問い合わせください。

metadata object

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

paid boolean

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

paid_at string

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

recipient string

送金先のRecipient ID

schedule object_id_expandable

Schedule associated with transfer.

sendable boolean

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

sent boolean

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

sent_at string

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

transaction object_id_expandable

この振込のTransaction ID

Example

  • JSON Response

Callback

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

振込ステータス(成功/失敗)を戻します。

Request Parameters

Name Type Description
failure_code string

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

failure_message string

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

success boolean

(任意, one of: true, false) Success

新しい送金の作成

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

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

Request Parameters

Name Type Description
amount integer

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

fail_fast boolean

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

idemp_key string

(任意) Idemp key

metadata object

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

recipient string

(任意) 送金先のRecipient ID

split_transfer boolean

(任意, one of: true, false) Split transfer

Example

  • 新しい送金の作成

  • Create a transfer while adding metadata

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

送金情報の削除

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

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

Example

  • 送金情報の削除

送金情報リストの取得

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

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

  • 送金情報リストの取得

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

送金情報の取得

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

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

Example

  • 送金情報の取得

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