Required headers:

Header Name Header Value
Authorization
required		 basic PayGAuthentication
PayGAuthentication = base64encoded(MerchantAuthenticationKey:MerchantAuthenticationToken:M:MerchantKeyId)
OR generate Authorization Header value in PayG Dashboard.
Content-Type
required		 application/json

# Account Balance ??

Request: ??

Merchantkeyid
required		 integer Please get this merchantkeyid from PayG Dashboard
PayoutAccountKeyId
required		 string(50) Provided by PayG for Virtual Account

Response: ??

MerchantKeyId
 integer Echo from request
PayoutAccountKeyId
 string(20) Echo from request
AccountNo
 string(25) Virtual account number provided by bank
BankCode
 string(20) ifsc code
AccountHolderName
 string(50) Account holdername of the virtual account
Address
 string(50) Address of the bank
City
 string(20) City of the Bank
State
 string(20) State of the bank
ZipCode
 string(20) ZipCode of the bank
CurrentBalance
 decimal(18,2) Current balance or your virtual account
Status
 string(20) Status of the api call - "Success"
UpdatedDatetime
 datetime Updated date & time of the account balance

# Add Payout Contact ??

Request: ??

Merchantkeyid
required		 integer Please get this merchantkeyid from PayG Dashboard
RequestUniqueId
required		 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
CustomerId
 string(20)) Unique Id generated for that customer, alphanumeric only
CompanyName
required		 string(50) Name of the Company
FirstName
required		 string(50) Name of the customer
LastName string(50) Customers last name
Address
required		 string(50) Address
City
required		 string(20) City
State
required		 string(20) State
ZipCode
required		 string(20) Zip
Country
 string(50) Country
MobileNo
required		 string(20) contact number
MobileNo2
 string(20) Alternate contact number
Email
required		 string(20) Email id
Email2
 string(20) Alternate email id
UserDefined1
 string(20) Optional Parameter, to be used later
UserDefined2
 string(20) Optional Parameter, to be used later
UserDefined3
 string(20) Optional Parameter, to be used later
UserDefined4
 string(20) Optional Parameter, to be used later
UserDefined5
 string(20) Optional Parameter, to be used later
UserDefined6
 string(20) Optional Parameter, to be used later
UserDefined7
 string(20) Optional Parameter, to be used later
UserDefined8
 string(20) Optional Parameter, to be used later
UserDefined9
 string(20) Optional Parameter, to be used later
UserDefined10
 string(20) Optional Parameter, to be used later

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayoutCustomerkeyId
 integer Unique id provided by PayG for the contact
RequestUniqueId
 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
CustomerId
 string(20)) Unique Id generated for that customer, alphanumeric only
CompanyName
 string(50) Name of the Company
FirstName
 string(50) Name of the customer
LastName string(50) Customers last name
Address
 string(50) Address
City
 string(20) City
State
 string(20) State
ZipCode
 string(20) Zip
Country
 string(50) Country
MobileNo
 string(20) contact number
MobileNo2
 string(20) Alternate contact number
Email
 string(20) Email id
Email2
 string(20) Alternate email id
UserDefined1
 string(20) Optional Parameter, to be used later
UserDefined2
 string(20) Optional Parameter, to be used later
UserDefined3
 string(20) Optional Parameter, to be used later
UserDefined4
 string(20) Optional Parameter, to be used later
UserDefined5
 string(20) Optional Parameter, to be used later
UserDefined6
 string(20) Optional Parameter, to be used later
UserDefined7
 string(20) Optional Parameter, to be used later
UserDefined8
 string(20) Optional Parameter, to be used later
UserDefined9
 string(20) Optional Parameter, to be used later
UserDefined10
 string(20) Optional Parameter, to be used later
UpdatedDatetime
 datetime Updated date & time

# Update Payout Contact ??

Request: ??

Merchantkeyid
required		 integer Please get this merchantkeyid from PayG Dashboard
PayoutCustomerkeyId
required		 string Unique id provided by PayG for the contact
RequestUniqueId
required		 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
CustomerId
required		 string(20)) Unique Id generated for that customer, alphanumeric only
CompanyName
 string(50) Name of the Company
FirstName
required		 string(50) Name of the customer
LastName string(50) Customers last name
Address
required		 string(50) Address
City
required		 string(20) City
State
required		 string(20) State
ZipCode
required		 string(20) Zip
Country
 string(50) Country
MobileNo
required		 string(20) contact number
MobileNo2
 string(20) Alternate contact number
Email
required		 string(20) Email id
Email2
 string(20) Alternate email id
UserDefined1
 string(20) Optional Parameter, to be used later
UserDefined2
 string(20) Optional Parameter, to be used later
UserDefined3
 string(20) Optional Parameter, to be used later
UserDefined4
 string(20) Optional Parameter, to be used later
UserDefined5
 string(20) Optional Parameter, to be used later
UserDefined6
 string(20) Optional Parameter, to be used later
UserDefined7
 string(20) Optional Parameter, to be used later
UserDefined8
 string(20) Optional Parameter, to be used later
UserDefined9
 string(20) Optional Parameter, to be used later
UserDefined10
 string(20) Optional Parameter, to be used later

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayoutCustomerkeyId
 string Unique id provided by PayG for the contact
RequestUniqueId
 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
CustomerId
 string(20)) Unique Id generated for that customer, alphanumeric only
CompanyName
 string(50) Name of the Company
FirstName
 string(50) Name of the customer
LastName string(50) Customers last name
Address
 string(50) Address
City
 string(20) City
State
 string(20) State
ZipCode
 string(20) Zip
Country
 string(50) Country
MobileNo
 string(20) contact number
MobileNo2
 string(20) Alternate contact number
Email
 string(20) Email id
Email2
 string(20) Alternate email id
UserDefined1
 string(20) Optional Parameter, to be used later
UserDefined2
 string(20) Optional Parameter, to be used later
UserDefined3
 string(20) Optional Parameter, to be used later
UserDefined4
 string(20) Optional Parameter, to be used later
UserDefined5
 string(20) Optional Parameter, to be used later
UserDefined6
 string(20) Optional Parameter, to be used later
UserDefined7
 string(20) Optional Parameter, to be used later
UserDefined8
 string(20) Optional Parameter, to be used later
UserDefined9
 string(20) Optional Parameter, to be used later
UserDefined10
 string(20) Optional Parameter, to be used later
UpdatedDatetime
 datetime Updated date & time

# Get Payout Contact ??

Request: ??

Merchantkeyid
required		 integer Please get this merchantkeyid from PayG Dashboard
PayoutCustomerkeyId
required		 string Unique id provided by PayG for the contact

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayoutCustomerkeyId
 string Unique id provided by PayG for the contact
RequestUniqueId
 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
CustomerId
 string(20)) Unique Id generated for that customer, alphanumeric only
CompanyName
 string(50) Name of the Company
FirstName
 string(50) Name of the customer
LastName string(50) Customers last name
Address
 string(50) Address
City
 string(20) City
State
 string(20) State
ZipCode
 string(20) Zip
Country
 string(50) Country
MobileNo
 string(20) contact number
MobileNo2
 string(20) Alternate contact number
Email
 string(20) Email id
Email2
 string(20) Alternate email id
UserDefined1
 string(20) Optional Parameter, to be used later
UserDefined2
 string(20) Optional Parameter, to be used later
UserDefined3
 string(20) Optional Parameter, to be used later
UserDefined4
 string(20) Optional Parameter, to be used later
UserDefined5
 string(20) Optional Parameter, to be used later
UserDefined6
 string(20) Optional Parameter, to be used later
UserDefined7
 string(20) Optional Parameter, to be used later
UserDefined8
 string(20) Optional Parameter, to be used later
UserDefined9
 string(20) Optional Parameter, to be used later
UserDefined10
 string(20) Optional Parameter, to be used later
UpdatedDatetime
 datetime Updated date & time

# Get All Payout Contacts ??

Request: ??

Merchantkeyid
required		 integer Please get this merchantkeyid from PayG Dashboard

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayoutCustomerkeyId
 string Unique id provided by PayG for the contact
RequestUniqueId
 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
CustomerId
 string(20)) Unique Id generated for that customer, alphanumeric only
CompanyName
 string(50) Name of the Company
FirstName
 string(50) Name of the customer
LastName string(50) Customers last name
Address
 string(50) Address
City
 string(20) City
State
 string(20) State
ZipCode
 string(20) Zip
Country
 string(50) Country
MobileNo
 string(20) contact number
MobileNo2
 string(20) Alternate contact number
Email
 string(20) Email id
Email2
 string(20) Alternate email id
UserDefined1
 string(20) Optional Parameter, to be used later
UserDefined2
 string(20) Optional Parameter, to be used later
UserDefined3
 string(20) Optional Parameter, to be used later
UserDefined4
 string(20) Optional Parameter, to be used later
UserDefined5
 string(20) Optional Parameter, to be used later
UserDefined6
 string(20) Optional Parameter, to be used later
UserDefined7
 string(20) Optional Parameter, to be used later
UserDefined8
 string(20) Optional Parameter, to be used later
UserDefined9
 string(20) Optional Parameter, to be used later
UserDefined10
 string(20) Optional Parameter, to be used later
UpdatedDatetime
 datetime Updated date & time

# Add Beneficiary ??

Request: ??

Merchantkeyid
required		 integer Please get this merchantkeyid from PayG Dashboard
PayoutCustomerkeyId
required		 string Unique id provided by PayG for the contact
AccountNumber
required		 string AccountNumber
BeneficiaryName
required		 string BeneficiaryName
BankName
required		 string BankName
BranchName
required		 string BranchName
BankCode
required		 string Ifsc code
BankCodeType
 integer default 5 (it is for IFSC code)
BankCountry
 string Country

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayOutBeneficiaryKeyId
 string Unique Id provided by PayG for the beneficiary
PayoutCustomerkeyId
 string Unique id provided by PayG for the contact
AccountNumber
 string AccountNumber
BeneficiaryName
 string BeneficiaryName
BankName
 string BankName
BranchName
 string BranchName
BankCode
 string Ifsc code
BankCodeType
 integer default 5 (it is for IFSC code)
BankCountry
 string Country
VerificationStatus
 string Verification status. Please refer for Verification status codes
VerificationResponse
 string Verification response
Status
 int Status. Please refer for Response Codes
UpdatedDatetime
 datetime Updated date & time

# Verify Beneficiary ??

Request: ??

Merchantkeyid
required		 integer Please get this merchantkeyid from PayG Dashboard
RequestUniqueId
required		 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only
PayOutType
required		 string Immediate (default)
TransactionType
required		 string Debit (default)
PaymentType
required		 string IMPS (default)
Amount
required		 decimal(18,2) amount
PayOutBeneficiaryKeyId
required		 string Unique id provided by PayG for the Beneficiary
PayoutCustomerkeyId
required		 string Unique id provided by PayG for the contact
PayOutDate
 datetime payout date & time

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayOutBeneficiaryKeyId
 string Unique Id provided by PayG for the beneficiary
PayoutCustomerkeyId
 string CustomerkeyId provided by PayG
AccountNumber
 string AccountNumber
BeneficiaryName
 string BeneficiaryName
BankName
 string BankName
BranchName
 string BranchName
BankCode
 string Ifsc code
BankCodeType
 integer default 5 (it is for IFSC code)
BankCountry
 string Country
VerificationStatus
 string Verification status. Please refer for Verification status codes
VerificationResponse
 string Verification response
Status
 int Status. Please refer for Response Codes
UpdatedDatetime
 datetime Updated date & time

# Get Beneficiary Details ??

Request: ??

MerchantKeyId
required		 integer Please get this merchantkeyid from PayG Dashboard
PayOutBeneficiaryKeyId
required		 string CustomerkeyId provided by PayG

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayOutBeneficiaryKeyId
 string Unique Id provided by PayG for the beneficiary
PayoutCustomerkeyId
 string CustomerkeyId provided by PayG
AccountNumber
 string AccountNumber
BeneficiaryName
 string BeneficiaryName
BankName
 string BankName
BranchName
 string BranchName
BankCode
 string Ifsc code
BankCodeType
 integer default 5 (it is for IFSC code)
BankCountry
 string Country
VerificationStatus
 string Verification status
VerificationResponse
 string Verification response
Status
 int Status
UpdatedDatetime
 datetime Updated date & time

# Get All Beneficiaries ??

Request: ??

MerchantKeyId
required		 integer Please get this merchantkeyid from PayG Dashboard

Response: ??

Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayOutBeneficiaryKeyId
 string Unique Id provided by PayG for the beneficiary
PayoutCustomerkeyId
 string CustomerkeyId provided by PayG
AccountNumber
 string AccountNumber
BeneficiaryName
 string BeneficiaryName
BankName
 string BankName
BranchName
 string BranchName
BankCode
 string Ifsc code
BankCodeType
 integer default 5 (it is for IFSC code)
BankCountry
 string Country
VerificationStatus
 string Verification status
VerificationResponse
 string Verification response
Status
 int Status
UpdatedDatetime
 datetime Updated date & time

# Payout Transfer ??

Request: ??

                                                     
MerchantKeyId
required		 integer Please get this merchantkeyid from PayG Dashboard
RequestUniqueId
required		 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
PayOutType
required		 string Immediate (default)
TransactionType
required		 string Debit (default)
PaymentType
required		 string IMPS (default)
Amount
required		 decimal(18,2) amount
PayOutBeneficiaryKeyId
required		 string Unique id provided by PayG for the Beneficiary
PayoutCustomerkeyId
required		 string Unique id provided by PayG for the contact
ProductData
required		 string - Json ObjectProduct/Service detail related to the order, please review ProductData for more detail and example
PayOutDate
 datetime payout date & time

Response: ??

TransactionId
 integer Id of the transaction
PayOutKeyId
 integer Unique id provided by PayG
Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayOutType
 string echo from request
PayOutDate
 datetime date & time
TransactionType
 string Debit (default)
PaymentType
 string IMPS (default)
Amount
 decimal(18,2) echo from request
PayOutBeneficiaryKeyId
 string Unique Id provided by PayG for the beneficiary
PayoutCustomerkeyId
 string CustomerkeyId provided by PayG
RequestUniqueId
 string(10) echo from the request
Status
 string status
ResponseCode
 string response. Please refer for Response Codes
ResponseText
 string response text
FeeCode
 string fee code
FeeAmount
 decimal(18,2) fee amount
GSTPercentage
 int gst percentage
GSTAmount
 decimal(18,2) gst amount
TotalFeeAmount
 decimal(18,2) total feeamount
AdditionalFee
 decimal(18,2) additional charges
BuyAmount
 decimal(18,2) bank fee
BuyGSTAmount
 decimal(18,2) bank gst
BatchId
 datetime Batchid
UpdatedDateTime
 datetime Updated date & time

# Payout Transfer Status ??

Request: ??

TransactionId
 integer Id of the transaction
PayOutKeyId
 string Unique id provided by PayG
MerchantKeyId
required		 integer Please get this merchantkeyid from PayG Dashboard

Response: ??

TransactionId
 integer Id of the transaction
PayOutKeyId
 integer Unique id provided by PayG
Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayOutType
 string echo from request
PayOutDate
 datetime date & time
TransactionType
 string Debit (default)
PaymentType
 string IMPS (default)
Amount
 decimal(18,2) echo from request
PayOutBeneficiaryKeyId
 string Unique Id provided by PayG for the beneficiary
PayoutCustomerkeyId
 string CustomerkeyId provided by PayG
RequestUniqueId
 string(10) echo from the request
Status
 string status. Please refer for Status Codes
ResponseCode
 string response
ResponseText
 string response text
FeeCode
 string fee code
FeeAmount
 decimal(18,2) fee amount
GSTPercentage
 int gst percentage
GSTAmount
 decimal(18,2) gst amount
TotalFeeAmount
 decimal(18,2) total feeamount
AdditionalFee
 decimal(18,2) additional charges
BuyAmount
 decimal(18,2) bank fee
BuyGSTAmount
 decimal(18,2) bank gst
BatchId
 datetime Batchid
UpdatedDateTime
 datetime Updated date & time
UTRNo
 string Transaction reference number

# Advanced Payout Transfer ??

Request: ??

                                                     
MerchantKeyId
required		 integer Please get this merchantkeyid from PayG Dashboard
RequestUniqueId
required		 string(10) Unique Id generated for that particular Request and it should not be repeated, alphanumeric only.
PayOutType
required		 string Immediate (default)
TransactionType
required		 string Debit (default)
PaymentType
required		 string IMPS (default)
Amount
required		 decimal(18,2) amount
PayoutCustomerkeyId
required		 string Unique id provided by PayG for the contact
AccountNumber
required		 string AccountNumber
BeneficiaryName
required		 string BeneficiaryName
BankName
required		 string BankName
BranchName
required		 string BranchName
BankCode
required		 string Ifsc code
ProductData
required		 string - Json ObjectProduct/Service detail related to the order, please review ProductData for more detail and example
BankCountry
 string Country
PayOutDate
 datetime payout date & time
KycData
 string kyc data
BeneficiaryVerification
 int 0 (default)

Response: ??

TransactionId
 integer Id of the transaction
PayOutKeyId
 integer Unique id provided by PayG
Merchantkeyid
 integer Please get this merchantkeyid from PayG Dashboard
PayOutType
 string echo from request
PayOutDate
 datetime date & time
TransactionType
 string Debit (default)
PaymentType
 string IMPS (default)
Amount
 decimal(18,2) echo from request
PayOutBeneficiaryKeyId
 string Unique Id provided by PayG for the beneficiary
PayoutCustomerkeyId
 string CustomerkeyId provided by PayG
RequestUniqueId
 string(10) echo from the request
Status
 string status.
ResponseCode
 string response Please refer for Response Codes
ResponseText
 string response text
FeeCode
 string fee code
FeeAmount
 decimal(18,2) fee amount
GSTPercentage
 int gst percentage
GSTAmount
 decimal(18,2) gst amount
TotalFeeAmount
 decimal(18,2) total feeamount
AdditionalFee
 decimal(18,2) additional charges
BuyAmount
 decimal(18,2) bank fee
BuyGSTAmount
 decimal(18,2) bank gst
BatchId
 datetime Batchid
UpdatedDateTime
 datetime Updated date & time

ProductData Object: ??

Note: Product/service detail of the order, this detail will be displayed on payment page (by default, and can be configured, please check settings in merchant portal) and the transaction reciept.
example "ProductData":"{'PaymentReason':'OnlineOrder for OrderNo- 1234', 'ItemId':'T-shirt', 'Size':'medium', 'AppName':'yourAppName'}" Suggestion: please refer below table contents as suggestion and you can add as per your requirement. however it should be valid json object
PaymentReason string(50) Reason for this payment
ServiceType string(50) Type of the service
ProductName string(50) Name of the product