POST
/
gsm
/
get
curl --request POST \
  --url https://sandbox.hyperswitch.io/gsm/get \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "connector": "aci",
  "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": "<string>",
  "step_up_possible": true,
  "unified_code": "<string>",
  "unified_message": "<string>"
}

Authorizations

api-key
string
headerrequired

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

A connector is an integration to fulfill payments

Available options:
aci,
adyen,
airwallex,
authorizedotnet,
bambora,
bankofamerica,
bitpay,
bluesnap,
boku,
braintree,
cashtocode,
checkout,
coinbase,
cryptopay,
cybersource,
dlocal,
fiserv,
forte,
globalpay,
globepay,
gocardless,
helcim,
iatapay,
klarna,
mollie,
multisafepay,
nexinets,
nmi,
noon,
nuvei,
opennode,
payme,
paypal,
payu,
placetopay,
powertranz,
prophetpay,
rapyd,
shift4,
square,
stax,
stripe,
trustpay,
tsys,
volt,
wise,
worldline,
worldpay,
zen,
signifyd,
plaid,
riskified
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

200 - application/json
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

router_error
string | null

optional error provided by the router

decision
string
required

decision to be taken for auto retries flow

step_up_possible
boolean
required

indicates if step_up retry is possible

unified_code
string | null

error code unified across the connectors

unified_message
string | null

error message unified across the connectors