PayNet Wallet API

Welcome to the PayNet API documentation. PayNet is a leading payment service provider and wallet system, offering a comprehensive platform to seamlessly integrate secure and efficient payment solutions into your applications, websites, or e-commerce platforms. This documentation provides detailed information on how to utilize PayTabs APIs to manage payments, process transactions, and retrieve essential information.

Understand Your API Response:

    JSON
json
Select...
{
status: true,
sessionExpired: false,
"payloadX": {
}
}
    JSON
json
Select...
{
status: false,
sessionExpired: false,
errors: [
{
shortMessage: "Error occurred",
longMessage: "Error occurred"
}
]
}
    JSON
json
Select...
{
status: false,
sessionExpired: true,
errors: [
{
shortMessage: "Session expired",
longMessage: "Session expired"
}
]
}
  1. All API response are considered as positive or success if the status key in the response is TRUE

  2. All API response are considered as negative or failure if the status key in the response is FALSE

  3. All API response are considered as session expired if the sessionExpired key in the response is TRUE

Our status is sync with the Http Status code, you can also handle the following status code for better error handling.

Status Code
Meaning
200
OK
201
Created
202
Accepted
400
Bad Request
401
Unauthorized
404
Not Found
405
Method Not Allowed
500
Internal Server Error
503
Service Unavailable
504
Gateway Timeout

Security:

Authentication

All API requests must be authenticated with a JWT Token in the request header. Your API keys carry many privileges, so be sure to keep them secret!

You authenticate to the PayNet API by providing your JWT token in the header of each request.

All the APIs require authentication, Click here for detailed information on API Authentication for Merchants and Partners.

Rate Limiting:

All APIs available on the PayNet cloud are limited to access. Users are restricted to a maximum of 2000 API calls per day. If you require a higher limit, please contact us at info@paynet.pro for further assistance.

IP Address Restriction

Valid public IP address is required for production environment.

API Key:

The PayNet API uses API keys to authenticate requests. You can view and manage your API keys in the PayNet Console.

An 'apiKey' is required to be sent with all API requests.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Base URL

Production:

https://gateway.paynet.systems/api

Sandbox:

https://gateway.paynet.systems/api

Language Box

Was this section helpful?

What made this section unhelpful for you?

Test Data

You can use below test data to call the API.

apiKey : Generate Using PayNet Console.

toMemberId: [3,4]

Transfer Type IDs

P2P

14

Loyalty Payments

18

Fixed Fee Payments

21

% Fee Payments

22

Cashback Payments

24

Discount Payments

25

Add Money

-

Withdraw Money

28

Was this section helpful?

What made this section unhelpful for you?

Registration

This API facilitates user registration with an additional layer of security through OTP (One-Time Password) validation. After successful registration, the API provides a resource ID, which is crucial for subsequent registration steps. This documentation outlines the steps to register a user, validate OTP, and obtain the resource ID for further interactions.

Add Money

APIs related to topping up customer wallets. These APIs allow customers to add funds to their wallets.

> Please note: This payment will be in pending state utill we have payment confirmation from outer service like payment gateway, bank etc.

Withdraw Money

Endpoints to perform money withdrawal from the customer wallet to bank account.

Transactions

APIs related to transactions, including payments, cashback, and loyalty rewards. The payment APIs follow a two-step process: validation and execution. transfer types determine the nature of the transaction.

Wallet

APIs related to customer wallets. These APIs allow you to retrieve information about all wallets associated with a customer, fetch specific wallets by their unique identifiers, and obtain wallet balances.

Statement

APIs for generating transaction statements, providing users with detailed records of their financial activities. Users can retrieve statements for a specific time period.

Change PIN

APIs for changing user PINs, allowing users to update their security credentials for authentication purposes. Users can securely change their PINs using the provided endpoints.

Was this section helpful?

What made this section unhelpful for you?

Change PIN

Initiate the process to change the user's PIN.

Request Body Fields

Field Name Type Required Description
oldPin string Yes The old PIN.
newPin string Yes The new PIN.
confirmPin string Yes The confirmed new PIN.

Header Parameters

apikeystring
Paynet-Session-Tokenstring

Body Parameters

oldPinstring
newPinstring
confirmPinstring

Responses

200
Object

Response Attributes

statusboolean
sessionExpiredboolean
messagesarray

Show child attributes

failedboolean
400
Object

Response Attributes

statusboolean
sessionExpiredboolean
errorsarray

Show child attributes

failedboolean

PUT

/members/self/pin

Select
1 2 3 4 5 6 7 8 curl --location --request PUT 'https://gateway.paynet.systems/api/members/self/pin' \ --header 'apikey: {{secret}}' \ --header 'Paynet-Session-Token: {{session}}' \ --data '{ "oldPin": "909090", "newPin": "909090", "confirmPin": "909090" }'

Response

{
  "status": true,
  "sessionExpired": false,
  "messages": [
    {
      "shortMessage": "OTP sent successfully to *****6540",
      "longMessage": "Your OTP for login is 457784"
    }
  ],
  "failed": false
}
Was this section helpful?

What made this section unhelpful for you?

Confirm Change PIN

Confirm the change of the user's PIN.

Request Body Fields

Field Name Type Required Description
oldPin string Yes The old PIN.
newPin string Yes The new PIN.
confirmPin string Yes The confirmed new PIN.
otp string Yes The one-time password (OTP) for verification.

Header Parameters

apikeystring
Paynet-Session-Tokenstring

Body Parameters

oldPinstring
newPinstring
confirmPinstring
otpstring

Responses

200
Object

Response Attributes

statusboolean
sessionExpiredboolean
messagesarray

Show child attributes

failedboolean

PUT

/members/self/pin

Select
1 2 3 4 5 6 7 8 9 curl --location --request PUT 'https://gateway.paynet.systems/api/members/self/pin' \ --header 'apikey: {{secret}}' \ --header 'Paynet-Session-Token: {{session}}' \ --data '{ "oldPin": "123456", "newPin": "909090", "confirmPin": "909090", "otp": "457784" }'

Response

{
  "status": true,
  "sessionExpired": false,
  "messages": [
    {
      "shortMessage": "PIN updated",
      "longMessage": "PIN updated successfully"
    }
  ],
  "failed": false
}
Was this section helpful?

What made this section unhelpful for you?

Login

APIs related to user authentication and profile retrieval, facilitating the login process for users. The APIs allow users to generate session tokens for authentication and fetch their profile information after successful login.

Agreements

QR

APIs related to QR creation, decoding, and payments. These APIs allow customers to create QRs and pay using created QRs.

Document

Endpoints to manage customer documents.

Dispute

The Dispute API allows for the management and resolution of disputes arising from transactions. This collection contains a set of endpoints designed to facilitate the creation, retrieval, updating, and closing of disputes.