Skip to main content
POST
/
gsm
/
get
Gsm - Get
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>"
}'
{
  "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"
    }
  }
}

Authorizations

​
api-key
string
header
required

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

Body

application/json
​
connector
enum<string>
required
Available options:
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,
bluecode,
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,
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,
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,
signifyd,
plaid,
riskified,
xendit,
zen,
zsl
​
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

Response

Gsm retrieved

​
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
enum<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
enum<string>
required
Available options:
retry
​
feature_data
object
required

Contains the data relevant to the specified GSM feature, if applicable. For example, if the feature is Retry, this will include configuration details specific to the retry behavior.

​
router_error
string | null

optional error provided by the router

​
unified_code
string | null

error code unified across the connectors

​
unified_message
string | null

error message unified across the connectors

​
error_category
enum<string>
Available options:
frm_decline,
processor_downtime,
processor_decline_unauthorized,
issue_with_payment_method,
processor_decline_incorrect_data,
hard_decline,
soft_decline