@blockchyp/blockchyp-ts 2.28.0 → 2.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -70,6 +70,46 @@ These are the core payment APIs used to execute and work with payment transactio
70
70
 
71
71
 
72
72
 
73
+ #### Surcharge Review
74
+
75
+
76
+
77
+ * **API Credential Types:** Merchant
78
+ * **Required Role:** Payment API Access
79
+
80
+ This API calculates surcharge information for a payment request.
81
+
82
+ If you're using BlockChyp's surcharging features, you can use this endpoint
83
+ to preview the surcharge amounts before processing a transaction. This allows
84
+ you to display accurate pricing information to customers before completing
85
+ the payment.
86
+
87
+
88
+
89
+
90
+ ```typescript
91
+ import * as BlockChyp from '@blockchyp/blockchyp-ts';
92
+
93
+ const client = BlockChyp.newClient({
94
+ apiKey: 'ZDSMMZLGRPBPRTJUBTAFBYZ33Q',
95
+ bearerToken: 'ZLBW5NR4U5PKD5PNP3ZP3OZS5U',
96
+ signingKey: '9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947'
97
+ });
98
+
99
+ const request = new BlockChyp.PricingRequest();
100
+
101
+
102
+ client.surchargeReview(request)
103
+ .then(function(httpResponse) {
104
+ const response: BlockChyp.PricingResponse = httpResponse.data;
105
+ console.log('Response: ' + JSON.stringify(response));
106
+ })
107
+ .catch(function (error: any) {
108
+ console.log(error);
109
+ });
110
+
111
+ ```
112
+
73
113
  #### Charge
74
114
 
75
115