API Reference

Get available gateways

post
https://gw.praxisgate.com/agent/get-available-gateways
Body Params
string
required
length ≤ 32

HASH value of customer's card.

Note: This field must not be sent in any subsequent Merchant Initiated Transaction (MIT) requests.

string
required
length ≤ 10

Base Currency: The user's account currency on the merchant site.

string
required
length ≤ 50

Unique customer id in your system.

Note: Personally Identifiable Information (PII), such as email addresses, is strictly forbidden. If your user identifier contains any PII, you must hash or encrypt it before sending it to the API.

integer
required

Transaction amount in cents.

Note: For certain currencies there is a fraction other than 100 cents per unit, this is important if you multiply by 100 to send the amount in cents.

string
required
length ≤ 50

Merchant API client account identifier.

string
required
length ≤ 32

Identifier of your application (website).

string
required
length ≤ 3

API version.

integer
required

Request time (unix timestamp, seconds).

string
required
length ≤ 16

Transaction type.

string
length ≤ 32

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 strings
length ≤ 2

Allowed values are:

  • card
  • apm
gateway_type
string
length ≤ 32

Gateway doing the processing.

string
length ≤ 2

ISO 3166-1 alpha-2 country code (US, MT, IT, GB, DE etc.)

string
enum
length ≤ 5

User locale, specified as a BCP 47 Language Tag (e.g., 'en-GB'). The first component is the ISO 639-1 language code, and the second is the ISO 3166-1 country code.

Note: Contact [email protected] to add new locale if not available in the list.

payment_method
array of objects

Allowed values, see key field for payment methods in Atlas

payment_method
integer

Allowed values are:

  • 0 to exclude payment information
  • 1 to include payment information
string
length ≤ 50

User IP address

string
length ≤ 2

User IP Country

string
length ≤ 256

User Agent

string
length ≤ 10

User Region Code

Headers
string
required

Authentication HTTP header of your outgoing request to the API. Below request parameters should be used for creating signature in request header.

  • merchant_id
  • application_key
  • timestamp
  • cid
Responses

Updated 6 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago