Direct API {card}

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

The Direct Card Processing API allows you to process credit and debit card deposits and payouts via REST API.
In simple terms, this API enables the merchant to collect card data directly on their side.

The following transaction types are supported:

• {authorization} – Used to receive payments from customers via card.
• {sale} – Also used to receive payments from customers via card.
• {payout} – Used to send funds from your merchant account to the customer’s card.

To stay up to date with transaction status changes, the following webhook is available:

• Notification – Triggered every time a transaction status is updated.

{danger.fa-exclamation} IMPORTANT 1: To use the Direct API with full card data, the merchant must comply with PCI DSS standards and provide an up-to-date Attestation of Compliance (AOC) or SAQ-D along with a valid external vulnerability scan report.

{danger.fa-exclamation} IMPORTANT 2: Either the customer_data object or a valid customer_token must be included in the request.

{danger.fa-exclamation} IMPORTANT 3: Currency conversion is not supported in Direct API. The filter currency and processing currency must always match.
This means that the currency sent to Praxis in a sale, payout, or refund request will be passed unchanged to the PSP for processing.

We use CryptoCompare for cryptocurrency rates, and Open Exchange Rates for FIAT currency exchange rates.
Rates are updated every 15 minutes for crypto, and every 5 minutes for FIAT.

Endpoints

If your CRM does not technically support two separate domains as endpoints, the solution is to use a single domain for all API calls.

• Sandbox: https://pci-gw-test.praxispay.com
• Live: https://gw.praxisgate.com

Example:
For the live environment, you should use https://gw.praxisgate.com instead of https://gateway.praxispay.com.
As a result, the endpoint becomes: https://gw.praxisgate.com/cashier/cashier.

Request Parameters

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

Response Parameters

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. transaction_type
5. cid
6. order_id
7. currency
8. amount
9. gateway
10. notification_url
11. return_url
12. card_data.card_number (or card_data.hpf_auth_token in case of HPF)

Response signature parameters

1. status
2. timestamp
3. redirect_url
4. customer.customer_token
5. transaction.tid
6. transaction.transaction_status
7. transaction.processed_currency
8. transaction.processed_amount

Example

{
      "merchant_id": "Test-Integration-Merchant",
      "application_key": "Sandbox",
      "transaction_type": "sale",
      "currency": "EUR",
      "amount": 100,
      "card_data": {
        "card_number": "ZMq4wDaiaQ/xOwMEcQ7R3ASjTnoOMu+avLuJYgAnz1Q=",
        "card_exp": "WI8V4bE5/l8fIhUv6aMO8w==",
        "cvv": "BCm5yhYeeYoJlsOSIRd8Mg=="
      },
      "device_data": {
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Safari/605.1.15",
        "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
        "language": "en-us",
        "ip_address": "127.0.0.1",
        "timezone_offset": -180,
        "color_depth": "24",
        "pixel_depth": "24",
        "pixel_ratio": "2",
        "screen_height": 900,
        "screen_width": 1440,
        "viewport_height": 400,
        "viewport_width": 1440,
        "java_enabled": 0,
        "javascript_enabled": 1
      },
      "three_ds_mpi_result": {
        "three_ds_server_trans_id": "1w111036-4abf-4b50-9cd6-e593b0218ed5",
        "acs_trans_id": "2d551036-4abf-4b50-9cd6-e593b0218ed5",
        "authentication_type": "01",
        "trans_status": "Y",
        "acs_challenge_mandated": "N",
        "challenge_indicator": "05",
        "ds_trans_id": "62453bce-2714-40e4-9c00-0aa98541682a",
        "eci": "05",
        "transaction_status_reason": "17",
        "authentication_value": "MTIRWG9SWWRpU2I1M21DelozSTA=",
        "message_version": "2.2.0",
        "exemption_flag": "01",
        "channel": "02"
      },
      "cid": "1",
      "locale": "en-GB",
      "customer_token": null,
      "customer_data": {
        "country": "GB",
        "first_name": "John",
        "last_name": "Johnson",
        "dob": "12/31/1980",
        "email": "[email protected]",
        "phone": "44201112222",
        "zip": "WC2N 5DU",
        "state": "JS",
        "city": "London",
        "address": "Random st., 12/3",
        "profile": 1
      },
      "mit": {
        "type": "initial",
        "expiry": 365
      },
      "gateway": "s-pTSZyK23E1Ee5KZpcNbX_aFl0HuhQ0",
      "notification_url": "https://api.merchant.com/v1/deposits/tx-1560610955",
      "return_url": "https://merchant.com/payment_result/tx-1560610955",
      "order_id": "test-1560610955",
      "withdrawal_request_id": null,
      "variable1": "your variable",
      "variable2": "if that is not enough, you can pass even one more variable",
      "variable3": null,
      "version": "1.3",
      "timestamp": 1590611635
}

{
    "status": 0,
    "description": "Ok",
    "redirect_url": "https:\/\/compute.praxispay.com\/login\/8a7sd87a8sd778ac961062c6bedddb8",
    "customer": {
        "customer_token": "87cfb23a8f1e68e162c276b754d9c061",
        "country": "GB",
        "first_name": "John",
        "last_name": "Johnson",
        "avs_alert": 0,
        "verification_alert": 0
    },
    "session": {
        "auth_token": "8a7sd87a8sd778ac961062c6bedddb8",
        "intent": "payment",
        "session_status": "created",
        "order_id": "test-1560610955",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.000000,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "payment_method": "Credit Card",
        "gateway": null,
        "cid": "1",
        "variable1": "your variable",
        "variable2": "if that is not enough, you can pass even one more variable",
        "variable3": null
    },
    "transaction": {
        "transaction_type": "sale",
        "transaction_status": "initialized",
        "tid": 756850,
        "transaction_id": "13348",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": null,
        "processed_currency": null,
        "processed_amount": null,
        "fee": 0,
        "payment_method": "Credit Card",
        "payment_processor": "TestCardProcessor",
        "gateway": "s-pTSZyK23E1Ee5KZpcNbX_aFl0HuhQ0",
        "card": {
            "card_token": "J-4-a0vPhjZ9R75JP98VDUFgbh9y8sYr",
            "card_type": "VISA",
            "card_number": "411111******1111",
            "card_exp": "12\/2024",
            "card_issuer_name": "Bank of Somewhere",
            "card_issuer_country": "GB"
        },
        "mit": {
          "type": "initial",
          "expiry": 365
        },
        "wallet": null,
        "is_async": 1,
        "is_cascade": 0,
        "cascade_level": 0,
        "reference_id": null,
        "withdrawal_request_id": null,
        "account_identifier": null,
        "created_by": "INTERNET",
        "edited_by": "INTERNET",
        "status_code": "SC-001",
        "status_details": "Redirect to acquirer page"
    },
    "version": "1.3",
    "timestamp": 1590611635
}

{
    "status": 0,
    "description": "Ok",
    "redirect_url": null,
    "customer": {
        "customer_token": "87cfb23a8f1e68e162c276b754d9c061",
        "country": "GB",
        "first_name": "John",
        "last_name": "Johnson",
        "avs_alert": 0,
        "verification_alert": 0
    },
    "session": {
        "auth_token": "8a7sd87a8sd778ac961062c6bedddb8",
        "intent": "payment",
        "session_status": "created",
        "order_id": "test-1560610955",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.000000,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "payment_method": "Credit Card",
        "gateway": null,
        "cid": "1",
        "variable1": "your variable",
        "variable2": "if that is not enough, you can pass even one more variable",
        "variable3": null
    },
    "transaction": {
        "transaction_type": "sale",
        "transaction_status": "approved",
        "tid": 756850,
        "transaction_id": "13348",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.000000,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "fee": 0,
        "payment_method": "Credit Card",
        "payment_processor": "TestCardProcessor",
        "gateway": "s-pTSZyK23E1Ee5KZpcNbX_aFl0HuhQ0",
        "card": {
            "card_token": "J-4-a0vPhjZ9R75JP98VDUFgbh9y8sYr",
            "card_type": "VISA",
            "card_number": "411111******1111",
            "card_exp": "12\/2024",
            "card_issuer_name": "Bank of Somewhere",
            "card_issuer_country": "GB"
        },
        "mit": {
          "type": "initial",
          "expiry": 365
        },
        "wallet": null,
        "is_async": 0,
        "is_cascade": 0,
        "cascade_level": 0,
        "reference_id": null,
        "withdrawal_request_id": null,
        "account_identifier": null,
        "created_by": "INTERNET",
        "edited_by": "INTERNET",
        "status_code": "SC-002",
        "status_details": "Transaction approved"
    },
    "version": "1.3",
    "timestamp": 1590611635
}

{
    "status": 0,
    "description": "Ok",
    "redirect_url": null,
    "customer": {
        "customer_token": "87cfb23a8f1e68e162c276b754d9c061",
        "country": "GB",
        "first_name": "John",
        "last_name": "Johnson",
        "avs_alert": 0,
        "verification_alert": 0
    },
    "session": {
        "auth_token": "8a7sd87a8sd778ac961062c6bedddb8",
        "intent": "payment",
        "session_status": "created",
        "order_id": "test-1560610955",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.000000,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "payment_method": "Credit Card",
        "gateway": null,
        "cid": "1",
        "variable1": "your variable",
        "variable2": "if that is not enough, you can pass even one more variable",
        "variable3": null
    },
    "transaction": {
        "transaction_type": "sale",
        "transaction_status": "rejected",
        "tid": 756850,
        "transaction_id": "13348",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": null,
        "processed_currency": null,
        "processed_amount": null,
        "fee": 0,
        "fee_included": 0,
        "fee_type": "flat",
        "payment_method": "Credit Card",
        "payment_processor": "TestCardProcessor",
        "gateway": "s-pTSZyK23E1Ee5KZpcNbX_aFl0HuhQ0",
        "card": null,
        "wallet": null,
        "is_async": 0,
        "is_cascade": 0,
        "cascade_level": 0,
        "reference_id": null,
        "withdrawal_request_id": null,
        "account_identifier": null,
        "created_by": "INTERNET",
        "edited_by": "INTERNET",
        "status_code": "GE-001",
        "status_details": "Do not honor"
    },
    "version": "1.3",
    "timestamp": 1590611635
}