Generate Token

The Generate Token API provides a secure way to authenticate your requests by generating a unique Bearer Token. This token must be included in the header of all subsequent API calls to ensure authorized and encrypted communication between your application and the TouchPay system. It helps safeguard sensitive data, prevent unauthorized access, and maintain the integrity of every transaction request.

Request Requirements:

You will get the API URI from us.

Request Body:

Request Body Structure:

{
  "email": "merchant@company.com",
  "password": "************"
}

Response Structure:

{
  "status":1,
  "message": "The Token is generated successfully.",
  "token" : "eyJaOeaadjgkAbwtCdEfGhIjKlMnOpQrStUvWxYz************************"
}

Fetch Wallet Balance

The Fetch Wallet Balance API allows you to securely retrieve the current wallet balance associated with your account in real time. By using the authorized Bearer Token in the request header, this API ensures that only authenticated users can access wallet information. It provides accurate and up-to-date balance details, enabling your application to display or validate available funds before initiating transactions, while maintaining data integrity and system security.

Request Requirements:

You will get the API URI from us.

Response Structure:

{
  "status": 1,
  "message": "Wallet balance fetched successfully",
  "data": {
        "wallet_balance": "4999.78"
       }
}
              

Initiate Payout

Payout is a service that allows businesses to send payments directly to the accounts of their customers, vendors, or service providers and handles outgoing transactions. They are essential for businesses that need to disburse funds regularly, such as payroll for employees, commissions for affiliates, or payments to freelancers.

Request Requirements:

You will get the API URI from us.

Status Codes

Every API response includes a status that indicates the outcome of the request. Refer to the table below for possible values and their meanings.

Request Body:

Request Body Structure:

{
  "service_provider_id": "14",
  "payment_mode": 1,
  "transaction_id": "TXN12893353",
  "amount": "100",
  "recipient_name": "John Doe",
  "account_type": 1,
  "account": "102759398573",
  "ifsc": "AQC023433",
  "sender_name": "AQC023433",
  "remarks": "Vendor Payment for September",
  "mobile_no": 92840*****
}

Response Structure:

{
    "status": 1,
    "message": "fundTransfer successfully processed",
    "data": {
        "transaction_id": "TXN12893353",
        "amount": "100",
        "txn_status": "success",
        "utr_number": "528615922252"
    }
}

Payin Link

Easily collect payments by generating unique, one-time payment links that can be instantly shared with your customers. These links direct users to a secure hosted page where they can complete their payments seamlessly.

Request Requirements:

You will get the API URI from us.

Request Body:

Request Body Structure:

{
  "service_provider_id": 14,
  "transaction_id": "TXN12893353",
  "amount": 100,
  "redirect_url": "http://redirect_url.com"
}

Response Structure:

{
    "success": true,
    "status_code": 201,
    "message": "Transaction created successfully.",
    "data": {
        "pay_link": "https://touchpay.tech/checkout?order_token=eyJhbGciOiJIUzI1NiIsInR5cC****************",
        "transaction_id": "TXN12893353",
        "amount": 100,
        "status": 1,
        "redirect_url": "http://redirect_url.com"
    }
}

Note: You will be notify as well using webhook for the Payin Approved or Rejected.

What after Pay Link Generation:

Once the user is redirected to the Pay Link, the Payment Page will appear. After completing the payment, the user will be redirected back to your specified redirect_url.

The redirection URL will include a query parameter named signature, for example:

https://redirect_url.com?signature=base64_encoded_string

You can Base64 decode this signature to verify the payment status. Additionally, the same payment status will also be sent via webhook notifications for confirmation.

Decoded Base64 Response Structure:

{
'success' : true,
'statusCode' : 200,
'message' : "Transaction successful",
'event_type' : 'payment_success',
'data' : [
     'client_id' : 'TXN12893353',
     'reference_number' : "o_G1LvGrE5BlMpyOg5-oJ6X7",
     'transaction_amount' : 100,
     'status' : 1,
     'transaction_type' : 'payment'
 ]                
}

Payout Status

The Payout Status API lets you verify the current state of a payout request. Using the unique transaction reference (such as transaction_id), you can check whether a payout is Pending, Approved, Rejected.

Request Requirements:

You will get the API URI from us.

Request Body:

Request Body Structure:

{
  "service_provider_id": 14,
  "transaction_id": "TXN12893353"
}
              

Response Structure:

{
  "status": 1,
  "message": "Record Fetch Success",
  "data": {
      "transaction_id": "TXN12893353",
      "amount": 10,
      "txn_status": "success",
      "reference_id": "ENAN1000131598443",
      "utr_number": "528615922255"
  }
}
              

Note: You will be notify as well using webhook for the Payout Approved or Rejected.

Payin Status

The Payin Status API lets you verify the current state of a payment request. Using the unique transaction reference (such as transaction_id), you can check whether a payment is Pending, Approved, Rejected.

Request Requirements:

You will get the API URI from us.

Request Body:

Request Body Structure:

{
  "service_provider_id": 14,
  "transaction_id": "TXN12893353"
}
              

Response Structure:

{
  "status": 1,
  "message": "Record fetched successfully.",
  "data": {
      "transaction_id": "TXN12893353",
      "amount": 100,
      "txn_status": "success",
      "reference_id": null,
      "utr_number": "o_BLYvmD2NmvJ9nKNY-5K6zn"
     }
}


            

Note: You will be notify as well using webhook for the Payin Approved or Rejected.

Payin Webhook

The Payin Webhook allows you to receive real-time notifications whenever the status of a payin transaction is updated. Once a payin is processed, the system will send a request to your configured webhook URL containing details such as Transaction ID, amount, status. Use this to automatically update your system without polling the status API.

Payin Webhook Response:

{
  "status" : 1,
  "message" : "Payment Success",
  "event_type" : "payment_success",
  "data" :{
        "transaction_id" : "TXN12893353",
        "amount" : 100,
        "txn_status" : "success",
        "utr_number" : "o_G1LvGrE5BlMpyOg5-oJ6X7",
  }
}

Payout Webhook

The Payout Webhook allows you to receive real-time notifications whenever the status of a payout transaction is updated. Once a payout is processed, the system will send a request to your configured webhook URL containing details such as order ID, transaction ID, amount, status, and timestamp. Use this to automatically update your system without polling the status API.

Payout Webhook Response:

{
  "status": 1,
  "message": "Transaction processed successfully",
  "data": {
    "transaction_id": "TXN123456789",
    "amount": 500.00,
    "txn_status": "success",
    "reference_id": "RPT987654321",
    "utr_number": "AXISN12345"
  }
}