refactor(customers_v2): Remove merchant reference id from v2 customer update

[AmeyWale]

Type of Change

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

Description

We are removing merchant_reference_id from all API updates, due to possible bugs on merchant side db and HS db as there might be mismatch in their's and our's db records. This exists only in customers and refunds v2 apis, a separate PR has been implemented for refunds update, and this PR is for customers v2 update api.

It was noticed that in the current implementation of customers v2 update flow, the merchant_reference_id field is being accepted by the API but it was never updated in the db. In this PR we are removing merchant_reference_id from being accepted in the customers v2 update request.

Additional Changes

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

Motivation and Context

Upon merging this PR, we will be removing merchant_reference_id from being updated in customer v2 update api.

How did you test it?

• Create Customer API Call

curl --location 'http://localhost:8080/v2/customers' \
--header 'x-profile-id: pro_saOFnM13wT1ngOuItKJl' \
--header 'Content-Type: application/json' \
--header 'Authorization: api-key=dev_VAtwaBd0cVItaaxIS8bUTFuPcxa9DkqlmBPvH5fq6IASKSlBxc9cBUygLoCaebFj' \
--data-raw '{   
    "merchant_reference_id": "customer_1748929359",
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "default_billing_address": null,
    "default_shipping_address": null,
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

• Response from above call

{
    "id": "12345_cus_0197344f74677930a77bfc4c926c3b3e",
    "merchant_reference_id": "customer_1748929312",
    "connector_customer_ids": null,
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "default_billing_address": null,
    "default_shipping_address": null,
    "created_at": "2025-06-03T05:41:51.849Z",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "default_payment_method_id": null
}

• Customer Update API call

curl --location --request PUT 'http://localhost:8080/v2/customers/12345_cus_0197344f74677930a77bfc4c926c3b3e' \
--header 'x-profile-id: pro_saOFnM13wT1ngOuItKJl' \
--header 'Content-Type: application/json' \
--header 'Authorization: api-key=dev_VAtwaBd0cVItaaxIS8bUTFuPcxa9DkqlmBPvH5fq6IASKSlBxc9cBUygLoCaebFj' \
--data-raw '{   
    "name": "Jane Doe",
    "email": "[email protected]",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "Second customer",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

• Response from the above call

{
    "id": "12345_cus_0197344f74677930a77bfc4c926c3b3e",
    "merchant_reference_id": "customer_1748929312",
    "connector_customer_ids": null,
    "name": "Jane Doe",
    "email": "[email protected]",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "Second customer",
    "default_billing_address": null,
    "default_shipping_address": null,
    "created_at": "2025-06-03T05:41:51.849Z",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "default_payment_method_id": null
}

• Trying to update merchant_reference_id API call

curl --location --request PUT 'http://localhost:8080/v2/customers/12345_cus_0197344f74677930a77bfc4c926c3b3e' \
--header 'x-profile-id: pro_saOFnM13wT1ngOuItKJl' \
--header 'Content-Type: application/json' \
--header 'Authorization: api-key=dev_VAtwaBd0cVItaaxIS8bUTFuPcxa9DkqlmBPvH5fq6IASKSlBxc9cBUygLoCaebFj' \
--data-raw '{   
    "merchant_reference_id": "customer_1748929499",
    "name": "Jane Doe",
    "email": "[email protected]",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "Second customer",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

• Response from the above call

{
    "error": {
        "error_type": "invalid_request",
        "message": "Json deserialize error: unknown field `merchant_reference_id`, expected one of `name`, `email`, `phone`, `description`, `phone_country_code`, `default_billing_address`, `default_shipping_address`, `metadata`, `default_payment_method_id` at line 2 column 27",
        "code": "IR_06"
    }
}

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]

Review changes with  

Changed Files

File	Status
api-reference-v2/openapi_spec.json	0% smaller
crates/api_models/src/customers.rs	0% smaller