Struct CreateCharge 

pub struct CreateCharge { /* private fields */ }

トークンIDまたはカードを保有している顧客IDを指定して支払いを作成します。. テスト用のキーでは、本番用の決済ネットワークへは接続されず、実際の請求が行われることもありません。. 本番用のキーでは、決済ネットワークで処理が行われ、実際の請求が行われます。.

支払いを確定せずに、カードの認証と支払い額のみ確保する場合は、 capture に false を指定してください。. このとき expiry_days を指定することで、認証の期間を定めることができます。 expiry_days はデフォルトで7日となっており、1日~60日の間で設定が可能です。なお60日に設定した場合、認証期限は59日後の11:59PM(日本時間)までになります。また確保されました与信枠は、expiry_days で設定されました期間を過ぎると解放されるようなっております。.

three_d_secure にtrueを指定することで、3Dセキュアを開始できます。 指定した場合、支払いオブジェクトは作成されますが実際の決済処理は保留された状態になります。. 保留中の支払いは、引数指定の内容に関わらずcapturedはfalse、captured_atはnull、expired_atはnullと表示されます。. なお、支払い作成から30分を経過すると、3Dセキュアフローはタイムアウトし、処理が進められなくなります。. 3Dセキュアの進め方は、 支払いで3Dセキュアを実施する を参照してください。.

Implementations

impl CreateCharge

pub fn new() -> Self

Construct a new CreateCharge.

pub fn amount(self, amount: impl Into<i64>) -> Self

50~9,999,999の整数

pub fn capture(self, capture: impl Into<bool>) -> Self

支払い処理を確定するかどうか

pub fn card(self, card: impl Into<String>) -> Self

トークンIDまたはカードID

pub fn currency(self, currency: impl Into<String>) -> Self

3文字のISOコード(現状 “jpy” のみサポート)

pub fn customer(self, customer: impl Into<String>) -> Self

顧客ID

pub fn description(self, description: impl Into<String>) -> Self

概要

pub fn expiry_days(self, expiry_days: impl Into<u32>) -> Self

認証状態が失効するまでの日数

pub fn metadata(self, metadata: impl Into<Value>) -> Self

キーバリューの任意データ

pub fn platform_fee(self, platform_fee: impl Into<i64>) -> Self

PAY.JP Platform のみ設定可能

プラットフォーマーに振り分けられる入金金額。

pub fn product(self, product: impl Into<String>) -> Self

プロダクトID

pub fn tenant(self, tenant: impl Into<String>) -> Self

PAY.JP Platform のみ設定可能

テナントID

pub fn three_d_secure(self, three_d_secure: impl Into<bool>) -> Self

3Dセキュアを行うならtrue

impl CreateCharge

pub async fn send<C: PayjpClient>( &self, client: &C, ) -> Result<<Self as PayjpRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: BlockingClient>( &self, client: &C, ) -> Result<<Self as PayjpRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CreateCharge

fn clone(&self) -> CreateCharge

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCharge

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateCharge

fn default() -> Self

Returns the “default value” for a type.

impl PayjpRequest for CreateCharge

type Output = Charge

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizablePayjpRequest<Self::Output>

Convert to a builder allowing per-request customization.

impl Serialize for CreateCharge

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.