fix(connectors): Amount received should be zero for pending and failed status

[Sakilmostak]

Type of Change

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

Description

Amount received as well as amount capturable were both showing total amount during pending status but this breaks the convention i.e amount_received + amount_capturable = total amount .

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?

Tested through postman:
Create MCA (Adyen or Paypal): (eg. Paypal)

{
    "connector_type": "fiz_operations",
    "connector_name": "paypal",
    "connector_account_details": {
        "auth_type": "BodyKey",
        "api_key": "{{api_key}}",
        "key1": "{{key1}}"
    },
    "business_country": "US",
    "business_label": "default",
    "test_mode": false,
    "disabled": false,
    "payment_methods_enabled": [
        {
            "payment_method": "card",
            "payment_method_types": [
                {
                    "payment_method_type": "credit",
                    "card_networks": [
                        "Visa",
                        "Mastercard"
                    ],
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "debit",
                    "card_networks": [
                        "Visa",
                        "Mastercard"
                    ],
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "wallet",
            "payment_method_types": [
                {
                    "payment_method_type": "paypal",
                    "payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": false,
                    "installment_payment_enabled": false
                }
            ]
        }
    ],
    "metadata": {
        "city": "NY",
        "unit": "245"
    }
}

Create a payment with Capture as Manual:

{
  "amount": 300,
  "currency": "USD",
  "confirm": true,
  "business_country": "US",
  "business_label": "default",
  "amount_to_capture": 300,
  "customer_id": "{{customer_id}}",
  "capture_method": "manual",
  "capture_on": "2022-09-10T10:11:12Z",
  "authentication_type": "no_three_ds",
  "return_url": "https://www.google.com",
  "email": "something@gmail.com",
  "name": "Joseph Doe",
  "phone": "999999999",
  "phone_country_code": "+65",
  "description": "Its my first payment request",
  "statement_descriptor_name": "Juspay",
  "statement_descriptor_suffix": "Router",
  "payment_method": "card",
  "payment_method_type": "credit",
  "payment_method_data": {
    "card": {
      "card_number": "4000000000001091",
      "card_exp_month": "01",
      "card_exp_year": "2026",
      "card_holder_name": "joseph Doe",
      "card_cvc": "100"
    }
  },
  "billing": {
    "address": {
      "line1": "1467",
      "line2": "CA",
      "line3": "Harrison Street",
      "city": "San Fransico",
      "state": "CA",
      "zip": "94122",
      "country": "PL",
      "first_name": "joseph",
      "last_name": "Doe"
    },
    "phone": {
      "number": "8056594427",
      "country_code": "+91"
    }
  },
  "browser_info": {
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
    "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
    "language": "nl-NL",
    "color_depth": 24,
    "screen_height": 723,
    "screen_width": 1536,
    "time_zone": 0,
    "java_enabled": true,
    "java_script_enabled": true,
    "ip_address": "109.71.40.0"
  },
  "metadata": {
    "order_category": "applepay"
  },
  "order_details": [
    {
      "product_name": "Apple iphone 15",
      "quantity": 1,
      "amount": 300,
      "account_name": "transaction_processing"
    }
  ],
  "setup_future_usage": "off_session"
}

Retrieve the Payment: The status should be requires_capture
Capture the Payment: status should be processing and amount_received should be 0 (zero). Example Response is below

{
    "payment_id": "pay_Ix9SLSEcEb6hkLSxTS7g",
    "merchant_id": "merchant_1712583118",
    "status": "processing",
    "amount": 300,
    "net_amount": 300,
    "amount_capturable": 300,
    "amount_received": 0,
    "connector": "paypal",
    "client_secret": "pay_Ix9SLSEcEb6hkLSxTS7g_secret_xKILdtpMBeUPmaH1V2VL",
    "created": "2024-04-08T14:00:17.738Z",
    "currency": "USD",
    "customer_id": "cus_69Qz5OIKkVfjxgdlRX8L",
    "customer": {
        "id": "cus_69Qz5OIKkVfjxgdlRX8L",
        "name": "Joseph Doe",
        "email": "something@gmail.com",
        "phone": "999999999",
        "phone_country_code": "+65"
    },
    "description": "Its my first payment request",
    "refunds": null,
    "disputes": null,
    "mandate_id": null,
    "mandate_data": null,
    "setup_future_usage": "off_session",
    "off_session": null,
    "capture_on": null,
    "capture_method": "manual",
    "payment_method": "card",
    "payment_method_data": {
        "card": {
            "last4": "1091",
            "card_type": null,
            "card_network": null,
            "card_issuer": null,
            "card_issuing_country": null,
            "card_isin": "400000",
            "card_extended_bin": "40000000",
            "card_exp_month": "01",
            "card_exp_year": "2026",
            "card_holder_name": "joseph Doe",
            "payment_checks": null,
            "authentication_data": null
        },
        "billing": null
    },
    "payment_token": null,
    "shipping": null,
    "billing": {
        "address": {
            "city": "San Fransico",
            "country": "PL",
            "line1": "1467",
            "line2": "CA",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "CA",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        },
        "email": null
    },
    "order_details": [
        {
            "brand": null,
            "amount": 300,
            "category": null,
            "quantity": 1,
            "product_id": null,
            "product_name": "Apple iphone 15",
            "product_type": null,
            "product_img_link": null,
            "requires_shipping": null
        }
    ],
    "email": "something@gmail.com",
    "name": "Joseph Doe",
    "phone": "999999999",
    "return_url": "https://www.google.com/",
    "authentication_type": "no_three_ds",
    "statement_descriptor_name": "Juspay",
    "statement_descriptor_suffix": "Router",
    "next_action": null,
    "cancellation_reason": null,
    "error_code": null,
    "error_message": null,
    "unified_code": null,
    "unified_message": null,
    "payment_experience": null,
    "payment_method_type": "credit",
    "connector_label": "paypal_US_default",
    "business_country": "US",
    "business_label": "default",
    "business_sub_label": null,
    "allowed_payment_method_types": null,
    "ephemeral_key": null,
    "manual_retry_allowed": false,
    "connector_transaction_id": "8W030039AX010491J",
    "frm_message": null,
    "metadata": {
        "order_category": "applepay"
    },
    "connector_metadata": null,
    "feature_metadata": null,
    "reference_id": "pay_Ix9SLSEcEb6hkLSxTS7g_1",
    "payment_link": null,
    "profile_id": "pro_k0JhxuX6vsJqtNXgNcr9",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_MzZlFWdMmr37qAvHgFQg",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2024-04-08T14:15:17.738Z",
    "fingerprint": null,
    "browser_info": {
        "language": "nl-NL",
        "time_zone": 0,
        "ip_address": "109.71.40.0",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
        "color_depth": 24,
        "java_enabled": true,
        "screen_width": 1536,
        "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "screen_height": 723,
        "java_script_enabled": true
    },
    "payment_method_id": null,
    "payment_method_status": null
}

Note: This affect capture of Adyen and Paypal

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
• I added a CHANGELOG entry if applicable

[srujanchikke]

Please mention all the statuses here, instead of using default case.

[srujanchikke]

Please resolve given comments

[hrithikesh026]

Please use either storage_enums or enums in the match arms. Not both.

[hrithikesh026]

LGTM