Gsm - Update

Update a Global Status Mapping (GSM).

Example request

cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/gsm/update \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "connector": "<string>",
  "flow": "<string>",
  "sub_flow": "<string>",
  "code": "<string>",
  "message": "<string>",
  "status": "<string>",
  "router_error": "<string>",
  "decision": "retry",
  "step_up_possible": true,
  "unified_code": "<string>",
  "unified_message": "<string>",
  "error_category": "frm_decline",
  "clear_pan_possible": true,
  "feature": "retry",
  "feature_data": {
    "retry": {
      "step_up_possible": true,
      "clear_pan_possible": true,
      "alternate_network_possible": true,
      "decision": "retry"
    }
  },
  "standardised_code": "account_closed_or_invalid",
  "description": "<string>",
  "user_guidance_message": "<string>"
}
'

Example response (200)

HTTP

POST /gsm/update

Authorization

  • api-key (string, header) — required Admin API keys allow privileged actions such as creating a merchant account and Merchant Connector account.

Body (application/json)

Fields:

  • connector (string) — required The connector through which payment has gone through.

  • flow (string) — required The flow in which the code and message occurred for a connector.

  • sub_flow (string) — required The sub_flow in which the code and message occurred for a connector.

  • code (string) — required Code received from the connector.

  • message (string) — required Message received from the connector.

  • status (string | null) Status provided by the router.

  • router_error (string | null) Optional error provided by the router.

  • decision (enum) Available options: retry, do_default.

  • step_up_possible (boolean | null) — deprecated Indicates if step_up retry is possible. Deprecated: This field is now included as part of feature_data under the Retry variant.

The step_up_possible field in the root body is deprecated. Use feature_data.retry.step_up_possible instead.

  • unified_code (string | null) Error code unified across the connectors.

  • unified_message (string | null) Error message unified across the connectors.

  • error_category (enum) Available options: frm_decline, processor_downtime, processor_decline_unauthorized, issue_with_payment_method, processor_decline_incorrect_data, hard_decline, soft_decline.

  • clear_pan_possible (boolean | null) — deprecated Indicates if retry with PAN is possible. Deprecated: This field is now included as part of feature_data under the Retry variant.

  • feature (enum) Available options: retry.

  • feature_data (object) Contains the data relevant to the specified GSM feature, if applicable. Example when feature is retry:

  • standardised_code (enum) See the expandable list below for all allowed values.

  • description (string | null) Detailed description of the error intended for debugging, analytics, and support teams.

  • user_guidance_message (string | null) A user-friendly message that can be safely displayed to the customer to guide resolution.

standardised_code allowed values

  • account_closed_or_invalid

  • authentication_failed

  • authentication_required

  • authorization_missing_or_revoked

  • card_lost_or_stolen

  • card_not_supported_restricted

  • cfg_pm_not_enabled_or_misconfigured

  • compliance_or_sanctions_restriction

  • configuration_issue

  • credit_limit_exceeded

  • currency_or_corridor_not_enabled

  • do_not_honor

  • downstream_technical_issue

  • duplicate_request

  • generic_unknown_error

  • incorrect_authentication_code

  • insufficient_funds

  • integ_cryptographic_issue

  • integration_issue

  • invalid_card_number

  • invalid_credentials

  • invalid_cvv

  • invalid_expiry_date

  • invalid_state

  • issuer_unavailable

  • merchant_inactive

  • missing_or_invalid_param

  • operation_not_allowed

  • payment_cancelled_by_user

  • payment_method_issue

  • payment_session_timeout

  • pm_address_mismatch

  • psp_acquirer_error

  • psp_fraud_engine_decline

  • rate_limit

  • stored_credential_or_mit_not_enabled

  • subscription_plan_inactive

  • suspected_fraud

  • three_ds_authentication_service_issue

  • three_ds_configuration_issue

  • three_ds_data_or_protocol_invalid

  • transaction_not_permitted

  • transaction_timed_out

  • velocity_limit_exceeded

  • wallet_or_token_config_issue

Response (200 application/json)

Gsm updated. Response body fields:

  • connector (string) — required

  • flow (string) — required

  • sub_flow (string) — required

  • code (string) — required

  • message (string) — required

  • status (string) — required

  • decision (enum) — required; Available options: retry, do_default

  • step_up_possible (boolean) — required; deprecated (see note above)

  • clear_pan_possible (boolean) — required; deprecated (see note above)

  • feature (enum) — required; Available options: retry

  • feature_data (object) — required; contains feature-specific configuration (e.g., retry details)

  • router_error (string | null)

  • unified_code (string | null)

  • unified_message (string | null)

  • error_category (enum) — same options as request

  • standardised_code (enum) — same options as request

  • description (string | null)

  • user_guidance_message (string | null)

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/gsm/gsm--update.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/gsm/gsm--update

Related:

  • Gsm - Get: https://api-reference.hyperswitch.io/v1/gsm/gsm--get

  • Gsm - Delete: https://api-reference.hyperswitch.io/v1/gsm/gsm--delete

PreviousOrganization - Merchant Account - ListNextRefunds - Retrieve