feat(payouts): apple pay decrypt payout by Sakilmostak · Pull Request #9857 · juspay/hyperswitch

Sakilmostak · 2025-10-15T10:01:02Z

Type of Change

Description

Payout is done via Decrypted Token data of Apple pay.
The decrypted data is directly collected in the request to initiate payout.
Integration is done via Worldpay for the following flow

Additional Changes

This PR modifies the API contract

"payout_method_data": {
        "wallet": {
            "apple_pay_decrypt": {
                "dpan": "4444333322221111",
                "expiry_month": "05",
                "expiry_year": "2035",
                "card_holder_name": "John Appleseed"
            }
        }
    },

This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

Create an MCA with WorldPay for payouts
Do a payout request with apple pay decrypted data:

curl --location '{{baseUrl}}/payouts/create' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: ={{api_key}}' \
--data-raw '{
    "amount": 100,
    "currency": "GBP",
    "customer_id": "payout_customer",
    "email": "payout_customer@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "profile_id": "{{profile_id}}",
    "phone_country_code": "+65",
    "description": "Its my first payout request",
    "payout_type": "wallet",
    "payout_method_data": {
        "wallet": {
            "apple_pay_decrypt": {
                "dpan": "4444333322221111",
                "expiry_month": "05",
                "expiry_year": "2035",
                "card_holder_name": "John Appleseed"
            }
        }
    },
    "entity_type": "Individual",
    "recurring": true,
    "metadata": {
        "ref": "123"
    },
    "auto_fulfill": true,
    "confirm": true
    
}'

response should have status as initiated, below is an example

{
    "payout_id": "payout_EVQi7ysLwVQ7cSuK2POO",
    "merchant_id": "merchant_1760528955",
    "merchant_order_reference_id": null,
    "amount": 100,
    "currency": "GBP",
    "connector": "worldpay",
    "payout_type": "wallet",
    "payout_method_data": {
        "wallet": {
            "email": null,
            "telephone_number": null,
            "paypal_id": null
        }
    },
    "billing": null,
    "auto_fulfill": true,
    "customer_id": "payout_customer",
    "customer": {
        "id": "payout_customer",
        "name": "John Doe",
        "email": "payout_customer@example.com",
        "phone": "999999999",
        "phone_country_code": "+65"
    },
    "client_secret": "payout_payout_EVQi7ysLwVQ7cSuK2POO_secret_6UFSzfVYuJ5GfA9Brxb1",
    "return_url": null,
    "business_country": null,
    "business_label": null,
    "description": "Its my first payout request",
    "entity_type": "Individual",
    "recurring": true,
    "metadata": {
        "ref": "123"
    },
    "merchant_connector_id": "mca_SRDKLfmRXfgKlJgjxE2P",
    "status": "initiated",
    "error_message": null,
    "error_code": null,
    "profile_id": "pro_UE5pBOruekGz1eD2yWxW",
    "created": "2025-10-15T12:05:17.747Z",
    "connector_transaction_id": null,
    "priority": null,
    "payout_link": null,
    "email": "payout_customer@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "unified_code": null,
    "unified_message": null,
    "payout_method_id": "pm_s8SUzT8ndfakfZ7Pw0Dn"
}

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

semanticdiff-com · 2025-10-15T10:01:05Z

Review changes with

Changed Files

File	Status
crates/hyperswitch_connectors/src/default_implementations.rs	26% smaller
crates/openapi/src/openapi.rs	9% smaller
crates/openapi/src/openapi_v2.rs	9% smaller
api-reference/v1/openapi_spec_v1.json	3% smaller
api-reference/v2/openapi_spec_v2.json	3% smaller
crates/api_models/src/enums.rs	0% smaller
crates/api_models/src/payouts.rs	0% smaller
crates/common_enums/src/connector_enums.rs	0% smaller
crates/common_utils/src/payout_method_utils.rs	0% smaller
crates/connector_configs/src/connector.rs	0% smaller
crates/connector_configs/toml/development.toml	Unsupported file format
crates/connector_configs/toml/production.toml	Unsupported file format
crates/connector_configs/toml/sandbox.toml	Unsupported file format
crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/worldpay.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/worldpay/payout_requests.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/worldpay/payout_response.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/worldpay/payout_transformers.rs	0% smaller
crates/hyperswitch_connectors/src/utils.rs	0% smaller
crates/router/src/core/payment_methods/vault.rs	0% smaller
crates/router/src/types/transformers.rs	0% smaller

crates/api_models/src/payouts.rs

kashif-m · 2025-10-15T10:19:23Z

crates/common_utils/src/payout_method_utils.rs

+pub struct ApplePayDecryptAdditionalData {
+    /// Card expiry month
+    #[schema(value_type = String, example = "01")]
+    pub card_exp_month: Secret<String>,
+
+    /// Card expiry year
+    #[schema(value_type = String, example = "2026")]
+    pub card_exp_year: Secret<String>,
+
+    /// Card holder name
+    #[schema(value_type = String, example = "John Doe")]
+    pub card_holder_name: Option<Secret<String>>,
+}


Do we need additional details for device bound data? If yes, we can add last4 of DPAN as well?

Will need to confirm with the merchant if it is a requirement for them.

crates/hyperswitch_connectors/src/connectors/worldpay/requests.rs

crates/hyperswitch_connectors/src/connectors/worldpay/response.rs

crates/hyperswitch_connectors/src/connectors/worldpay/transformers.rs

crates/hyperswitch_connectors/src/connectors/worldpay.rs

AkshayaFoiger · 2025-10-16T06:41:42Z

crates/hyperswitch_connectors/src/utils.rs

+#[cfg(feature = "payouts")]
+impl CardData for api_models::payouts::ApplePayDecrypt {
+    fn get_card_expiry_year_2_digit(&self) -> Result<Secret<String>, errors::ConnectorError> {
+        let binding = self.expiry_month.clone();


should we fetch expiry_year ?

raised a corresponding fix in a separate pr to not make this pr stale: #9871
Note: this method is not being used in current implementation

Sakilmostak added 2 commits October 14, 2025 17:15

feat: add payout via apple pay decrypted token

eef07af

feat: integrate apple pay decrypted payout via worldpay

d0334a1

Sakilmostak self-assigned this Oct 15, 2025

Sakilmostak requested review from a team as code owners October 15, 2025 10:01

Sakilmostak added A-connector-integration Area: Connector integration C-feature Category: Feature request or enhancement Payouts Area: Payouts labels Oct 15, 2025

kashif-m requested changes Oct 15, 2025

View reviewed changes

Sakilmostak added 2 commits October 15, 2025 17:40

refactor: resolve comments

a10976f

chore: run formatter

f088f44

Sakilmostak linked an issue Oct 15, 2025 that may be closed by this pull request

[FEATURE]: [Payouts] apple pay decrypt payout #9860

Closed

kashif-m previously approved these changes Oct 16, 2025

View reviewed changes

refactor: resolve ci checks + openapi specs

7924313

Sakilmostak dismissed kashif-m’s stale review via 7924313 October 16, 2025 05:46

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Oct 16, 2025

kashif-m approved these changes Oct 16, 2025

View reviewed changes

sai-harsha-vardhan approved these changes Oct 16, 2025

View reviewed changes

su-shivanshmathur approved these changes Oct 16, 2025

View reviewed changes

AkshayaFoiger reviewed Oct 16, 2025

View reviewed changes

AkshayaFoiger approved these changes Oct 16, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Oct 16, 2025

Merged via the queue into main with commit e7dee75 Oct 16, 2025
21 of 25 checks passed

likhinbopanna deleted the apple_pay_decrypt_payout branch October 16, 2025 08:06

Sakilmostak added a commit that referenced this pull request Oct 16, 2025

feat(payouts): apple pay decrypt payout (#9857)

b95beaf

Sakilmostak mentioned this pull request Oct 16, 2025

feat(payouts): apple pay decrypt payout #9875

Merged

14 tasks

chaitak-gorai pushed a commit that referenced this pull request Oct 16, 2025

feat(payouts): apple pay decrypt payout (#9857)

3e52e9e

drdholu pushed a commit to drdholu/hyperswitch that referenced this pull request Oct 30, 2025

feat(payouts): apple pay decrypt payout (juspay#9857)

189cb79

aadityaguptaa pushed a commit that referenced this pull request Nov 10, 2025

feat(payouts): apple pay decrypt payout (#9857)

7e2a6b7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(payouts): apple pay decrypt payout#9857

feat(payouts): apple pay decrypt payout#9857
likhinbopanna merged 5 commits intomainfrom
apple_pay_decrypt_payout

Sakilmostak commented Oct 15, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Oct 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

kashif-m Oct 15, 2025

Uh oh!

Sakilmostak Oct 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AkshayaFoiger Oct 16, 2025

Uh oh!

Sakilmostak Oct 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

Sakilmostak commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

kashif-m Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Sakilmostak Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AkshayaFoiger Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Sakilmostak Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Sakilmostak commented Oct 15, 2025 •

edited

Loading

semanticdiff-com bot commented Oct 15, 2025 •

edited

Loading