Direct API {apm}

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

Direct API lets you use a single integration to connect with a variety of e-wallets and online banking solutions.
In a few easy steps, you can open a direct path for your customers to pay in the most convenient way using their local payment solutions.

Currently, Direct API offers the following APIs:

• {sale} lets you receive card payments from customers
• {payout} allows you to transfer funds from your merchant account to the customer's wallet or bank account

In addition, the following webhook is available to keep your system updated asynchronously:

• Notification — triggered each time the transaction status changes

Direct API is a single integration point that allows your customers to pay using a number of alternative payment methods directly.
Because each payment method may have different requirements (e.g., local personal ID or wallet identity), the API call structure may vary slightly per method.

The wallet_data structure depends on the PSP and the specific APM, as each uses a different way of identifying the customer.
The example provided in the documentation is not universal.

{danger.fa-exclamation-triangle} IMPORTANT 1: Some APM solutions do not accept some or any customer/payment details over the API. In such cases, the customer will be asked to enter these details manually on the APM’s transaction page.

{danger.fa-exclamation} IMPORTANT 2: 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.

{danger.fa-exclamation} IMPORTANT 3: The gateway field should be included in the signature calculation only if it is present in the request body.

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

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

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,
    "wallet_data": {
        "full_name": "John Johnson",
        "bank_account": "11112222333344",
        "bank_name": "Random Bank, London",
        "bank_code": "AABBCC",
        "iban": "GB999911112222333344"
    },
    "cid": "1",
    "locale": "en-GB",
    "customer_token": "87cfb23a8f1e68e162c276b754d9c061",
    "payment_method": "WireOnline",
    "gateway": "XkI4sCxOBpcXylpK3-7ycM39RLTAqsyt",
    "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": null,
        "first_name": null,
        "last_name": null,
        "avs_alert": null,
        "verification_alert": null
    },
    "session": {
        "auth_token": "8a7sd87a8sd778ac961062c6bedddb8",
        "intent": "payment",
        "session_status": "created",
        "order_id": "test-1560610955",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.0,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "payment_method": "WireOnline",
        "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,
        "fee_included": 0,
        "fee_type": "flat",
        "payment_method": "WireOnline",
        "payment_processor": "TestWallet",
        "gateway": "XkI4sCxOBpcXylpK3-7ycM39RLTAqsyt",
        "card": null,
        "wallet": {
            "wallet_token": "wxtDmu8trYHrMWnpoBsEoq6YxqNxAsP-",
            "wallet_data": {
                "full_name": "John Johnson",
                "bank_account": "11112222333344",
                "bank_name": "Random Bank, London",
                "bank_code": "AABBCC",
                "iban": "GB999911112222333344"
            }
        },
        "is_3d": 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-001",
        "status_details": "Redirect to acquirer page"
    },
    "version": "1.3",
    "timestamp": 1590611635
}

{
    "status": 0,
    "description": "Ok",
    "redirect_url": null,
    "customer": {
        "customer_token": "87cfb23a8f1e68e162c276b754d9c061",
        "country": null,
        "first_name": null,
        "last_name": null,
        "avs_alert": null,
        "verification_alert": null
    },
    "session": {
        "auth_token": "8a7sd87a8sd778ac961062c6bedddb8",
        "intent": "payment",
        "session_status": "created",
        "order_id": "test-1560610955",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.0,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "payment_method": "WireOnline",
        "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.0,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "fee": 0,
        "payment_method": "WireOnline",
        "payment_processor": "TestWallet",
        "gateway": "XkI4sCxOBpcXylpK3-7ycM39RLTAqsyt",
        "card": null,
        "wallet": {
            "wallet_token": "wxtDmu8trYHrMWnpoBsEoq6YxqNxAsP-",
            "wallet_data": {
                "full_name": "John Johnson",
                "bank_account": "11112222333344",
                "bank_name": "Random Bank, London",
                "bank_code": "AABBCC",
                "iban": "GB999911112222333344"
            }
        },
        "is_3d": 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": null,
        "first_name": null,
        "last_name": null,
        "avs_alert": null,
        "verification_alert": null
    },
    "session": {
        "auth_token": "8a7sd87a8sd778ac961062c6bedddb8",
        "intent": "payment",
        "session_status": "created",
        "order_id": "test-1560610955",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.0,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "payment_method": "WireOnline",
        "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,
        "payment_method": "WireOnline",
        "payment_processor": "TestWallet",
        "gateway": "XkI4sCxOBpcXylpK3-7ycM39RLTAqsyt",
        "card": null,
        "wallet": null,
        "is_3d": 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,
    "signature": "64c181094246006b2c22d63cf9fa95e2cdfe5ba4d1c78a2c981448af5bffeaee627a3633891292a935290a7b804a06eb"
}