Payout Client

  • API Specification
  • Required headers:

    Header Name Header Value
    Authorization
    required
    basic PayGAuthentication
    PayGAuthentication = base64encoded(MerchantAuthenticationKey:MerchantAuthenticationToken:M:MerchantKeyId)
    Base64 Encode.
    Content-Type
    required
    application/json

    Please refer Payout API Documentation for more details.

    1. Get Account Balance ๐Ÿ”—

    Use the below url for your check balance

    URL:https://uatapi.payg.in/payment/api/Payout/CheckBalance

    
    {
    "MerchantKeyId": 7771,
    "PayoutAccountKeyId": "PayGM7771AID000002"
    }
      
                      
          
    {
    "MerchantKeyId": 7771,
    "PayoutAccountKeyId": "PayGM7771AID000002",
    "AccountNo": "PayGX000000011113",
    "BankCode": "A000001",
    "AccountHolderName": "TEST",
    "Address": "Hyderbaad",
    "City": null,
    "State": null,
    "ZipCode": null,
    "CurrentBalance": 5000,
    "Status": "Success",
    "UpdatedDatetime": "2020-12-24T20:12:44"
    }
      
     

    2. Add Payout Contact ๐Ÿ”—

    URL: https://uatapi.payg.in/payment/api/Payout/AddContact

    
    {
    "MerchantKeyId": 2,
    "RequestUniqueId":  "Test123",
    "CustomerId":  "Customer123",
    "CompanyName":  "Xsilica",
    "FirstName":  "First Name",
    "LastName":  "Last Name",
    "Address":  "Banjara Hill ",
    "City":  "Hyderabad",
    "State":  "Telangana",
    "ZipCode":  "500034",
    "Country":  "India",
    "MobileNo":  "90XXXXXXXX",
    "MobileNo2":  "",
    "Email":  "test@abc.com",
    "Email2":  "",
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  โ€œ",
    "UserDefined10":  ""
    }
      
                      
          
    {
    "MerchantKeyId":  2,
    "PayoutCustomerkeyId":  "M7771C1801",
    "RequestUniqueId":  "Test123",
    "CustomerId":  "Customer123",
    "CompanyName":  "Xsilica",
    "FirstName":  "First Name",
    "LastName":  "Last Name",
    "Address":  "Banjara Hill ",
    "City": " Hyderabad",
    "State":  "Telangana",
    "ZipCode":  "500034",
    "Country":  "India",
    "MobileNo":  "90XXXXXXXX",
    "MobileNo2":  "",
    "Email":  "test@abc.com",
    "Email2":  "",
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  โ€œ",
    "UserDefined10":  "",
    "UpdatedDatetime":  "2020-12-04T19:02:03.757"
    }
      
     

    3. Update Payout Contact ๐Ÿ”—

    URL: https://uatapi.payg.in/payment/api/Payout/UpdateContact

          
    {
    "MerchantKeyId":  2,
    "PayoutCustomerkeyId":  "M7771C1801",
    "RequestUniqueId":  "Test123",
    "CustomerId":  "Customer123",
    "CompanyName":  "Xsilica",
    "FirstName":  "First Name",
    "LastName":  "Last Name",
    "Address":  "Banjara Hill ",
    "City":  "Hyderabad",
    "State":  "Telangana",
    "ZipCode":  "500034",
    "Country":  "India",
    "MobileNo":  "90XXXXXXXX",
    "MobileNo2":  "",
    "Email":  "test@abc.com",
    "Email2":  "",
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  โ€œ",
    "UserDefined10":  ""
    }
      
     
          
    {
    "MerchantKeyId":  2,
    "PayoutCustomerkeyId":  "M7771C1801",
    "RequestUniqueId":  "Test123",
    "CustomerId":  "Customer123",
    "CompanyName":  "Xsilica",
    "FirstName":  "First Name",
    "LastName":  "Last Name",
    "Address":  "Banjara Hill ",
    "City":  "Hyderabad",
    "State":  "Telangana",
    "ZipCode":  "500034",
    "Country":  "India",
    "MobileNo":  "90XXXXXXXX",
    "MobileNo2":  "",
    "Email":  "test@abc.com",
    "Email2":  "",
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  โ€œ",
    "UserDefined10":  "" ,
    "UpdatedDatetime":  "2020-12-04T19:02:03.757",
    }
      
     

    4. Get Payout Contact ๐Ÿ”—

    URL: https://uatapi.payg.in/payment/api/Payout/GetContact

                            
    {
    "MerchantKeyId":  2,
    "PayoutCustomerkeyId":  "M7771C1801"
    }
      
     
                            
    {
    "MerchantKeyId":  2,
    "PayoutCustomerkeyId":  "M7771C1801",
    "RequestUniqueId":  "Test123",
    "CustomerId":  "Customer123",
    "CompanyName":  "Xsilica",
    "FirstName":  "First Name",
    "LastName":  "Last Name",
    "Address":  "Banjara Hill ",
    "City":  "Hyderabad",
    "State":  "Telangana",
    "ZipCode":  "500034",
    "Country":  "India",
    "MobileNo":  "90XXXXXXXX",
    "MobileNo2":  "",
    "Email":  "test@abc.com",
    "Email2":  "",
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  โ€œ",
    "UserDefined10" : "" ,
    "UpdatedDatetime":  "2020-12-04T19:02:03.757",
    }
      
     

    5. Get All Payout Contacts ๐Ÿ”—

    URL: : https://uatapi.payg.in/payment/api/Payout/GetContacts

                            
    {
    "MerchantKeyId":  2,
    "PayoutCustomerkeyId":  "M7771C1801"
    }
      
     
                            
    
    {
    "Id":  2,
    "MerchantKeyId":  7771,
    "PayoutCustomerkeyId":  "M7771Ca7ae1",
    "RequestUniqueId":  "a7ae13cf-d1c2-4804-8290-fac109d48c0c",
    "CustomerId":  "SKT@11321",
    "CompanyName":  "Test Company",
    "FirstName": "Suryapal",
    "LastName":  "",
    "Address":  "Surjapol",
    "City":  "Hyderbad",
    "State":  "Telanagana",
    "ZipCode":  "555555",
    "Country":  "India",
    "MobileNo":   "80XXXXXX",
    "MobileNo2":  "",
    "Email":  "abc@xsilica.com",
    "Email2":  "",
    "Status":  1,
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  "",
    "UserDefined10":  "",
    "UpdatedUserName":  "0b8f90ac-0987-4bb5-a4a6-6bf67fa39529",
    "UpdatedDatetime":  "2020-12-03T20:54:08.657",
    },
    {
    "Id":  8,
    "MerchantKeyId":  7771,
    "PayoutCustomerkeyId":  "M7771CTEst13",
    "RequestUniqueId":  "TEst13",
    "CustomerId":  "3214",
    "CompanyName":  "R.D.T",
    "FirstName":  "Sai",
    "LastName":  "",
    "Address":  "Ameerpret",
    "City":  "hyd",
    "State":  "tel",
    "ZipCode":  "530590",
    "Country":  "Indian",
    "MobileNo":  "80XXXX",
    "MobileNo2":  "",
    "Email":  "test@abc.com",
    "Email2":  "",
    "Status":  1,
    "UserDefined1":  "",
    "UserDefined2":  "",
    "UserDefined3":  "",
    "UserDefined4":  "",
    "UserDefined5":  "",
    "UserDefined6":  "",
    "UserDefined7":  "",
    "UserDefined8":  "",
    "UserDefined9":  "",
    "UserDefined10":  "",
    "UpdatedUserName":  "",
    "UpdatedDatetime":  "2020-12-04T19:02:03.757",
    },
    etcโ€ฆ..
    
      
     

    6. Add Beneficiary ๐Ÿ”—

    URL: :https://uatapi.payg.in/payment/api/Payout/AddBeneficiary

                            
    {
    "MerchantKeyId":  7771,
    "PayoutCustomerkeyId":  "M7771C1801",
    "BankCodeType":  0,
    "BankName": " SBI",
    "BranchName":  "Repalle",
    "BankCode":  "SBIN0000183",
    "AccountNumber":  "123XXXXX000000",
    "BankAccountType":  0,
    "BankCountry":  "India",
    "BeneficiaryName":  "Test"
    }
      
     
                            
    {
    "MerchantKeyId":  7771,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "BankCodeType":  5,
    "BankName":  "SBI",
    "BranchName":  "Repalle",
    "BankCode":  "SBIN0000183",
    "AccountNumber":  "123XXXXX000000",
    "BankAccountType":  0,
    "BankCountry":  "India",
    "VerificationStatus":  "Pending for Verification",
    "VerificationResponse":  "4",
    "Status":  1,
    "BeneficiaryName" :  "Test",
    "UpdatedDatetime":  "2021-05-04T18:48:34.4577757+05:30"
    }
      
     

    7. Verify Beneficiary ๐Ÿ”—

    URL:https://uatapi.payg.in/payment/api/Payout/InitiateBeneficiaryVerification

          
    {
    "MerchantKeyId":  7771,
    "UniqueRequestId":  "testpayout",
    "PayOutType":  "Immediate",
    "PayOutDate":  "",
    "TransactionType":  "Debit",
    "PaymentType":  "IMPS",
    "Amount":  1.0,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801"
    }
          
          

          
    {
    "TransactionId":  2,
    "PayOutKeyId":  "PDD78797",
    "MerchantKeyId":  2,
    "PayOutType":  "Immediate",
    "PayOutDate":  "2021-04-26T12:06:06.8035695+05:30",
    "TransactionType":  "Debit",
    "PaymentType":  "IMPS",
    "Amount":  1,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "UniqueRequestId":  testpayout,
    "Status":  0,
    "ResponseCode":  "1",
    "ResponseText":  Approved,
    "UpdatedDateTime":  "2021-04-26T12:06:19.8834096+05:30"
    }
          
          

    8. Get Beneficiary Details ๐Ÿ”—

    URL:: https://uatapi.payg.in/payment/api/Payout/GetBeneficiary

          
    {
    "MerchantKeyId":  7771,
    "PayOutBeneficiaryKeyId":  "M7771B58515"
    }
          
          

          
    {
    "MerchantKeyId":  7771,
    "PayOutBeneficiaryKeyId" : "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "BankCodeType":  5,
    "BankName":  "SBI",
    "BranchName":  "Repalle",
    "BankCode":  "SBIN0000183",
    "AccountNumber":  "134XXXXX123",
    "BankAccountType":  0,
    "BankCountry":  "India",
    "VerificationStatus":  "Pending for Verification",
    "VerificationResponse":  "4",
    "Status":  1,
    โ€œBeneficiaryNameโ€ :  โ€œTestโ€
    "UpdatedDatetime":  "2021-05-04T18:48:34.457",
    }
          
          

    9. Get All Beneficiary ๐Ÿ”—

    URL:: https://uatapi.payg.in/payment/api/Payout/GetBeneficiaries

          
    {
    "MerchantKeyId":  7771,
    "PayOutBeneficiaryKeyId":  "M7771B58515"
    }
          
          

          
    
    {
    "MerchantKeyId":  7771,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "BankCodeType":  5,
    "BankName":  "SBI",
    "BranchName":  "Repalle",
    "BankCode":  "SBIN0000183",
    "AccountNumber":  "134XXXXX123",
    "BankAccountType":  0,
    "BankCountry":  "India",
    "VerificationStatus":  "Pending for Verification",
    "VerificationResponse":  "4",
    "Status":  1,
    โ€œBeneficiaryNameโ€ :  โ€œTestโ€
    "UpdatedDatetime":  "2021-05-04T18:48:34.457",
    }
         
          

    10. Payout Transfer ๐Ÿ”—

    URL:: https://paygapi.payg.in/payment/api/PayOut/FundTransfer

          
    {
    "MerchantKeyId":  7771,
    "UniqueRequestId":  "testpayout",
    "PayOutType":  "Immediate",
    "PayOutDate":  "",
    "TransactionType":  "Debit",
    "PaymentType":  "IMPS",
    "Amount":  1.0,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "ProductData": "{'PaymentReason':'OnlineOrder for OrderNo- 1234','ItemId':'T-shirt',Size':'medium', 'AppName':'XYZApp'}"
    }
          
          

          
    {
    "TransactionId":  2,
    "PayOutKeyId":  "PDD78797",
    "MerchantKeyId":  2,
    "PayOutType":  "Immediate",
    "PayOutDate":  "2021-04-26T12:06:06.8035695+05:30",
    "TransactionType":  "Debit",
    "PaymentType":  "IMPS",
    "Amount":  1,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "UniqueRequestId":  testpayout,
    "Status":  0,
    "ResponseCode":  "1",
    "ResponseText":  Approved,
    "FeeCode": " sample string 28",
    "FeeAmount":  29.0,
    "GSTPercentage":  30.0,
    "GSTAmount":  31.0,
    "TotalFeeAmount":  32.0,
    "AdditionalFee":  33.0,
    "BuyAmount":  34.0,
    "BuyGSTAmount":  35.0,
    "BatchId":  36
    "UpdatedDateTime":  "2021-04-26T12:06:19.8834096+05:30"
    }
       
          

    11. Payout Transfer Status ๐Ÿ”—

    URL:: https://paygapi.payg.in/payment/api/PayOut/FundStatus

          
    {
    "TransactionId": "2",
    "PayOutKeyId":  "PMD3423432",
    "MerchantKeyId":2
    }
          
          
          
    {
    "TransactionId": 2,
    "PayOutKeyId":  "PDD78797",
    "MerchantKeyId":  2,
    "PayOutType":  "Immediate",
    "PayOutDate":  "2021-04-26T12:06:06.8035695+05:30",
    "TransactionType":  "Debit",
    "PaymentType":  "IMPS",
    "Amount":  1,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "UniqueRequestId":  testpayout,
    "Status":  0,
    "ResponseCode":  "1",
    "ResponseText":  Approved,
    "FeeCode":  "sample string 28",
    "FeeAmount":  29.0,
    "GSTPercentage":  30.0,
    "GSTAmount":  31.0,
    "TotalFeeAmount":  32.0,
    "AdditionalFee":  33.0,
    "BuyAmount":  34.0,
    "BuyGSTAmount":  35.0,
    "BatchId":  36
    "UpdatedDateTime":  "2021-04-26T12:06:19.8834096+05:30"
    "UTRNo":  "IND03458"
    }
       
          

    12. Advanced Payout Transfer ๐Ÿ”—

    URL:: https://paygapi.payg.in/payment/api/PayOut/FundTransfer2

          
    {
       "MerchantKeyId":  8463,
       "UniqueRequestId":  "0091928",
       "PayOutType":  "Immediate",
       "PayOutDate":  "2021-07-03T13:03:02.2437907+05:30",
       "PaymentType":  "IMPS",
       "Amount":  5.0,
       "PayoutCustomerkeyId":  "M8463CID284",
       "BankName":  "Idbi",
       "BranchName":  "Hyderabad",
       "BankCode":  "IBKL0000183",
       "AccountNumber":  "100022872707",
       "BankCountry":  "",
       "BeneficiaryName":  "Anil",
       "ProductData":  "",
       "KycData":  "",
       "BeneficiaryVerification": 0,
       "ProductData": "{'PaymentReason':'OnlineOrder for OrderNo- 1234','ItemId':'T-shirt',Size':'medium', 'AppName':'XYZApp'}"
    
    }
    
          
          

          
    {
    "TransactionId":  2,
    "PayOutKeyId":  "PDD78797",
    "MerchantKeyId":  2,
    "PayOutType":  "Immediate",
    "PayOutDate":  "2021-04-26T12:06:06.8035695+05:30",
    "TransactionType":  "Debit",
    "PaymentType":  "IMPS",
    "Amount":  1,
    "PayOutBeneficiaryKeyId":  "M7771B58515",
    "PayoutCustomerkeyId":  "M7771C1801",
    "UniqueRequestId":  testpayout,
    "Status":  0,
    "ResponseCode":  "1",
    "ResponseText":  Approved,
    "FeeCode":  "sample string 28",
    "FeeAmount":  29.0,
    "GSTPercentage":  30.0,
    "GSTAmount":  31.0,
    "TotalFeeAmount":  32.0,
    "AdditionalFee":  33.0,
    "BuyAmount":  34.0,
    "BuyGSTAmount":  35.0,
    "BatchId":  36
    "UpdatedDateTime":  "2021-04-26T12:06:19.8834096+05:30"
    }