Show / Hide Table of Contents

# Class RakutenCancelRequestDto

決済サービスタイプ：楽天、コマンド名：取消の要求Dtoクラス

##### Inheritance

object
MdkDtoBase
AbstractPaymentRequestDto
RakutenCancelRequestDto

##### Implements

IRequestDto

##### Inherited Members

AbstractPaymentRequestDto.PayNowIdParam
AbstractPaymentRequestDto.CncTokenParam
AbstractPaymentRequestDto.AccountId
AbstractPaymentRequestDto.CreateDate
AbstractPaymentRequestDto.FreeKey
AbstractPaymentRequestDto.Memo1
AbstractPaymentRequestDto.ReceiptData
AbstractPaymentRequestDto.ExistPayNowIdParam()
AbstractPaymentRequestDto.ExistAccountParam()
AbstractPaymentRequestDto.ExistAccountBasicParam()
AbstractPaymentRequestDto.ExistCardParam()
AbstractPaymentRequestDto.ExistRecurringChargeParam()
AbstractPaymentRequestDto.ExistBankAccountParam()
AbstractPaymentRequestDto.ExistCncTokenParam()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)

###### Namespace: jp.veritrans.tercerog.mdk.dto

###### Assembly: cg-mdk-dto.dll

##### Syntax

    public class RakutenCancelRequestDto : AbstractPaymentRequestDto, IRequestDto

### Properties

#### Amount

金額

半角数字 最大桁数:8

減額する金額を指定する
payType=0（オンライン決済）：売上前の場合は全額以外を指定できません。売上後は指定任意
payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定できません
payType=2（オンライン決済（V2））:売上前の場合は全額以外を指定できません。売上後は指定任意。

##### Declaration

    [JsonProperty("amount")]
    public string Amount { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### CancelReason

キャンセル理由詳細

文字列 最大桁数:1024

キャンセル理由の詳細を記載します。
-最大文字数:1024byte
payType=0（オンライン決済）：指定できません
payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意
payType=2（オンライン決済（V2））：指定できません

##### Declaration

    [JsonProperty("cancelReason")]
    public string CancelReason { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### CancelType

キャンセル理由種別

半角数字 最大桁数:2

キャンセル理由の種別を下記のコード値から指定します。
- 10: 重複しての決済
- 11: 商品の返品
- 12: お支払方法の変更
- 13: 金額の間違い
- 14: テスト決済
- 98: 障害取消（タイムアウトなど）
- 99: その他
payType=0（オンライン決済）：指定できません
payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定必須
payType=2（オンライン決済（V2））：指定できません

##### Declaration

    [JsonProperty("cancelType")]
    public string CancelType { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### MaskedLog

ログ用文字列(マスク済み)を設定する @param maskedLog ログ用文字列(マスク済み)

##### Declaration

    [JsonIgnore]
    public override string MaskedLog { set; }

##### Property Value

Type | Description
--- | ---
string |

##### Overrides

AbstractPaymentRequestDto.MaskedLog

#### OrderId

取引ID

半角英数字 最大桁数:100

キャンセル対象の取引IDを指定する。

##### Declaration

    [JsonProperty("orderId")]
    public string OrderId { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### ServiceCommand

決済サービスコマンド

##### Declaration

    [JsonIgnore]
    public override string ServiceCommand { get; }

##### Property Value

Type | Description
--- | ---
string |

##### Overrides

AbstractPaymentRequestDto.ServiceCommand

#### ServiceType

決済サービスタイプ

##### Declaration

    [JsonIgnore]
    public override string ServiceType { get; }

##### Property Value

Type | Description
--- | ---
string |

##### Overrides

AbstractPaymentRequestDto.ServiceType

#### StoreId

店舗ID

半角英数字 最大桁数:36

店舗番号を指定します。
- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。
payType=0（オンライン決済）：指定できません
payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意
payType=2（オンライン決済（V2））：指定できません

##### Declaration

    [JsonProperty("storeId")]
    public string StoreId { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### TerminalId

店舗端末ID

半角英数字 最大桁数:36

端末を識別するIDを指定します。
- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。
payType=0（オンライン決済）：指定できません
payType=1（バーコード決済（店舗スキャン型））、3（バーコード決済（消費者スキャン型））：指定任意
payType=2（オンライン決済（V2））：指定できません

##### Declaration

    [JsonProperty("terminalId")]
    public string TerminalId { get; set; }

##### Property Value

Type | Description
--- | ---
string |

### Methods

#### ToString()

ログ用文字列(マスク済み)を取得する @return ログ用文字列(マスク済み)

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
string |

##### Overrides

object.ToString()

### Implements

IRequestDto