Praxis Wiki logo
Praxis Wiki
Latest API Version Available
Version:
3.3 (API 1.1)
  • 3.3 (API 1.1)
  • 3.4 (API 1.2)
  • latest (API 1.3)

    • Payment API {process} Sale

    Payment Card Processing API lets you process the credit and debit card deposits and payouts over REST API.

    There are several transaction types supported by the API:
    - Sale transaction API lets you receive the card payments from customers;
    - Credit transaction API is a fund transfer from your merchant account to customer's card;
    - Refund transaction API is a reverse operation to a successful deposit;

    {danger.fa-exclamation} IMPORTANT: Sometimes transaction_id (PSP transaction identifier) is empty, this may happen in the cases when the PSP has rejected the processing attempt due to input validation or unavailability of the payment gateway.

    ENDPOINTS

    Name URL
    Sandbox https://pci-gw-test.praxispay.com/api/process
    Live https://gw.praxisgate.com/api/process

    REQUEST PARAMETERS

    Variable Type Description
    amount int(20) Required. Payment amount in cents.
    Please note: for certain currencies (see full list here) there is a fraction other than 100 cents per unit, this is important if you multiply by 100 to send the amount in cents
    currency varchar(10) Required. Payment currency
    card_number varchar(19) Required. Payment card number (PAN)
    cvv varchar(4) Optional. (Required on sale) Payment Card verification number
    card_exp varchar(8) Required. Payment card expiration month/year in format MM/YYYY (ex. 12/2024)
    pin varchar(50) Required. Unique customer id in your system
    dob date Required. Date of birth of the customer. MM/DD/YYYY format accepted.
    email varchar(50) Required. Customer's email
    phone int(20) Required. Numeric only, includes country area code. Should not be a dummy sequence like 123456 or 111111, should be at least 6 digits long.
    requester_ip varchar(10) Required. Customer's IP address
    address varchar(100) Required. Customer's address
    city varchar(50) Required. City of the customer
    country varchar(2) Required. ISO 3166-1 alpha-2 (US, MT, IT, GB, DE etc)
    first_name varchar(25) Required. Customer's first name
    last_name varchar(25) Required. Customer's last name
    state varchar(2) Required. State/Province where the customer resides. 2 characters ISO format. Otherwise leave blank.
    zip varchar(12) Required. Postal Code of the customer. Can provide values for other countries. Limited to 12 alphanumeric characters only.
    frontend varchar(256) Required. Cashier FrontEnd name, normally it is a common name of the website. Linked to a specific base currency.
    merchant_id varchar(50) Required. Merchant API client account identifier
    return_url varchar(256) Required. User will be redirected to a specified URL upon 3D Secure confirmation (in case of 3D Secure flow)
    notification_url varchar(256) Required. URL to which the deposit status notification will be sent
    order_id varchar(50) Required. Transaction identifier in your system
    transaction_type varchar(8) Required. Transaction type. Must be set to sale for deposit
    gateway varchar(32) Optional. Gateway doing the processing
    timestamp int(11) Required. Request time. URL will be active during 1 min after this time
    version varchar(3) Required. API version
    signature varchar(96) Required. Request signature. Please refer to How to Build Signature for details on signing the request.

    RESPONSE PARAMETERS

    Variable Type Description
    status int Required.
    - 0 if the request was successful
    - Negative integer if internal server/network error occurs
    - Positive integer if application/logical error occurs
    description varchar(256) Required. Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
    redirect_url varchar(256) Optional. 3D Secure verification URL. Appears only in combination with "transaction_status":"pending_async"
    trace_id int(11) Optional. Transaction identifier in
    transaction_id varchar(50) Optional. Transaction identifier in PSP
    transaction_status varchar(16) Required.
    - pending - processing initiated, final response expected from PSP
    - approved - processing was successful
    - declined (obsolete) - processing failed
    - rejected - processing failed
    - pending_async - customer action expected (3D Secure, etc.)
    - error - processing or configuration error
    payment_processor varchar(25) Optional. Gateway doing the processing
    error_code varchar(32) Optional. Error code for rejected transactions
    error_details varchar(256) Optional. Error description for rejected transactions
    version varchar(3) Required. API version
    signature varchar(96) Required. sha384 HASH code of response (same algorithm as request signature)

    EXAMPLE - SALE

    For example below: Merchant Secret = "MerchantSecretKey"

    Request

     
    curl -X POST \ https://gw.praxisgate.com/api/process \
-H 'Content-Type: application/json' \
-d '{
    "address":"Avenue 51/2",
    "amount":"100",
    "card_exp":"12/2028",
    "card_number":"4012888888881881",
    "city":"New York",
    "country":"US",
    "currency":"USD",
    "cvv":"111",
    "dob":"05/15/1980",
    "email":"[email protected]",
    "first_name":"Test",
    "frontend":"Integration TEST USD",
    "last_name":"User",
    "merchant_id":"Test-Integration-Merchant",
    "notification_url":"https://api.merchant.com/v1/deposits/tx-1560610955",
    "order_id":"test-1560610955",
    "phone":"+1987987987987",
    "pin":"1",
    "requester_ip":"127.0.0.1",
    "return_url":"https://merchant.com/payment_result/tx-1560610955",
    "state":"LA",
    "timestamp":1569154493,
    "transaction_type":"sale",
    "version":"1.1",
    "zip":"24123",
    "signature":"25e48cc9f92bdf889e506c2894c20ead5a50c2062d7c0da05ed56a2c290197193bc91dcfeadfe02da5df8164e5253c5c"
}'

    Response (3D Secure)

     
    {
    "description":"Ok",
    "error_code":"0",
    "error_details":"[TEST] Transaction status: redirect",
    "payment_processor":"TestPP",
    "redirect_url":"https://ccport-test.praxispay.com/site/process/WEYrdE5XKzhhKzRjQjBIbE5kWlpLZz09",
    "status":0,
    "trace_id":1000000680,
    "transaction_id":"15607165967613",
    "transaction_status":"pending_async",
    "version":"1.1",
    "signature":"1aaa93f90a50fa5d9c6c8e8a843198988a789ffd2a104b870babd550391ad24da18429453bc1aa36d37462199a6ebe0a"
}

    Response (Approved)

     
    {
    "description":"Ok",
    "error_code":"0",
    "error_details":"[TEST] Transaction status: approved",
    "payment_processor":"TestPP",
    "redirect_url":null,
    "status":0,
    "trace_id":1000000681,
    "transaction_id":"15607165967620",
    "transaction_status":"approved",
    "version":"1.1",
    "signature":"b5cd45a06f21cb4b566d6be76e4f4690ab31f366e99b95c09da479795fb552bbe63363cc4d73ae45a7f08542fe6968c3"
}

    Response (Declined)

     
    {
    "description":"Ok",
    "error_code":"1",
    "error_details":"[TEST] Transaction status: declined",
    "payment_processor":"TestPP",
    "redirect_url":null,
    "status":0,
    "trace_id":1000000682,
    "transaction_id":"15607165967622",
    "transaction_status":"declined",
    "version":"1.1",
    "signature":"f7a05d4ead2f00d731116b005bb5d8186574611f2818bfc405ad9061d61bc8393b49cc8d7fdd11299cea95c75e9da2e3"
}

    You are currently viewing version 3.3 Latest version here

    2022 © PRAXIS CASHIER