This document provides technical specs for our Operator to perform integration and integration tests with Singhapay Payment Gateway. This documentation includes functions, parameters, results, and error responses.
\n4.1 Pre Requirement Provide by Provider
\nServer info & API URL
\nCredential api : api key, secret key, merchant code
\nCredential BO : username , password
\n4.2 Pre Requirement Provide by Operator :
\nAPI Callback URL ( mandatory )
\nCall back success url page ( optional )
\nCall back failed url page ( optional )
\n4.3 Api Security
\nToken and transaction key ( Need to create token and key for each transaction )
\nIP White list for Back Office login
\nThis Function provides secure AES-256-CBC encryption and decryption capabilities for sensitive data transmission. It uses industry-standard cryptographic methods with proper key derivation and initialization vector generation for secure data exchange between systems.
\nWhen action = \"encrypt\":
Authentication: Validates the provided API key and secret key
\nKey Derivation: Generates a 256-bit encryption key using SHA-256 hash of the API key
\nIV Generation: Creates a 128-bit initialization vector using SHA-256 hash of the secret key
\nEncryption: Encrypts the input data using AES-256-CBC algorithm
\nEncoding: Applies Base64 encoding followed by URL encoding for safe transmission
\nResponse: Returns the URL-encoded, Base64-encoded encrypted string
\nWhen action = \"decrypt\":
Authentication: Validates the provided API key and secret key
\nDecoding: URL decodes then Base64 decodes the input data
\nKey/IV Regeneration: Uses the same derivation process as encryption
\nDecryption: Decrypts the data using AES-256-CBC algorithm
\nResponse: Returns the original plaintext data
\nEncryption Algorithm: AES-256-CBC (Advanced Encryption Standard with 256-bit key)
\nKey Size: 256 bits (32 bytes)
\nIV Size: 128 bits (16 bytes)
\nHash Algorithm: SHA-256 for key and IV derivation
\nEncoding: Base64 + URL encoding for encrypted output
\nContent-Type: Supports both application/json and application/x-www-form-urlencoded
public function encrypt_decrypt($action, $string, $apikey = '{your_api_key}', $secretkey = '{your_secret_key}') {\n $output = false;\n $encrypt_method = \"AES-256-CBC\";\n $secret_key = $apikey;\n $secret_iv = $secretkey;\n // hash\n $key = substr(hash('sha256', $secret_key, true), 0, 32);\n $iv = substr(hash('sha256', $secret_iv), 0, 16);\n if ( $action == 'encrypt' ) {\n $output = openssl_encrypt($string, $encrypt_method, $key, OPENSSL_RAW_DATA, $iv);\n $output = base64_encode($output);\n $output = urlencode($output);\n } else if( $action == 'decrypt' ) {\n $output = openssl_decrypt(base64_decode(urldecode($string)), $encrypt_method, $key, OPENSSL_RAW_DATA, $iv);\n }\n return $output;\n}\n\n2. C#
\nusing System;\nusing System.Security.Cryptography; \nusing System.Text;\nusing System.IO;\npublic class EncryptDecrypt\n{\n public static void Main()\n {\n string source = \"currency_code=INR&merchant_code=213213&merchant_api_key=3213212ewfewqfwqf&transaction_code=TEST-DP-163158903432&transaction_timestamp=1631589012&bank_code=1003&transaction_amount=1000\";\n string apiKey = \"3213212ewfewqfwqf\";\n string secretKey = \"jdo383f1d2021ehd1dj2di32\";\n string result = encrypt_decrypt(\"encrypt\", source, apiKey, secretKey);\n Console.WriteLine(\"The key of \" + source + \" is: \" + result);\n Console.WriteLine(\"Decoded of key \" + result + \" is: \" + encrypt_decrypt(\"decrypt\", result, apiKey, secretKey));\n }\n public static string encrypt_decrypt(string action, string payload, string apikey, string secretkey){\n string secret_iv = secretkey;\n string iv = hashSha256(secret_iv).Substring(0, 16);\n SHA256 mySHA256 = SHA256Managed.Create();\n string output = \"\";\n if ( action == \"encrypt\" ) {\n output = EncryptString(payload, mySHA256.ComputeHash(Encoding.ASCII.GetBytes(apikey)), Encoding.ASCII.GetBytes(iv));\n } else if( action == \"decrypt\" ) {\n output = DecryptString(payload, mySHA256.ComputeHash(Encoding.ASCII.GetBytes(apikey)), Encoding.ASCII.GetBytes(iv));\n }\n return output;\n }\n public static string hashSha256(string payload){\n string hash = \"\";\n using (SHA256 sha256Hash = SHA256.Create()){\n byte[] sourceBytes = Encoding.UTF8.GetBytes(payload);\n byte[] hashBytes = sha256Hash.ComputeHash(sourceBytes);\n hash = BitConverter.ToString(hashBytes).Replace(\"-\", String.Empty).ToLower();\n }\n return hash;\n }\n public static string EncryptString(string plainText, byte[] key, byte[] iv)\n { \n Aes encryptor = Aes.Create();\n encryptor.Mode = CipherMode.CBC;\n encryptor.Key = key;\n encryptor.IV = iv;\n MemoryStream memoryStream = new MemoryStream();\n ICryptoTransform aesEncryptor = encryptor.CreateEncryptor();\n CryptoStream cryptoStream = new CryptoStream(memoryStream, aesEncryptor, CryptoStreamMode . Write);\n byte[] plainBytes = Encoding.ASCII.GetBytes(plainText);\n cryptoStream.Write(plainBytes, 0, plainBytes . Length);\n cryptoStream.FlushFinalBlock();\n byte[] cipherBytes = memoryStream.ToArray();\n memoryStream.Close();\n cryptoStream.Close();\n string cipherText = Convert.ToBase64String(cipherBytes, 0, cipherBytes.Length);\n return Uri.EscapeDataString(cipherText);\n }\n public static string DecryptString(string cipherText, byte[] key, byte[] iv)\n {\n Aes encryptor = Aes.Create();\n encryptor.Mode = CipherMode.CBC;\n encryptor.Key = key;\n encryptor.IV = iv;\n MemoryStream memoryStream = new MemoryStream();\n ICryptoTransform aesDecryptor = encryptor.CreateDecryptor();\n CryptoStream cryptoStream = new CryptoStream(memoryStream, aesDecryptor, CryptoStreamMode . Write);\n string plainText = String.Empty;\n try {\n byte[] cipherBytes = Convert.FromBase64String(Uri.UnescapeDataString(cipherText));\n cryptoStream.Write(cipherBytes, 0, cipherBytes . Length);\n cryptoStream.FlushFinalBlock();\n byte[] plainBytes = memoryStream.ToArray();\n plainText = Encoding.ASCII.GetString(plainBytes, 0, plainBytes.Length);\n } finally {\n memoryStream.Close();\n cryptoStream.Close();\n }\n return plainText;\n }\n}\n\n3. Java
\nimport java.nio.charset.StandardCharsets;\nimport java.security.MessageDigest;\nimport java.util.Arrays;\nimport java.util.Base64;\nimport java.util.Base64.Decoder;\nimport java.net.URLDecoder;\nimport java.net.URLEncoder;\nimport javax.crypto.Cipher;\nimport javax.crypto.spec.IvParameterSpec;\nimport javax.crypto.spec.SecretKeySpec;\nimport java.security.NoSuchAlgorithmException;\nimport java.math.BigInteger;\npublic class Playground {\n public static void main(String[] args) throws Exception {\n String key_api = \"FjgHGLxnJO1qjlhHcK4KHg==\";\n String secret_api = \"vqw330bxVfX9TEGMF1BDUKlVDm4DFejA0STb0WDarkU=\"; \n //For Encrypt Sample Data\n String data = \"currency_code=INR&merchant_code=SKU20220913051108&merchant_api_key=FjgHGLxnJO1qjlhHcK4KHg==&transaction_code=D996574709141&transaction_timestamp=1663729322&payment_code=P001&bank_code=104&transaction_amount=500.00&user_id=4\";\n //For Descrypt Sample Data\n String encryptData = \"6mWOao2m34hP/ZHQ/5skq5kTDuzWkHePH74pJsc4FTgmXqhidXtY4VLq9eW0N7/WDfY4gH2gHEVw8FU5d0LKpqc6mOc1gy8dhxyeT/lAyzaI0gnkXzRWwMm7pXlwNpoNG2v7/SXMCioAJMf3nLWEQji+yRTdBxietyMP8XArnQ2KJ/7IoOwQgxl6rPPGuHHCoi74POTI5lEzHbHCNDgGc4XjF89BQM0ROtlAyTpG+STCtEYjE90crt/GaZwYkwCcaqgtFo8o/BNRZTDs4WcQOQCTyu2AnHtxdJvcPUgXAW+ebPv91vNrwt68AmxcLhic\";\n //Hash Key 32 Length\n final MessageDigest md_key = MessageDigest.getInstance(\"SHA-256\");\n byte[] key_hash = Arrays.copyOfRange(md_key.digest(key_api.getBytes(\"UTF-8\")),0,32);\n //Hash Secret 16 Length\n String sha_secret = hashsha256(secret_api).substring(0,16);\n byte[] iv_hash = sha_secret.getBytes(\"UTF-8\");\n //Execute Test Scenario\n // String result = EncryptDecrypt(\"encrypt\",data,key_hash,iv_hash);\n String result = EncryptDecrypt(\"decrypt\",encryptData,key_hash,iv_hash);\n System.out.println(result);\n }\n static String EncryptDecrypt(String action, String data, byte[] key_hash, byte[] iv_hash) throws Exception {\n //Process OpenSSL EncryptDecrypt\n byte[] cipherText;\n String output;\n Cipher cipher = Cipher.getInstance(\"AES/CBC/PKCS5Padding\");\n final SecretKeySpec key = new SecretKeySpec(key_hash, \"AES\");\n final IvParameterSpec iv = new IvParameterSpec(iv_hash, 0, cipher.getBlockSize());\n if(action == \"encrypt\"){\n //Encrypt condition\n cipher.init(Cipher.ENCRYPT_MODE, key, iv);\n cipherText = cipher.doFinal(data.getBytes(\"UTF-8\"));\n output = Base64.getEncoder().encodeToString(cipherText);\n String result = URLEncoder.encode(output, StandardCharsets.UTF_8.toString());\n return result;\n }else{\n //Decrypt condition\n String decodeX = URLDecoder.decode(data, StandardCharsets.UTF_8.toString());\n byte[] decodeData = Base64.getDecoder().decode(decodeX);\n cipher.init(Cipher.DECRYPT_MODE, key, iv);\n cipherText = cipher.doFinal(decodeData);\n output = new String(cipherText,StandardCharsets.UTF_8);\n return output;\n } \n }\n static String hashsha256(String key) throws NoSuchAlgorithmException {\n MessageDigest md = MessageDigest.getInstance(\"SHA-256\");\n md.update(key.getBytes(StandardCharsets.UTF_8));\n byte[] digest = md.digest();\n String key_string = String.format(\"\u00064x\", new BigInteger(1, digest));\n return key_string;\n }\n}\n\n4. NodeJs
\nvar crypto = require('crypto')\nconst apikey = \"myapikey\"\nconst secretkey = \"mysecretkey\"\nconst encrypt_decrypt = (action, data) => {\n const encryptionMethod = \"AES-256-CBC\"\n const key = crypto.createHash('sha256').update(apikey).digest()\n const iv = crypto.createHash('sha256').update(secretkey, 'utf8').digest('hex').substring(0,16)\n if (action == \"encrypt\") {\n const cipher = crypto.createCipheriv(encryptionMethod, key, iv)\n const res = encodeURIComponent(Buffer.from(\n cipher.update(data, 'utf8', 'base64') + cipher.final('base64')\n ).toString())\n console.log(res)\n return res\n } else if (action == \"decrypt\") {\n const buff = decodeURIComponent(Buffer.from(data))\n const decipher = crypto.createDecipheriv(encryptionMethod, key, iv)\n const res = (\n decipher.update(buff.toString('utf8'), 'base64', 'utf8') +\n decipher.final('utf8')\n )\n console.log(res)\n return res\n }\n}\n// example to encrypt data\nencrypt_decrypt(\"encrypt\", \"currency_code=INR&merchant_code=SKU20230101012023&merchant_api_key=myapikey&transaction_code=TEST-DP-123&transaction_timestamp=1677495605&payment_code=PAY01D&transaction_amount=1000&user_id=test01\")\n// example to decrypt data\nencrypt_decrypt(\"decrypt\", \"QqqF5QD9NdtM1O5JCpySZXyFT0gmXvEgWUEgoW19xajeviLAAlwzdDJmD7sgE2laIp7iEt/1SzUpquHykjfQP2eTTQGyR3Jw60iVniAayGxBOQRoPW9ln/T4DzQkZL1eqapgcum/yGKLErYJ0v1WedA2nYZ/d64vZISGh3eA2PqDGJdLZWYKbAP7uGHzMGBslmx8CcBCFbjrKvfA5VGam6LHi1ZWTfv8eeHmlBv4CSI6pXzhb43UZ22uBQj/N8rc6oJQd7l14FK2A4sZhpUhZQ==\")\n\nThis reference describes the possible status values for deposit transactions in the system. Each transaction is assigned a status code that indicates its current processing state.
\nThis reference describes the possible status values for payout transactions in the system. Each payout transaction is assigned a status code that indicates its current processing state and outcome.
\nPayment Request v2
This endpoint is used to initiate a payment request using GET method.
URLGET https://api.singhapayapi.com/YOUR_MERCHANT_CODE/v2/dopayment?key=ENCRYPTED_KEY_STRING
Parameters
\nkey (required): Encrypted string generated using merchant_code, api_key, secret_key.Notes
\nThis endpoint used to redirect to our payment page directly.
\n","_postman_id":"fbe8870e-9b7c-4ef8-86b4-3ea26b251ea6"},{"name":"V3 (H2H for create own Payment Page)","item":[{"name":"Payment Request v3","id":"749c16a4-772a-475c-8870-2e65bab9ed6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"ENCRYPTED_KEY_STRING\"\n}"},"url":"https://api.singhapayapi.com/api/YOUR_MERCHANT_CODE/v3/dopayment","description":"Payment Request v3
Used to create a payment request with POST method.
URLPOST https://api.singhapayapi.com/api/YOUR_MERCHANT_CODE/v3/dopayment
Body Parameters
\nkeyResponse Example
\n{\n \"status\": \"success\",\n \"message\": \"Submit Transaction Success!\",\n \"transaction_no\": \"DP16873387xxxxx\",\n \"transaction_code\": \"TEST-DP-16873xxxxx\",\n \"amount\": \"510.00\",\n \"upi_id\": \"example@upi\",\n \"qr\":\"https://api.singhapayapi.com/imageencoded=true...\",\n \"expired_at\":\"2023-06-22 15:06:04\",\n \"expired_timezone\":\"GMT+05:30\"\n}\n\nSubmit UTR
Submit UTR code to complete an INR payment.
URLPOST https://api.singhapayapi.com/api/YOUR_MERCHANT_CODE/v3/submit-utr
Request Flow
\n{\n \"transaction_code\": \"xxx\",\n \"utr\": 112344578899\n}\n\n2. Encrypt Raw Parameter
\n$combined_params = \"merchant_code=xxx&merchant_api_key=xxx&...\";\n$encrypted_key = encrypt_decrypt('encrypt', json_encode($raw_params), '{your_api_key}', '{your_secret_key}');\n\n3. Put encrypted parameters on body parameters
\nBody Parameters
\nResponse Example
\n{\n \"status\": \"success\",\n \"message\": \"Success Submit Utr!\"\n}\n\nThis endpoint will respond by displaying the data required by the merchant so that you can create your own payment page.
\n","_postman_id":"1b1b4146-bacb-46ae-84e7-92a74d572b40"},{"name":"V4 (Response our Payment Page URL)","item":[{"name":"Payment Request v4","id":"8660ea61-a91a-4700-85cd-f4f98832d55d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"ENCRYPTED_KEY_STRING\"\n}"},"url":"https://api.singhapayapi.com/api/YOUR_MERCHANT_CODE/v4/dopayment","description":"Payment Request v4
Used to create a payment request with POST method.
URLPOST https://api.singhapayapi.com/api/YOUR_MERCHANT_CODE/v4/dopayment
Body Parameters
\nkeyResponse Example
\n{\n \"status\": \"success\",\n \"message\": \"[DP] Submit Transaction Success!\",\n \"transaction_no\": \"xxx\",\n \"transaction_code\": \"xxx\",\n \"amount\": \"1010.00\",\n \"pay_url\": \"https://api.singhapayapi.com/v4/deposit?transaction_no=xxx\",\n \"upi_id\": \"accountone@upidemo\",\n \"qr\": \"https://api.singhapayapi.com/image?encoded=true&url=xxx\"\n}\n\nThis endpoint will respond by displaying the data our payment page url, so you can manage how to redirect in your side.
\n","_postman_id":"1149dba6-c1d5-458d-ba7e-dedc0c69ddf4"}],"id":"1191cb98-7dff-4728-88c7-4b9312211a1d","description":"This API enables merchants to initiate secure payment transactions through our payment gateway. All sensitive data is transmitted using AES-256-CBC encryption to ensure maximum security and data integrity.
\nPrepare the raw parameters according to the specifications below, then combine and encrypt them before transmission.
\nThese parameters must be prepared and combined into a query string format before encryption.
\nCombine all parameters into a single query string format, separated by \"&\" characters:
\nmerchant_code=xxx&merchant_api_key=xxx&transaction_code=xxx&transaction_timestamp=xxx&payment_code=xxx&transaction_amount=xxx&user_id=xxx¤cy_code=INR\n\nExample:
\nmerchant_code=MERCH001&merchant_api_key=ak_test_12345&transaction_code=TXN20231201001&transaction_timestamp=1701425400&payment_code=P001&transaction_amount=100.50&user_id=user123¤cy_code=USD&bank_code=BANK001&callback_url=https://merchant.com/callback&return_url=https://merchant.com/return\n\nEncrypt the combined parameter string using the provided encryption function with your API credentials:
\nphp
\n$combined_params = \"merchant_code=xxx&merchant_api_key=xxx&...\";\n$encrypted_key = encrypt_decrypt('encrypt', $combined_params, '{your_api_key}', '{your_secret_key}');\n\nSample Encrypted Output:
\n3eX+f+MoVECXxSkKqV7aBRYIbyWg3DxdPdgZyG+377a7dR1OBBDNnU+/vtn7hUyjP7WWdZ7gCsPF0J+JOiSxb1BFueIyRX3rxbSMa+/AyFvhz4L/2wJmSJKcNQn4whIL1sc1cfj7E1smQFAiYjfLXdY1Ev6Pnoit8Vouex3+upnZjJS8t44XRx5wugB5GuybZWPtlPhiN/P7P4uJW3RlFlo+tYrnHQ6GwqwRkoLrdv3qZXUzaatT8EWdztr973KWFDof2rVD+56SMAVrRHQZcYICU8RcjpyvJUaCtXpOKKg=\n\nRefer to point Encrypt Decrypt Function for the encryption/decryption function explanation.
\n","_postman_id":"1191cb98-7dff-4728-88c7-4b9312211a1d"},{"name":"Payout","item":[{"name":"Payout Request","id":"5272082c-a5d0-4bf8-8105-aebfceab48db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"ENCRYPTED_KEY_STRING\"\n}"},"url":"https://api.singhapayapi.com/api/v1/payout/YOUR_MERCHANT_CODE","description":"Payout Request
Used to submit a payout/withdrawal request.
URLPOST https://api.singhapayapi.com/api/v1/payout/YOUR_MERCHANT_CODE
Body Parameters (JSON)
\nSuccess Response
\n{\n \"success\": true,\n \"message\": \"request withdraw successful\"\n}\n\nFailure Response
\n{\n \"success\": false,\n \"message\": \"Invalid Transaction Code ( not unique )!, error code 111\"\n}\n\nThis API enables merchants to initiate secure payment transactions through our payment gateway. All sensitive data is transmitted using AES-256-CBC encryption to ensure maximum security and data integrity.
\nPrepare the raw parameters according to the specifications below, then make it Json and encrypt them before transmission.
\nThese parameters must be prepared as a Json format before encryption.
\nExample Raw Parameters
\n{\n \"merchant_code\": \"SKU20220406065553\",\n \"transaction_code\": \"WD00008\",\n \"transaction_timestamp\": \"1652339606\",\n \"payout_code\": \"WWW\",\n \"transaction_amount\": \"100\",\n \"user_id\": \"1\",\n \"currency_code\": \"INR\",\n \"bank_account_number\": \"123456\",\n \"account_name\": \"jhon\",\n \"bank_name\": \"ICIC Bank\",\n \"ifsc_code\": \"ICIC0000269\",\n \"phone_number\": \"9102901920\"\n}\n\nEncrypt the json parameter string using the provided encryption function with your API credentials:
\nphp
\n$encrypted_key = encrypt_decrypt('encrypt', json_encode($raw_params), '{your_api_key}', '{your_secret_key}');\n\nSample Encrypted Output:
\n3eX+f+MoVECXxSkKqV7aBRYIbyWg3DxdPdgZyG+377a7dR1OBBDNnU+/vtn7hUyjP7WWdZ7gCsPF0J+JOiSxb1BFueIyRX3rxbSMa+/AyFvhz4L/2wJmSJKcNQn4whIL1sc1cfj7E1smQFAiYjfLXdY1Ev6Pnoit8Vouex3+upnZjJS8t44XRx5wugB5GuybZWPtlPhiN/P7P4uJW3RlFlo+tYrnHQ6GwqwRkoLrdv3qZXUzaatT8EWdztr973KWFDof2rVD+56SMAVrRHQZcYICU8RcjpyvJUaCtXpOKKg=\n\nRefer to point Encrypt Decrypt Function for the encryption/decryption function explanation.
\n","_postman_id":"5f032001-bf85-4a44-9bfc-6645b3fdccab"},{"name":"Callback","item":[{"name":"Deposit Callback","id":"e78ccf5b-6fd9-426b-a41e-f9da68212f6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"This webhook API is called by the payment provider to notify operators about payment transaction status updates. After a payment request is processed through the DoPayment API, the provider will call this callback endpoint to forward the final transaction status (success or failed).
\nCallback URL: Submit with param callback_url at Request Deposit API or Configure via Back Office (BO) settings
\nMethod: POST
\nContent-Type: application/json or application/x-www-form-urlencoded
\nAuthentication: Encrypted parameters using API key and secret
\nPOST {operator_callback_url}\n\nNote: This endpoint must be implemented by the operator and configured using parameter callback_url at Deposit API Request or set in the BO settings.
\njson
\n{\n \"key\": \"ENCRYPTED_KEY_STRING\",\n \"transaction_code\": \"TXN20231201001\",\n \"transaction_no\": \"PROV123456789\",\n \"user_id\": \"0\",\n \"note\": \"\",\n \"utr\": \"261047559234\"\n}\n\nThe key parameter contains encrypted transaction details that must be decrypted using your API key and API secret.
php
\n$decrypted_data = encrypt_decrypt('decrypt', $key, $your_api_key, $your_api_secret);\n\nAfter decryption, the following parameters are available:
\nThe encrypted data follows query string format with \"&\" separators:
\ncurrency_code=INR&transaction_code=xxx&transaction_status=2&transaction_amount=523&transaction_actual_amount=523.00000000&transaction_fee=5.23000000&transaction_ref=&transaction_ref2=xxx&transaction_no=xxx&user_id=0&upi_id=accountfour@upi\n\nThis webhook API is called by the payment provider to notify operators about payout transaction status updates. After a payout request is processed through the Payout Request API, the provider will call this callback endpoint to forward the final transaction status (success or failed).
\nCallback URL: Submit with param callback_url at Request Payout API or Configure via Back Office (BO) settings
\nMethod: POST
\nContent-Type: application/json or application/x-www-form-urlencoded
\nAuthentication: Encrypted parameters using API key and secret
\nPOST {operator_payout_callback_url}\n\nNote: This endpoint must be implemented by the operator and configured using parameter callback_url at Payout API Request or set in the BO settings.
\njson
\n{\n \"key\": \"encrypted_payout_data\",\n \"transaction_code\": \"WD00008\",\n \"transaction_no\": \"PROV_WD_123456789\",\n \"user_id\": \"838\",\n \"note\": \"others\",\n \"utr\": \"\"\n}\n\nThe key parameter contains encrypted payout transaction details that must be decrypted using your API key and API secret.
php
\n$decrypted_data = encrypt_decrypt('decrypt', $key, $your_api_key, $your_api_secret);\n\nAfter decryption, the following parameters are available:
\nThe decrypted data is in JSON format:
\njson
\n{\n \"transaction_no\": \"xxx\",\n \"transaction_code\": \"xxxx\",\n \"transaction_status\": 2,\n \"transaction_amount\": \"10.00000000\",\n \"transaction_fee\": \"0.10000000\",\n \"currency_code\": \"INR\",\n \"transaction_ref\": null,\n \"transaction_ref2\": null,\n \"user_id\": \"0\",\n \"bank_code\": \"ORCB\",\n \"bank_name\": \"THE ODISHA STATE CO-OPERATIVE BANK LTD\",\n \"bank_account\": \"11133322\",\n \"bank_account_name\": \"Stephen Garcia\",\n \"ifsc_code\": \"ORCB0ANG001\"\n}\n\nTransaction Status\nCheck the status of a specific transaction.
\nURL\nPOST https://api.singhapayapi.com/api/v1/YOUR_MERCHANT_CODE/transactions/status
Parameters
\nkey (required, form-urlencoded): Encrypted string containing:merchant_api_keytransaction_codeResponse Example
\n{\n \"success\": true,\n \"data\": [{\n \"transaction_no\": \"DP1678780607892\",\n \"transaction_code\": \"TEST-DP-1678780607\",\n \"amount\": \"500.00\",\n \"status\": \"pending\",\n \"currency_code\": \"INR\",\n \"datetime\": \"2023-03-14 15:56:47\"\n }],\n \"message\": \"request transaction list successful\"\n}\nThis API endpoint allows merchants to check the status of their transactions by providing the transaction code. The request requires encrypted parameters using merchant credentials for secure transaction status retrieval.
\nAll transaction status requests require encrypted parameters containing merchant API key and transaction code for secure authentication and transaction lookup.
\nPOST {base_url}/api/v1/{merchant_code}/transactions/status\n\nRetrieve the current status and details of a specific transaction using the transaction code provided during the original payment or payout request.
\nMethod: POST
\nContent-Type: application/x-www-form-urlencoded or multipart/form-data
\nAuthentication: Encrypted parameter string
\nThe parameters that need to be combined and encrypted:
\nCombine Parameters: Join parameters with \"&\" character
\nEncrypt Data: Use the encryption function with your API credentials
\nSubmit Request: Send as form data parameter
\n// Step 1: Combine parameters\n$raw_params = \"merchant_api_key=xxxxxxxxby9tUGdNbXI4U2o2Vml3dz09&transaction_code=DP0001\";\n// Step 2: Encrypt\n$encrypted_key = encrypt_decrypt('encrypt', $raw_params, $your_api_key, $your_secret_key);\n\nmerchant_api_key=xxxxxxxxby9tUGdNbXI4U2o2Vml3dz09&transaction_code=DP0001\n\n$encrypted_key = encrypt_decrypt('encrypt', 'merchant_api_key=xxxxxxxxby9tUGdNbXI4U2o2Vml3dz09&transaction_code=DP0001', '{your_api_key}', '{your_secret_key}');\n\nPOST https://api.example.com/api/v1/MERCH001/transactions/status\nContent-Type: application/x-www-form-urlencoded\nkey=aHO52zIzSNR6wSQhSlS+9CSrEPWlEdsfKOL5YuWGSdPLny3Rgeo+KhglyFL2wgbO...\n\ncurl -X POST \"https://api.example.com/api/v1/MERCH001/transactions/status\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"key=aHO52zIzSNR6wSQhSlS+9CSrEPWlEdsfKOL5YuWGSdPLny3Rgeo+KhglyFL2wgbO...\"\n\n{\n \"success\": true,\n \"data\": [\n {\n \"transaction_no\": \"DP1678780607892\",\n \"transaction_code\": \"TEST-DP-1678780607\",\n \"amount\": \"500.00000000\",\n \"transaction_fee\": \"15.00000000\",\n \"transaction_ref\": null,\n \"transaction_ref2\": null,\n \"status\": \"pending\",\n \"type\": \"deposit\",\n \"note\": null,\n \"method_name\": \"UPI 3\",\n \"currency_name\": \"Indian Rupee\",\n \"currency_code\": \"INR\",\n \"datetime\": \"2023-03-14 15:56:47\"\n }\n ],\n \"message\": \"request transaction list successful\"\n}\n\n{\n \"success\": false,\n \"error\": \"TRANSACTION_NOT_FOUND\",\n \"message\": \"Transaction with code 'INVALID001' not found\",\n \"code\": 404\n}\n\nGet Balance
Fetch the merchant balance.
URLGET https://api.singhapayapi.com/api/v1/balance/YOUR_MERCHANT_CODE
Parameters
\nkey (required): Encrypted string containing merchant_code.Response Example
\n{\n \"currency_name\": \"India Rupee\",\n \"currency_code\": \"INR\",\n \"balance\": \"100000\",\n \"frozen_balance\": \"1000\",\n \"available_balance\": \"99000\"\n}\n\nThis API endpoint allows merchants to check their account balance, including total balance, frozen balance, and available balance. The request requires encrypted merchant credentials for secure balance retrieval.
\nMethod: GET
\nContent-Type: application/json
\nAuthentication: Encrypted merchant code parameter
\nThe parameter that needs to be encrypted:
\nPrepare Parameter: Create JSON object with merchant code
\nEncrypt Data: Use the encryption function with your API credentials
\nURL Encode: Ensure proper encoding for HTTP transmission
\n// Step 1: Prepare parameter\n$raw_data = json_encode([\"merchant_code\" => \"SKU211111111\"]);\n// Step 2: Encrypt\n$encrypted_key = encrypt_decrypt('encrypt', $raw_data, $your_api_key, $your_secret_key);\n// Step 3: URL encode\n$encoded_key = urlencode($encrypted_key);\n\n{\n \"merchant_code\": \"SKU211111111\"\n}\n\ncurl -X GET \"https://api.singhapayapi.com/api/v1/balance/SKU211111111\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"key\": \"ev0FFVerPMdbrFcXYLIwkyuL/Y1v7/3GlKH46MJlNSI=\"\n }'\n\n{\n \"currency_name\": \"India Rupee\",\n \"currency_code\": \"INR\",\n \"balance\": \"100000\",\n \"frozen_balance\": \"1000\",\n \"available_balance\": \"99000\"\n}\n\n{\n \"success\": false,\n \"error\": \"INVALID_MERCHANT_CODE\",\n \"message\": \"Merchant code not found or invalid\",\n \"code\": 404\n}\n\n