Skip to content

Commit ea9e8e3

Browse files
Aswinsharon20383008Aswinsharon20383008
authored
V24.2.0 shipping query (#51)
* Shipping method quey * Document updates
1 parent 8341851 commit ea9e8e3

13 files changed

Lines changed: 39 additions & 17 deletions

‎.env‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ PAYMENT_GATEWAY_MERCHANT_ID =
99
PAYMENT_GATEWAY_MERCHANT_KEY_ID =
1010
PAYMENT_GATEWAY_MERCHANT_SECRET_KEY =
1111

12-
PAYMENT_GATEWAY_SHIPPING_METHOD =
13-
1412
PAYMENT_GATEWAY_TARGET_ORIGINS =
1513
PAYMENT_GATEWAY_VERIFICATION_KEY =
1614
PAYMENT_GATEWAY_CC_ALLOWED_CARD_NETWORKS =

‎docs/API-Extension-Setup.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ Variables that begin with 'CT' prefix are Commercetools project specific propert
2222
| PAYMENT_GATEWAY_MERCHANT_ID | Your Cybersource merchant Id | Provided by Cybersource |
2323
| PAYMENT_GATEWAY_MERCHANT_KEY_ID | Id of a Cybersource shared secret key to be used for HTTP Signature authentication | Created in [key-Creation\#Cybersource](Key-Creation.md#Cybersource). |
2424
| PAYMENT_GATEWAY_MERCHANT_SECRET_KEY | Value of a Cybersource shared secret key to be used for HTTP Signature authentication | Created in [key-Creation\#Cybersource](key-Creation.md#Cybersource). |
25-
| PAYMENT_GATEWAY_SHIPPING_METHOD | Shipping method to be passed in shipTo.method field | The value should be any of the following: lowcost, sameday, oneday, twoday, threeday, pickup, other or none. |
2625
| PAYMENT_GATEWAY_TARGET_ORIGINS | Base URLs where your frontend will be accessible | Used for Card payment method. Comma separated value without any spaces |
2726
| PAYMENT_GATEWAY_VERIFICATION_KEY | Used to check Flex tokens for tampering | Use <b>Openssl -rand64 32 </b>command to generate verification key |
2827
| PAYMENT_GATEWAY_CC_ALLOWED_CARD_NETWORKS | csv(comma separated value) of the card networks | If not specified extension will support all the card networks(VISA, MASTERCARD, AMEX, DISCOVER, MAESTRO, CUP, JCB, CARTESBANCAIRES & DINERSCLUB) by default. Case sensitive. Accepts block letters only without any spaces – eg: VISA,AMEX |

‎docs/Commercetools-Setup.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ Fields
159159
| isv_CVVResponse | String | false ||
160160
| isv_responseCode | String | false ||
161161
| isv_dmpaFlag | Boolean | false ||
162+
| isv_shippingMethod | String | false ||
162163

163164
### Payer Authentication enrolment check
164165

‎docs/Process-a-Card-Payment-With-Payer-Authentication.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ After authentication is complete, authorization of the payment can then be tri
9090
| custom.fields.isv_cardExpiryYear | Card expiry year | No | Can be obtained from the token parameter passed into the callback for the microform.createToken call. The token is a JWT which when decoded has a `flexData.content.paymentInformation.card.expirationYear.value` field containing the card type <br><br> Not required by the extension but used for display |
9191
| custom.fields.isv_deviceFingerprintId | Customer device fingerprint Id | Yes | Refer [Device Fingerprinting](./Decision-Manager.md#device-fingerprinting) to generate this value |
9292
| custom.fields.isv_saleEnabled | false | Yes | Set the value to true if sale is enabled |
93+
| custom.fields.isv_shippingMethod | Shipping method for the order | No | Possible values: <ul> <li> `lowcost`: Lowest-cost service </li> <li>`sameday`: Courier or same-day service </li> <li>`oneday`: Next-day or overnight service </li> <li>`twoday`: Two-day service </li> <li>`threeday`: Three-day service.</li> <li> `pickup`: Store pick-up </li> <li> `other`: Other shipping method </li> <li> `none`: No shipping method because product is a service or subscription </li> |
9394

9495

9596
c. For saved token, when the payment is being updated, the extension will do a Payer Auth Setup call to get reference_id for Digital Wallets to use in place of BIN number in Cardinal.
@@ -101,6 +102,7 @@ After authentication is complete, authorization of the payment can then be tri
101102
| custom.fields.isv_cardExpiryMonth | Card expiry month | No | custom.fields.isv_tokens's "cardExpiryMonth" value from Customer object <br>Not required by the extension but used for display |
102103
| custom.fields.isv_cardExpiryYear | Card expiry year | No | custom.fields.isv_tokens's "cardExpiryYear" value from Customer object <br>Not required by the extension but used for display |
103104
| custom.fields.isv_deviceFingerprintId | Customer device fingerprint Id | Yes | Refer [Device Fingerprinting](./Decision-Manager.md#device-fingerprinting) to generate this value |
105+
| custom.fields.isv_shippingMethod | Shipping method for the order | No | Possible values: <ul> <li> `lowcost`: Lowest-cost service </li> <li>`sameday`: Courier or same-day service </li> <li>`oneday`: Next-day or overnight service </li> <li>`twoday`: Two-day service </li> <li>`threeday`: Three-day service.</li> <li> `pickup`: Store pick-up </li> <li> `other`: Other shipping method </li> <li> `none`: No shipping method because product is a service or subscription </li> |
104106

105107

106108
6. Wait for the event to return back the following fields, verify them from update response. If the data exists for below fields, submit the device data collection form using below data, else throw error to the user. See [Device Data Collection](https://developer.cybersource.com/docs/cybs/en-us/payer-authentication/developer/all/rest/payer-auth/pa2-ccdc-ddc-intro.html) to get more details about device data collection Iframe
@@ -200,4 +202,4 @@ See [Commercetools Setup](Commercetools-Setup.md) for more details on the indiv
200202

201203
## Further reading
202204

203-
- [Cybersource Payer Authentication documentation](https://developer.cybersource.com/docs/cybs/en-us/payer-authentication/developer/all/rest/payer-auth/pa-revisions.html)
205+
- [Cybersource Payer Authentication documentation](https://developer.cybersource.com/docs/cybs/en-us/payer-authentication/developer/all/rest/payer-auth/pa-revisions.html)

‎docs/Process-a-Card-Payment-Without-Payer-Authentication.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Processing of a payment is triggered by adding an initial transaction to a Comme
8989
| custom.fields.isv_deviceFingerprintId | Customer device fingerprint Id | Yes | Should pass this field to extension, if Decision Manager is enabled.Refer [Device Fingerprinting](./Decision-Manager.md#device-fingerprinting) to generate this value |
9090
| custom.fields.isv_customerIpAddress | Customer IP address | No | Populated from client-side libraries |
9191
| custom.fields.isv_saleEnabled | false | Yes | Set the value to true if sale is enabled |
92+
| custom.fields.isv_shippingMethod | Shipping method for the order | No | Possible values: <ul> <li> `lowcost`: Lowest-cost service </li> <li>`sameday`: Courier or same-day service </li> <li>`oneday`: Next-day or overnight service </li> <li>`twoday`: Two-day service </li> <li>`threeday`: Three-day service.</li> <li> `pickup`: Store pick-up </li> <li> `other`: Other shipping method </li> <li> `none`: No shipping method because product is a service or subscription </li> |
9293

9394
6. Add a transaction to the payment with the following values populated
9495

@@ -120,4 +121,4 @@ Processing of a payment is triggered by adding an initial transaction to a Comme
120121

121122
When a token is saved as a subscription the saved token value will be returned as a custom property on the payment called isv_savedToken.
122123

123-
See [Commercetools Setup](Commercetools-Setup.md) for more details on the individual fields.
124+
See [Commercetools Setup](Commercetools-Setup.md) for more details on the individual fields.

‎docs/Process-a-Payment-ApplePay.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
| custom.fields.isv_customerIpAddress | Customer IP address | Yes | Populated from client-side libraries |
5959
| custom.fields.isv_saleEnabled | false | Yes | Set the value to true if sale is enabled |
6060
| custom.fields.isv_walletType | Wallet type | No | This value is required if walletType is to be passed in authorization. Refer [Cybersource Processing a Payment](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments_process-a-payment) for more information about the wallet type value to be passed. It is supported only for ApplePay, ClicktoPay and GooglePay payment methods|
61+
|custom.fields.isv_shippingMethod | Shipping method for the order | No | Possible values: <ul> <li> `lowcost`: Lowest-cost service </li> <li>`sameday`: Courier or same-day service </li> <li>`oneday`: Next-day or overnight service </li> <li>`twoday`: Two-day service </li> <li>`threeday`: Three-day service.</li> <li> `pickup`: Store pick-up </li> <li> `other`: Other shipping method </li> <li> `none`: No shipping method because product is a service or subscription </li> |
6162

6263
4. Add the payment to the cart
6364

@@ -88,4 +89,4 @@
8889

8990
b. If the state of transaction is updated to **Pending** which is due to Fraud Check, display the order confirmation page
9091

91-
c. If the state of transaction is updated to **Failure**, display the error page and See [Overview\#Errorhandling](Overview.md#error-handling) for handling errors or failures
92+
c. If the state of transaction is updated to **Failure**, display the error page and See [Overview\#Errorhandling](Overview.md#error-handling) for handling errors or failures

‎docs/Process-a-Payment-ClicktoPay.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ The shipping address should be acquired from Visa Click to Pay. This can be set
4848
| custom.fields.isv_saleEnabled | false | Yes | Set the value to true if sale is enabled |
4949
| custom.fields.isv_walletType | Wallet type | No | This value is required if walletType is to be passed in authorization. Refer [Cybersource Processing a Payment](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments_process-a-payment) for more information about the wallet type value to be passed. It is supported only for ApplePay, ClicktoPay and GooglePay payment methods|
5050
| custom.fields.isv_merchantId | Merchant Id used for the transaction | No | Required when you want to support Multi-Mid functionality. Populate this field with the value of merchant Id in which the transaction should happen. When this field is empty, default mid configuration will be considered for the transaction. The same mid will be used for the follow-on transactions. |
51+
| custom.fields.isv_shippingMethod | Shipping method for the order | No | Possible values: <ul> <li> `lowcost`: Lowest-cost service </li> <li>`sameday`: Courier or same-day service </li> <li>`oneday`: Next-day or overnight service </li> <li>`twoday`: Two-day service </li> <li>`threeday`: Three-day service.</li> <li> `pickup`: Store pick-up </li> <li> `other`: Other shipping method </li> <li> `none`: No shipping method because product is a service or subscription </li> |
5152

5253
3. Add the payment to the cart
5354

@@ -77,4 +78,4 @@ The shipping address should be acquired from Visa Click to Pay. This can be set
7778

7879
b. If the state of transaction is updated to **Pending** which is due to Fraud Check, display the order confirmation page
7980

80-
c. If the state of transaction is updated to **Failure**, display the error page and See [Overview\#Errorhandling](Overview.md#error-handling) for handling errors or failures
81+
c. If the state of transaction is updated to **Failure**, display the error page and See [Overview\#Errorhandling](Overview.md#error-handling) for handling errors or failures

‎docs/Process-a-Payment-GooglePay.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929
| custom.fields.isv_customerIpAddress | Customer IP address | Yes | Populated from client-side libraries |
3030
| custom.fields.isv_saleEnabled | false | Yes | Set the value to true if sale is enabled |
3131
| custom.fields.isv_walletType | Wallet type | No | This value is required if walletType is to be passed in authorization. Refer [Cybersource Processing a Payment](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments_process-a-payment) for more information about the wallet type value to be passed. It is supported only for ApplePay, ClicktoPay and GooglePay payment methods|
32-
| custom.fields.isv_merchantId | Merchant Id used for the transaction | No | Required when you want to support Multi-Mid functionality. Populate this field with the value of merchant Id in which the transaction should happen. When this field is empty, default mid configuration will be considered for the transaction. The same mid will be used for the follow-on transactions. |
32+
| custom.fields.isv_merchantId | Merchant Id used for the transaction | No | Required when you want to support Multi-Mid functionality. Populate this field with the value of merchant Id in which the transaction should happen. When this field is empty, default mid configuration will be considered for the transaction. The same mid will be used for the follow-on transactions. |
33+
| custom.fields.isv_shippingMethod | Shipping method for the order | No | Possible values: <ul> <li> `lowcost`: Lowest-cost service </li> <li>`sameday`: Courier or same-day service </li> <li>`oneday`: Next-day or overnight service </li> <li>`twoday`: Two-day service </li> <li>`threeday`: Three-day service.</li> <li> `pickup`: Store pick-up </li> <li> `other`: Other shipping method </li> <li> `none`: No shipping method because product is a service or subscription </li> |
3334

3435
3. Add the payment to the cart
3536

@@ -60,4 +61,4 @@
6061

6162
b. If the state of transaction is updated to **Pending** which is due to Fraud Check, display the order confirmation page
6263

63-
c. If the state of transaction is updated to **Failure**, display the error page and See [Overview\#Errorhandling](Overview.md#error-handling) for handling errors or failures
64+
c. If the state of transaction is updated to **Failure**, display the error page and See [Overview\#Errorhandling](Overview.md#error-handling) for handling errors or failures

0 commit comments

Comments
 (0)