Hipopotamya API is a powerful system that can be integrated with various types of dealership, offering a range of features. By utilizing our platform, you can efficiently manage your business in the virtual world and take advantage of various benefits.
\nHipocard E-Pin, developed exclusively by Hipopotamya.com, is a payment and reward program designed to enhance your creativity in the virtual world. As a Hipocard dealer, you can offer your customers an alternative payment option with this special gift card on our platform.
\nAbout Dealership: https://www.hipopotamya.com/become-a-dealer
\nWholesale dealership enables you to procure products offered on Hipopotamya.com at discounted rates. Depending on your total spending, you can increase your earnings with the discounts you'll obtain on products.
\nAbout Delaership: https://www.hipopotamya.com/e-pin-bayilik-basvurusu
\nMerchant dealership is a currently inactive type. Game developers can sell their own E-Pin products directly by adding them to Hipopotamya stocks on the platform.
\nTo use the Hipopotamya.com API system, you need to have an active dealer account and obtain API usage authorization for that account.
\nUsing the HIPOPOTAMIA API system;
\nPerform Hipocard e-pin code verification.
\nPlace E-pin code orders.
\nInstantly view the status of orders placed through the API.
\nView your order history.
\nCheck your current account balance.
\nNew features are continuously being developed...
\nHipopotamya API, çeşitli bayilik türleri üzerinden sunulan bir dizi özellik ile entegre edilebilen güçlü bir sistemdir. Platformumuzu kullanarak işletmenizi sanal dünyada daha etkili bir şekilde yönetebilir ve çeşitli avantajlardan yararlanabilirsiniz.
\nHipopotamya.com'un özel geliştirdiği \"Hipocard E-Pin,\" sanal dünyada yaratıcılığınızı artırmak için tasarlanmış bir ödeme ve ödül programıdır. Hipocard bayisi olarak, platformuz üzerinde müşterilerinize bu özel hediye kartı ile alternatif ödeme imkanı sunabilirsiniz.
\nBayilik Hakkında: https://www.hipopotamya.com/become-a-dealer
\nToptan satış bayiliği, Hipopotamya.com üzerinde sunulan ürünleri indirimli bir şekilde temin etmenizi sağlayan bir bayilik türüdür. Toplam harcamanıza bağlı olarak ürünlerde elde edeceğiniz indirimlerle kazancınızı artırabilirsiniz.
\nBayilik Hakkında: https://www.hipopotamya.com/e-pin-bayilik-basvurusu
\nMerchant bayiliği, henüz aktif olmayan bir bayilik tipidir. Oyun üreticileri, kendi E-Pin ürünlerini doğrudan Hipopotamya stoklarına ekleyerek platform üzerinde satış yapabilirler.
\nHipopotamya.com API sistemini kullanabilmek için aktif bir bayi hesabınız ve bu hesaba API kullanım yetkisi almış olmanız gerekmektedir.
\nHIPOPOTAMYA API sistemini kullanarak;
\nHipocard e-pin kod doğrulaması yapabilirsiniz.
\nE-pin kod siparişi verebilirsiniz.
\nAPI üzerinden vermiş olduğunuz siparişlerin durumunu anlık olarak görüntüleyebilirsiniz.
\nGeçmiş siparişinizi görüntüleyebilirsiniz.
\nÜyeliğinizin mevcut bakiyesini görüntüleyebilirsiniz.
\nYeni özellikler geliştirilmeye devam etmektedir...
\nEN: You can work with the sandbox (test) link during the integration process. You can try epin codes as many times as you want. When the integration process is finished, it is recommended to test with at least 1 epin code after switching to the Live-Production environment.
\nTR: Entegrasyon sürecinde sandbox (test) bağlantısı ile çalışabilirsiniz. Epin kodlarının istediğiniz kadar deneyebilirsiniz. Entegrasyon süreci bittiğinde Live-Production sistemde geçiş yaptıktan sonra en az 1 tane epin kodu ile test yapmanız önerilmektedir.
\nEN: Each request to the API must include the following HTTP request.
TR: API'ye yapılan her istek aşağıdaki HTTP istek başlıklarını içermelidir:
EN: This header indicates the response format, which is required for operations with a response body. The syntax is:
\nTR: Bu başlık, yanıt gövdesiyle yapılan işlemler için gerekli olan yanıt biçimini belirtir. Sözdizimi şöyledir:
\nAccept: application/json
EN: This header is required to authenticate via the API. The User-Agent parameter specifies which browser or application made the request sent in API requests.
TR: Bu başlık, API üzerinden kimlik doğrulamak için gereklidir. User-Agent parametresi, API isteklerinde gönderilen isteğin hangi tarayıcı veya uygulama tarafından yapıldığını belirtir.
User-Agent: Custom App Name (https://example.com/contact)
ORUser-Agent: Custom App Name (contact@example.com)
EN: The dealer API key and API Secret required for the test environment are specified on the sandbox page. If you want to test live environment, you can create a dealer account. Or you can use the api code mentioned below.
\nTR: Test ortamı için gereken bayi API Key ve API Secret sandbox sayfasında belirtilmiştir. Canlı ortamda test yapmak isterseniz bir bayi hesabı oluşturabilirsiniz. Veya aşağıda belirtilen API Key'i kullanabilirsiniz.
\nEN: Wholesale Dealership API utilizes a Bearer token-based mechanism for session control, distinguishing this feature from the Hipocard dealership mechanism. This type of dealership employs the Bearer token method to ensure secure and authorized access.
\nTR: Toptan Satış Bayiliği API'si, oturum kontrolünü gerçekleştirmek için Bearer token tabanlı bir mekanizma kullanmaktadır, ki bu özellik, Hipocard bayilik mekanizmasından farklıdır. Bu bayilik türü, güvenli ve yetkilendirilmiş erişimi sağlamak amacıyla Bearer token yöntemini kullanmaktadır.
\nEN: Session control for the Wholesale Dealership API is carried out using a Bearer token. Following the approval of your dealership application, you can use the valid token for the specified IP addresses to conduct testing in both the sandbox environment and seamlessly transition to the live environment.
\nTR: Toptan Satış Bayiliği için API oturumunun kontrolü, Bearer token ile gerçekleştirilir. Bayilik başvurunuzun onaylanmasının ardından belirlediğiniz IP adreslerinde geçerli olan token ile hem sandbox ortamında test işlemleri gerçekleştirebilir hem de doğrudan canlı ortama geçiş yapabilirsiniz.
\nAuthorization: Bearer
EN: After the completion of your application, you can employ the valid token for the specified IP addresses, accessible via the \"My Account > API Settings\" page, to perform various test scenarios in the sandbox environment. This allows you to ensure the accuracy and reliability of your API integration.
\nTR: Başvurunuzun tamamlanmasının ardından, Hesabım > API Ayarları sayfası üzerinden belirlenen IP adreslerinde geçerli olan token ile sandbox ortamında çeşitli test senaryolarını uygulayabilirsiniz. Bu sayede API entegrasyonunuzun doğru ve güvenilir bir şekilde çalıştığından emin olabilirsiniz.
\nEN: Upon successful tests, you can transition to the live environment using your Wholesale Dealership Bearer token. The token, valid for the specified IP addresses, provides secure and authorized access in the live environment. All you need to do is update the API connection used in the sandbox environment for live use.
\nPlease carefully review the documentation to ensure proper token management and execute a secure integration
\nTR: Başarılı testlerin ardından, toptan satış bayiliği Bearer token'inizi kullanarak canlı ortama geçiş yapabilirsiniz. Belirlediğiniz IP adreslerinde geçerli olan token, canlı ortamda güvenli ve yetkilendirilmiş erişim sağlar. Tek yapmanız gereken sanbox ortamında kullandığınız API bağlantısını canlı ortam için güncellemeniz gerekemektedir.
\nLütfen dökümantasyonu dikkatlice inceleyerek doğru token yönetimi sağlayın ve güvenli bir entegrasyon gerçekleştirin.
\nEN: It is currently limited to 60 requests per minute. This amount can be increased upon request.
\nTR: Şu anda dakikada 60 istekle sınırlıdır. Bu miktar talep üzerine artırılabilir.
\nV1.5.3 - 07.09.2025
\ncurrency parameter has been added.currency is not provided, the default currency will be TRY.USD, EUR, GBP, or EGP is provided, the amount will be automatically converted and processed in TRY by the system.V1.5.2 - 07.09.2025
\nV1.5 - 01.08.2025
\nOrder status codes have changed in wholesale API orders.
\nA webhook structure has been developed for products that require preparation.
\nV1.4 - 16-01-2024
\nThe Hipocard API URL has been changed (Old API is active until June 1, 2024).
\nHipocard request responses and error codes have been updated. Reintegration is required.
\n25,000 TRY and 50,000 TRY test e-pin codes have been added to the Hipocard SANDBOX environment.
\nE-pin order creation and order detail viewing functionalities have been added.
\nUser balance listing has been added.
\nV1.3 - 09-08-2023
\nAdded changelog.
\n2.500 TRY, 5.000 TRY and 10.000 TRY test epin codes have been added to the SANDBOX environment.
\n3 new products have been added without any change in HİPOCARD E-PIN API structure.
\nV1.5.3 - 07.09.2025
\ncurrency değeri eklendi.currency gönderilmezse varsayılan para birimi TRY olarak alınır.USD, EUR, GBP veya EGP gönderildiğinde, tutar sistem tarafından otomatik olarak TRY para birimine çevrilerek işlenir.V1.5.2 - 07.09.2025
\nV1.5 - 01.08.2025
\nWholesale api siparişinde sipariş durum koduları değişti.
\nHazırlık gereken ürünler için webhook yapısı geliştirildi.
\nV1.4 - 16-01-2024
\nHipocard api url değiştirildi (Eski API 01-06-2024'e kadar aktif).
\nHipocard istek yanıtları ve hata kodları güncellendi. Entegrasyon yeniden yapılmalıdır.
\nHipocard SANDBOX ortamına 25.000 TRY ve 50.000 TRY test epin kodları eklendi.
\nE-pin sipariş oluşturma ve sipariş detayı görüntüleme eklendi.
\nKullanıcı bakiye listeleme eklendi.
\nV1.3 - 09-08-2023
\nGüncelleme geçmişi eklendi.
\nSANDBOX ortamına 2.500 TRY, 5.000 TRY ve 10.000 TRY test epin kodları eklendi.
\nHİPOCARD E-PİN api yapısında değişiklik olmadan 3 yeni ürün eklendi.
\nRequired
\n"},{"key":"api-secret","value":"HIPOCARD","description":"Required
\n"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"HIPOCARDSANDBOXEPINCODE123AB0050","description":"Required | Epin code in Hipocard product order detail
\n","type":"text"},{"key":"epin_secret","value":"HIPOCARD","description":"Required | Epin secret in Hipocard product order detail
\n","type":"text"},{"key":"player_name","value":"player_id","description":"Required | Char name or username of the player who activated Epin
\n","type":"text"},{"key":"used_ip","value":"127.0.0.1","description":"Requeired | Ip address of the player who activated the epin
\n","type":"text"}]},"url":"https://www.hipopotamya.com/api/sandbox/v1/hipocard/epins","description":"EN: This endpoint allows checking the Hipocard e-PIN. If the e-pin code is valid, it will be instantly marked as consumed. The consumed e-pin amount will be added to your dealer account as withdrawable balance.
\nTR: Bu endpoint, Hipocard e-pini kontrol edilmesini sağlamaktadır. Eğer e-pin kodu geçerli ise anında tüketilmiş olarak güncellenecektir. Tüketilen e-pin tutarı çekilebilir bakiye olarak bayi hesabınıza eklenecektir.
\n","urlObject":{"protocol":"https","path":["api","sandbox","v1","hipocard","epins"],"host":["www","hipopotamya","com"],"query":[],"variable":[]}},"response":[{"id":"12d407bc-ceaf-426c-be4a-42cbc21bdc84","name":"200 Dealer is not active","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/sandbox/v1/hipocard/epins"},"status":"Dealer is not active","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Dealer is not active!\",\n \"error_code\": 11\n}"},{"id":"3673100c-dd26-4602-8dfe-0945c56db931","name":"200 E-PIN Code Used or Invalid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/sandbox/v1/hipocard/epins"},"status":"E-PIN Code Used","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"E-PIN Code has been used or is invalid!\",\n \"error_code\": 12\n}"},{"id":"c72aba3f-49b1-444a-bedf-e3eaad26c3d5","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/sandbox/v1/hipocard/epins"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No API Key or Secret!\",\n \"error_code\": 9\n}"},{"id":"6fedd200-b935-4f29-b703-c25625b6d5ff","name":"401 Unauthorized 2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/sandbox/v1/hipocard/epins"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"API Key or API Password is invalid!\",\n \"error_code\": 10\n}"},{"id":"21dedf11-6f80-4891-b634-def76b7d1eed","name":"422 Validation Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/sandbox/v1/hipocard/epins"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Validation error.\",\n \"error_code\": 3,\n \"errors\": {\n \"player_name\": [\n \"player name field is required.\"\n ],\n \"used_ip\": [\n \"used ip field is required.\"\n ],\n \"epin_code\": [\n \"epin code field is required.\"\n ],\n \"epin_secret\": [\n \"epin secret field is required.\"\n ]\n }\n}"},{"id":"9f4c983d-12c7-4836-b4a0-1894c8293b27","name":"200 Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/sandbox/v1/hipocard/epins"},"status":"Successful","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successful\",\n \"data\": {\n \"total_sales\": \"100.00\",\n \"total_sales_multiplied\": 10000, // Epin price (Multiplied by 100: e.g. 34.56 => 3456)\n \"total_commission\": 7,\n \"net_total\": 93,\n \"currency\": \"TRY\",\n \"rounded_total_sales\": 100\n }\n}"}],"_postman_id":"be687dd6-0c48-47e4-bdd9-6054dbbfc510"}],"id":"c4c77bc8-96a5-406c-b6f9-4e9a28a16280","description":"You can use the following epin codes in the test environment. In the first row, the epin code ending with 0000 is used code. Other epin codes give results according to the product amount.
\nAşağıda belirtilen epin kodlarını test ortamında kullanabilirsiniz. İlk satırda 0000 ile biten epin kodu kullanılmış olarak yanıt vermektedir. Diğer epin kodları ise ürün tutarına göre sonuç vermektedir.
\n","_postman_id":"c4c77bc8-96a5-406c-b6f9-4e9a28a16280"}],"id":"c8eb6815-dd7a-4ac5-bc72-7de1a2c7ecd6","description":"The dealer information you can use for testing is given below.
\nTest işlemleri için kullanabileceğiniz bayi bilgilerin aşağıda belirtilmiştir.
\n","_postman_id":"c8eb6815-dd7a-4ac5-bc72-7de1a2c7ecd6"},{"name":"HIPOCARD E-PIN","item":[{"name":"HIPOCARD CHECK","id":"08cc17b4-c20b-4c19-917a-53a398353fa9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"api-key","value":"","description":"Required
\n"},{"key":"api-secret","value":"","description":"Required
\n"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail
\n","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail
\n","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin
\n","type":"text"},{"key":"used_ip","value":"","description":"Required | Ip address of the player who activated the epin
\n","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/hipocard/epins","description":"EN: This endpoint allows checking the Hipocard e-PIN. If the e-pin code is valid, it will be instantly marked as consumed. The consumed e-pin amount will be added to your dealer account as withdrawable balance.
\nTR: Bu endpoint, Hipocard e-pini kontrol edilmesini sağlamaktadır. Eğer e-pin kodu geçerli ise anında tüketilmiş olarak güncellenecektir. Tüketilen e-pin tutarı çekilebilir bakiye olarak bayi hesabınıza eklenecektir.
\n","urlObject":{"protocol":"https","path":["api","v1","hipocard","epins"],"host":["www","hipopotamya","com"],"query":[],"variable":[]}},"response":[{"id":"2d3b3b9a-9bbd-4c2b-80d9-cdfacb90f143","name":"200 Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/hipocard/epins"},"status":"Successful","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successful\",\n \"data\": {\n \"total_sales\": \"100.00\",\n \"total_sales_multiplied\": 10000, // Epin price (Multiplied by 100: e.g. 34.56 => 3456)\n \"total_commission\": 7,\n \"net_total\": 93,\n \"currency\": \"TRY\"\n }\n}"},{"id":"bc713cca-3a3b-4a02-8a01-d2e0368711cd","name":"200 Dealer is not active","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/hipocard/epins"},"status":"Dealer is not active","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Dealer is not active!\",\n \"error_code\": 11\n}"},{"id":"b741eac0-cdaf-4daf-a6fb-56fde29d7b88","name":"200 E-PIN Code Used or Invalid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/hipocard/epins"},"status":"E-PIN Code Used","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"E-PIN Code has been used or is invalid!\",\n \"error_code\": 12\n}"},{"id":"44796ba0-ca42-4f9e-9988-afe523eb1263","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/hipocard/epins"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No API Key or Secret!\",\n \"error_code\": 9\n}"},{"id":"b6345989-e068-4a36-a3bf-f082ab7d5f18","name":"401 Unauthorized 2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/hipocard/epins"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"API Key or API Password is invalid!\",\n \"error_code\": 10\n}"},{"id":"5cee4789-70f1-454c-89e5-d6c6c1e8776c","name":"422 Validation Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"","description":"Required","type":"text"},{"key":"api-secret","value":"","description":"Required","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"epin_code","value":"","description":"Required | Epin code in Hipocard product order detail","type":"text"},{"key":"epin_secret","value":"","description":"Required | Epin secret in Hipocard product order detail","type":"text"},{"key":"player_name","value":"","description":"Required | Char name or username of the player who activated Epin","type":"text"},{"key":"used_ip","value":"","description":"Requeired | Ip address of the player who activated the epin","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/hipocard/epins"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Validation error.\",\n \"error_code\": 3,\n \"errors\": {\n \"player_name\": [\n \"player name field is required.\"\n ],\n \"used_ip\": [\n \"used ip field is required.\"\n ],\n \"epin_code\": [\n \"epin code field is required.\"\n ],\n \"epin_secret\": [\n \"epin secret field is required.\"\n ]\n }\n}"}],"_postman_id":"08cc17b4-c20b-4c19-917a-53a398353fa9"}],"id":"6e25ef1f-96b9-4a3a-b20f-760ac0d75d0f","_postman_id":"6e25ef1f-96b9-4a3a-b20f-760ac0d75d0f","description":""},{"name":"MERCHANT - HIPOPAY","item":[{"name":"Store","item":[{"name":"Create Store Session","id":"6906425a-c232-4319-8817-40efccc10dd6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"","description":"Required | String | Merchant dealer api key
\n","type":"text"},{"key":"user_id","value":"","description":"Required | String | Immutable ID data of your user
\n","type":"text"},{"key":"username","value":"","description":"Required | String | Username of the customer. If username is not available, Email must be sent.
\n","type":"text"},{"key":"email","value":"","description":"Required | String | Email address of the customer.
\n","type":"text"},{"key":"ip_address","value":"","description":"Required | String | The IP address the user is connected to. It should be correct.
\n","type":"text"},{"key":"hash","value":"","description":"Required | String | Calculated hash using submitted data
\n","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/merchants/store/token","description":"EN: (coming soon)
\nTR: (coming soon)
\nInformation on how to calculate the hashdata while accessing Merchant services is processed here.
\nInformation you need to calculate \"hash\" for POST requests.
API Secret Key data is the private key you will use while generating a hash. We use the HMAC-SHA256 standard while generating the hash and then convert this generated data to base64.
\nYou should bring your data side by side in the order below.
\n$user_id.$email.$username.$api_key
We use the information we combine in this way as a whole value and encrypt it with the API Secret Key private key with hmac, then convert it to base64.
\nPHP example;
\n$api_key = \"00000000HIPOMERCANT00000000\"; // Apı key\n$api_secret = \"00000000\"; // Api secret key\n$user_id = 12345; // Customer unique ID\n$email = \"customer@example.com\"; // Customer email address\n$username = \"jhon001\"; // Customer username (Otherwise, you should send an email here as well.)\n$calculateHash = base64_encode(hash_hmac('sha256',$user_id.$email.$username.$api_key,$api_secret ,true));\n\nRequired | String | Merchant dealer api key
\n"},{"key":"user_id","value":"","type":"text","description":"Required | String | Immutable ID data of your customer
\n"},{"key":"username","value":"","type":"text","description":"Required | String | Username of the customer. If username is not available, Email must be sent.
\n"},{"key":"email","value":"","type":"text","description":"Required | String | Email address of the customer.
\n"},{"key":"ip_address","value":"","type":"text","description":"Required | String | The IP address the user is connected to. It should be correct.
\n"},{"key":"hash","value":"","type":"text","description":"Required | String | Calculated hash using submitted data
\n"},{"key":"pro","value":"","type":"text","description":"Required | Boolean | If you want to list predefined products in the store, this field should be sent to false. If order-based payment will be received, true should be sent and the product[data] object should be filled.
\n"},{"key":"product[name]","value":"","type":"text","description":"Required | String | Min: 5 ~ Max: 255| Name to describe the Product / Basket.
\n"},{"key":"product[price]","value":"","type":"text","description":"Required | Integer | Min: 100 ~ Max: 5000000 | The price area is obtained by multiplying the total amount by 100. (Multiplied by 100: e.g. 34.56 => 3456)
\n"},{"key":"product[currency]","value":"","description":"Nullable | String | Enum: TRY, USD, EUR, GBP, EGP | If null or omitted, the default value is TRY.
\n","type":"text","uuid":"ceccefc2-d53d-40bf-b591-c6e89244e40a"},{"key":"product[reference_id]","value":"","type":"text","description":"Required | String Max:100 | This field must contain the order number or another reference value that identifies the transaction.
\n"},{"key":"product[commission_type]","value":"","type":"text","description":"Default 1 | Enum 1,2,3 | 1) Assume Dealer Commission. 2) Assume All Commission. 3) Reflect Commission Fully
\n"}]},"url":"https://www.hipopotamya.com/api/v1/merchants/payment/token","description":"EN: (coming soon)
\nTR: (coming soon)
\nInformation on how to calculate the hashdata while accessing Merchant services is processed here.
\nInformation you need to calculate \"hash\" for POST requests.
API Secret Key data is the private key you will use while generating a hash. We use the HMAC-SHA256 standard while generating the hash and then convert this generated data to base64.
\nYou should bring your data side by side in the order below.
\n$user_id.$email.$username.$api_key
We use the information we combine in this way as a whole value and encrypt it with the API Secret Key private key with hmac, then convert it to base64.
\nPHP example;
\n$api_key = \"00000000HIPOMERCANT00000000\"; // Apı key\n$api_secret = \"00000000\"; // Api secret key\n$user_id = 12345; // Customer unique ID\n$email = \"customer@example.com\"; // Customer email address\n$username = \"jhon001\"; // Customer username (Otherwise, you should send an email here as well.)\n$calculateHash = base64_encode(hash_hmac('sha256',$user_id.$email.$username.$api_key,$api_secret ,true));\n\nInteger | Transaction ID It is created by Hipopotamya
\n"},{"key":"reference_id","value":"","type":"text","description":"String | It is the reference id data defined in the your product data.
\n"},{"key":"token","value":"","type":"text","description":"String | Customer session token
\n"},{"key":"user_id","value":"","type":"text","description":"Integer | Your customer user ID
\n"},{"key":"name","value":"","type":"text","description":"String | Your customer account name
\n"},{"key":"email","value":"","type":"text","description":"String | Your customer account email
\n"},{"key":"status","value":"success","type":"text","description":"Payment Status. \"success\" is Successfull. (Other conditions are not notifiable.)
\n"},{"key":"payment_total","value":"","type":"text","description":"Integer | Your customer's paid amount (Multiplied by 100: e.g. 34.56 => 3456)
\n"},{"key":"net_profit","value":"","type":"text","description":"Integer | Your net profit of the order. (Multiplied by 100: e.g. 34.56 => 3456)
\n"},{"key":"product[name]","value":"","type":"text","description":"String | Your product name
\n"},{"key":"product[sku]","value":"","type":"text","description":"String | Your product sku
\n"},{"key":"product[price]","value":"","type":"text","description":"Integer | Your product price (Multiplied by 100: e.g. 34.56 => 3456)
\n"},{"key":"product[qty]","value":"","description":"Integer | Amount of items purchased
\n","type":"text"},{"key":"hash","value":"","type":"text","description":"String | It is used to validate that the notification came from the correct source.
\n"},{"key":"user[id]","value":"","type":"text","description":"Integer | Your customer user ID
\n"},{"key":"user[name]","value":"","type":"text","description":"String | Your customer account name
\n"},{"key":"user[email]","value":"","type":"text","description":"String | Your customer account email
\n"}]},"url":"https://www.yoursite.com/your_ipn_path","description":"The IPN Service provides notification flow between Hipopotamya servers and vendor servers regarding successful payments. This notification enables the seller to deliver products / services to the customer with the relevant payment data.
\nTechnical information
\nThe data is transmitted using the POST method, with content-type application/json.
The hash parameter included in the data set is used to confirm that the sent notification has by Hipopotamya servers.
The transaction_id parameter in the data set is the transaction number generated by Hipopotamya. Product / service delivery should not be made for the same transaction number for the second time.
You should reply with the message \"OK\" inside the body that you have successfully processed the data sent by the IPN service. Otherwise, the transaction will be perceived as not successfully transmitted to you. The notification will continue for the same process continuously.
Example response:
\necho \"OK\";\n\nInformation you need to calculate \"hash\" data for verifying IPN Service requests.
API Key
\nApı Secet Key
\ntransaction_id value
\nuser_id value
\nemail valu
\npayment_status value
\nusername value
\nYou should bring your data side by side in the order below.
\n$transaction_id.$user_id.$email.$username.$payment_status.$api_key
We use the information we combine in this way as a whole value and encrypt it with the API Secret Key private key with hmac, then convert it to base64.
\nPHP Example;
\n$api_key = \"00000000HIPOMERCANT00000000\"; // Apı key\n$api_secret = \"00000000\"; // Api secret key\n$transaction_id = $_POST[\"transaction_id \"];\n$user_id = $_POST[\"user_id\"];\n$email = $_POST[\"email\"];\n$payment_status = $_POST[\"status\"];\n$username = $_POST[\"name\"];\n$calculateHash = base64_encode(hash_hmac('sha256',$transaction_id.$user_id.$email.$username.$payment_status.$api_key,$api_secret ,true));\n\nEN: This endpoint is used to listing existing product categories. Each category contains a unique identification (ID) and category name.
\nTR: Bu endpoint, mevcut ürün kategorilerini listelemek için kullanılır. Her bir kategori, benzersiz bir kimlik (ID) ve kategori adı içerir.
\n","urlObject":{"protocol":"https","path":["api","v1","categories"],"host":["www","hipopotamya","com"],"query":[],"variable":[]}},"response":[{"id":"fe35867b-4b22-4878-835f-004bd226f88b","name":"200 Successful","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"HipoCard\",\n \"slug\": \"https://www.hipopotamya.com/category/hipocard\",\n \"parent_id\": null\n },\n {\n \"id\": 2,\n \"name\": \"Knight Online Cash\",\n \"slug\": \"https://www.hipopotamya.com/category/knight-online-cash\",\n \"parent_id\": 63\n },\n {\n \"id\": 3,\n \"name\": \"Riot Games\",\n \"slug\": \"https://www.hipopotamya.com/category/riot-games\",\n \"parent_id\": null\n },\n {\n \"id\": 4,\n \"name\": \"Valorant VP\",\n \"slug\": \"https://www.hipopotamya.com/category/valorant-vp\",\n \"parent_id\": 3\n },\n {\n \"id\": 5,\n \"name\": \"League of Legends LOL RP\",\n \"slug\": \"https://www.hipopotamya.com/category/league-of-legends-lol-rp\",\n \"parent_id\": 3\n }\n ],\n \"status\": true,\n \"message\": \"Successful.\"\n}"},{"id":"a6db9b93-0ef3-40a4-a8be-ddc6fe0a31ff","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/categories"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"The user's allowed IP addresses were not found\",\n \"error_code\": 2\n}"},{"id":"466d04ee-6361-4d5c-beb7-199fe138c33e","name":"404 Wholesale dealer not found.","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Wholesale dealer not found.\",\r\n \"error_code\": 16\r\n}"}],"_postman_id":"8fbf4922-fd79-42cc-a5a0-5a6f189303d4"},{"name":"List All Products","id":"64690cf9-d78c-4a57-bb54-4761c7d35bf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"EN: This endpoint lists the products that can be ordered. When creating an order, the min_order and max_order values in the list that responds to this method should be taken into account. If the max_order value is 0, it means that there is no limitation.
\nTR: Bu endpoint, sipariş verilebilecek ürünlerin listelenmesini sağlar. Sipariş oluştururken bu methoda cevap olarak gelen listedeki min_order ve max_order değerleri dikkate alınmalıdır. max_order değeri 0 geldiği taktirde herhangi bir sınırlandırma olmadığı anlamına gelir.
\n","urlObject":{"protocol":"https","path":["api","v1","products"],"host":["www","hipopotamya","com"],"query":[],"variable":[]}},"response":[{"id":"cc006f36-3141-4b35-b39b-28f9af58a8bf","name":"200 Successful","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"HipoCard 5 TL\",\r\n \"slug\": \"https://www.hipopotamya.com/product/hipocard-5-tl\",\r\n \"stock\": 1000,\r\n \"category_id\": 1,\r\n \"price\": \"5.00\",\r\n \"min_order\": 0,\r\n \"max_order\": 0,\r\n \"tax_type\": null\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"HipoCard 10 TL\",\r\n \"slug\": \"https://www.hipopotamya.com/product/hipocard-10-tl\",\r\n \"stock\": 1000,\r\n \"category_id\": 1,\r\n \"price\": \"10.00\",\r\n \"min_order\": 0,\r\n \"max_order\": 0,\r\n \"tax_type\": null\r\n },\r\n {\r\n \"id\": 3,\r\n \"name\": \"HipoCard 25 TL\",\r\n \"slug\": \"https://www.hipopotamya.com/product/hipocard-25-tl\",\r\n \"stock\": 1000,\r\n \"category_id\": 1,\r\n \"price\": \"25.00\",\r\n \"min_order\": 0,\r\n \"max_order\": 0,\r\n \"tax_type\": null\r\n },\r\n {\r\n \"id\": 4,\r\n \"name\": \"HipoCard 50 TL\",\r\n \"slug\": \"https://www.hipopotamya.com/product/hipocard-50-tl\",\r\n \"stock\": 1000,\r\n \"category_id\": 1,\r\n \"price\": \"50.00\",\r\n \"min_order\": 0,\r\n \"max_order\": 0,\r\n \"tax_type\": null\r\n }\r\n ],\r\n \"status\": true,\r\n \"message\": \"Successful.\"\r\n}"},{"id":"03d36497-0be8-4030-bddf-c14cd21d6691","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/products"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"The user's allowed IP addresses were not found\",\n \"error_code\": 2\n}"},{"id":"d7459a49-ad7c-4610-b55f-ba51a8486b3b","name":"404 Wholesale dealer not found.","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Wholesale dealer not found.\",\r\n \"error_code\": 16\r\n}"}],"_postman_id":"64690cf9-d78c-4a57-bb54-4761c7d35bf9"},{"name":"Create a Order","id":"bd4c1cd6-e76c-423e-867c-d950f1b038d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"reqired
\n","type":"text"},{"key":"quantity","value":"","description":"required|min:1|max:100
\n","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/orders","description":"EN: This endpoint allows you to create an order. In each order, you can create multiple quantities of a single product.
\nNote: The status code is 200, but if the order status is 0, you need to use the webhook structure. Please review the Webhook request.
\nTR: Bu endpoint, sipariş oluşturmanızı sağlar. Her siparişte bir üründen birden fazla adet sipariş oluşturulabilirsiniz.
\nNot: Durum kodu 200 ama sipariş durumu eğer 0 ise webhook yapısını kullanmanı gerekmektedir. Lütfen Webhook isteğini inceleyiniz.
\nEN:
\nTR:
\n","urlObject":{"protocol":"https","path":["api","v1","orders"],"host":["www","hipopotamya","com"],"query":[],"variable":[]}},"response":[{"id":"6f130a74-062c-4673-b9c7-32c32fb43006","name":"200 Successful","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"E-pin order placed successfully.\",\r\n \"data\": {\r\n \"order_id\": 1234,\r\n \"order_status\": 2,\r\n \"currency\": \"TRY\",\r\n \"total_amount\": \"200.00\",\r\n \"total_tax\": \"0.00\",\r\n \"unit_price\": \"100.00\",\r\n \"subtotal\": \"200.00\",\r\n \"product_id\": 304,\r\n \"product_name\": \"HipopoTamya 100 TL Hediye Kartı\",\r\n \"quantity\": 2,\r\n \"items\": [\r\n {\r\n \"code\": \"HIPO-100-OJMP-060S-B5O2-1070\",\r\n \"price\": \"100.00\",\r\n \"expiration_date\": null\r\n },\r\n {\r\n \"code\": \"HIPO-100-0V4B-2IBP-P0Q4-ASUA\",\r\n \"price\": \"100.00\",\r\n \"expiration_date\": null\r\n }\r\n ],\r\n \"ip\": \"127.0.0.1\"\r\n }\r\n}"},{"id":"ce3579a6-7853-4a6d-90b3-e5dfaa3084d9","name":"200 Insufficient balance","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"product_id","value":"","description":"reqired","type":"text"},{"key":"quantity","value":"","description":"required|min:1|max:100","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Insufficient balance.\",\n \"error_code\": 6\n}"},{"id":"c45c99c9-09b8-4660-ba27-d614ac75a3b7","name":"200 The product is out of stock.","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"product_id","value":"","description":"reqired","type":"text"},{"key":"quantity","value":"","description":"required|min:1|max:100","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"The product is out of stock.\",\n \"error_code\": 5\n}"},{"id":"904ef8e9-26f3-4be9-8359-29bacd777815","name":"200 An error occurred in the order.","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"product_id","value":"","description":"reqired","type":"text"},{"key":"quantity","value":"","description":"required|min:1|max:100","type":"text"}]},"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"An error occurred in the order.\",\n \"error_code\": 7\n}"},{"id":"fbd54793-ed53-4874-8760-520d2e93bfd5","name":"404 Product not found.","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Product not found.\",\r\n \"error_code\": 4\r\n}"},{"id":"85041605-8fd9-46f1-9d2f-339a47bd970d","name":"404 Wholesale dealer not found.","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Wholesale dealer not found.\",\r\n \"error_code\": 16\r\n}"},{"id":"70a09195-aeb4-4b56-a1e6-2c3d2e32cffe","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"The user's allowed IP addresses were not found\",\r\n \"error_code\": 2\r\n}"},{"id":"0fe256cd-de82-491f-a216-9d2832ff223e","name":"422 Validation Error","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders"},"code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Validation error\",\r\n \"error_code\": 3,\r\n \"errors\": {\r\n \"product_id\": [\r\n \"product id alanı gereklidir.\"\r\n ],\r\n \"quantity\": [\r\n \"quantity alanı gereklidir.\"\r\n ]\r\n }\r\n}"}],"_postman_id":"bd4c1cd6-e76c-423e-867c-d950f1b038d4"},{"name":"Get a Order Detail","id":"7d4303f1-78d9-426c-a9c5-f38c0f764aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"EN: This endpoint is used to view the detail of your current order. It includes the order amount and delivered e-pin codes.
\nTR: Bu endpoint, mevcut siparişinizin detayını görüntülemek için kullanılır. Sipariş tutarı ve teslim edilen e-pin kodlarını içerir.
\nEN:
\nTR:
\n","urlObject":{"protocol":"https","path":["api","v1","orders","{{order_id}}"],"host":["www","hipopotamya","com"],"query":[],"variable":[]}},"response":[{"id":"28d50ac4-182a-427d-b0b5-57baa21267c4","name":"200 Successful","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders/{{order_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Successful.\",\r\n \"data\": {\r\n \"order_id\": 1234,\r\n \"order_status\": \"received\",\r\n \"currency\": \"TRY\",\r\n \"total_amount\": \"200.00\",\r\n \"total_tax\": \"0.00\",\r\n \"unit_price\": \"100.00\",\r\n \"subtotal\": \"200.00\",\r\n \"product_id\": null,\r\n \"product_name\": \"HipopoTamya 100 TL Hediye Kartı\",\r\n \"quantity\": 2,\r\n \"items\": [\r\n {\r\n \"code\": \"HIPO-100-OJMP-060S-B5O2-1070\",\r\n \"price\": \"100.00\",\r\n \"expiration_date\": null\r\n },\r\n {\r\n \"code\": \"HIPO-100-0V4B-2IBP-P0Q4-ASUA\",\r\n \"price\": \"100.00\",\r\n \"expiration_date\": null\r\n }\r\n ],\r\n \"ip\": \"127.0.0.1\"\r\n }\r\n}"},{"id":"5e0b7980-20ec-437c-9b51-edfa9b8bdd3a","name":"200 Order not found, check order number.","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders/{{order_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Order not found, check order number.\",\r\n \"error_code\": 8\r\n}"},{"id":"6a7c7911-8db2-40fa-b0b0-f8ef151c7a5e","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/orders/{{order_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"The user's allowed IP addresses were not found\",\r\n \"error_code\": 2\r\n}"}],"_postman_id":"7d4303f1-78d9-426c-a9c5-f38c0f764aee"},{"name":"Webhook Request Example","id":"4a07fc08-0b27-4d2b-8750-b102e1faac59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Hipo-Hash","value":"hash","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"order_id","value":"","description":"Integer | Order Number
\n","type":"text","uuid":"0de41306-d587-4770-ae4b-2368c6e299b7"},{"key":"order_status","value":"","description":"Integer | 0: Pending 1: Delivered 2: Received 3: Success 4: Cancelled 5: Failed
\n","type":"text","uuid":"a916a81b-6cdc-4373-ab4b-5b99a6f2ef6b"},{"key":"items[code]","value":"","description":"String | E-Pin Code
\n","type":"text","uuid":"a28cda7b-d72e-415a-8cfb-91f0acdc4a63"},{"key":"items[sale_price]","value":"","description":"Float | Sale Price
\n","type":"text","uuid":"6c10cbf2-8af1-4582-8983-64d305a1213b"},{"key":"items[expiration_date]","value":"","description":"Nullable | Expiration Date
\n","type":"text","uuid":"f5627d38-cfb1-4a5c-af03-b064f40c565c"}]},"url":"https://www.yoursite.com/your_webhook_url","description":"Webhook requests are requests made to deliver epins to you.
\nInformation you need to calculate \"hash\" data for verifying Webhook requests.
\nAPI Key
\nOrder ID
\nPHP Example;
\n$api_key = \"apikey\"; // Apı key\n$order_id = \"00000000\"; // Order ID\n$calculateHash = hash_hmac('sha256', $order_id, $api_key);\n\nYou can create a hash as shown above.
\nYou need to compare this hash value with the one we sent. Therefore, you need to retrieve the “Hipo-Hash” value from the Headers data received with the webhook request. Then, you need to verify that it matches the hash you created.
\nPHP Example;
\n$generatedHash = \"hash\";\n$headersHash = \"hash\";\nif($generatedHash === $headersHash) {\n// success\n} else {\n// fail\n}\n\nEN:
\nTR:
\n","urlObject":{"protocol":"https","path":["your_webhook_url"],"host":["www","yoursite","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a07fc08-0b27-4d2b-8750-b102e1faac59"}],"id":"a76cb1ed-846a-4b7b-b29f-df24cabdf45d","_postman_id":"a76cb1ed-846a-4b7b-b29f-df24cabdf45d","description":""},{"name":"Membership / Üyelik","item":[{"name":"Get Balances","id":"f8c06b26-356c-41ee-a47c-5b7de911468c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"EN: This API is designed to provide information about the balance associated with your user account.
\nTR: Bu API, kullanıcı hesabınızla ilişkili bakiye hakkında bilgi sağlamak için tasarlanmıştır.
\n","urlObject":{"protocol":"https","path":["api","v1","user","balance"],"host":["www","hipopotamya","com"],"query":[],"variable":[]}},"response":[{"id":"1ab5bdb2-a441-45a0-9f99-13549cc39b49","name":"200 Successful","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/user/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successful.\",\n \"data\": {\n \"balance\": \"123.56\",\n \"spend\": \"123456.78\",\n \"withdrawable\": \"0.00\",\n \"awaiting\": \"0.00\",\n \"credit\": \"0.00\",\n \"bonus\": \"0.00\",\n \"currency\": \"TRY\"\n }\n}"},{"id":"a4f29ac8-e93f-4cd6-b39f-ff43761546df","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://www.hipopotamya.com/api/v1/user/balance"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"The user's allowed IP addresses were not found\",\r\n \"error_code\": 2\r\n}"}],"_postman_id":"f8c06b26-356c-41ee-a47c-5b7de911468c"}],"id":"53900dc7-c87c-4987-bba1-e59c71548e64","_postman_id":"53900dc7-c87c-4987-bba1-e59c71548e64","description":""}],"event":[{"listen":"prerequest","script":{"id":"ffe861e8-618d-45fd-b49f-310238a4c57a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"559cff38-e65f-4658-8104-0391b2903ccd","type":"text/javascript","exec":[""]}}],"variable":[{"key":"token","value":"Berer Token","type":"string"}]}