Gsm - Get

POST https://sandbox.hyperswitch.io/gsm/get

Description: Retrieve Global Status Mapping (GSM) information for a connector error code/message.

Example request (cURL)

cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/gsm/get \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "connector": "authipay",
  "flow": "<string>",
  "sub_flow": "<string>",
  "code": "<string>",
  "message": "<string>"
}
'

Authorization

Header: api-key (string, required)

Notes: Admin API keys allow privileged actions such as creating a merchant account and Merchant Connector account.

Request body (application/json)

  • connector (string, required) — connector through which the code/message was received

  • 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

Available connector values (expand to view)

authipay, adyenplatform, stripe_billing_test, phonypay, fauxpay, pretendpay, stripe_test, adyen_test, checkout_test, paypal_test, aci, adyen, affirm, airwallex, amazonpay, archipel, authorizedotnet, bambora, bamboraapac, bankofamerica, barclaycard, billwerk, bitpay, bluesnap, blackhawknetwork, calida, boku, braintree, breadpay, cardinal, cashtocode, celero, chargebee, checkbook, checkout, coinbase, coingate, custombilling, cryptopay, ctp_mastercard, ctp_visa, cybersource, datatrans, deutschebank, digitalvirgo, dlocal, dwolla, ebanx, elavon, facilitapay, finix, fiserv, fiservemea, fiuu, flexiti, forte, getnet, gigadat, globalpay, globepay, gocardless, gpayments, hipay, helcim, hyperswitch_vault, inespay, iatapay, itaubank, jpmorgan, juspaythreedsserver, klarna, loonio, mifinity, mollie, moneris, multisafepay, netcetera, nexinets, nexixpay, nmi, nomupay, noon, nordea, novalnet, nuvei, opennode, paybox, payload, payme, payone, paypal, paysafe, paystack, paytm, payu, peachpayments, payjustnow, payjustnowinstore, phonepe, placetopay, powertranz, prophetpay, rapyd, razorpay, recurly, redsys, santander, shift4, silverflow, square, stax, stripe, stripebilling, taxjar, threedsecureio, tesouro, tokenex, tokenio, trustpay, trustpayments, tsys, vgs, volt, wellsfargo, wise, worldline, worldpay, worldpayvantiv, worldpayxml, worldpaymodular, signifyd, plaid, riskified, xendit, zen, zift, zsl

Response (200, application/json)

Gsm retrieved — example response:

Response 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, required) — status provided by the router

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

  • step_up_possible (boolean, required) — deprecated; indicates if step_up retry is possible Deprecated: This field is now included as part of feature_data under the Retry variant.

  • clear_pan_possible (boolean, required) — deprecated; indicates if retry with pan is possible Deprecated: This field is now included as part of feature_data under the Retry variant.

  • feature (string, required) — Available options: retry

  • feature_data (object, required) — Contains the data relevant to the specified GSM feature (e.g., retry configuration)

  • router_error (string | null, optional) — error provided by the router

  • unified_code (string | null, optional) — error code unified across the connectors

  • unified_message (string | null, optional) — error message unified across the connectors

  • description (string | null, optional) — A detailed description of the error intended for debugging, analytics, and support teams

  • user_guidance_message (string | null, optional) — A user-friendly message that can be safely displayed to the customer

Available error_category values (expand to view)

frm_decline, processor_downtime, processor_decline_unauthorized, issue_with_payment_method, processor_decline_incorrect_data, hard_decline, soft_decline

Available standardised_code values (expand to view)

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

Feedback and editing links:

  • Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/gsm/gsm--get.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/gsm/gsm--get

PreviousGsm - CreateNextcustomer-set-default-payment-method