![](\"https://lh7-us.googleusercontent.com/cfWw_RYZ9eZVEKzKjeRW4I_VwbBTyqH78LUrJG6ulp7FkE1pXVD6DZr9MnQXB9KH_oLFasJDb156naCsBc2bgotPaVY7LtGOJNifpTOb5uks3fjAKpgVhU4dsXQmQ7hFKNFIVhZEl2p8fCN1YufsRaA\"){kind=spacer}
\n\n![](\"https://lh7-us.googleusercontent.com/Uxy8jmp5RP-c360-oIMAZy2As8naqJdARgKsWU0x_BtszfJlwdRVM6-obffbtjTABfI9V0hxH4Ad-Ns96We42lIMdL434tTzLJ6aEQBt0dzX_ZXeM4RtG_kmEeem7WIsN520Zh5PS3xTFYNzOmks0ak\")
\n\n![](\"https://lh7-us.googleusercontent.com/UcxDawvzgu9zw6gCa8i_KrzNRn2baEIsJOJfAkuyBWu9yl3Hky5JyA0xQnNrT18ovLe4Lwl2sdD0kjKMFQUrYUMvnKimvRbxLio0pd5xjNy63PlYeV4phxMspF6sYGLug0OHaw__oWW8UE8m2Nt-3XA\")
\n\n![](\"https://lh7-us.googleusercontent.com/QiIrZmMWISniXvk4h0Wpq5y4QDrWlUNK8cVUra7HhfDL9B12sdZv7kwGJ24R8Hs6AKPLRKZJafk1p5S3jCikw0V1lIBTVUy67hEgNRNNjH5Q2HysOP-3HlHZAjZiVvPsohyopIwZA48ejeFF0Ul1PX4\"){kind=spacer}
\n\n![](\"https://lh7-us.googleusercontent.com/C3wVvecNtQw4_DB4-8CRpFabuqko5aLMycrWTkTjyCTHPuK1Of3lNOiyyTV2wKCwT0gLmsFZkfAgJ4sa6NHBp3ea0l6dD9gJAX2FQhOTG4p7pa-YZzQRXY5aHsYOB8uGk76XIcBZ7rLq9G4gHbHnYqU\")
\n\n![](\"https://lh7-us.googleusercontent.com/XMBcrVkVU_Iak6-k1uzllUV3Lr6e_wVP_25CzedW8zYahgDiRS1KmuGMn8obKpQ8DnSrMuNvE4GvFEcoe3_0oeDNnAsGtfGf9EtQnNZpnoFNt9iAuoWtSjBDwXIAm6a3fdeY61GPtXbJUw0d_bGBRIU\")
\n\nThis API is used to initate refund of the purchases that have status as PAID can be initiated for refund
Once the refund has been initiated, the status of the purchase would become REFUND_IN_PROCESS and once the refund has been approved by the bank, the status woud become REFUNDED
Purchase ID is mandatory for this API.
\nResponse Examples
\nIn the response examples you can see instances of both successful and unsuccessful in refund of purchases.
This API gives back the list of Payment methods available .
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3da39501-048e-4967-afcd-eec0ffa5523a","id":"3da39501-048e-4967-afcd-eec0ffa5523a","name":"💳 Card Payments","type":"folder"}},"urlObject":{"path":["payment_methods"],"host":["https://app.thefundstream.org/api/v1"],"query":[{"disabled":true,"key":"brand_id","value":"aff0471b-e37d-4e76-9dee-d235063bf276"},{"disabled":true,"key":"currency","value":""},{"disabled":true,"key":"country","value":"india"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"a89f44a5-0cc9-4a64-9f40-5745b0ad02af","name":"Payment Methods","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.fundstream.net/api/v1/payment_methods","protocol":"https","host":["api","fundstream","net"],"path":["api","v1","payment_methods"],"query":[{"key":"brand_id","value":"4067e336-b558-4f81-9c98-2ad56b017e3d","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:50:33 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"available_payment_methods\": [\n \"s2s\",\n \"cybersource_hosted_checkout\",\n \"mastercard\",\n \"visa\"\n ],\n \"by_country\": {\n \"any\": [\n \"s2s\",\n \"cybersource_hosted_checkout\",\n \"mastercard\",\n \"visa\"\n ]\n },\n \"country_names\": {\n \"any\": \"Other\"\n },\n \"names\": {\n \"cybersource_hosted_checkout\": \"Cybersource Hosted Checkout\",\n \"s2s\": \"Server To Server\",\n \"visa\": \"Visa\",\n \"mastercard\": \"Mastercard\"\n },\n \"card_methods\": [\n \"cybersource_hosted_checkout\",\n \"mastercard\",\n \"visa\"\n ]\n}"}],"_postman_id":"ffd88bb7-96fc-4d83-b2c0-dbbb1a74bb03"},{"name":"checkWhiteList","id":"266e1d59-99ab-4053-bb13-69e636471251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"dev@fundstream.net\",\r\n \"card_num\": \"5178006985381351\"\r\n // \"signup_date\": \"16-05-2023\", not requered\r\n // \"deposit_date\": \"16-05-2023\",\r\n // \"number_of_deposits\": 6,\r\n \r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/checkWhiteList","description":"Overview
\nFundstream supports the concept of whitelisted cards. The merchant can send Fundstream a list of cards that are to be whitelisted. Once whitelisted, only whitelisted cards are allowed to be transacted for that merchant.
\nThe merchant can check the individual card status with this API by giving the email and card numbers of the customers.
\nMandatory Parameters (in body)
\nOther parameters:
\nResponse Examples
\nIn the response examples, you can observe both instances of verifying whether a card exists in a merchant's whitelist, one for an existing card and another for a non-existing card.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3da39501-048e-4967-afcd-eec0ffa5523a","id":"3da39501-048e-4967-afcd-eec0ffa5523a","name":"💳 Card Payments","type":"folder"}},"urlObject":{"path":["checkWhiteList"],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"8d3d9c65-f30d-49e9-b8c2-383f41883603","name":"checkWhiteList - Doesn't exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"dk6@dk.com\",\r\n // \"signup_date\": \"16-05-2023\",\r\n // \"deposit_date\": \"16-05-2023\",\r\n // \"number_of_deposits\": 6,\r\n \"card_num\": \"5555555555554444\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://18.214.100.20/api/v1/checkWhiteList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Date","value":"Thu, 13 Jul 2023 17:56:25 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"NOTEXIST\"\n}"},{"id":"45d9aa63-93c0-4567-a587-723e88bf8e02","name":"checkWhiteList - Exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"dev@fundstream.net\",\r\n \"card_num\": \"5178006985381351\"\r\n // \"signup_date\": \"16-05-2023\", not requered\r\n // \"deposit_date\": \"16-05-2023\",\r\n // \"number_of_deposits\": 6,\r\n \r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.fundstream.net/api/v1/checkWhiteList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jul 2023 13:19:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fe4c2207fc59dd7aa34d5b9c9e7bef06.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"jlhkO3uk9ZosIKb3n8d5UGa0s_yk0g6ZgyZwca4NrvzFfMpnXkSwnA=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=19ICPHCEH52J%2B2gKwR6R65hkypRr9yFP63OeSZ7qaZZOzI7pQC0g67Hgv9iDno43u0razeIYgP0%2FJL8kYiAUCElFZeVnd94rYn%2BYqHXKtJDt5yItEDTYHOmHjNCc2Qbs7fyu5w%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7ec4b216b9a606f1-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"EXIST\"\n}"}],"_postman_id":"266e1d59-99ab-4053-bb13-69e636471251"},{"name":"Whitelist Upload","id":"9d63bf6b-db13-4852-8721-edaa44bb940b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"csvFile","type":"file","value":null}]},"url":"https://api.fundstream.net/api/v1/whitelist/upload/","description":"Overview
\nThe merchant can upload a list of whitelist cards and email ids through this API. All cards successfully uploaded will be considered whitelisted and allowed for that merchant.
\nMandatory parameters in the request body:
\nPlease note:
\n- \n
CSV file should contain the following headers (both mandatory)
\n- \n
card_number
\n \nemail_id
\n \n
\nCSV file should not be empty
\n \n
public class FileUploader {\n public static void uploadFile(String apiUrl, String filePath, String authorizationHeader) {\n try {\n File file = new File(filePath);\n OkHttpClient client = new OkHttpClient();\n RequestBody requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM)\n .addFormDataPart(\"csvFile\", file.getName(), RequestBody.create(MediaType.parse(\"text/csv\"), file))\n .build();\n Request request = new Request.Builder().url(apiUrl).post(requestBody)\n .addHeader(\"Authorization\", authorizationHeader).build();\n Response response = client.newCall(request).execute();\n if (response.code() == 202) {\n System.out.println(\"File uploaded successfully!\");\n System.out.println(\"Response: \" + response.body().string());\n } else {\n System.out.println(\"File upload failed.\");\n System.out.println(\"Status: \" + response.code());\n System.out.println(\"Error: \" + response.body().string());\n }\n } catch (IOException e) {\n e.printStackTrace();\n }\n }\n public static void main(String[] args) {\n String apiUrl = \"https://{{base_url}}/api/v1/whitelist/upload\";\n String filePath = \"whitelist.csv.file.path\";\n String authorizationHeader = \"Bearer YOUR API KEY\";\n uploadFile(apiUrl, filePath, authorizationHeader);\n }\n}\n\nStep 1:
\nCreate a purchase using POST /purchase/ API to create a Purchase in the system. make sure to meet all the required criteria, which include defining success_redirect and failure_redirect fields for the Purchase and setting them to valid URLs
Step 2:
\nThe customer is redirected to the checkout_url page, configured to point to their net banking system.
\nStep 3:
\nOnce the payment is initiated from the net banking site, the user will be redirected to the appropriate redirect URL.
\n","_postman_id":"a9b1be0a-3eb3-48f5-b25f-3aa877664742","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","name":"🌐 Open Banking","type":"folder"}}},{"name":"Transaction Status and their meaning","item":[],"id":"7a4a02d3-89ef-43dd-aa56-51816e48d64f","description":"The lifecycle of a transaction is reflected through the status of the transaction.
\nThis section details various statuses of a transaction and what it means and when does it appears.
\nThe status of a transaction can be read from the \"status\" field of the responses or webhook payload.
Overview
\nEFT (Electronic Funds Transfer) is a secure and efficient method of processing online payments in South Africa. It allows customers to make instant payments directly from their bank accounts without using a credit card. EFT leverages the existing online banking infrastructure to facilitate quick and secure transactions, making it a popular choice for consumers and merchants.
\nKey Features of EFT
\n- \n
Instant Payment Confirmation: Transactions are processed and confirmed immediately, allowing for real-time payment updates.
\n \nSecure Transactions: Uses bank-level security measures to ensure the safety of customer data.
\n \nBroad Bank Support: It supports many South African banks, ensuring broad accessibility.
\n \nUser-Friendly: The payment process is simple and intuitive, providing a seamless experience for users.
\n \n
Payment Processing Steps Through EFT
\nStep 1: Initiating the Payment
\n- \n
Customer Selects 'Net Bankin' Payment Option: At the checkout page, the customer selects 'Net Banking' as their preferred payment method.
\n \nMerchant Redirects to EFT Gateway: The merchant's website or application redirects the customer to the EFT payment gateway.
\n \n
Step 2: Redirect to Bank Login
\n- \n
Customer Selects Their Bank: The customer selects their bank from the list of supported banks on the EFT gateway.
\n \nCustomer is Redirected to Bank Login Page: Platform securely redirects customers to their bank’s online banking login page.
\n \n
Step 3: Logging into Online Banking
\n- \n
Customer Logs In The customer logs into their online banking account using their credentials.
\n \nSecure Session: The login session is safe, and the customer’s banking credentials are not shared with the EFT gateway or the merchant.
\n \n
Step 4: Confirming the Payment
\n- \n
Payment Details: The customer reviews the pre-filled payment details, including the amount and beneficiary information.
\n \nAuthorise Payment: The customer authorises the payment using their bank’s authentication method (e.g., OTP, password).
\n \n
Step 5: Payment Processing and Confirmation
\n- \n
Bank Processes Payment: The customer’s bank processes the payment and debits the amount from the customer’s account.
\n \nInstant Confirmation to the EFT gateway: Once the payment is processed, the bank sends an instant confirmation to the EFT gateway.
\n \n
Step 6: Notification to Merchant
\n- \n
EFT Gateway Confirms Payment to Merchant: EFT gateway immediately notifies the merchant of the successful payment.
\n \nOrder Completion: The merchant completes and confirms the order to the customer.
\n \n
Step 7: Customer Redirect
\n- \n
Redirect to Merchant’s Site: After confirming the payment, the customer is redirected back to the merchant’s website.
\n \nPayment Confirmation Page: The merchant’s website displays a payment confirmation page to the customer.
\n \n
Fundstream leverages its OpenBanking network across Europe and UK to make secure and fast payments, making top choice for customers in respective regions. It allows customers to pay in EUR or GBP via Fundstream Gateway, directly thru their bank account
\nFundstream Gateway is a web page that handles all the user interaction during a payment initiation process:
\n- \n
user credentials input
\n \ninteractive confirmation
\n \nprogress reporting
\n \nerror reporting
\n \n
After your application has received an URL for executing a payment using Fundstream, you can redirect your end-user to it. There, they will see a screen that lets them pick a provider to execute a payment.
\nYour user will also be asked to input credentials and, if needed, any of the interactive credentials. After the process is done, the user will be redirected back to your application URL
\nPayIn User Flow
\nStep 1: Initiating the Payment
\n- \n
Customer Selects 'Net Bankin' Payment Option: At the checkout page, the customer selects 'Net Banking' as their preferred payment method.
\n \nMerchant Redirects to SaltEdge Gateway: The merchant's website or application redirects the customer to the SaltEdge Connect.
\n \n
Step 2: Redirect to Bank Login
\n- \n
Customer Selects Their Bank: The customer selects the provider/bank from the list of supported providers/banks on the Fundstream Gateway
\n \nCustomer is Redirected to Bank Login Page: Platform securely redirects customers to their bank’s online banking login page.
\n \n
Step 3: Logging into Online Banking
\n- \n
Customer Logs In The customer logs into their online banking account using their credentials.
\n \nSecure Session: The login session is safe, and the customer’s banking credentials are not shared with the SaltEdge or the merchant.
\n \n
Step 4: Confirming the Payment
\n- \n
Payment Details: The customer reviews the pre-filled payment details, including the amount and beneficiary information.
\n \nAuthorise Payment: The customer authorises the payment using their bank’s authentication method (e.g., OTP, password).
\n \n
Step 5: Payment Processing and Confirmation
\n- \n
Bank Processes Payment: The customer’s bank processes the payment and debits the amount from the customer’s account.
\n \nInstant Confirmation to the Fundstream gateway: Once the payment is processed, payment confirmation is received through a webhook url
\n \n
Step 6: Notification to Merchant
\n- \n
Confirms Payment to Merchant: Fundstream gateway immediately notifies the merchant of the successful payment.
\n \nOrder Completion: The merchant completes and confirms the order to the customer.
\n \n
Step 7: Customer Redirect
\n- \n
Redirect to Merchant’s Site: After confirming the payment, the customer is redirected back to the merchant’s website.
\n \nPayment Confirmation Page: The merchant’s website displays a payment confirmation page to the customer.
\n \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nEssential Optional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nUpon successul create on a Purchase you'd get a \"purchaseId\" .
paymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Fundstreamwill perform direct payment with the selected payment method instead of loading Fundstream URL.
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\n","urlObject":{"path":["purchases"],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a93f809e-cdae-45f1-b583-8ad7c6f13d5e","name":"Purchase (Openbanking EU & UK)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@fundstream.net\",\r\n \"country\":\"IN\",\r\n \"city\":\"123\",\r\n \"stateCode\":\"ca\",\r\n \"street_address\":\"test test\",\r\n \"zip_code\":\"234567\",\r\n \"phone\":\"9999999999\"\r\n \r\n },\r\n \"purchase\": {\r\n \"currency\" : \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"THIRDPARTY-NETBANKING\",\r\n \"brand_id\": \"{{Your.brandID}}\",\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"send_receipt\": \"\" ,\r\n \"skip_capture\": \"\" ,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://18.214.100.20/api/v1/purchases"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:22:14 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6634f0f1d0b7c63861485de8\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"+447755564318\",\n \"full_name\": \"\",\n \"date_of_birth\": \"1970-07-10\",\n \"personal_code\": \"\",\n \"street_address\": \"asdfsa\",\n \"country\": \"GB\",\n \"city\": \"a\",\n \"zip_code\": \"W1S 3BE\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"documentId\": \"\",\n \"documentType\": \"\",\n \"bankAccountNumber\": \"\",\n \"bankAccount\": \"\",\n \"bankCode\": \"\",\n \"description\": \"\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1714745585,\n \"type\": \"purchase\",\n \"paymentMethod\": \"THIRDPARTY-NETBANKING\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1714745585,\n \"merchantRef\": \"6634f0f1d0b7c63861485de8\",\n \"merchantName\": \"merchant002\",\n \"signature\": \"RShYJXst+wi8yPMAi/PSqV4JkJpTrXrl9yRYPUiagrSqBNMXEPndEQD6gnKQYq1syKW7B/s7XmRmnzWnB2QDCBHjtv/ZAg4o5lDmOIPDjVdIgHpZ8EMOvF/O/64D9JaLRViIrjSM/kPiAKbxWsoQtmKumfcly7hwL50iZNUovp3jnzoGtOTWLkbUTDk4xPH1OrAwVUeqkmYFgD9bkQZ/MgSB+p/0ahRskx6jjNlKlG1vujk1dWckgw35CwLJwThx/ZW52kpAp+3GwDaANic0vV3dJOhsqpW8+3G0tIiL4+8FBFAFb31jM6K7CpjuI1lwFZoa4+mQEw+/xLBMiDjPyQ==\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1.0,\n \"price\": 18000.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 18000.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"gdhnb\",\n \"brand_name\": \"gdhnb\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1714745585\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"76fad4ea-2ba2-4511-8989-3bed04e7d5bb\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS9049\",\n \"issued\": \"2024-05-03\",\n \"due\": 1714745585,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.53\",\n \"checkout_url\": \"https://app.thefundstream.org/payments/6634f0f1d0b7c63861485de8/\"\n}"},{"id":"b22f60a8-8703-4a9a-ac87-52b7cdba9318","name":"Purchase (SA)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@fundstream.net\",\r\n \"country\":\"IN\",\r\n \"city\":\"123\",\r\n \"stateCode\":\"ca\",\r\n \"street_address\":\"test test\",\r\n \"zip_code\":\"234567\",\r\n \"phone\":\"9999999999\"\r\n \r\n },\r\n \"purchase\": {\r\n \"currency\" : \"ZAR\",\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"THIRDPARTY-NETBANKING\",\r\n \"brand_id\": \"{{Your.brandID}}\",\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"send_receipt\": \"\" ,\r\n \"skip_capture\": \"\" ,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6634f0f1d0b7c63861485de8\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"+447755564318\",\n \"full_name\": \"\",\n \"date_of_birth\": \"1970-07-10\",\n \"personal_code\": \"\",\n \"street_address\": \"asdfsa\",\n \"country\": \"GB\",\n \"city\": \"a\",\n \"zip_code\": \"W1S 3BE\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"documentId\": \"\",\n \"documentType\": \"\",\n \"bankAccountNumber\": \"\",\n \"bankAccount\": \"\",\n \"bankCode\": \"\",\n \"description\": \"\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1714745585,\n \"type\": \"purchase\",\n \"paymentMethod\": \"THIRDPARTY-NETBANKING\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1714745585,\n \"merchantRef\": \"6634f0f1d0b7c63861485de8\",\n \"merchantName\": \"merchant002\",\n \"signature\": \"RShYJXst+wi8yPMAi/PSqV4JkJpTrXrl9yRYPUiagrSqBNMXEPndEQD6gnKQYq1syKW7B/s7XmRmnzWnB2QDCBHjtv/ZAg4o5lDmOIPDjVdIgHpZ8EMOvF/O/64D9JaLRViIrjSM/kPiAKbxWsoQtmKumfcly7hwL50iZNUovp3jnzoGtOTWLkbUTDk4xPH1OrAwVUeqkmYFgD9bkQZ/MgSB+p/0ahRskx6jjNlKlG1vujk1dWckgw35CwLJwThx/ZW52kpAp+3GwDaANic0vV3dJOhsqpW8+3G0tIiL4+8FBFAFb31jM6K7CpjuI1lwFZoa4+mQEw+/xLBMiDjPyQ==\",\n \"purchase\": {\n \"currency\": \"ZAR\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1.0,\n \"price\": 18000.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 18000.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"gdhnb\",\n \"brand_name\": \"gdhnb\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1714745585\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"76fad4ea-2ba2-4511-8989-3bed04e7d5bb\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS9049\",\n \"issued\": \"2024-05-03\",\n \"due\": 1714745585,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.53\",\n \"checkout_url\": \"https://app.thefundstream.org/payments/6634f0f1d0b7c63861485de8/\"\n}"}],"_postman_id":"48ade11d-dcc0-4557-8e46-e3cabfe2cb93"},{"name":"Payment (To be initiated From client browser)","id":"2528cd84-24a5-46a5-a482-39ebdee1be3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://18.214.100.20/payments/64b032c3c6dccf7d329d9e7e/","description":"This is the checkout_url that is in the response object of the Purchase.
\nWhen this URL is called from the end user's browser, the user would be redirected to the success_redirect or failure_redirect URL given by the merchant at the time of create purchase
This API tells you about all the details of a purchase, including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","name":"🌐 Open Banking","type":"folder"}},"urlObject":{"path":["purchases","64bff12bf63e36669499e97d",""],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6947e1e9-30b0-4ab4-b711-a417c170e4fe","name":"Purchases-error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://18.214.100.20/api/v1/purchases/64bfd7c9f63e36669499e779/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:44:06 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfd7c9f63e36669499e779\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@fundstream.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690294251,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690294220,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 100,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"US\",\n \"processing_time\": 1690294279,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"error\": {\n \"message\": \"Transaction Failed\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690294220\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690294251\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1690294299\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690294382\n }\n ],\n \"viewedOn\": 1690299845,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS188\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690294220,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfd7c9f63e36669499e779/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfd7c9f63e36669499e779/\"\n}"},{"id":"065de48e-b9d3-4c36-95c6-07f958bdc579","name":"Purchases - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://18.214.100.20/api/v1/purchases/64bfdb7df63e36669499e82f/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:45:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@fundstream.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690296521,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690295168\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690295193\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1690295205\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1690296521\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690299929\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 9,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"}],"_postman_id":"c37dcd7a-0607-43e9-9a83-f1bccb1c90b8"},{"name":"cancel","id":"233a5dbf-401d-4a19-b0ce-ccde1f197e9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://app.thefundstream.org/api/v1/purchases/64bff556f63e36669499e9d3/cancel","description":"As the name implies this API is used to cancel purchases that have been posted
\n- \n
- either after creating a purchase or \n
- after doing the server-to-server call, but before redirecting the user to the callbackURL. \n
Purchase ID is mandatory for this API.
\nResponse Examples
\nIn the response examples you can see instances of cancelling a purchase that has Paid and Error Status.
This API gives back the list of Payment methods available for a brand.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","name":"🌐 Open Banking","type":"folder"}},"urlObject":{"path":["payment_methods"],"host":["https://app.thefundstream.org/api/v1"],"query":[{"key":"brand_id","value":"aff0471b-e37d-4e76-9dee-d235063bf276"},{"key":"currency","value":""},{"key":"country","value":"india"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"39f72551-2bc6-4869-b03c-bfe008f7451e","name":"Payment Methods","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"http://18.214.100.20/api/v1/payment_methods?brand_id=4067e336-b558-4f81-9c98-2ad56b017e3d¤cy=inr&country=india","protocol":"http","host":["18","214","100","20"],"path":["api","v1","payment_methods"],"query":[{"key":"brand_id","value":"4067e336-b558-4f81-9c98-2ad56b017e3d"},{"key":"currency","value":"inr"},{"key":"country","value":"india"},{"key":"","value":"","disabled":true}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:50:33 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"available_payment_methods\": [\n \"s2s\",\n \"cybersource_hosted_checkout\",\n \"mastercard\",\n \"visa\"\n ],\n \"by_country\": {\n \"any\": [\n \"s2s\",\n \"cybersource_hosted_checkout\",\n \"mastercard\",\n \"visa\"\n ]\n },\n \"country_names\": {\n \"any\": \"Other\"\n },\n \"names\": {\n \"cybersource_hosted_checkout\": \"Cybersource Hosted Checkout\",\n \"s2s\": \"Server To Server\",\n \"visa\": \"Visa\",\n \"mastercard\": \"Mastercard\"\n },\n \"card_methods\": [\n \"cybersource_hosted_checkout\",\n \"mastercard\",\n \"visa\"\n ]\n}"}],"_postman_id":"22d23f74-8257-4e44-bb1a-4cc7005dee9f"}],"id":"a360b1c7-6715-4741-b4eb-c74fdd20e2fa","_postman_id":"a360b1c7-6715-4741-b4eb-c74fdd20e2fa","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","name":"🌐 Open Banking","type":"folder"}}}],"id":"bf3570e5-b815-4af8-947a-8544aa41d3c2","description":"Overview
\nThird-Party Net Banking refers to the integration with local bank transfer systems in specific countries, enabling users to make payments directly from their bank accounts through a secure and trusted interface. This is particularly useful for regions where direct bank transfers are a preferred payment method over cards or other APMs.
\nFundstream leverages third-party net banking to facilitate transactions for different regions, enabling businesses to access localized payment options without the complexity of managing individual bank integrations. Each third-party service is tailored to the specific financial infrastructure of the country or region, ensuring compliance, security, and ease of use.
\nKey Benefits of Third-Party Net Banking:
\n- \n
Localized Payment Options: Supports region-specific payment methods, giving customers familiar and trusted ways to pay.
\n \nSecure Transactions: Payments are processed directly through the customer’s bank, enhancing trust and security.
\n \nReal-Time Verification: Enables real-time confirmation of payments, reducing risks and improving cash flow.
\n \nCompliance: Adheres to local and international regulatory standards like PSD2 for Europe, ensuring that payments are secure and compliant.
\n \n
This setup allows Fundstream to offer a diverse range of bank transfer options to its global clientele, catering to the specific needs of different regions while maintaining a consistent and secure payment experience.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"8d95dc75-4be8-458b-acff-40e89befb3ff"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2f8b4c40-6da3-4899-b370-8820b69b0397"}}],"_postman_id":"bf3570e5-b815-4af8-947a-8544aa41d3c2"},{"name":"🪙 On Ramp","item":[],"id":"d64ae94a-a8cd-4992-8746-2a534559975f","description":"Overview
\nFundstream provides a user-friendly, direct integration with Quickbit wallet where users can purchase and manage their crypto funds easily. Integrating this interface into your payment process is a straightforward process, requiring just a few simple steps.
\nWe continuously work on improving the integration flow, and as we roll out updates, both customers and merchants can look forward to an enhanced and improved payment experience.
\nIntegration Flow
\nStep 1
\nThe first call to the Fundstream API is POST /purchases initiated by the merchant's backend when they receive a request from the user to make a QuickBit purchase.
\nIt's essential to ensure that the request body includes:
\n- \n
success_redirect - URL where the user will be redirected from Quickbit after completing the purchase
\n \nfailure_redirect - URL where the user will be redirected from Quickbit if the purchase fails
\n \npaymentMethod - Payment method requested. It must specify QBPAYFTOPUP.
\n \n
\n\nIt is important to note that paymentMethod is not a mandatory parameter. If it is not provided, the redirect URL will point to Fundstream Cashier. It must be provided for direct payment with Quickbit.
\n
Here's a sample body of the request:
\n{\n \"client\": {\n \"email\": \"john.doe@fundstream.net\",\n \"country\":\"GB\",\n \"city\":\"London\",\n \"stateCode\":\"Marleybone\",\n \"street_address\":\"221B Baker Street\",\n \"zip_code\":\"NW1 6XE\",\n \"phone\":\"9999999999\"\n },\n \"purchase\": {\n \"products\": [\n {\n \"name\": \"QBit Payment\",\n \"price\": \"10\"\n }\n ]\n },\n \"status\": \"created\",\n \"brand_id\": \"brand_id_from_the_portal\",\n \"paymentMethod\":\"QBPAYFTOPUP\",\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\"\n}```\nIf the request is successful the response will include a parameter called CheckOutURL. That is the QBit payment URL that should be loaded to the customer to proceed with the payment. Here is an example of what a successful response looks like:\n```{\n \"purchaseId\": \"657a10b3c0daf365fa98cdf9\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"john.doe@fundstream.net\",\n \"phone\": \"9999999999\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"221B Baker Street\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"zip_code\": \"NW1 6XE\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"Marleybone\"\n },\n \"updated_on\": 1702498483,\n \"type\": \"purchase\",\n \"paymentMethod\": \"QBPAYFTOPUP\",\n \"amountUnit\": \"MINOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1702498483,\n \"merchantRef\": \"657a10b3c0daf365fa98cdf9\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"QBit Payment\",\n \"quantity\": 1.0,\n \"price\": 1000.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"brand1\",\n \"brand_name\": \"brand1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1702498483\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"brand_id_from_the_portal\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS185\",\n \"issued\": \"2023-12-13\",\n \"due\": 1702498483,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"135.129.121.137\",\n \"checkout_url\": \"https://api.example.net/payments/657a10b3casd23123122/\",\n \"merchantIp\": \"10.10.10.10\"\n}\n\nStep 2
\nOnce the customer is redirected to the CheckOutURL page they will see will depend on the user's country. For the users in Sweden, the page will look like this:
For user's in other countries, the page will look following:
\nOn this page, new users will have to verify their identity and existing users will be prompted to log in.
\nStep 3
\nIn the Quickbit app, the user will be requested to provide their payment details:
\nOnce the payment goes through, the user has to confirm sending the transaction to complete the process:
\nStep 4
\nDepending on the outcome of the payment at Quickbit, the customer will be directed to the:
\n- \n
If the payment is successful - the URL specified in
\nsuccess_redirectthat was provided in the initialPOST /purchasesrequest \nIf the payment is unsuccessful - the URL specified in
\nfailure_redirectthat was provided in the initialPOST /purchasesrequest \n
Concepts
\n- \n
APM Integration: Cashfree functions as an APM where merchants integrate its APIs to manage both incoming (pay-ins) and outgoing (payouts) funds.
\n \nAsynchronous Communication: Both payin and payout flows use callback URLs and webhooks to confirm transaction statuses, ensuring the merchant system stays updated.
\n \nUPI Payment Options: The integration supports UPI-based payments, presenting customers with choices like UPI Dynamic QR and UPI ID payments during the checkout process.
\n \nBeneficiary Details: For payouts, essential beneficiary details, including the Virtual Payment Address (VPA), must be provided to correctly route funds.
\n \nSecure Redirection: Customers are securely redirected from the merchant site to the Cashfree cashier page for payments and back to the merchant site upon completion.
\n \n
\n
Key Steps in the Integration Process
\nPayIn Flow
\n- \n
Customer Selection:
\n
The customer selects Cashfree as the payment method on the merchant’s website. \nAPI Call to Create Purchase:
\n
The merchant system calls the fundstreamcreatePurchaseAPI to initiate the transaction.- \n
Input: Transaction details, order ID, amount, etc.
\n \nOutput: A response containing a checkout URL and an initiated callback URL.
\n \n
\nRedirection to Cashfree Cashier Page:
\n
The customer is redirected to the Cashfree cashier page using the provided checkout URL. \nPayment Options Display:
\n
On the cashier page, the customer is presented with multiple UPI payment options, such as:- \n
UPI Dynamic QR
\n \nPay with UPI ID
\n \n
\nTransaction Execution:
\n
The customer completes the payment using their UPI app. \nCallback & Confirmation:
\n
Upon a successful payment, Cashfree sends a success callback to the merchant’s designated URL. The customer is then redirected back to the merchant’s checkout page, where they see confirmation of a successful payment and an updated balance. \n
Payout Flow
\n- \n
Payout Request Initiation:
\n
The customer initiates a payout request directly on the merchant’s website. \nBeneficiary Details Entry:
\n
The customer enters the Virtual Payment Address (VPA) where they wish to receive the payout. \nAPI Call to Process Payout:
\n
The merchant calls the payout API, which in turn invokes the Cashfree payout API to process the request.- \n
Input: Payout amount, beneficiary details (including VPA), and other required parameters.
\n \nCallback: A callback URL is set up to receive asynchronous updates.
\n \n
\nPayout Execution:
\n
Cashfree processes the payout request by transferring funds to the customer’s specified VPA. \nWebhook Notification:
\n
A success webhook is triggered upon the successful completion of the payout. \nBalance Update:
\n
Both the customer’s and merchant’s account balances are updated to reflect the transaction. \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Fundstream.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Fundstream's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Fundstream and at customer's Bank, the merchant and Fundstream will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Fundstream will perform direct payment with the selected payment method instead of loading Fundstream URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Fundstream also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["purchases",""],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c5846eb-fa7d-4952-9072-c21104da6403"},{"name":"Get Status","id":"19f00ae7-f8a4-4607-9711-8972d8ee84da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.thefundstream.org/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1f193e84-fd87-4ce5-a6d1-35604b624b45","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://app.thefundstream.org/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66c4667bb993c970367c288a\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"IN\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1724147324,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1724147324,\r\n \"merchantRef\": \"66c4667bb993c970367c288a\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"expireInMin\": \"35\",\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1724147324,\r\n \"remote_paid_on\": 1724147324\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"103.59.75.113\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1724147324,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1724147324\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10907\",\r\n \"issued\": \"2024-08-20\",\r\n \"due\": 1724147324,\r\n \"refund_upto\": 1725871728,\r\n \"cc_descriptor\": \"test1\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\",\r\n \"gpayUri\": \"gpay://upi/pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\r\n \"phonepeUri\": \"phonepe://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\r\n \"paytmUri\": \"paytmmp://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\r\n \"generatedLink\": \"https://staging.decf.in/pay/514o5z3m9z\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://api.example.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://api.example.net/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://api.example.net\",\r\n \"failure_callback\": \"https://api.example.net\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.59.75.113\",\r\n \"checkout_url\": \"https://api.example.net/payments/66c4667bb993c970367c288a/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"96346270-4286-4d2e-ae76-2bc769748de2","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://app.thefundstream.org/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"19f00ae7-f8a4-4607-9711-8972d8ee84da"}],"id":"20580f87-286b-4fa1-b5e1-ac3e7ba284d8","description":"PayIn API Flow
\n- \n
Customer Action:
\n- \n
- Customer selects Cashfree at checkout. \n
\nInitiation:
\n- \n
Merchant system calls fundstream
\ncreatePurchaseAPI. \nResponse: Returns a checkout URL and initiates a callback URL.
\n \n
\nRedirection:
\n- \n
- Customer is redirected to the Cashfree cashier page. \n
\nPayment Method Selection:
\n- \n
- Cashfree cashier page displays options such as UPI Dynamic QR and UPI ID. \n
\nTransaction Processing:
\n- \n
- Customer completes the payment using a UPI app. \n
\nSuccess Callback:
\n- \n
- On successful payment, Cashfree triggers a success callback. \n
\nFinalization:
\n- \n
- Customer is redirected back to the merchant site where the transaction status is displayed and the balance is updated. \n
\n
To Initiate a payment, the very first call to make is/payout/
\nwith the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["payout",""],"host":["https://app.thefundstream.org/api/v1"],"query":[{"disabled":true,"key":"","value":""},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[],"_postman_id":"c9a798c3-e9e9-4afe-bab8-943d0f673780"},{"name":"Get Status","id":"bd3ae532-ee8f-4863-b18e-d37ae368343f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.thefundstream.org/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"61e44ad3-ee03-476c-aa5c-307508bfe4c3","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://app.thefundstream.org/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"66838ae86d41e41c10a8656d\",\r\n \"client\": {\r\n \"email\": \"Yogesh@gmail.com\",\r\n \"phone\": \"766533230591\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"country\": \"CA\"\r\n },\r\n \"updated_on\": 1719896808,\r\n \"payoutMethod\": \"PAYOUT-UPI\",\r\n \"beneficiaryDetail\": {\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"UPI\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1719896808,\r\n \"merchantRef\": \"66838ae86d41e41c10a8656d\",\r\n \"merchantName\": \"newMerchant777\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719896808\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1719896810\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719900796\r\n }\r\n ],\r\n \"viewedOn\": 1719900796,\r\n \"currency\": \"INR\",\r\n \"paymentOn\": 0,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"3f9e9ac4-46ab-4155-907f-df6ecb4bf337","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://app.thefundstream.org/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"bd3ae532-ee8f-4863-b18e-d37ae368343f"}],"id":"e64121f8-488a-4ca2-9061-3491de3aeae3","description":"Payout API Flow
\n- \n
Customer Action:
\n- \n
- Customer initiates a payout request on the merchant site and inputs their VPA. \n
\nInitiation:
\n- \n
Merchant system calls its payout API, which then calls the Cashfree payout API.
\n \nInput Data: Includes payout amount, beneficiary details (with VPA), and callback URL.
\n \n
\nProcessing:
\n- \n
- Cashfree processes the payout request. \n
\nWebhook Notification:
\n- \n
- Upon successful payout, Cashfree sends a success webhook. \n
\nFinalization:
\n- \n
- Merchant system updates both customer and merchant balances accordingly. \n
\n
Cashfree is a versatile payment solution that supports both pay-ins (customer payments) and payouts (customer withdrawals) primarily using UPI-based transactions. This integration enables merchants to provide seamless payment experiences on their platforms, offering multiple UPI payment options such as UPI Dynamic QR and UPI ID payments. The integration leverages asynchronous callbacks and webhooks to ensure real-time transaction status updates and balance synchronization between the merchant’s system and Cashfree.
\n","_postman_id":"2ff4b73c-2e5a-4ae9-a770-685b0bd8327f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}}}],"id":"231b25d0-0ff5-49e2-add7-55fd5a40996e","description":"Cashfree is a versatile payment solution that supports both pay-ins (customer payments) and payouts (customer withdrawals) primarily using UPI-based transactions. This integration enables merchants to provide seamless payment experiences on their platforms, offering multiple UPI payment options such as UPI Dynamic QR and UPI ID payments. The integration leverages asynchronous callbacks and webhooks to ensure real-time transaction status updates and balance synchronization between the merchant’s system and Cashfree.
\n","_postman_id":"231b25d0-0ff5-49e2-add7-55fd5a40996e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}}}],"id":"14c12d0f-721a-4bce-939b-016d7f137fca","_postman_id":"14c12d0f-721a-4bce-939b-016d7f137fca","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}}},{"name":"Trust Score","item":[{"name":"TrustScore Detailed","id":"aea39e32-ada2-4e86-a5fe-db4f8729ace4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/trustScore","description":"Overview
\nFundstream TrustScore's proprietary API combines email, phone number, IP and URL so that you can request and receive a user trust score from our enriched data, rules, and scoring in a single API call.
\nOur take on Trust is different from the usual approach to fraud. This API tells you how much you can trust this user. It’s based on 100+ data points to which we have access. We use complex algorithms based on data sanity and customer behaviour in our partner network.
\nAlso, the additional optional parameter would be used to boost the accuracy of our response. So the more data we get the better we can ascertain the users' trust. So please endeavour to send as much information about the user as possible.
\nTrust Score & Usage
\nTrustScore offers two distinct endpoints: General and Detailed.
The General endpoint provides basic information by indicating whether a transaction is permitted or not. It gives a simple 'yes' or 'no' response regarding whether the transaction can proceed.
\nOn the other hand, the Detailed endpoint offers a more comprehensive evaluation. It furnishes an in-depth analysis of the transaction's authenticity, providing a detailed assessment beyond a simple allowance or denial, offering nuanced insights and information about the transaction's legitimacy.
\nDetailed TrustScore
\nTrust scores range from 0 to 5. A trust score of 0 indicates that we have limited information about the user, and it corresponds to the lowest level of trust. In addition to the TrustScore, we offer eight other flags to help assess the user's overall profile and determine appropriate actions to take. We suggest flagging or blocking users, transactions, or clicks as high risk based on a combination of the following factors: email deliverability, proxy usage, VPN usage, Tor usage, and recent abusive behavior.
\nEvery company has a unique target audience, so you might achieve better results by only flagging or blocking entities with low trust scores and recent instances of abuse. Keep in mind that mobile IP addresses are frequently misused and recycled by mobile carriers. Therefore, for mobile lookups, we advise giving more weight to the trust score, VPN usage, and Tor usage, as opposed to proxy usage.
\nPermission
\nAccess to this API has to be given to you by the admin. So please contact your sales representative at Fundstream to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nMandatory Parameters (in body)
\nOther optional parameters:
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nResponse
\nIn the response examples, you can observe both instances of a successful TrustScore response and an unsuccessful one.
\nPlease note that there are a lot of parameters to determine the trust level and give you some additional details on the email and IP of the user.
\nin a successful trust score call the following data would be provided:
\nErrors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["trustScore"],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f0a18858-5761-4e7e-a145-7a5e7fe17cf3","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/trustScore"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"trustScore\": 0,\n \"deliverable\": \"false\",\n \"proxy\": \"false\",\n \"vpn\": \"false\",\n \"tor\": \"false\",\n \"active_vpn\": \"false\",\n \"active_tor\": \"false\",\n \"recent_abuse\": \"false\",\n \"bot_status\": \"false\"\n}"},{"id":"5b4667bb-2635-42e1-b048-76982d03a80e","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"example/trustScore"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"aea39e32-ada2-4e86-a5fe-db4f8729ace4"},{"name":"checkTransactionAllowed","id":"7dadd5ad-9e95-4e62-93ef-b0c91fe5ae9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/checkTransAllowed","description":"General TrustScore
\nRequest for the checkTransactionAllowed endpoint is identical to the TrustScore API. Only thing different is the response. Instead of detailed score, this endpoint only returns transactionAllowed parameter that can have either YES or NO value.
Permission
\nAccess to this API has to be given to you by the admin. So please contact your sales representative at Fundstream to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nMandatory Parameters (in body)
\nOther optional paramters:
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nResponse
\nResponse contains a single parameter: transactionAllowed which can either be YES or NO .
{\n\"transactionAllowed\" : \"YES\"\n}\n\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["checkTransAllowed"],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"acca5fb3-72a9-45af-a48f-7ab484b4d1c7","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.net/api/v1/checkTransAllowed"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionAllowed\": \"YES\"\n}"},{"id":"5dd375c2-3864-446f-8cf2-705417ce4d29","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/checkTransAllowed"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"7dadd5ad-9e95-4e62-93ef-b0c91fe5ae9c"}],"id":"66e29974-e620-45c7-9836-e76251f15cf7","_postman_id":"66e29974-e620-45c7-9836-e76251f15cf7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}}},{"name":"Cashier APIs","item":[{"name":"Customer","id":"6df14867-fc8b-4062-8aa1-4d6044233cb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"merchantCustomerId\": \"Merchant to provide\", //mandatory\r\n \"fullName\": \"Akshaya Singhal\",\r\n \"emailId\": \"akshayas@example.net\",\r\n \"dateOfBirth\": \"1995-11-27\",\r\n \"phoneNo\": \"7976390821\",\r\n \"city\": \"jaipur\",\r\n \"stateCode\": \"ra\",\r\n \"zipCode\": \"202020\",\r\n \"address\": \"Mansarovar Jaipur\",\r\n \"country\": \"IN\",\r\n \"custRegDate\": \"Merchant to provide\", //non-mandatory - customer registration date on merchant site\r\n \"successTxn\": \"Merchant to provide\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/customer","description":"OVERIEW
\nThe createCustomer API allows merchants to create a customer profile on Fundstream when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the Fundstream Cashier. The API takes in customer information and returns a unique customerID that can be passed in purchase payload, eliminating the need for customers to manually enter their details during transactions.
\n\n\n\n
Mercahnt can add upto 20 additional parameters in this request.
User Flow
\n- \n
Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n \nMerchant calls the
\ncreateCustomerAPI: The merchant sends aPOSTrequest to the Fundstream API with the customer's details. \nCustomer ID generation: Fundstream processes the request and generates a unique
\ncustomerIdwhich is returned in the response. \nPayment Process: The merchant uses the
\ncustomerIdfor subsequent transactions, ensuring the customer doesn’t need to re-enter their details for future payments. \n
\n
Benefits
\n- \n
Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n \nFaster Checkout: The merchant can use the
\ncustomerIdfor faster payment processing. \nData Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n \n
Implementing createCustomer on merchant site:
\nThe createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:
At Checkout:
\nWhen a customer initiates the checkout process, your system should invoke the createCustomer API, before actually starting the session.
- \n
Call
\ncreateCustomer****: This API call generates a unique customer ID. \nUse of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n \n
Upon Customer Login:
\nAlternatively, merchants may choose to call createCustomer at the time of customer login on their site.
- \n
Persistent Customer Profiles: This approach can help build or maintain a persistent customer profile, ensuring the customer ID is available for any subsequent payment sessions without needing to call
\ncreateCustomeragain. \nIntegration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n \n
\n\nThis method is not advised for white-label merchants who want to manage different customerIDs for each brand.
\n
The method you choose depends on your business requirements and how your system is architected. Regardless of when you call it, the resulting customer ID must be passed to the createSession API to initiate a payment session.
This endpoint makes an HTTP GET request to retrieve customer information from the Fundstream API.
\nRequest
\nThe request does not include any query parameters, but it uses a raw request body with the following payload:
\n{\n \"merchantCustomerId\": \"merchantCustomerId\"\n}\n\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["customer"],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0e062cbf-0dd7-4b25-b09b-862a2fe89777","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.example.net/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"67c54bff81fd9953719186ff\",\n \"merchantCustomerId\": \"testuser@gmail.com\",\n \"fullName\": \"Akshaya Singhal\",\n \"emailId\": \"testuser@gmail.com\",\n \"dateOfBirth\": \"1995-11-27\",\n \"phoneNo\": \"2222222222\",\n \"brandID\": \"db8414b4-e527-4be6-b2bf-df5cb7a646c7\",\n \"city\": \"jaipur\",\n \"zipCode\": \"202020\",\n \"address\": \"Mansarovar Jaipur\",\n \"country\": \"IN\",\n \"stateCode\": \"ra\",\n \"custRegDate\": \"2024-11-27\",\n \"successTrans\": 32\n}"},{"id":"4fd08c6f-81f4-4a32-939b-d33066ca9d49","name":"Invalid Customer","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.example.net/api/v1/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer with this information does not exist\",\n \"code\": \"customer_does_not_exist\"\n}"}],"_postman_id":"8f8fb879-c5f5-4b00-90ab-fc43739eea1f"},{"name":"Customer","event":[{"listen":"test","script":{"exec":["var template = `","","","| Customer ID | ","First Name | ","Last Name | ","Phone | ","|
|---|---|---|---|---|
| {{response.customerId}} | ","{{response.firstName}} | ","{{response.lastName}} | ","{{response.email}} | ","{{response.phone}} | ","
Whenever a customer or the merchant updates customer details on the merchant site, a PATCH request must be made to synchronize these changes with Fundstream.
\nThis API endpoint allows you to update the customer details using an HTTP PATCH request. The request should be sent to https://app.example.org/api/v1/{customerId}/patchCustomer.
\nRequest Body
\nThe request body should be in raw format and include the following parameters:
\n- \n
\nfullName(string): The full name of the customer. \n
\nemailId(string): The email address of the customer. \n
\ndateOfBirth(string): The date of birth of the customer. \n
\nphoneNo(string): The phone number of the customer. \n
\ncity(string): The city of the customer. \n
\nstateCode(string): The state code of the customer. \n
\nzipCode(string): The zip code of the customer. \n
\naddress(string): The address of the customer. \n
\ncountry(string): The country of the customer. \n
\ncreatedOn(string): Time when the customer was created. \n
\ncustRegDate(string): Customer registration date (Non-Mandatory). \n
\nsuccessTxn(string): Success transaction details (Non-Mandatory). \n
\nlastActivity(string): Time of the last activity. \n
\nlastUpdated(string): Time when the last patch was called. \n
\nextraParam(object): Additional parameters includingparam1,param2,param3,param4with their respective values. \n
Response
\nThe response will contain the updated customer details or a success message upon successful update.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}},"urlObject":{"path":["{customerId}","patchCustomer"],"host":["https://app.thefundstream.org/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9bb7d14c-9d4a-47f3-9023-3075964913a7","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorisation","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Akshaya Singhal\",\n \"emailId\": \"testuserabcd@gmail.com\",\n \"dateOfBirth\": \"1995-11-27\",\n \"phoneNo\": \"2222222222\",\n \"city\": \"jaipur\",\n \"stateCode\": \"ra\",\n \"zipCode\": \"202020\",\n \"address\": \"Mansarovar Jaipur\",\n \"country\": \"IN\",\n \"custRegDate\": \"2024-11-27\",\n \"successTxn\": \"32\"\n // \"extraParam\":\n// {\n// \"param1\":\"value1\",\n// \"param2\":\"value2\",\n// \"param3\":\"value3\",\n// \"param4\":\"value4\"\n// }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.net/api/v1/{customerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"customerId\",\n \"merchatCustomerID\": \"merchantProvidedCustomerId\",\n \"brandId\": \"brandId\",\n \"fullName\": \"Akshaya Singhal\",\n \"emailId\": \"testuserabcd@gmail.com\",\n \"dateOfBirth\": \"1995-11-27\",\n \"phoneNo\": \"2222222222\",\n \"city\": \"jaipur\",\n \"stateCode\": \"ra\",\n \"zipCode\": \"202020\",\n \"address\": \"Mansarovar Jaipur\",\n \"country\": \"IN\",\n \"createdOn\": \"2025-02-27\",\n \"custRegDate\": \"2024-11-27\",\n \"successTrans\": 32\n \"lastActivity\": \"\",\n \"lastUpdated\": \"\"\n}"}],"_postman_id":"5abee2dc-1e0c-404c-99a2-73cd6ef86274"},{"name":"createSession","id":"cf799a8e-fd08-42eb-bb8d-da271116d1dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"customerId\": \"67c54bff81fd9953719186ff\",\r\n \"currency\" : \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"10\"\r\n }\r\n ],\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n\t\"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.thefundstream.org/api/v1/createSession","description":"OVERIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nUsage Flow
\n- \n
Customer completes the
\ncreateCustomerAPI: Once the customer is created via thecreateCustomerAPI, the merchant proceeds to call thecreateSessionAPI to generate a session. \nMerchant sends
\ncreateSessionrequest: The merchant sends aPOSTrequest to thecreateSessionAPI with the customer’scustomerIdand the merchant’sbrandId. \nSession created automatically on the checkout URL: Fundstream creates the session and associates it with the merchant’s checkout page. This session remains active on the backend, allowing the customer to continue the payment process without interruption.
\n \nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\n \nSession Expiry: The session expires after the set expiration time (
\nexpiryOn), ensuring the payment process is completed within the defined window. \n
\n
Benefits
\n- \n
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n \nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n \nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\n \n
The CreatePurchase API is a core feature of the Fundstream Cashier System, enabling merchants to initiate payments by creating a purchase session. This API streamlines the payment process by allowing customization based on customer details, purchase information, and payment methods.
Overview
\nThe CreatePurchase API initiates the payment process by generating a unique session for a transaction. Depending on the passed paymentMethod and pre-configured routing rules, the API directs the transaction through the appropriate payment channel. Additionally, success and failure callbacks are used to provide real-time updates on transaction status.
Key Features
\n- \n
Dynamic Payment Routing: Routes transactions to specific payment methods based on the merchant's configuration.
\n \nCustomizable Callbacks: Configure URLs for success and failure redirects as well as server-to-server callbacks for real-time updates.
\n \nReceipt and Capture Options: Optionally send customer receipts or skip the capture step for certain use cases.
\n \nTimeout Configuration: Define an expiration period (
\nexpireInMin) for the purchase session. \n
\n
API Endpoint
\nURL:POST /api/v1/createPurchase
\n
Request Payload
\nBelow is the sample payload for initiating a purchase session:
\n{\n \"client\": {\n \"full_name\": \"Test User\",\n \"email\": \"testuser@email.com\",\n \"country\": \"GB\",\n \"city\": \"sdf\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test street\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\",\n \"tax_number\": \"34946395822\"\n },\n \"purchase\": {\n \"currency\": \"GBP\",\n \"expireInMin\": \"40\",\n \"products\": [\n {\n \"name\": \"testProduct\",\n \"price\": \"10\"\n }\n ]\n },\n \"paymentMethod\": \"\",\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"merchantRef\": \"\",\n \"send_receipt\": \"\",\n \"skip_capture\": \"\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}\n\nParameters
\nClient Information
\nPurchase Information
\nAdditional Parameters
\n\n
Payment Flow
\n- \n
Initiate Payment: Use the
\nCreatePurchaseAPI to create a payment session by passing the required details in the payload. \nDynamic Routing: The
\npaymentMethodparameter determines the channel for processing the payment based on pre-configured rules. \nCallback Notification: Once the payment is completed, the system triggers the configured
\nsuccess_callbackorfailure_callbackURL with transaction details. \nRedirects: After processing, the customer is redirected to the configured
\nsuccess_redirectorfailure_redirectpage. \n
\n
Sample Response
\nWhen the CreatePurchase API is successfully called, it generates a detailed response containing essential information about the transaction. Below is a sample response structure:
{\n \"purchaseId\": \"675bd05011ba785cc1356c32\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"akshaya@gmail.com\",\n \"phone\": \"9999999999\",\n \"full_name\": \"akshaya singhal\",\n \"street_address\": \"test test\",\n \"country\": \"GB\",\n \"city\": \"sdf\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"tax_number\": \"34946395822\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1734070352,\n \"type\": \"purchase\",\n \"paymentMethod\": \"SPEI-CLABE,SPEI-CARD,SPEI-MOBILE,eNaira,BANKTRANSFER,KoraPayMobileMoney,PIX,MASTER,VISA,THIRDPARTY-NETBANKING,INTERAC,INTERAC-E-TRANSFER,QBPAYFTOPUP,MOBILEWALLET,UZCARD,HUMO,AMEX,KLARNA,JCB,FawryPay,DISCOVER,QBPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1734070352,\n \"merchantRef\": \"675bd05011ba785cc1356c32\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"name\": \"he2938h\",\n \"quantity\": 1.0,\n \"price\": 1.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"expireInMin\": \"40\",\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1734070352\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS12952\",\n \"issued\": \"2024-12-13\",\n \"due\": 1734070352,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"paidOn\": 0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"49.36.232.165\",\n \"checkout_url\": \"https://app.example.org//payments/675bd05011ba785cc1356c32/\",\n \"direct_post_url\": \"https://app.example.org/api/v1/p/675bd05011ba785cc1356c32/\",\n \"payoutProcess\": false\n}\n\nFundstream Cashier is a unified payment management solution that connects with leading PSP and acquirers, offering merchants one convenient access point to simplify transaction processing and enhance efficiency.
\nTo start the cashier system, a payment session is initiated—a secure, temporary environment generated by our payment gateway. This session encapsulates all transaction details and state information before the cashier loads, overseeing the complete lifecycle of a payment attempt—from initial setup to final completion—ensuring every necessary detail is managed safely and consistently.
\n","_postman_id":"342db195-d530-4a12-b29d-a5405f04fd7a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","id":"0c8c27a0-0c1b-4c90-a68e-15a831edeb50","name":"Fundstream API Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"49e62c8b-5e3c-4646-bbcf-810081a8162c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0d4f6db1-d0c8-4f42-969c-35c973b7cf26"}}],"variable":[{"key":"BaseURL","value":"https://app.thefundstream.org/api/v1"},{"key":"StagingAPIKey","value":""},{"key":"StagingBaseURL","value":"https://app.thefundstream.org/api/v1"}]}