Praxis Wiki logo

Payment API | {process} | Refund


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://gateway-test.praxispay.com/api/process
Live https://gateway.praxispay.com/api/process

REQUEST PARAMETERS

Variable Type Description
amount int(20) Required. Payment amount in cents.
Please note: for certain currencies (JPY, CLP, KRW, VND, BHD, IQD, JOD, LYD, OMR, TND) the amount is sent as-in without being converted to cents, this is important if you multiply by 100 to send the amount in cents
currency varchar(10) Required. Payment currency
card_number varchar(16) Required. Payment card number (PAN)
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 Optional. Date of birth of the customer. MM/DD/YYYY format accepted.
email varchar(50) Required. Customer's email
phone int(20) Optional. 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) Optional. Customer's IP address
address varchar(50) Optional. Customer's address
city varchar(50) Optional. 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) State/Province where the customer resides. Only for US, CA and AU. 2 characters ISO format. Otherwise leave blank.
zip varchar(12) Required. Postal Code of the customer. Only required for US and CA. 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
notification_url varchar(256) Optional. 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 refund for the refund operation upon the approved card deposit
reference_id varchar(50) refund Required. Original transaction identifier from Praxis
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
trace_id int(11) Required. Transaction identifier in Praxis
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 retry - processing failed and will be reattempted
- declined - processing failed
- cancelled - processing cancelled by the merchant or client
- pending async - customer action expected (3D Secure, etc.)
- requested - merchant action expected (approval)
payment_processor varchar(25) Optional. Gateway doing the processing
error_code int(10) 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 as in request)

EXAMPLE - SALE

For example below: Merchant Secret = "MerchantSecretKey"

Request

curl -X POST \ https://gateway.praxispay.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",
    "dob":"",
    "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",
    "state":"LA",
    "timestamp":1569155177,
    "transaction_type":"sale",
    "version":"1.1",
    "zip":"24123",
    "signature":"4dfe74aec784d1f8946aa6b98a3a63475459df605fbfe5ebcc0e189bb140376f2123a4bd4b1bbcd1946b519110630ed0"
}'

Response (Approved)

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

Response (Declined)

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