キャンセル
キャンセルリソースは、awaiting もしくは authorized 状態の課金に対してキャンセルを作成する為に使われ、またその状態を表現します。これは、コンビニ決済で課金を作成した時、もしくはクレジットカード(Apple Pay を含む)決済でオーソリを行った際に利用します。
successful 状態の課金については、返金 を参照ください。
キャンセルオブジェクト
| Fields | |
|---|---|
| id | string (UUID) キャンセルのID。 |
| store_id | string (UUID) キャンセルが行われたストアのID。 |
| charge_id | string (UUID) キャンセルが行われた課金のID。 |
| status | string キャンセルの状態。 pending, successful, failed, errorのいずれか。 |
| error.code | string 課金が失敗またはエラーになった理由を表すエラーコード |
| error.message | string 課金が失敗した理由 |
| error.detail | string 課金が失敗した詳細理由 |
| metadata | json キャンセルに紐づいているメタデータ |
| mode | string |
| created_on | string (ISO-8601) キャンセルが作成された日時 |