Gsm - Create
curl --request POST \
--url https://sandbox.birrpay.io/gsm \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"flow": "<string>",
"sub_flow": "<string>",
"code": "<string>",
"message": "<string>",
"status": "<string>",
"step_up_possible": true,
"clear_pan_possible": true,
"router_error": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"feature": "retry",
"feature_data": {
"retry": {
"step_up_possible": true,
"clear_pan_possible": true,
"alternate_network_possible": true
}
},
"description": "<string>",
"user_guidance_message": "<string>"
}
'import requests
url = "https://sandbox.birrpay.io/gsm"
payload = {
"flow": "<string>",
"sub_flow": "<string>",
"code": "<string>",
"message": "<string>",
"status": "<string>",
"step_up_possible": True,
"clear_pan_possible": True,
"router_error": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"feature": "retry",
"feature_data": { "retry": {
"step_up_possible": True,
"clear_pan_possible": True,
"alternate_network_possible": True
} },
"description": "<string>",
"user_guidance_message": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow: '<string>',
sub_flow: '<string>',
code: '<string>',
message: '<string>',
status: '<string>',
step_up_possible: true,
clear_pan_possible: true,
router_error: '<string>',
unified_code: '<string>',
unified_message: '<string>',
feature: 'retry',
feature_data: {
retry: {
step_up_possible: true,
clear_pan_possible: true,
alternate_network_possible: true
}
},
description: '<string>',
user_guidance_message: '<string>'
})
};
fetch('https://sandbox.birrpay.io/gsm', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.birrpay.io/gsm",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flow' => '<string>',
'sub_flow' => '<string>',
'code' => '<string>',
'message' => '<string>',
'status' => '<string>',
'step_up_possible' => true,
'clear_pan_possible' => true,
'router_error' => '<string>',
'unified_code' => '<string>',
'unified_message' => '<string>',
'feature' => 'retry',
'feature_data' => [
'retry' => [
'step_up_possible' => true,
'clear_pan_possible' => true,
'alternate_network_possible' => true
]
],
'description' => '<string>',
'user_guidance_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.birrpay.io/gsm"
payload := strings.NewReader("{\n \"flow\": \"<string>\",\n \"sub_flow\": \"<string>\",\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"status\": \"<string>\",\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"router_error\": \"<string>\",\n \"unified_code\": \"<string>\",\n \"unified_message\": \"<string>\",\n \"feature\": \"retry\",\n \"feature_data\": {\n \"retry\": {\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"alternate_network_possible\": true\n }\n },\n \"description\": \"<string>\",\n \"user_guidance_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.birrpay.io/gsm")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flow\": \"<string>\",\n \"sub_flow\": \"<string>\",\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"status\": \"<string>\",\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"router_error\": \"<string>\",\n \"unified_code\": \"<string>\",\n \"unified_message\": \"<string>\",\n \"feature\": \"retry\",\n \"feature_data\": {\n \"retry\": {\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"alternate_network_possible\": true\n }\n },\n \"description\": \"<string>\",\n \"user_guidance_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/gsm")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flow\": \"<string>\",\n \"sub_flow\": \"<string>\",\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"status\": \"<string>\",\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"router_error\": \"<string>\",\n \"unified_code\": \"<string>\",\n \"unified_message\": \"<string>\",\n \"feature\": \"retry\",\n \"feature_data\": {\n \"retry\": {\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"alternate_network_possible\": true\n }\n },\n \"description\": \"<string>\",\n \"user_guidance_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"connector": "<string>",
"flow": "<string>",
"sub_flow": "<string>",
"code": "<string>",
"message": "<string>",
"status": "<string>",
"decision": "retry",
"step_up_possible": true,
"clear_pan_possible": true,
"feature": "retry",
"feature_data": {
"retry": {
"step_up_possible": true,
"clear_pan_possible": true,
"alternate_network_possible": true,
"decision": "retry"
}
},
"router_error": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"error_category": "frm_decline",
"standardised_code": "account_closed_or_invalid",
"description": "<string>",
"user_guidance_message": "<string>"
}GSM (Global Status Mapping)
Gsm - Create
Creates a GSM (Global Status Mapping) Rule. A GSM rule is used to map a connector’s error message/error code combination during a particular payments flow/sub-flow to BirrPay’s unified status/error code/error message combination. It is also used to decide the next action in the flow - retry/requeue/do_default
POST
/
gsm
Gsm - Create
curl --request POST \
--url https://sandbox.birrpay.io/gsm \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"flow": "<string>",
"sub_flow": "<string>",
"code": "<string>",
"message": "<string>",
"status": "<string>",
"step_up_possible": true,
"clear_pan_possible": true,
"router_error": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"feature": "retry",
"feature_data": {
"retry": {
"step_up_possible": true,
"clear_pan_possible": true,
"alternate_network_possible": true
}
},
"description": "<string>",
"user_guidance_message": "<string>"
}
'import requests
url = "https://sandbox.birrpay.io/gsm"
payload = {
"flow": "<string>",
"sub_flow": "<string>",
"code": "<string>",
"message": "<string>",
"status": "<string>",
"step_up_possible": True,
"clear_pan_possible": True,
"router_error": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"feature": "retry",
"feature_data": { "retry": {
"step_up_possible": True,
"clear_pan_possible": True,
"alternate_network_possible": True
} },
"description": "<string>",
"user_guidance_message": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow: '<string>',
sub_flow: '<string>',
code: '<string>',
message: '<string>',
status: '<string>',
step_up_possible: true,
clear_pan_possible: true,
router_error: '<string>',
unified_code: '<string>',
unified_message: '<string>',
feature: 'retry',
feature_data: {
retry: {
step_up_possible: true,
clear_pan_possible: true,
alternate_network_possible: true
}
},
description: '<string>',
user_guidance_message: '<string>'
})
};
fetch('https://sandbox.birrpay.io/gsm', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.birrpay.io/gsm",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flow' => '<string>',
'sub_flow' => '<string>',
'code' => '<string>',
'message' => '<string>',
'status' => '<string>',
'step_up_possible' => true,
'clear_pan_possible' => true,
'router_error' => '<string>',
'unified_code' => '<string>',
'unified_message' => '<string>',
'feature' => 'retry',
'feature_data' => [
'retry' => [
'step_up_possible' => true,
'clear_pan_possible' => true,
'alternate_network_possible' => true
]
],
'description' => '<string>',
'user_guidance_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.birrpay.io/gsm"
payload := strings.NewReader("{\n \"flow\": \"<string>\",\n \"sub_flow\": \"<string>\",\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"status\": \"<string>\",\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"router_error\": \"<string>\",\n \"unified_code\": \"<string>\",\n \"unified_message\": \"<string>\",\n \"feature\": \"retry\",\n \"feature_data\": {\n \"retry\": {\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"alternate_network_possible\": true\n }\n },\n \"description\": \"<string>\",\n \"user_guidance_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.birrpay.io/gsm")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flow\": \"<string>\",\n \"sub_flow\": \"<string>\",\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"status\": \"<string>\",\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"router_error\": \"<string>\",\n \"unified_code\": \"<string>\",\n \"unified_message\": \"<string>\",\n \"feature\": \"retry\",\n \"feature_data\": {\n \"retry\": {\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"alternate_network_possible\": true\n }\n },\n \"description\": \"<string>\",\n \"user_guidance_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/gsm")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flow\": \"<string>\",\n \"sub_flow\": \"<string>\",\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"status\": \"<string>\",\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"router_error\": \"<string>\",\n \"unified_code\": \"<string>\",\n \"unified_message\": \"<string>\",\n \"feature\": \"retry\",\n \"feature_data\": {\n \"retry\": {\n \"step_up_possible\": true,\n \"clear_pan_possible\": true,\n \"alternate_network_possible\": true\n }\n },\n \"description\": \"<string>\",\n \"user_guidance_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"connector": "<string>",
"flow": "<string>",
"sub_flow": "<string>",
"code": "<string>",
"message": "<string>",
"status": "<string>",
"decision": "retry",
"step_up_possible": true,
"clear_pan_possible": true,
"feature": "retry",
"feature_data": {
"retry": {
"step_up_possible": true,
"clear_pan_possible": true,
"alternate_network_possible": true,
"decision": "retry"
}
},
"router_error": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"error_category": "frm_decline",
"standardised_code": "account_closed_or_invalid",
"description": "<string>",
"user_guidance_message": "<string>"
}Authorizations
Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.
Body
application/json
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, 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 The flow in which the code and message occurred for a connector
The sub_flow in which the code and message occurred for a connector
code received from the connector
message received from the connector
status provided by the router
Available options:
retry, do_default indicates if step_up retry is possible
Deprecated: This field is now included as part of feature_data under the Retry variant.
indicates if retry with pan is possible
Deprecated: This field is now included as part of feature_data under the Retry variant.
optional error provided by the router
error code unified across the connectors
error message unified across the connectors
Available options:
frm_decline, processor_downtime, processor_decline_unauthorized, issue_with_payment_method, processor_decline_incorrect_data, hard_decline, soft_decline Available options:
retry 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.
Show child attributes
Show child attributes
Available options:
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 A detailed description of the error intended for debugging, analytics, and support teams.
A user-friendly message that can be safely displayed to the customer. This message provides guidance on what the user should do to resolve the issue.
Response
Gsm created
The connector through which payment has gone through
The flow in which the code and message occurred for a connector
The sub_flow in which the code and message occurred for a connector
code received from the connector
message received from the connector
status provided by the router
Available options:
retry, do_default indicates if step_up retry is possible
Deprecated: This field is now included as part of feature_data under the Retry variant.
indicates if retry with pan is possible
Deprecated: This field is now included as part of feature_data under the Retry variant.
Available options:
retry 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.
Show child attributes
Show child attributes
optional error provided by the router
error code unified across the connectors
error message unified across the connectors
Available options:
frm_decline, processor_downtime, processor_decline_unauthorized, issue_with_payment_method, processor_decline_incorrect_data, hard_decline, soft_decline Available options:
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 A detailed description of the error intended for debugging, analytics, and support teams.
A user-friendly message that can be safely displayed to the customer. This message provides guidance on what the user should do to resolve the issue.