feat(payment_methods): Implement Process tracker workflow for Payment method Status update

[Sarthak1799]

Type of Change

• Bugfix
• New feature
• Enhancement
• Refactoring
• Dependency updates
• Documentation
• CI/CD

Description

This PR -

• Implemented a process tracker workflow for status update after pm client_secret expiry

Additional Changes

• This PR modifies the API contract
• This PR modifies the database schema
• This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

When vaulting is done within session -

1. Create a Payment_method

curl --location --request POST 'http://localhost:8080/payment_methods' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_cHN6hMdCFUUrNWjYSxnwhiuMsg83rXTX9jBmtHmCL6sq9a43PswY304MSt3a9blR' \
--data-raw '{
    "customer_id": "cus_LALaPcTuxxmCBORKevPC"
}'

Response -

{
    "merchant_id": "sarthak1",
    "customer_id": "cus_LALaPcTuxxmCBORKevPC",
    "payment_method_id": "pm_gnnmqGeng12XWnsr3AWy",
    "payment_method": null,
    "payment_method_type": null,
    "card": null,
    "recurring_enabled": false,
    "installment_payment_enabled": false,
    "payment_experience": null,
    "metadata": null,
    "created": "2024-06-19T08:58:05.050Z",
    "last_used_at": null,
    "client_secret": "pm_gnnmqGeng12XWnsr3AWy_secret_ikc5JKsFFREjtR9hk5Co"
}

2. Vault using /save

curl --location --request POST 'http://localhost:8080/payment_methods/pm_gnnmqGeng12XWnsr3AWy/save' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: pk_dev_16e38a16176e45298a70da6c56c5028d' \
--data-raw '{
    "payment_method": "card",
    "payment_method_type": "credit",
    "payment_method_issuer": "visa",
    "client_secret": "pm_gnnmqGeng12XWnsr3AWy_secret_ikc5JKsFFREjtR9hk5Co",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "08",
            "card_exp_year": "2028",
            "card_holder_name": "joseph"
        }
    }
}'

Response -

{
    "merchant_id": "sarthak1",
    "customer_id": null,
    "payment_method_id": "pm_gnnmqGeng12XWnsr3AWy",
    "payment_method": "card",
    "payment_method_type": "credit",
    "card": {
        "scheme": null,
        "issuer_country": null,
        "last4_digits": "4242",
        "expiry_month": "08",
        "expiry_year": "2028",
        "card_token": null,
        "card_holder_name": "joseph",
        "card_fingerprint": null,
        "nick_name": null,
        "card_network": null,
        "card_isin": "424242",
        "card_issuer": null,
        "card_type": null,
        "saved_to_locker": true
    },
    "recurring_enabled": false,
    "installment_payment_enabled": false,
    "payment_experience": [
        "redirect_to_url"
    ],
    "metadata": null,
    "created": "2024-06-19T08:58:19.752Z",
    "last_used_at": "2024-06-19T08:58:19.752Z",
    "client_secret": "pm_gnnmqGeng12XWnsr3AWy_secret_ikc5JKsFFREjtR9hk5Co"
}

DB entry for PT -

When vaulting is not done within session -

1. Create Payment method -

curl --location --request POST 'http://localhost:8080/payment_methods' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_cHN6hMdCFUUrNWjYSxnwhiuMsg83rXTX9jBmtHmCL6sq9a43PswY304MSt3a9blR' \
--data-raw '{
    "customer_id": "cus_LALaPcTuxxmCBORKevPC"
}'

Response -

{
    "merchant_id": "sarthak1",
    "customer_id": "cus_LALaPcTuxxmCBORKevPC",
    "payment_method_id": "pm_LlMdO3mS6HQ9EJLfDpL3",
    "payment_method": null,
    "payment_method_type": null,
    "card": null,
    "recurring_enabled": false,
    "installment_payment_enabled": false,
    "payment_experience": null,
    "metadata": null,
    "created": "2024-06-19T09:04:11.634Z",
    "last_used_at": null,
    "client_secret": "pm_LlMdO3mS6HQ9EJLfDpL3_secret_4565heI7J2bLsBgTLbJ5"
}

2. Vault using /save after session expiry -

curl --location --request POST 'http://localhost:8080/payment_methods/pm_LlMdO3mS6HQ9EJLfDpL3/save' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: pk_dev_16e38a16176e45298a70da6c56c5028d' \
--data-raw '{
    "payment_method": "card",
    "payment_method_type": "credit",
    "payment_method_issuer": "visa",
    "client_secret": "pm_LlMdO3mS6HQ9EJLfDpL3_secret_4565heI7J2bLsBgTLbJ5",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "08",
            "card_exp_year": "2028",
            "card_holder_name": "joseph"
        }
    }
}'

Response -

{
    "error": {
        "type": "invalid_request",
        "message": "The payment method with the specified details already exists in our records",
        "code": "HE_01"
    }
}

DB entry after session expiry -

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

[vspecky]

Logic LGTM

[NishantJoshi00]

LGTM

[NishantJoshi00]

Can you attach some test cases