Show / Hide Table of Contents

# Class AmazonpayAuthorizeRequestDto

決済サービスタイプ：Amazonpay、コマンド名：決済申込の要求Dtoクラス

##### Inheritance

object
MdkDtoBase
AbstractPaymentRequestDto
AmazonpayAuthorizeRequestDto

##### 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 AmazonpayAuthorizeRequestDto : AbstractPaymentRequestDto, IRequestDto

### Properties

#### AccountingType

課金種別

半角数字 最大桁数:1

"0"：都度決済
"1"：随時決済
※未指定の場合は、"0"：都度決済となります。

##### Declaration

    [JsonProperty("accountingType")]
    public string AccountingType { get; set; }

##### Property Value

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

#### AddressRestrictions

配送先制限リスト

文字列 最大桁数:4000

配送先を制限するための許可リストまたは禁止リスト。
- リストには下記内容をJSON形式で指定する必要があります。
{"type": "【Allowed】", "restrictions": {
"【countryCode】": {"statesOrRegions": ["【AA】"],"zipCodes": ["【99999】", "【99999】"]},
"【countryCode】": {"statesOrRegions": ["【AA】"],"zipCodes": ["【999-9999】"]}, ...
}
※【】で括られた部分は下記に従い適切な値を設定
"type"："Allowed"(許可)
"NotAllowed"(禁止)
"countryCode"： 国名コード(日本：JP,アメリカ：US等のISO3166準拠コード)
"statesOrRegions"：都道府県等の地域名、アメリカは2桁の州略号(WA, CA, IL...)
"zipCodes"： 郵便番号、日本の場合は【999-9999】

##### Declaration

    [JsonProperty("addressRestrictions")]
    public string AddressRestrictions { get; set; }

##### Property Value

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

#### Amount

決済金額

半角数字 最大桁数:8

決済金額を指定します。
- 課金種別が都度決済の場合：1 以上かつ 10000000(8桁) 以下
- 課金種別が随時決済の場合：1 以上かつ 100000(6桁) 以下

##### Declaration

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

##### Property Value

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

#### AuthorizePushUrl

与信時プッシュ先URL

URL 最大桁数:256

決済申込、再与信要求および与信変更要求が成立（成功または失敗）した時に、結果通知電文をプッシュする先のURLを指定（クエリパラメータ指定可）
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
- 最大:256byte

##### Declaration

    [JsonProperty("authorizePushUrl")]
    public string AuthorizePushUrl { get; set; }

##### Property Value

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

#### CancelPushUrl

キャンセル時プッシュ先URL

URL 最大桁数:256

キャンセル要求、返金要求および解約要求の処理結果が確定（成功または失敗）した時に、結果通知電文をプッシュする先のURLを指定（クエリパラメータ指定可）
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
- 最大:256byte

##### Declaration

    [JsonProperty("cancelPushUrl")]
    public string CancelPushUrl { get; set; }

##### Property Value

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

#### CancelUrl

キャンセル時URL

URL 最大桁数:256

決済申込を消費者がキャンセルした時に、店舗側サイトに画面遷移を戻すためのURLを指定（クエリパラメータ指定可）
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
- 最大:256byte

##### Declaration

    [JsonProperty("cancelUrl")]
    public string CancelUrl { get; set; }

##### Property Value

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

#### CapturePushUrl

売上時プッシュ先URL

URL 最大桁数:256

売上要求の処理結果が確定（成功または失敗）した時に、結果通知電文をプッシュする先のURLを指定（クエリパラメータ指定可）
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
- 最大:256byte

##### Declaration

    [JsonProperty("capturePushUrl")]
    public string CapturePushUrl { get; set; }

##### Property Value

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

#### ConsentAuthType

承諾時決済タイプ

半角英数字 最大桁数:1

"0"：承諾のみ
"1"：与信＋承諾
※課金種別が都度決済の場合は 指定できません。
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

##### Declaration

    [JsonProperty("consentAuthType")]
    public string ConsentAuthType { get; set; }

##### Property Value

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

#### ErrorUrl

エラー時URL

URL 最大桁数:256

決済申込エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定（クエリパラメータ指定可）
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
- 最大:256byte

##### Declaration

    [JsonProperty("errorUrl")]
    public string ErrorUrl { get; set; }

##### Property Value

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

#### ExtendExpiration

与信期限延長フラグ

英字（boolean）

"true"： 延長する
"false"： 延長しない
※指定が無い場合は、延長しないとなります。
※課金種別が都度決済の場合のみ、指定可能。

##### Declaration

    [JsonProperty("extendExpiration")]
    public string ExtendExpiration { get; set; }

##### Property Value

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

#### FrequencyUnit

頻度（単位）

半角英数字 最大桁数:5

随時決済の頻度の単位（例：2週間毎であれば、単位はWeek、値は2）
"Year"：年
"Month"：月
"Week"：週
"Day"：日
※課金種別が都度決済の場合は 指定できません。
※課金種別が随時決済の場合は指定必須 。

##### Declaration

    [JsonProperty("frequencyUnit")]
    public string FrequencyUnit { get; set; }

##### Property Value

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

#### FrequencyValue

頻度（値）

半角数字 最大桁数:3

随時決済の頻度の値（例：2週間毎であれば、単位はWeek、値は2）
- 頻度（単位）毎に設定できる範囲が異なります。
"Year"：1のみ
"Month"：1～12
"Week"：1～52
"Day"：1～365
※課金種別が都度決済の場合は指定できません。
※課金種別が随時決済の場合は指定必須 。

##### Declaration

    [JsonProperty("frequencyValue")]
    public string FrequencyValue { 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

#### NoteToBuyer

注文説明

文字列 最大桁数:255

購入者のメールに表示される注文の説明
- 最大:255文字

##### Declaration

    [JsonProperty("noteToBuyer")]
    public string NoteToBuyer { get; set; }

##### Property Value

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

#### OrderId

取引ID

半角英数字 最大桁数:100

- マーチャント側で取引を一意に表す注文管理IDを指定します。
- 申込処理ごとに一意である必要があります。
- 半角英数字、“-”（ハイフン）、“_”（アンダースコア）も使用可能です。

##### Declaration

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

##### Property Value

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

#### PayConfirmScreenType

決済確認画面種別

文字列 最大桁数:1

加盟店用の決済確認画面を利用するかの種別。
"0"：DGFT決済確認画面利用
"1"：加盟店決済確認画面利用
※未指定の場合は、"0"：DGFT決済確認画面利用となります。

##### Declaration

    [JsonProperty("payConfirmScreenType")]
    public string PayConfirmScreenType { get; set; }

##### Property Value

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

#### PayConfirmScreenUrl

決済確認画面URL

URL 最大桁数:256

決済確認画面へ遷移するためのURL
※決済確認画面種別が"1"かつ決済確認画面URLが未指定の場合は、エラーとする。
- 最大:256byte

##### Declaration

    [JsonProperty("payConfirmScreenUrl")]
    public string PayConfirmScreenUrl { get; set; }

##### Property Value

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

#### PlatformId

プラットフォームID

文字列 最大桁数:21

Amazonから指定のあった場合のみ設定する予定の項目
- 最大:21byte

##### Declaration

    [JsonProperty("platformId")]
    public string PlatformId { 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

#### SuccessUrl

完了時URL

URL 最大桁数:256

決済申込成功時に、店舗側サイトに画面遷移を戻すためのURLを指定（クエリパラメータ指定可）
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
- 最大:256byte

##### Declaration

    [JsonProperty("successUrl")]
    public string SuccessUrl { get; set; }

##### Property Value

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

#### SuppressShippingAddressView

配送先表示抑止フラグ

英字（boolean）

"true"： 配送先非表示
"false"： 配送先表示
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

##### Declaration

    [JsonProperty("suppressShippingAddressView")]
    public string SuppressShippingAddressView { get; set; }

##### Property Value

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

#### WithCapture

与信同時売上フラグ

英字（boolean）

"true"： 与信同時売上
"false"： 与信のみ
※指定が無い場合は、与信のみとなります。

##### Declaration

    [JsonProperty("withCapture")]
    public string WithCapture { get; set; }

##### Property Value

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

### Methods

#### ToString()

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

##### Declaration

    public override string ToString()

##### Returns

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

##### Overrides

object.ToString()

### Implements

IRequestDto