Skip to content

Commit 898205a

Browse files
Release 4.5.0
1 parent a38542f commit 898205a

File tree

83 files changed

+449
-362
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+449
-362
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,43 @@ let transactionService: PostFinanceCheckout.api.TransactionService = new PostFin
122122
transactionService.timeout = 15;
123123
```
124124

125+
### Integrating Webhook Payload Signing Mechanism into webhook callback handler
126+
127+
The HTTP request which is sent for a state change of an entity now includes an additional field `state`, which provides information about the update of the monitored entity's state. This enhancement is a result of the implementation of our webhook encryption mechanism.
128+
129+
Payload field `state` provides direct information about the state update of the entity, making additional API calls to retrieve the entity state redundant.
130+
131+
#### ⚠️ Warning: Generic Pseudocode
132+
133+
> **The provided pseudocode is intentionally generic and serves to illustrate the process of enhancing your API to leverage webhook payload signing. It is not a complete implementation.**
134+
>
135+
> Please ensure that you adapt and extend this code to meet the specific needs of your application, including appropriate security measures and error handling.
136+
For a detailed webhook payload signing mechanism understanding we highly recommend referring to our comprehensive
137+
[Webhook Payload Signing Documentation](https://checkout.postfinance.ch/doc/webhooks#_webhook_payload_signing_mechanism).
138+
```
139+
app.post('/webhook/callback', (req: Request, res: Response) => {
140+
const requestPayload: string = req.body;
141+
const signature: string | undefined = req.headers['x-signature'] as string;
142+
143+
if (!signature) {
144+
// Make additional API call to retrieve the entity state
145+
// ...
146+
} else {
147+
if (webhookEncryptionService().isContentValid(signature, requestPayload)) {
148+
// Parse requestPayload to extract 'state' value
149+
// Process entity's state change
150+
// ...
151+
}
152+
}
153+
154+
// Process the received webhook data
155+
// ...
156+
157+
});
158+
```
159+
160+
161+
125162
## License
126163

127164
Please see the [license file](https://github.com/pfpayments/typescript-sdk/blob/master/LICENSE) for more information.

package-lock.json

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "postfinancecheckout",
33
"title": "PostFinance Checkout",
4-
"version": "4.4.0",
4+
"version": "4.5.0",
55
"description": "TypeScript/JavaScript client for PostFinance Checkout",
66
"homepage": "http://github.com/pfpayments/typescript-sdk",
77
"repository": {

src/api/AccountService.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ class AccountService {
9494
Object.assign(headers, options.headers);
9595

9696
let defaultHeaders = {
97-
"x-meta-sdk-version": "4.4.0",
97+
"x-meta-sdk-version": "4.5.0",
9898
"x-meta-sdk-language": "typescript",
9999
"x-meta-sdk-provider": "PostFinance Checkout",
100100
"x-meta-sdk-language-version": this.getVersion(),
@@ -172,7 +172,7 @@ class AccountService {
172172
Object.assign(headers, options.headers);
173173

174174
let defaultHeaders = {
175-
"x-meta-sdk-version": "4.4.0",
175+
"x-meta-sdk-version": "4.5.0",
176176
"x-meta-sdk-language": "typescript",
177177
"x-meta-sdk-provider": "PostFinance Checkout",
178178
"x-meta-sdk-language-version": this.getVersion(),
@@ -255,7 +255,7 @@ class AccountService {
255255
Object.assign(headers, options.headers);
256256

257257
let defaultHeaders = {
258-
"x-meta-sdk-version": "4.4.0",
258+
"x-meta-sdk-version": "4.5.0",
259259
"x-meta-sdk-language": "typescript",
260260
"x-meta-sdk-provider": "PostFinance Checkout",
261261
"x-meta-sdk-language-version": this.getVersion(),
@@ -342,7 +342,7 @@ class AccountService {
342342
Object.assign(headers, options.headers);
343343

344344
let defaultHeaders = {
345-
"x-meta-sdk-version": "4.4.0",
345+
"x-meta-sdk-version": "4.5.0",
346346
"x-meta-sdk-language": "typescript",
347347
"x-meta-sdk-provider": "PostFinance Checkout",
348348
"x-meta-sdk-language-version": this.getVersion(),
@@ -424,7 +424,7 @@ class AccountService {
424424
Object.assign(headers, options.headers);
425425

426426
let defaultHeaders = {
427-
"x-meta-sdk-version": "4.4.0",
427+
"x-meta-sdk-version": "4.5.0",
428428
"x-meta-sdk-language": "typescript",
429429
"x-meta-sdk-provider": "PostFinance Checkout",
430430
"x-meta-sdk-language-version": this.getVersion(),
@@ -507,7 +507,7 @@ class AccountService {
507507
Object.assign(headers, options.headers);
508508

509509
let defaultHeaders = {
510-
"x-meta-sdk-version": "4.4.0",
510+
"x-meta-sdk-version": "4.5.0",
511511
"x-meta-sdk-language": "typescript",
512512
"x-meta-sdk-provider": "PostFinance Checkout",
513513
"x-meta-sdk-language-version": this.getVersion(),

src/api/AnalyticsQueryService.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class AnalyticsQueryService {
9797
Object.assign(headers, options.headers);
9898

9999
let defaultHeaders = {
100-
"x-meta-sdk-version": "4.4.0",
100+
"x-meta-sdk-version": "4.5.0",
101101
"x-meta-sdk-language": "typescript",
102102
"x-meta-sdk-provider": "PostFinance Checkout",
103103
"x-meta-sdk-language-version": this.getVersion(),
@@ -198,7 +198,7 @@ class AnalyticsQueryService {
198198
Object.assign(headers, options.headers);
199199

200200
let defaultHeaders = {
201-
"x-meta-sdk-version": "4.4.0",
201+
"x-meta-sdk-version": "4.5.0",
202202
"x-meta-sdk-language": "typescript",
203203
"x-meta-sdk-provider": "PostFinance Checkout",
204204
"x-meta-sdk-language-version": this.getVersion(),
@@ -289,7 +289,7 @@ class AnalyticsQueryService {
289289
Object.assign(headers, options.headers);
290290

291291
let defaultHeaders = {
292-
"x-meta-sdk-version": "4.4.0",
292+
"x-meta-sdk-version": "4.5.0",
293293
"x-meta-sdk-language": "typescript",
294294
"x-meta-sdk-provider": "PostFinance Checkout",
295295
"x-meta-sdk-language-version": this.getVersion(),
@@ -365,7 +365,7 @@ class AnalyticsQueryService {
365365
Object.assign(headers, options.headers);
366366

367367
let defaultHeaders = {
368-
"x-meta-sdk-version": "4.4.0",
368+
"x-meta-sdk-version": "4.5.0",
369369
"x-meta-sdk-language": "typescript",
370370
"x-meta-sdk-provider": "PostFinance Checkout",
371371
"x-meta-sdk-language-version": this.getVersion(),
@@ -451,7 +451,7 @@ class AnalyticsQueryService {
451451
Object.assign(headers, options.headers);
452452

453453
let defaultHeaders = {
454-
"x-meta-sdk-version": "4.4.0",
454+
"x-meta-sdk-version": "4.5.0",
455455
"x-meta-sdk-language": "typescript",
456456
"x-meta-sdk-provider": "PostFinance Checkout",
457457
"x-meta-sdk-language-version": this.getVersion(),
@@ -533,7 +533,7 @@ class AnalyticsQueryService {
533533
Object.assign(headers, options.headers);
534534

535535
let defaultHeaders = {
536-
"x-meta-sdk-version": "4.4.0",
536+
"x-meta-sdk-version": "4.5.0",
537537
"x-meta-sdk-language": "typescript",
538538
"x-meta-sdk-provider": "PostFinance Checkout",
539539
"x-meta-sdk-language-version": this.getVersion(),

src/api/ApplicationUserService.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ class ApplicationUserService {
9595
Object.assign(headers, options.headers);
9696

9797
let defaultHeaders = {
98-
"x-meta-sdk-version": "4.4.0",
98+
"x-meta-sdk-version": "4.5.0",
9999
"x-meta-sdk-language": "typescript",
100100
"x-meta-sdk-provider": "PostFinance Checkout",
101101
"x-meta-sdk-language-version": this.getVersion(),
@@ -173,7 +173,7 @@ class ApplicationUserService {
173173
Object.assign(headers, options.headers);
174174

175175
let defaultHeaders = {
176-
"x-meta-sdk-version": "4.4.0",
176+
"x-meta-sdk-version": "4.5.0",
177177
"x-meta-sdk-language": "typescript",
178178
"x-meta-sdk-provider": "PostFinance Checkout",
179179
"x-meta-sdk-language-version": this.getVersion(),
@@ -256,7 +256,7 @@ class ApplicationUserService {
256256
Object.assign(headers, options.headers);
257257

258258
let defaultHeaders = {
259-
"x-meta-sdk-version": "4.4.0",
259+
"x-meta-sdk-version": "4.5.0",
260260
"x-meta-sdk-language": "typescript",
261261
"x-meta-sdk-provider": "PostFinance Checkout",
262262
"x-meta-sdk-language-version": this.getVersion(),
@@ -343,7 +343,7 @@ class ApplicationUserService {
343343
Object.assign(headers, options.headers);
344344

345345
let defaultHeaders = {
346-
"x-meta-sdk-version": "4.4.0",
346+
"x-meta-sdk-version": "4.5.0",
347347
"x-meta-sdk-language": "typescript",
348348
"x-meta-sdk-provider": "PostFinance Checkout",
349349
"x-meta-sdk-language-version": this.getVersion(),
@@ -425,7 +425,7 @@ class ApplicationUserService {
425425
Object.assign(headers, options.headers);
426426

427427
let defaultHeaders = {
428-
"x-meta-sdk-version": "4.4.0",
428+
"x-meta-sdk-version": "4.5.0",
429429
"x-meta-sdk-language": "typescript",
430430
"x-meta-sdk-provider": "PostFinance Checkout",
431431
"x-meta-sdk-language-version": this.getVersion(),
@@ -508,7 +508,7 @@ class ApplicationUserService {
508508
Object.assign(headers, options.headers);
509509

510510
let defaultHeaders = {
511-
"x-meta-sdk-version": "4.4.0",
511+
"x-meta-sdk-version": "4.5.0",
512512
"x-meta-sdk-language": "typescript",
513513
"x-meta-sdk-provider": "PostFinance Checkout",
514514
"x-meta-sdk-language-version": this.getVersion(),

src/api/BankAccountService.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class BankAccountService {
9797
Object.assign(headers, options.headers);
9898

9999
let defaultHeaders = {
100-
"x-meta-sdk-version": "4.4.0",
100+
"x-meta-sdk-version": "4.5.0",
101101
"x-meta-sdk-language": "typescript",
102102
"x-meta-sdk-provider": "PostFinance Checkout",
103103
"x-meta-sdk-language-version": this.getVersion(),
@@ -194,7 +194,7 @@ class BankAccountService {
194194
Object.assign(headers, options.headers);
195195

196196
let defaultHeaders = {
197-
"x-meta-sdk-version": "4.4.0",
197+
"x-meta-sdk-version": "4.5.0",
198198
"x-meta-sdk-language": "typescript",
199199
"x-meta-sdk-provider": "PostFinance Checkout",
200200
"x-meta-sdk-language-version": this.getVersion(),
@@ -286,7 +286,7 @@ class BankAccountService {
286286
Object.assign(headers, options.headers);
287287

288288
let defaultHeaders = {
289-
"x-meta-sdk-version": "4.4.0",
289+
"x-meta-sdk-version": "4.5.0",
290290
"x-meta-sdk-language": "typescript",
291291
"x-meta-sdk-provider": "PostFinance Checkout",
292292
"x-meta-sdk-language-version": this.getVersion(),

src/api/BankTransactionService.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class BankTransactionService {
9797
Object.assign(headers, options.headers);
9898

9999
let defaultHeaders = {
100-
"x-meta-sdk-version": "4.4.0",
100+
"x-meta-sdk-version": "4.5.0",
101101
"x-meta-sdk-language": "typescript",
102102
"x-meta-sdk-provider": "PostFinance Checkout",
103103
"x-meta-sdk-language-version": this.getVersion(),
@@ -194,7 +194,7 @@ class BankTransactionService {
194194
Object.assign(headers, options.headers);
195195

196196
let defaultHeaders = {
197-
"x-meta-sdk-version": "4.4.0",
197+
"x-meta-sdk-version": "4.5.0",
198198
"x-meta-sdk-language": "typescript",
199199
"x-meta-sdk-provider": "PostFinance Checkout",
200200
"x-meta-sdk-language-version": this.getVersion(),
@@ -286,7 +286,7 @@ class BankTransactionService {
286286
Object.assign(headers, options.headers);
287287

288288
let defaultHeaders = {
289-
"x-meta-sdk-version": "4.4.0",
289+
"x-meta-sdk-version": "4.5.0",
290290
"x-meta-sdk-language": "typescript",
291291
"x-meta-sdk-provider": "PostFinance Checkout",
292292
"x-meta-sdk-language-version": this.getVersion(),

src/api/CardProcessingService.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ class CardProcessingService {
122122
Object.assign(headers, options.headers);
123123

124124
let defaultHeaders = {
125-
"x-meta-sdk-version": "4.4.0",
125+
"x-meta-sdk-version": "4.5.0",
126126
"x-meta-sdk-language": "typescript",
127127
"x-meta-sdk-provider": "PostFinance Checkout",
128128
"x-meta-sdk-language-version": this.getVersion(),
@@ -235,7 +235,7 @@ class CardProcessingService {
235235
Object.assign(headers, options.headers);
236236

237237
let defaultHeaders = {
238-
"x-meta-sdk-version": "4.4.0",
238+
"x-meta-sdk-version": "4.5.0",
239239
"x-meta-sdk-language": "typescript",
240240
"x-meta-sdk-provider": "PostFinance Checkout",
241241
"x-meta-sdk-language-version": this.getVersion(),

src/api/ChargeAttemptService.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class ChargeAttemptService {
9797
Object.assign(headers, options.headers);
9898

9999
let defaultHeaders = {
100-
"x-meta-sdk-version": "4.4.0",
100+
"x-meta-sdk-version": "4.5.0",
101101
"x-meta-sdk-language": "typescript",
102102
"x-meta-sdk-provider": "PostFinance Checkout",
103103
"x-meta-sdk-language-version": this.getVersion(),
@@ -194,7 +194,7 @@ class ChargeAttemptService {
194194
Object.assign(headers, options.headers);
195195

196196
let defaultHeaders = {
197-
"x-meta-sdk-version": "4.4.0",
197+
"x-meta-sdk-version": "4.5.0",
198198
"x-meta-sdk-language": "typescript",
199199
"x-meta-sdk-provider": "PostFinance Checkout",
200200
"x-meta-sdk-language-version": this.getVersion(),
@@ -286,7 +286,7 @@ class ChargeAttemptService {
286286
Object.assign(headers, options.headers);
287287

288288
let defaultHeaders = {
289-
"x-meta-sdk-version": "4.4.0",
289+
"x-meta-sdk-version": "4.5.0",
290290
"x-meta-sdk-language": "typescript",
291291
"x-meta-sdk-provider": "PostFinance Checkout",
292292
"x-meta-sdk-language-version": this.getVersion(),

src/api/ChargeBankTransactionService.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class ChargeBankTransactionService {
9797
Object.assign(headers, options.headers);
9898

9999
let defaultHeaders = {
100-
"x-meta-sdk-version": "4.4.0",
100+
"x-meta-sdk-version": "4.5.0",
101101
"x-meta-sdk-language": "typescript",
102102
"x-meta-sdk-provider": "PostFinance Checkout",
103103
"x-meta-sdk-language-version": this.getVersion(),
@@ -194,7 +194,7 @@ class ChargeBankTransactionService {
194194
Object.assign(headers, options.headers);
195195

196196
let defaultHeaders = {
197-
"x-meta-sdk-version": "4.4.0",
197+
"x-meta-sdk-version": "4.5.0",
198198
"x-meta-sdk-language": "typescript",
199199
"x-meta-sdk-provider": "PostFinance Checkout",
200200
"x-meta-sdk-language-version": this.getVersion(),
@@ -286,7 +286,7 @@ class ChargeBankTransactionService {
286286
Object.assign(headers, options.headers);
287287

288288
let defaultHeaders = {
289-
"x-meta-sdk-version": "4.4.0",
289+
"x-meta-sdk-version": "4.5.0",
290290
"x-meta-sdk-language": "typescript",
291291
"x-meta-sdk-provider": "PostFinance Checkout",
292292
"x-meta-sdk-language-version": this.getVersion(),

0 commit comments

Comments
 (0)