Stripe: Customer, Destination Charge
Stripe: Customer, Destination Charge
Creates the Charge object with Transfer Amount to charge the Customer ID for any amount in any currency. Any Connected Account as the Transfer Destination, any Transfer Amount within the Charge amount are available. If fails, the object is not created.
Configs
  • U: Select HTTP_Authz Setting *
  • B: Set Cusomer ID *#{EL}
  • C1: Set Charge Amount in positive integer *#{EL}
  • C2: Set Currency Code (e.g. “USD” “JPY” “EUR” etc) *#{EL}
  • C3: Set Charge Description (Registration Num, Corp Name, etc) *#{EL}
  • C4: Set Transfer Destination (e.g. “acct_1234567890abcdef”) *#{EL}
  • C5: Set Transfer Amount in positive integer *#{EL}
  • D1: Select STRING DATA for Stripe Charge ID (update)
  • D2: Select STRING DATA for Card Brand (update)
  • D3: Select STRING DATA for Card Last4 (update)
  • D4: Select STRING/YMDATE for Card Exp (update)
Script (click to open)
// GraalJS Script (engine type: 2)

//////// START "main()" /////////////////////////////////////////////////////////////////

main();
function main(){ 

//// == Config Retrieving / 工程コンフィグの参照 ==
const strAuthzSetting     = configs.get      ( "AuthzConfU" );   /// REQUIRED
  engine.log( " AutomatedTask Config: Authz Setting: " + strAuthzSetting );
const strCustomerId    = configs.get( "strSetConfB"  ); // required
let   strChargeAmount  = configs.get( "strSetConfC1" ); // required
const strCurrencyCode  = configs.get( "strSetConfC2" ); // required
const strChargeDescr   = configs.get( "strSetConfC3" ); // required
const strTransferDest   = configs.get( "strSetConfC4" ); // required
let   strTransferAmount = configs.get( "strSetConfC5" ); // required
const pocketChargeId   = configs.getObject( "SelectConfD1" ); // not
const pocketCardBrand  = configs.getObject( "SelectConfD2" ); // not
const pocketCardLast4  = configs.getObject( "SelectConfD3" ); // not
const pocketCardExp    = configs.getObject( "SelectConfD4" ); // not *STRING/YMDATE

if( strCustomerId === "" ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {Customer ID B} is empty \n" );
}
if( strChargeAmount === "" ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {ChargeAmount C1} is empty \n" );
}
if( strCurrencyCode === "" ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {CurrencyCode C2} is empty \n" );
}
if( strChargeDescr === "" ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {ChargeDescription C3} is empty \n" );
}
if( strTransferDest === "" ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {TransferDestination C4} is empty \n" );
}
if( strTransferAmount === "" ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {TransferAmount C5} is empty \n" );
}

strChargeAmount = strChargeAmount.replace(/,/g, '').replace(/\./g, '');
let numChargeAmount = parseInt( strChargeAmount, 10 );
if( numChargeAmount <= 0 ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {ChargeAmount C1} must be positive \n" );
}
strChargeAmount = numChargeAmount + "";

strTransferAmount = strTransferAmount.replace(/,/g, '').replace(/\./g, '');
let numTransferAmount = parseInt( strTransferAmount, 10 );
if( numTransferAmount <= 0 ){
  throw new Error( "\n AutomatedTask ConfigError:" +
                   " Config {TransferAmount C5} must be positive \n" );
}
strTransferAmount = numTransferAmount + "";


//// == Data Retrieving / ワークフローデータの参照 ==
// (nothing, except Expression Language config)


//// == Calculating / 演算 ==
/// Create Charge Object
/// POST /v1/charges
// https://stripe.com/docs/api/charges/create
// https://stripe.com/docs/api/authentication
// If you need to authenticate via bearer auth (e.g., for a cross-origin request), 
// use -H "Authorization: Bearer sk_xxx" instead of -u sk_test_xxx.

// preparing for API Request
let apiUri = "https://api.stripe.com/v1/charges";
let apiRequest = httpClient.begin(); // HttpRequestWrapper
    apiRequest = apiRequest.authSetting( strAuthzSetting ); // with "Authorization: Bearer XX"
    // https://questetra.zendesk.com/hc/en-us/articles/360024574471-R2300#HttpRequestWrapper
    apiRequest = apiRequest.formParam( "customer",    strCustomerId   );
    apiRequest = apiRequest.formParam( "amount",      strChargeAmount );
    apiRequest = apiRequest.formParam( "currency",    strCurrencyCode );
    apiRequest = apiRequest.formParam( "description", strChargeDescr  );
    apiRequest = apiRequest.formParam( "transfer_data[amount]", strTransferAmount );
    apiRequest = apiRequest.formParam( "transfer_data[destination]", strTransferDest );


// throwing Request to the API (POST, GET, PUT, etc)
engine.log( " AutomatedTask Trying: POST " + apiUri );
const response = apiRequest.post( apiUri );
const responseCode = response.getStatusCode() + "";
engine.log( " AutomatedTask ApiResponse: Status " + responseCode );
if( responseCode !== "200"){
  throw new Error( "\n AutomatedTask UnexpectedResponseError: " +
                    responseCode + "\n" + response.getResponseAsString() + "\n" );
} // C.F. https://stripe.com/docs/api/errors

// parsing Response Json
const responseStr = response.getResponseAsString() + "";
//engine.log( " DEBUG for api upgrade: \n" + responseStr );
const responseObj = JSON.parse( responseStr );
engine.log( " AutomatedTask ApiResponse:" +
            " New ChargeObject ID: " + responseObj.id );
engine.log( " AutomatedTask ApiResponse:" +
            " Card Brand: " + responseObj.source.brand );


//// == Data Updating / ワークフローデータへの代入 ==
if( pocketChargeId !== null ){ // STRING
  engine.setData( pocketChargeId, responseObj.id );
}
if( pocketCardBrand !== null ){ // STRING
  engine.setData( pocketCardBrand, responseObj.source.brand );
}
if( pocketCardLast4 !== null ){ // STRING
  engine.setData( pocketCardLast4, responseObj.source.last4 );
}
if( pocketCardExp !== null ){ // STRING or YMDATE
  if( pocketCardExp.matchDataType( "STRING" ) ){
    engine.setData( pocketCardExp, 
         ("0" + responseObj.source.exp_month).slice(-2) + "/" +
         responseObj.source.exp_year );
  }else{
    engine.setData( pocketCardExp, 
         java.sql.Date.valueOf(
           responseObj.source.exp_year + "-" +
           ("0" + responseObj.source.exp_month).slice(-2) + "-01"
         )
    );
  }
}

} //////// END "main()" /////////////////////////////////////////////////////////////////


/*

Notes-en:
- Can include the automated step "charging process" into the workflow. (No code)
    - When the matter reaches, a charging request is automatically sent to the Stripe API.
    - https://stripe.com/docs/api/charges
- A positive integer representing how much to charge in the smallest currency unit
    - e.g., "100" cents to charge $1.00
    - e.g., "100" to charge \100 (a zero-decimal currency) (JPY)
    - "#{#q_numUsdWithoutCent}00" is also possible if numerical data without auxiliary info
- If present, commas "," and periods "." are removed in advance
    - When using numeric data, be careful of the number of digits after the decimal point
- If the Charging is successful, the Transfer Amount will be sent to the Connected Account.
    - https://stripe.com/docs/connect/destination-charges

APPENDIX-en:
- Numeric parsing depends on JavaScript parseInt(x,10). (The prefix gives an error)
    - See below for more information on available currency codes (JPY, USD, EUR, ...).
    - https://stripe.com/docs/currencies
- In case of USD, the minimum amount is $0.50 or equivalent.
    - The amount value supports up to eight digits (e.g., for a USD charge of $999,999.99)
- Refer to the following for the error codes (ResponseCode other than 200)
    - https://stripe.com/docs/api/errors
- Transfer Amount is also expressed in the smallest currency unit (Positive integer).
    - Exceeding the Charge amount will result in an error
        - `destination[amount]` must be less than or equal to the charge amount
- Charges by the Connect Destination method (for Express/Custom type).
    - https://stripe.com/docs/connect/destination-charges#transfer-amount
    - Connected Account (child account) must be registered in advance on Stripe.
- You can get the link for Express account registration from the Stripe admini page.
    - Give the link to the recipient of the Transfer Amount. (Link expiration date 7 days)
    - Once the deposit account etc is registered, the Connect (onboarding) process will be completed.

Notes-ja:
- ワークフロー内に自動工程『課金処理』を組み込むことができるようになります。(ノーコード実装)
    - 案件が自動工程に到達すると、Stripe API に対して課金リクエストが自動送信されます。
    - https://stripe.com/docs/api/charges
- 課金額の設定は、最小の通貨単位で表現します。(正の整数)
    - "1.00ドル" の場合は "100" セント (USD)
    - 小数のない円通貨の場合は "100円" は "100" 円 (JPY)
    - "1(ドル)" といったデータの場合 "#{#q_numUsdWithoutCent}00" のように設定します。
- もしカンマ "," やピリオド "." が存在する場合は課金処理前に除去されます。
    - 数値型データの小数を使う場合、小数点以下の桁数設定に注意
    - "100.00円" は「1万円」の課金になります。
- 課金が成功すれば、分配金が Connected Account(子アカウント)に仕向送金されます。
    - https://stripe.com/docs/connect/destination-charges

APPENDIX-ja:
- 数値判定は JavaScript parseInt(x,10) に依存します (接頭辞はエラーになります)
    - 利用できる通貨コードの詳細は以下を参照してください (JPY, USD, EUR, ...)
    - https://stripe.com/docs/currencies
- 最小課金金額は、日本円の場合、50円です。
    - 課金額の最大桁数は8桁です。(日本円の場合、99,999,999円)
- エラーコード(200以外のResponseCode)の内容については以下を参照してください。
    - https://stripe.com/docs/api/errors
- 分配金額の設定も、最小の通貨単位で表現します。(正の整数)
    - 課金額を超える設定はエラーとなります
        - `destination[amount]` must be less than or equal to the charge amount
- Connect Destination 方式(Express/Customタイプ向け)で課金されます。
    - https://stripe.com/docs/connect/destination-charges#transfer-amount
    - Connected Account(子アカウント)は、予め Stripe 上で登録されている必要があります。
- Express アカウント登録用のリンクは、Stripe 管理画面から取得できます。
    - 分配金を受け取る方(子アカウントのユーザ)にリンクを伝えます。(リンク有効期限7日)
    - 入金用口座等が登録されれば、Connect連結プロセス(オンボーディングプロセス)が完了します。
*/

Download

2021-06-08 (C) Questetra, Inc. (MIT License)
https://support.questetra.com/addons/stripe-customer-destination-charge-2021/
The Addon-import feature is available with Professional edition.

Notes

  • Can include the automated step “charging process” into the workflow. (No code)
  • A positive integer representing how much to charge in the smallest currency unit
    • e.g., “100” cents to charge $1.00
    • e.g., “100” to charge \100 (a zero-decimal currency) (JPY)
    • #{#q_numUsdWithoutCent}00” is also possible if numerical data without auxiliary info
  • If present, commas “,” and periods “.” are removed in advance
    • When using numeric data, be careful of the number of digits after the decimal point
  • If the Charging is successful, the Transfer Amount will be sent to the Connected Account.

Capture

Creates the Charge object with Transfer Amount to charge the Customer ID for any amount in any currency. Any Connected Account as the Transfer Destination, any Transfer Amount within the Charge amount are available. If fails, the object not created.
Creates the Charge object with Transfer Amount to charge the Customer ID for any amount in any currency. Any Connected Account as the Transfer Destination, any Transfer Amount within the Charge amount are available. If fails, the object not created.

Appendix

  • Numeric parsing depends on JavaScript parseInt(x,10). (The prefix gives an error)
  • In case of USD, the minimum amount is $0.50 or equivalent.
    • The amount value supports up to eight digits (e.g., for a USD charge of $999,999.99)
  • Refer to the following for the error codes (ResponseCode other than 200)
  • Transfer Amount is also expressed in the smallest currency unit (Positive integer).
    • Exceeding the Charge amount will result in an error
      • destination[amount] must be less than or equal to the charge amount
  • Charges by the Connect Destination method (for Express/Custom type).
  • You can get the link for Express account registration from the Stripe admini page.
    • Give the link to the recipient of the Transfer Amount. (Link expiration date 7 days)
    • Once the deposit account etc is registered, the Connect (onboarding) process will be completed.

See also

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: