Agent API {get-available-gateways}

---

• ENDPOINTS
• REQUEST PARAMETERS
• RESPONSE PARAMETERS
• SIGNATURE
• EXAMPLE

By using {get-available-gateways} you can dynamically fetch all available gateways for the customer. Depending on the information in the response and the number of available gateways for processing, the merchant can decide how to continue the attempt.

Endpoints

Name	URL
Sandbox	https://pci-gw-test.praxispay.com/agent/get-available-gateways
Live	https://gw.praxisgate.com/agent/get-available-gateways

Request Parameters

✓ - required value
? - optional, value or null
✕ - always appears as null

Variable	Type		Description
merchant_id	varchar(50)	✓	Merchant API client account identifier
application_key	varchar(32)	✓	Identifier of your application (website)
transaction_type	varchar(32)	✓	Transaction type. Allowed values are: - authorization for authorization - sale for payment - payout for payout
hpf_auth_token	string	?	HPF auth token. It is recommended to be applied especially if customer enters new card, in that case for better cascade matching card data could be picked up from session by hpf_auth_token
gateway_type	array of varchar(32)	?	Allowed values are: - card - apm
gateway	varchar(32)	?	A specific gateway to be found
country	varchar(2)	?	ISO 3166-1 alpha-2 country code (US, MT, IT, GB, DE, etc.)
currency	varchar(10)	?	ISO-4217 symbol for regular currencies Symbol for crypto currencies
locale	varchar(5)	?	User locale
cid	varchar(50)	✓ if card_token received	Unique customer id
payment_method	array of varchar(50)	?	Allowed values, see key field for payment methods in Atlas
amount	int(20)	✓ if card_token received	Transaction amount in cents. For certain currencies there is a fraction other than 100 cents per unit
card_token	varchar(32)	?	HASH value of customer's card
include_payment_information	int(1)	?	Allowed values are: - 0 to exclude payment information - 1 to include payment information
version	varchar(3)	✓	API version
timestamp	int(11)	✓	Request time (unix timestamp, seconds)

Response Parameters

Variable	Type		Description
status	int	✓	API communication status - for transaction processing status please refer to transaction.transaction.status - 0 if the request was successful - Negative integer if internal server/network error occurs - Positive integer if application/logical error occurs
description	varchar(256)	✓	Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
gateway_list	List<Object>	?	List of gateway objects, where keys are gateway hash strings and values are actual data objects. Appears in all cases except the authentication/validation error, or application malfunction
version	varchar(3)	✓	API version
timestamp	int(11)	✓	Response time (unix timestamp, seconds)

Gateway List

Variable	Type		Description
gateway	varchar(32)	✓	Hash value of gateway
gateway_type	varchar(32)	✓	If processor_type = 'pp', then send the value card. If processor_type = 'apm', then send the value apm
payment_method	varchar(50)	✓	Payment method
display_name	varchar(100)	✓	Gateway display name
system_name	varchar(100)	✓	Gateway title
image	varchar(512)	?	URL of an image corresponding to the payment method
payment_information	List<Object>	?	This object is sent only if the input parameter include_payment_information = 1

Payment Information

Variable	Type		Description
deposit_supported	int(1)	✓	Whether deposit is supported: - 1 is supported - 0 isn't supported
authorization_supported	int(1)	✓	Whether authorization is supported: - 1 is supported - 0 isn't supported
payout_supported	int(1)	✓	Whether payout is supported: - 1 is supported - 0 isn't supported
input_fields_for_payment	List<Object>	?	List of input_field objects, representing the data input fields to be rendered for the full data set required for successful processing. The value may be an empty list if no additional fields are required
input_fields_for_withdrawal	List<Object>	?	List of input_field objects, representing the data input fields to be rendered for the full data set required for successful processing. The value may be an empty list if no additional fields are required
card_types	array of varchar(10)	?	Card Types applied on the gateway in Atlas
processing_currencies	List<Object>	✓	Currency settings applied on the gateway in Atlas
fees	List<Object>	?	Fee settings applied on the gateway in Atlas
spreads	List<Object>	?	Spread settings applied on the gateway in Atlas
countries_supported	varchar(2)	?	Customer registration countries allowed by the gateway. Indicates the list of ISO 3166-1 alpha-2 codes of countries that can be accepted by the gateway, based on all of the gateway’s filter currencies.

Input Fields

Variable	Type	Description
key	varchar(32)	The parameter name as it appears in JSON
label	varchar(50)	Label for the input
format	varchar(32)	The field format. Possible values are: integer, text, email, phone, url
default_value	varchar(256)	Represents the initial content or pre-selected option.
required	int(1)	Whether the fields is required: - 1 is required - 0 isn't required
min	int(10)	Minimal value (integer) or minimal length (all other formats)
max	int(10)	Maximum value (integer) or maximum length (all other formats)
options	varchar(256)	Options allowed to be selected (applies only if format is "select")

Processing Currencies

Variable	Type	Description
currency	varchar(10)	ISO-4217 symbol for regular currencies Symbol for crypto currencies
min_amount	int(10)	Min Amount
max_amount	int(10)	Max Amount
bdcc	int(1)	Whether the currency is used in Background Dynamic Currency Conversion (BDCC) attempts where the gateway is not supporting the selected currency: - 1 is enabled - 0 isn't enabled

Fees

Variable	Type	Description
rate	int(20)	Fee rate
fee_type	varchar(32)	Allowed values are: - Flat - Percentage
processing_currency	varchar(10)	ISO-4217 symbol for regular currencies Symbol for crypto currencies
payment_method	varchar(50)	Payment method
transaction_type	varchar(32)	Transaction type
min_amount	int(10)	Min Transaction Amount
max_amount	int(10)	Max Transaction Amount
fee_included	int(1)	- 1 is included - 0 isn't included

Spreads

Variable	Type	Description
rate	int(20)	Spread rate
spread_type	varchar(32)	Allowed values are: - Flat - Percentage
processing_currency	varchar(10)	ISO-4217 symbol for regular currencies Symbol for crypto currencies

Signature

The full signature generation algorithm can be found in the Authentication section.

Request signature parameters

1. merchant_id
2. application_key
3. timestamp
4. cid

Response signature parameters

1. status
2. timestamp

Example

Request

{
    "merchant_id": "Test-Integration-Merchant",
    "application_key": "Sandbox",
    "transaction_type": "sale",
    "gateway_type": [
        "card"
    ],
    "country": "GB",
    "currency": "EUR",
    "locale": "en-GB",
    "cid": "1",
    "payment_method": [
        "Credit Card"
    ],
    "amount": null,
    "card_token": null,
    "include_payment_information": 1,
    "version": "1.3",
    "timestamp": 1590613956
}

Response (Found)

{
    "status": 0,
    "description": "Ok",
    "gateway_list": [
        {
            "gateway": "s-pTSZyK23E1Ee5KZpcNbX_aFl0HuhQ0",
            "gateway_type": "pp",
            "payment_method": "Credit Card",
            "display_name": "Credit Card",
            "system_name": "Credit Card - global traffic",
            "image": "https://cdn.cashier-test.com/payment_method_/payment_method_608129b58c1dd.svg",
            "payment_information": {
                "deposit_supported": 1,
                "authorization_supported": 0,
                "payout_supported": 1,
                "input_fields": [],
                "card_types": [
                    "AMEX",
                    "Dankort",
                    "DinersClub",
                    "Discover",
                    "Electron",
                    "Forbrugsforeningen",
                    "JCB",
                    "Maestro",
                    "MasterCard",
                    "Mir",
                    "Unionpay",
                    "VISA"
                ],
                "processing_currencies": {
                    "USD": {
                        "min_amount": 1,
                        "max_amount": 10000,
                        "bdcc":1
                    },
                    "EUR": {
                        "min_amount": 1,
                        "max_amount": 10000,
                        "bdcc":1
                    },
                    "GBP": {
                        "min_amount": 1,
                        "max_amount": 10000,
                        "bdcc":1
                    }
                },
                "fees": null,
                "spreads": null,
                "countries_supported": {
                    ["UK","DE","FR"]
                },
            }},
        {
            "gateway": "15287e60e253b57c3968a8d33746dd69",
            "gateway_type": "apm",
            "payment_method": "altbankwire",
            "display_name": "E-Wallet",
            "system_name": "E-Wallet - global traffic",
            "image": "https://cdn.cashier-test.com/payment_method_/payment_method_608129b58c1dd.svg",
            "payment_information": {
                "deposit_supported": 1,
                "authorization_supported": 0,
                "payout_supported": 1,
                "input_fields_for_payment": [
                    {
                        "key": "full_name",
                        "label": "Full Name",
                        "default_value":"",
                        "required": 0,
                        "format": "text",
                        "min": 0,
                        "max": 50
                    }
                ],
                "card_types": [],
                "processing_currencies": {
                    "USD": {
                        "min_amount": 1,
                        "max_amount": 10000,
                        "bdcc":0
                    },
                    "EUR": {
                        "min_amount": 1,
                        "max_amount": 10000,
                        "bdcc":0
                    }
                },
                "fees": [
                    {
                        "rate": 5,
                        "fee_type":"Flat",
                        "processing_currency":"EUR",
                        "payment_method":"altbankwire",
                        "transaction_type":"sale",
                        "min_amount": 1,
                        "max_amount":10000,
                        "fee_included":1
                    },
                    {
                        "rate": 5,
                        "fee_type":"Flat",
                        "processing_currency":"USD",
                        "payment_method":"altbankwire",
                        "transaction_type":"sale",
                        "min_amount": 1,
                        "max_amount":10000,
                        "fee_included":1
                    }
                ],
                "spreads": [
                    {
                        "rate": 10,
                        "fee_type":"Percentage",
                        "processing_currency":"EUR"
                    },
                    {
                        "rate": 10,
                        "fee_type":"Percentage",
                        "processing_currency":"USD"
                    }
                ],
                "countries_supported": {
                    ["AA","AB","AC","AD","AE","AF","AG","AH","AI","AJ","AK","AL","AM","AN","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ","BA","BB","BC","BD","BE","BF","BG","BH","BI","BJ","BK","BL","BM","BN","BO","BP","BQ","BR","BS","BT","BU","BV","BW","BX","BY","BZ","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","CU","CV","CW","CX","CY","CZ","DA","DB","DC","DD","DE","DF","DG","DH","DI","DJ","DK","DL","DM","DN","DO","DP","DQ","DR","DS","DT","DU","DV","DW","DX","DY","DZ","EA","EB","EC","ED","EE","EF","EG","EH","EI","EJ","EK","EL","EM","EN","EO","EP","EQ","ER","ES","ET","EU","EV","EW","EX","EY","EZ","FA","FB","FC","FD","FE","FF","FG","FH","FI","FJ","FK","FL","FM","FN","FO","FP","FQ","FR","FS","FT","FU","FV","FW","FX","FY","FZ","GA","GB","GC","GD","GE","GF","GG","GH","GI","GJ","GK","GL","GM","GN","GO","GP","GQ","GR","GS","GT","GU","GV","GW","GX","GY","GZ","HA","HB","HC","HD","HE","HF","HG","HH","HI","HJ","HK","HL","HM","HN","HO","HP","HQ","HR","HS","HT","HU","HV","HW","HX","HY","HZ","IA","IB","IC","ID","IE","IF","IG","IH","II","IJ","IK","IL","IM","IN","IO","IP","IQ","IR","IS","IT","IU","IV","IW","IX","IY","IZ","JA","JB","JC","JD","JE","JF","JG","JH","JI","JJ","JK","JL","JM","JN","JO","JP","JQ","JR","JS","JT","JU","JV","JW","JX","JY","JZ","KA","KB","KC","KD","KE","KF","KG","KH","KI","KJ","KK","KL","KM","KN","KO","KP","KQ","KR","KS","KT","KU","KV","KW","KX","KY","KZ","LA","LB","LC","LD","LE","LF","LG","LH","LI","LJ","LK","LL","LM","LN","LO","LP","LQ","LR","LS","LT","LU","LV","LW","LX","LY","LZ","MA","MB","MC","MD","ME","MF","MG","MH","MI","MJ","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NB","NC","ND","NE","NF","NG","NH","NI","NJ","NK","NL","NM","NN","NO","NP","NQ","NR","NS","NT","NU","NV","NW","NX","NY","NZ","OA","OB","OC","OD","OE","OF","OG","OH","OI","OJ","OK","OL","OM","ON","OO","OP","OQ","OR","OS","OT","OU","OV","OW","OX","OY","OZ","PA","PB","PC","PD","PE","PF","PG","PH","PI","PJ","PK","PL","PM","PN","PO","PP","PQ","PR","PS","PT","PU","PV","PW","PX","PY","PZ","QA","QB","QC","QD","QE","QF","QG","QH","QI","QJ","QK","QL","QM","QN","QO","QP","QQ","QR","QS","QT","QU","QV","QW","QX","QY","QZ","RA","RB","RC","RD","RE","RF","RG","RH","RI","RJ","RK","RL","RM","RN","RO","RP","RQ","RR","RS","RT","RU","RV","RW","RX","RY","RZ"]
                },
            }
        }
    ],
    "version": "1.3",
    "timestamp": 1590611635
}

Response (No gateways available)

{
    "status": 0,
    "description": "Ok",
    "gateway_list": [],
    "version": "1.3",
    "timestamp": 1590611635
}