Show / Hide Table of Contents

# Class PaypalCaptureRequestDto

決済サービスタイプ：Paypal、コマンド名：売上の要求Dtoクラス

##### Inheritance

object
MdkDtoBase
AbstractPaymentRequestDto
PaypalCaptureRequestDto

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

### Properties

#### Action

アクションタイプ

半角英数字 10 文字以内

set: 売上請求処理 get: 売上請求確認処理 do : 売上請求完了処理 capture : 売上請求完了処理 　※"capture"は 与信を行った場合にのみ、実行可能

##### Declaration

    [JsonProperty("action")]
    public string Action { get; set; }

##### Property Value

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

#### Amount

取引金額

半角数字

日本円を設定します。 ただし、$10,000 USD を上限とした金額を設定します。

##### Declaration

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

##### Property Value

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

#### CancelUrl

取消URL

半角英数字 1024文字以内

消費者がPayPal上で支払いをキャンセルした場合に遷移するマーチャントのURLを設定します。 半角英数字のほかに、URLとして使用できる文字を使用できます。（"."など）

##### Declaration

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

##### Property Value

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

#### HeaderImageUrl

ヘッダーイメージURL

半角英数字 127文字以内

PayPal画面のヘッダーに表示する画像のURLを設定します。 半角英数字のほかに、URLとして使用できる文字を使用できます。（"."など）

##### Declaration

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

#### OptionParams

拡張パラメータリスト

##### Declaration

    [JsonProperty("optionParams")]
    public OptionParams[] OptionParams { get; set; }

##### Property Value

Type | Description
--- | ---
OptionParams[] |

#### OrderDescription

オーダー説明

文字列 127Byte以内

商品の説明を設定します。 ※文字コードは"UTF-8"とします。

##### Declaration

    [JsonProperty("orderDescription")]
    public string OrderDescription { get; set; }

##### Property Value

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

#### OrderId

取引ID

半角英数字 100 文字以内

決済請求、予授権完了時に採番した取引IDを指定指定します。 “.”（ドット）、“-”（ハイフン）、“_”（アンダースコア）も使用できます。

##### Declaration

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

##### Property Value

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

#### PayerId

顧客番号

半角英数字 13文字以内

顧客番号を設定します。 PayPalから処理が戻ってきたとき、URL（戻り先URL）に付加されています。

##### Declaration

    [JsonProperty("payerId")]
    public string PayerId { get; set; }

##### Property Value

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

#### ReturnUrl

戻り先URL

半角英数字 1024文字以内

消費者がPayPal上での操作が完了したときの遷移するマーチャントのURLを設定します。 半角英数字のほかに、URLとして使用できる文字を使用できます。（"."など）

##### Declaration

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

#### ShipCity

配送先市区町村名

文字列 40Byte以内

配送先市区町村名を設定します。 ※文字コードは"UTF-8"とします。 配送先フラグに"1"を設定した場合は必須。

##### Declaration

    [JsonProperty("shipCity")]
    public string ShipCity { get; set; }

##### Property Value

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

#### ShipCountry

配送先国コード

半角英数字 2文字以内

配送先コードを設定します。

##### Declaration

    [JsonProperty("shipCountry")]
    public string ShipCountry { get; set; }

##### Property Value

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

#### ShipName

配送先氏名

文字列 32Byte以内

配送先氏名を設定します。 ※文字コードは"UTF-8"とします。 配送先フラグに"1"を設定した場合は必須。

##### Declaration

    [JsonProperty("shipName")]
    public string ShipName { get; set; }

##### Property Value

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

#### ShipPhone

配送先電話番号

半角英数字 20文字以内

配送先電話番号を設定します。 全角文字を除く文字列を設定します。

##### Declaration

    [JsonProperty("shipPhone")]
    public string ShipPhone { get; set; }

##### Property Value

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

#### ShipPostalCode

配送先郵便番号

半角英数字 20文字以内

配送先郵便番号を設定します。 全角文字を除く文字列を設定します。 配送先フラグに"1"を設定した場合は必須。

##### Declaration

    [JsonProperty("shipPostalCode")]
    public string ShipPostalCode { get; set; }

##### Property Value

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

#### ShipState

配送先州名

文字列 40Byte以内

配送先州名を設定します。 ※文字コードは"UTF-8"とします。

##### Declaration

    [JsonProperty("shipState")]
    public string ShipState { get; set; }

##### Property Value

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

#### ShipStreet1

配送先住所１

文字列 100Byte以内

配送先住所１を設定します。 ※文字コードは"UTF-8"とします。 配送先フラグに"1"を設定した場合は必須。

##### Declaration

    [JsonProperty("shipStreet1")]
    public string ShipStreet1 { get; set; }

##### Property Value

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

#### ShipStreet2

配送先住所２

文字列 100Byte以内

配送先住所２を設定します。 ※文字コードは"UTF-8"とします。

##### Declaration

    [JsonProperty("shipStreet2")]
    public string ShipStreet2 { get; set; }

##### Property Value

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

#### ShippingFlag

配送先フラグ

半角英数字 1文字以内

配送先情報を有効とするかを設定します。 "0"： 配送先の設定を無効にする。 "1"： 配送先の設定を有効にする。

##### Declaration

    [JsonProperty("shippingFlag")]
    public string ShippingFlag { get; set; }

##### Property Value

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

#### Token

トークン

半角英数字 20文字以内

トークンを設定します。

##### Declaration

    [JsonProperty("token")]
    public string Token { get; set; }

##### Property Value

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

### Methods

#### ToString()

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

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
string | ログ用文字列(マスク済み)

##### Overrides

object.ToString()

### Implements

IRequestDto