Overview

With ITECPay's HTTP API, you can seamlessly integrate the payment page into your website or application, providing a safe and secure payment process for your customers.

This section contains the following sub sections. You can click on the link below to quickly jump to that section:


Concepts.

Gain a comprehensive understanding of the key concepts related to ITECPay's HTTP API. Explore topics such as:

  • authentication
  • endpoints
  • request
  • response formats
  • data encryption

This subsection provides the necessary foundation for effectively utilizing the API.

Usage

Integrate to the Test Environment

Learn how to use ITECPay's HTTP API to integrate payment functionality into your website or application. Discover the step-by-step process of setting up API integration, including authentication, making API calls, handling responses, and error handling.

This subsection guides you through the practical aspects of implementing and utilizing the API.

Once the integration process is successfully completed, a dedicated production account will be created for you by ITECPay. You will be provided with the necessary production credentials, which include authentication details and other relevant information.


Functions

Receiving Payments

In the payment process, the App, acting as the client, utilizes the RequestPayment API to trigger a payment request to a subscriber on ITECPay, which acts as the server.

Upon receiving the payment request from the App, the ITECPay gateway will respond with a pending status, indicating that the transaction is awaiting confirmation from the subscriber.

Once the subscriber confirms the payment on the platform, the ITECPay gateway will then trigger a callback to the App's designated transaction status URL, providing the updated status of the transaction.

This function uses the RequestPayment API.

  • Sending Payment.
  • RequestDeposit API.

Parameter Requirements Levels

In order to integrate the RequestPayment API effectively, the App developer is responsible for developing APIs that align with the specific requirements of each parameter

  • Mandatory Parameters APIs
  • Optional Parameters APIs
  • Conditional Parameters APIs

Format of the Request

Parameters are submitted as http-form post to the ITECPay url

Format of the Response

The ITECPay gateway will provide a response in the json format.

Receiving Payments

Function

As an ITECPay, the process of receiving payments involves the following steps:

  • Payment Request Initiation:

    The App, acting as the client, triggers the RequestPayment API to initiate a payment request.

  • API Communication

    The RequestPayment API forwards the payment request from the App to ITECPay's server.

  • Subscriber Notification

    ITECPay's server receives the payment request and proceeds to notify the subscriber about the pending transaction

  • Subscriber Confirmation

    Upon receiving the notification, the subscriber interacts with the provided interface (such as a web page or mobile app) to review and confirm the payment.

  • Transaction Processing

    Once the subscriber confirms the payment, ITECPay's server processes the transaction securely and initiates the necessary financial transfers between the involved parties.

  • Transaction Status Update

    Following the completion of the payment, ITECPay's server communicates the transaction status back to the App.


Initiating a Payment Request

To initiate a deposit request, you can follow these steps:

  • Prepare Deposit Details:

    Gather all the necessary information required for the deposit request.

  • Invoke the Deposit Request API:

    Utilize the appropriate API, such as the RequestDeposit API, to initiate the deposit request.

  • Transmit the Request:

    Send the deposit request from your application or system to the ITECPay server.

  • Transaction Validation:

    Upon receiving the deposit request, ITECPay validates the transaction details to ensure accuracy and security.

  • Transaction Processing:

    If the deposit request passes the validation process, ITECPay proceeds with processing the transaction.

  • Transaction Confirmation:

    Once the transaction is processed successfully, ITECPay sends a confirmation response back to your application or system.

Checking Account Balance

To retrieve the account balance through the ITECPay system,here are the steps to be followed:

  • Invoke the GetBalance API

    The client application, acting as the App, initiates the account balance query by invoking the GetBalance API.

  • Include Required Parameters:

    The API call should include any necessary parameters, such as authentication credentials, account identifiers, or any other required information to identify and authenticate the user's account.

  • Transmit the Request:

    The client application sends the GetBalance API request to the ITECPay server.

  • Retrieve Account Balance:

    Upon receiving the API request, the ITECPay server verifies the provided credentials and queries the account balance associated with the specified account.

  • Response Handling:

    The ITECPay server generates a response to the GetBalance API request, containing the queried account balance.

  • Process and Display:

    The client application receives the response from the ITECPay server and processes the account balance information.