Introduction

 

Kartpay is an Online Payment Platform Allows you to Process your Payments at Faster Rate with High Level Security.

Kartpay Platform Experience

 

Web Integration

 

Kartpay provides very simple and developer friendly API for collection of payments. Currently we only support hosted checkout method.

Transaction Request API

 

Merchant needs to post the request parameters on the Payment Gateway URLs that are given below. Dynamic & unique Order_ID (explained in table below) needs to be appended to each request as shown. Below are Payment Gateway URL’s:

Staging:

https://test.kartpay.com/api/v1/payments

Production:

https://live.kartpay.com/api/v1/payments

The Request Parameters for Normal transactions are as given below:

Parameter Name Type Mandatory

merchant_id

Alphanumeric

Yes

access_key

Alphanumeric

Yes

currency

Alphanumeric

Max 3 (INR)

Yes

order_id

Alphanumeric Dash

Max 10

Yes

order_amount

Numeric

Min : 1

Yes

customer_email

Email

Yes

customer_phone

Numeric

Max : 10

Between : 1 - 10

Yes

success_url

URL

Yes

FAILED_URL failed_url

URL

Yes

hash

Alpha

Yes

language

Alpha

Min : 2, Max : 2

Yes

api_option

Alpha (hosted, iframe, seamless)

Yes

udf1

User Defined Parameters
(String)

No

udf2

User Defined Parameters
(String)

No

udf3

User Defined Parameters
(String)

No

udf4

User Defined Parameters
(String)

No

udf5

User Defined Parameters
(String)

No

billing_name

Alpha Spaces

Max : 100

No

billing_address

Alpha Spaces

Max : 200

No

billing_city

Alpha

Max : 20

No

billing_state

Alpha

Max : 20

No

billing_zip

Numeric

Between : 1 - 8

No

billing_phone

Numeric

Between : 1 - 10

No

billing_email

Email

No

shipping_name

Alpha Spaces

Max : 100

No

shipping_address

Alpha Spaces

Max : 200

No

shipping_city

Alpha

Max : 20

No

shipping_state

Alpha

Max : 20

No

shipping_zip

Numeric

Between : 1 - 8

No

shipping_phone

Numeric

Between : 1 - 10

No

shipping_email

Email

No

  • If Billing Parameters are passed then all Billing Parameters need to be sent else you will face an error.
  • If Shipping Parameters are sent then All parameters of Billing and Shipping is compulsory.
Test API

https://test.kartpay.com/api/v1/payments

Live API

https://live.kartpay.com/api/v1/payments


How to Generate Hash

 

Follow the Sequence of the Code in the same Manner to Generate the Correct Hash, Wrong Hash Code will not allow you to check

Sequence => merchant_id + access_key + order_id + order_amount + currency + customer_email + customer_phone + language

Example:

    Merchant ID => 1
    Access Key = > oimQgm3UzD4ZA3jbWuDA67421
    Order ID => 121212
    Amount = > 10.00
    Currency = > INR
    Email = > xyz@gmail.com
    Phone = > 1111111111

So Sequence would be: 1oimQgm3UzD4ZA3jbWuDA6742121212110.00INRxyz@gmail.com1111111111

Hash Formula: hash('sha512', $data)

Hash Generated: 5c423b59997e8d0b5ddc1ecb080c1f5fa3c84a9590899
3c096e5c35200ef90d9ef24e210810f6622912228f0
deb6c3243f314daddbd39a1f304d782ffefe6144


Transaction Status API

 

Merchant needs to post the request parameters on the Payment Gateway URLs that are given below. Dynamic & unique Order_ID (explained in table below) needs to be appended to each request as shown. Below are Payment Gateway URL’s:

Staging:

https://test.kartpay.com/api/v1/txn_status

Production:

https://live.kartpay.com/api/v1/txn_status

The Request Parameters for Normal transactions are as given below:

Parameter Name Type Mandatory

MID

Alphanumeric

Yes

ACCESS_KEY

Alphanumeric

Yes

HASH

Alphanumeric

Yes

ORDER_ID

Alphanumeric Dash

Max 10

Yes

Follow the Sequence of the Code in the same Manner to Generate the Correct Hash, Wrong Hash Code will not allow you to check.

Sequence => merchant_id(+)access_key(+)kartpay_id(+)order_id(+)refund_amount(+)reason

Example:

    MID => 1
    access_key = > tyytQgm3UzD4ZA3jbWuDA67421
    order_id = > 12145

So Sequence would be: tyytQgm3UzD4ZA3jbWuDA612145

Hash Formula: hash('sha512', $data)

Hash Generated: 7072f1b364a64bcf4752bb7fa6c18f909b55a
83dc5aa4f507dd929427cd9e186e38dde523ed53
ce4ab35c3349dce6875ce5d0a1615b90aa71be0e27d15eae63e

Test API

https://test.kartpay.com/api/v1/txn_status

Live API

https://live.kartpay.com/api/v1/txn_status


Refund Request API

 

Merchant needs to post the request parameters on the Payment Gateway URLs that are given below. Dynamic & unique Order_ID (explained in table below) needs to be appended to each request as shown. Below are Payment Gateway URL’s:

Staging:

https://test.kartpay.com/api/v1/refunds

Production:

https://live.kartpay.com/api/v1/refunds

The Request Parameters for Normal transactions are as given below:

Parameter Name Type Mandatory

MERCHANT_ID

Alphanumeric

Yes

ACCESS_KEY

Alphanumeric

Yes

KARTPAY_ID

Alphanumeric

Yes

ORDER_ID

Alphanumeric Dash

Max 10

Yes

REFUND_AMOUNT

Numeric

Min : 0.1

Yes

REASON

Alphanumeric

Yes

HASH

Alphanumeric

Yes

Follow the Sequence of the Code in the same Manner to Generate the Correct Hash, Wrong Hash Code will not allow you to check.

Sequence => merchant_id(+)access_key(+)kartpay_id(+)order_id(+)refund_amount(+)reason

Example:

    merchant_id => 1
    access_key = > tyytQgm3UzD4ZA3jbWuDA67421
    kartpay_id = > 12345
    order_id = > 12145
    refund_amount = > 10.00
    reason = > Can not passs

So Sequence would be: 1tyytQgm3UzD4ZA3jbWuDA67421123451214510.00Can not passs

Hash Formula: hash('sha512', $data)

Hash Generated: 7072f1b364a64bcf4752bb7fa6c18f909b55a
83dc5aa4f507dd929427cd9e186e38dde523ed53
ce4ab35c3349dce6875ce5d0a1615b90aa71be0e27d15eae63e

Test API

https://test.kartpay.com/api/v1/refunds

Live API

https://live.kartpay.com/api/v1/refunds


Refund Status API

 

Merchant needs to post the request parameters on the Payment Gateway URLs that are given below. Dynamic & unique Order_ID (explained in table below) needs to be appended to each request as shown. Below are Payment Gateway URL’s:

Staging:

https://test.kartpay.com/api/v1/refund_status

Production:

https://live.kartpay.com/api/v1/refund_status

The Request Parameters for Normal transactions are as given below:

Parameter Name Type Mandatory

MERCHANT_ID

Alphanumeric

Yes

ACCESS_KEY

Alphanumeric

Yes

ORDER_ID

Alphanumeric Dash

Max 10

Yes

ORDER_AMOUNT

Numeric

Min : 1

Yes

HASH

Alphanumeric

Yes

Test API

https://test.kartpay.com/api/v1/refund_status

Live API

https://live.kartpay.com/api/v1/refund_status

App Integration

 

Currently this method is not available. It would be notified soon on merchant dashboard or at the same page.