Skip to content

Fix webhook response builder params for transaction events to align w… #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kzuraw merged 1 commit into from
Apr 15, 2025
+30 −15
Merged

Fix webhook response builder params for transaction events to align w… #429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shy-pigs-appear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@saleor/app-sdk": patch
---

Fixed `TRANSACTION_CHARGE_REQUESTED`, `TRANSACTION_REFUND_REQUESTED`, `TRANSACTION_CANCELATION_REQUESTED`, `TRANSACTION_INITIALIZE_SESSION` and `TRANSACTION_PROCESS_SESSION` webhook response builder params. After this change `buildSyncWebhookResponsePayload` for those events should be the same as in Saleor docs.
40 changes: 25 additions & 15 deletions src/handlers/shared/sync-webhook-response-builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,66 +29,76 @@ export type SyncWebhookResponsesMap = {
*/
maximum_delivery_days?: number;
}>;
// https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response
TRANSACTION_CHARGE_REQUESTED: {
pspReference: string;
result?: "CHARGE_SUCCESS" | "CHARGE_FAILURE";
amount?: number;
result: "CHARGE_SUCCESS" | "CHARGE_FAILURE";
amount: number;
pspReference?: string;
time?: string;
externalUrl?: string;
message?: string;
actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
};
// https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#sync-flow-2
TRANSACTION_REFUND_REQUESTED: {
pspReference: string;
result?: "REFUND_SUCCESS" | "REFUND_FAILURE";
amount?: number;
result: "REFUND_SUCCESS" | "REFUND_FAILURE";
amount: number;
pspReference?: string;
time?: string;
externalUrl?: string;
message?: string;
actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
};
// https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response-1
TRANSACTION_CANCELATION_REQUESTED: {
pspReference: string;
result?: "CANCEL_SUCCESS" | "CANCEL_FAILURE";
amount?: number;
result: "CANCEL_SUCCESS" | "CANCEL_FAILURE";
amount: number;
pspReference?: string;
time?: string;
externalUrl?: string;
message?: string;
actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
};
PAYMENT_GATEWAY_INITIALIZE_SESSION: {
data: unknown;
};
// https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response-4
TRANSACTION_INITIALIZE_SESSION: {
pspReference?: string;
data?: unknown;
result:
| "CHARGE_SUCCESS"
| "CHARGE_FAILURE"
| "CHARGE_REQUEST"
| "CHARGE_ACTION_REQUIRED"
| "AUTHORIZATION_SUCCESS"
| "AUTHORIZATION_FAILURE"
| "AUTHORIZATION_REQUESTED"
| "AUTHORIZATION_REQUEST"
| "AUTHORIZATION_ACTION_REQUIRED";
amount: number;
pspReference?: string;
data?: unknown;
time?: string;
externalUrl?: string;
message?: string;
actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
};
// https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response-5
TRANSACTION_PROCESS_SESSION: {
pspReference?: string;
data?: unknown;
result:
| "CHARGE_SUCCESS"
| "CHARGE_FAILURE"
| "CHARGE_REQUEST"
| "CHARGE_ACTION_REQUIRED"
| "AUTHORIZATION_SUCCESS"
| "AUTHORIZATION_FAILURE"
| "AUTHORIZATION_REQUESTED"
| "AUTHORIZATION_REQUEST"
| "AUTHORIZATION_ACTION_REQUIRED";
amount: number;
pspReference?: string;
data?: unknown;
time?: string;
externalUrl?: string;
message?: string;
actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
};
PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION:
| {
Expand Down
Loading