This 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":"0a0e190f-e543-4e35-85da-c3cc9314af0d","id":"0a0e190f-e543-4e35-85da-c3cc9314af0d","name":"💳 Card Payments","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","payment_methods"],"host":["api-pay-neo","com"],"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":"f17eebba-f25e-4e2a-8b2c-6fecc64b7f26","name":"Payment Methods","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api-pay-neo.com/api/v1/payment_methods","protocol":"https","host":["api-pay-neo","com"],"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":"422fd22c-99a5-4115-8a81-ec60a5ff0779"},{"name":"checkWhiteList","id":"24573039-7cac-41ac-8015-0105d54d4091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"dev@neogated.com\",\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-pay-neo.com/api/v1/checkWhiteList","description":"Overview
\nNeogated supports the concept of whitelisted cards. The merchant can send Neogated 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":"0a0e190f-e543-4e35-85da-c3cc9314af0d","id":"0a0e190f-e543-4e35-85da-c3cc9314af0d","name":"💳 Card Payments","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","checkWhiteList"],"host":["api-pay-neo","com"],"query":[],"variable":[]}},"response":[{"id":"654a4781-4709-482f-a848-9d5dcbfe3f7b","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://https://api-pay-neo.com/api/v1/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":"4e1b4b5a-cf57-4463-92d9-dac32ad3def6","name":"checkWhiteList - Exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"dev@neogated.com\",\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://https://api-pay-neo.com/api/v1/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":"24573039-7cac-41ac-8015-0105d54d4091"},{"name":"Whitelist Upload","id":"d69a9426-d1ea-45ff-8719-917553c62462","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"csvFile","type":"file","value":null}]},"url":"https://https://api-pay-neo.com/api/v1/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\nOVERIEW
\nThe createCustomer API allows merchants to create a customer profile on Neogated when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the Neogated 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.
\nUser 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 Neogated API with the customer's details. \nCustomer ID generation: Neogated processes the request and generates a unique
\ncustomerIdwhich is returned in the response. \nPayment Process: The merchant uses the
\ncustomerIdfor subsequent session creation, 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
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 Neogated API.
\nRequest
\nThe request does not include any query parameters, but it uses a raw request body with the following parameter \"merchantCustomerId\", which will be the customer id on the merchant's side.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c8d524cd-388a-4316-9f41-d8e430d3e4a4","id":"c8d524cd-388a-4316-9f41-d8e430d3e4a4","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","customer"],"host":["app","neogated","net"],"query":[],"variable":[]}},"response":[{"id":"bd4ed176-5575-4b41-bfad-5080cf3c1d48","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://app.neogated.net/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@neogated.com\",\n \"fullName\": \"Rahul Agarwal\",\n \"emailId\": \"rahul+26@neogated.com\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"brandID\": \"1d666074-39be-4b90-aec9-e9de78fbdcb9\",\n \"city\": \"Jaipur\",\n \"zipCode\": \"302018\",\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\n \"country\": \"IN\",\n \"stateCode\": \"RJ\",\n \"custRegDate\": \"2023-12-27\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 0,\n \"lastActivity\": 1763376070,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"},{"id":"b7ffaeed-5675-4004-8849-1357c3c32d2d","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://app.neogated.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":"ddb44fcc-de67-4d09-ad63-42e325ae4a7e"},{"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 Neogated.
\nThis API endpoint allows you to update the customer details using an HTTP PATCH request. The request should be sent to https://api-pay-neo.com/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","urlObject":{"protocol":"https","path":["api","v1","{NeogatedCustomerId}","patchCustomer"],"host":["api","neogated","net"],"query":[],"variable":[]}},"response":[{"id":"485bae32-4805-4d8b-a1f0-b4fc8e006b02","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\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@neogated.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Dausa\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\",\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.neogated.net/api/v1/{NeogatedCustomerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@neogated.com\",\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@neogated.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"brandID\": \"brandID\",\n \"city\": \"Dausa\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"stateCode\": \"Raj\",\n \"custRegDate\": \"2023-12-28\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 1763377024,\n \"lastActivity\": 1763377024,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"}],"_postman_id":"d5822521-6a90-4356-970d-89c8514260f9"},{"name":"Purchase Session","id":"544a2412-84fa-430e-9a29-1914fa90189b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"30f7ce6e-3b7e-46a2-9b50-484fc55be689","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@neogated.com\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://merchant-success-page.com/\",\r\n \"failure_redirect\": \"https://merchant-failure-page.com/\",\r\n \"pending_redirect\": \"https://merchant-pending-page.com/\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.neogated.net/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.
\nMandatory Parameters
\nShow Crypto Conversion
\nAdditionally, there are some default extra parameters that you can pass for allowing Crypto Conversion on Neogated's cashier itself.
\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: Neogated 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. Default is 15 mins from the creation time. \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
This API is used to initiate a payout session for a customer. By passing the customerId (generated via the createCustomer API) and specifying \"type\": \"payout\", a payout session is started.
A sessionURL is returned in the response, which can be used to redirect the customer to the payout cashier. The customer can then select the payment method, pass required parameters, and the payout will be processed.
Parameters:
\nRequest Headers:
\n- \n
BrandId: Your unique brand ID (required).
\n \nContent-Type: application/json (required).
\n \n
Response:
\nThe API will return a JSON object containing the sessionURL that can be used to redirect the customer to the payout cashier.
{\n \"sessionUrl\": \"https://api-pay-neo.com/payoutSession/68341ad35f895955355d5452/\",\n \"brandId\": \"brand_id_value\",\n \"customerId\": \"67c9983fba18400ab6cceb8f\",\n \"sessionId\": \"68341ad35f895955355d5452\",\n \"expiryOn\": 1748246103,\n \"createdOn\": 1748245203\n}\n\nThis endpoint retrieves the details of a session identified by the provided session ID.
\n\n\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c8d524cd-388a-4316-9f41-d8e430d3e4a4","id":"c8d524cd-388a-4316-9f41-d8e430d3e4a4","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases","{Session ID}",""],"host":["api","neogated","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3d71875-8d8b-4fbc-aa82-99bc537fcd24"}],"id":"c8d524cd-388a-4316-9f41-d8e430d3e4a4","description":"Note that this API only respond once the SessionURL, received in the reposne for session API, is clicked.
\n
Neogated 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","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c2be7aac-c3c0-4986-9a82-3c66ef08a73b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"fbd94b30-7256-4c37-8d23-951baff3ea4b"}}],"_postman_id":"c8d524cd-388a-4316-9f41-d8e430d3e4a4"},{"name":"User Defined Fields (UDF)","item":[],"id":"b0dbd4e3-55ca-451a-94e5-03d87e6b1b64","description":"User Defined Fields (also referred to as Merchant Defined Parameters) allow you to attach custom identifiers to transactions. These identifiers can help you map transactions to your internal systems and configure advanced routing rules.
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
Adding a User Defined Field
\n- \n
Click Add Parameters.
\n \nEnter the Parameter Name.
\n \nChoose the Value Type (Numeric, String, or Boolean).
\n \nClick Add to save.
\n \n
Here is how you can define UDFs in Neogated's app.
\nUsing UDF in API Requests
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
\"extraParam\": {\n \"userDefinedParameter\": \"value\"\n}\n\nBest Practices
\n- \n
Use consistent naming conventions for parameters to avoid confusion across integrations.
\n \nKeep the number of UDFs minimal — only add fields that provide clear value (e.g., customer segment, order type, risk score).
\n \nLeverage UDFs in rule-based routing to optimize processing flows (e.g., route high-value transactions to a specific MID).
\n \nDocument your UDFs internally so operations and support teams can easily reference them.
\n \n
Orchestration powered by Paysecure
\n![](\"https://dashboard.paysecure.net/assets/Logo-BGiXeLxq.svg\"){kind=logo}
","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"ac55baed-ecfc-4780-aaea-dcec83c11af8"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"189f4705-38cc-4089-aba7-59faa0cfa38b"}}],"_postman_id":"b0dbd4e3-55ca-451a-94e5-03d87e6b1b64"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{APIKey}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ae44171c-d932-49ba-b03a-1747ff336a9e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b24dd2c4-24bd-46f2-89b8-a0274b1e0204"}}],"variable":[{"key":"BaseURL","value":"https://api-pay-neo.com/api/v1","type":"string"},{"key":"StagingAPIKey","value":"","type":"string"}]}