Skip to main content
PUT
/
api
/
adm
/
companyProjects
/
{id}
/
merchant
Update Project Merchant Information
curl --request PUT \
  --url https://localhost:44371/api/adm/companyProjects/{id}/merchant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Updates payment processor configuration for a project. Common use cases include credential rotation when API keys expire, switching payment processors, updating merchant IDs for production deployments, or configuring test vs. production payment gateway settings.

​
Input

  • Path Parameter: id (guid, required) — Unique identifier of the project to update.
  • Body: model (CompanyProjectMerchantInfoUpdateCommandRequest, required) — Updated merchant information including:
    • id (guid, required) — Project identifier (must match path parameter).
    • merchantId (string, optional) — Payment processor merchant ID.
    • apiKey (string, optional) — Payment processor API key or secret.
    • processorGateway (int, optional) — Payment processor gateway type.
    • isTestMode (bool, optional) — Test mode flag.

​
Output

Returns a CompanyProjectUpdateCommandResponse indicating whether the merchant information update was successful.

​
Example Request

PUT /api/admin/companyProjects/7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a/merchant-info
Content-Type: application/json
Authorization: Bearer {token}

{
  "id": "7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a",
  "merchantId": "MERCHANT_12345",
  "apiKey": "sk_live_abc123xyz789",
  "processorGateway": 1,
  "isTestMode": false
}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Errors

  • 400 Bad Request — Missing required credentials, validation errors, invalid merchant credentials format, or unsupported processor gateway.
  • 404 Not Found — No project exists with the specified ID.

​
Notes

  • Changing merchant credentials takes effect immediately for new transactions.
  • In-flight transactions continue using previous credentials until completion.
  • Test mode credentials should never be used in production environments.
  • Merchant credential changes are logged for security auditing.
  • Invalid credentials may cause transaction processing failures.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string<guid>
required

The unique identifier of the project to update.

Body

application/json

The updated merchant information including merchant IDs, API credentials, and payment processor settings.

Base structure for command requests that modify data. Represents the payload used to update merchant information for a project.

​
id
string<guid>

The identifier of the project being updated.

​
merchantPhone
string | null

The merchant phone number.

​
softDescriptor
string | null

The soft descriptor that should appear on merchant statements.

​
comments
string | null

The comments for the project.

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard command response indicating the result of a data modification. Represents the response returned after updating project information.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null