API's documentation of methods for integration with other platforms.
\nFor pricing, access token api and additional information please contact:
\nemail: admin@hubchain.com
\nphone/whatsapp: +55 (11) 97797-8000
\n{ \n \"status\": \"ok\",\n \"data\": { \n \"service-task\": { \n \"count\": 100, \n \"rows\": [ ]\n } \n } \n}\n\n{\n \"status\": \"error\",\n \"reason\": \"id_is_not_valid\",\n \"message\": \"The id value is not valid.\"\n}\n\nFor all the requests it is needed to provide an Access Token in the headers request header of request. Check the following instructions to learn how to create credentials and the Access Token.
\nTo create the Access Token is imperative that you have in hand a client_id and client_secret.
With the client_id and client_secret in hand you can make a request to our endpoint of permission, as detailed bellow:
To be authenticated with us you must send your Credentials on the header Authorization, following the pattern of HTTP Basic Authentication.
\nCreate a string connecting: client_id and the client_secret, using the symbol 2 points between them:
`${**client_id**}`:`${**client_secret****}`
Code a string with base64
Result: ZXlKcFpDSTZJamc0TlRFd1ltSTRMV001TmpFdE1URmxaQzA1TXpnM0xUUXlNREV3WVRrMk1EQXdOeUlzSW01aGJXVWlPaUpGWkdsc2MyOXVJbjA9PTo4M013NXU4OTg4UQ==
Send this string at header, alongside the prefix \"Authorization: Basic\" .
\nThe endpoint retrieves ticker information from the server.
\nThe response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"symbol\": {\n \"type\": \"string\"\n },\n \"updatedAt\": {\n \"type\": \"integer\"\n },\n \"price\": {\n \"type\": \"string\"\n },\n \"buy\": {\n \"type\": \"string\"\n },\n \"sell\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n },\n \"lastVariation\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n\n\n\n¹ max length
\nmetadatajson: 400 bytes
Is Invoice Paid ?POST https://mycompany.com/payments/webhook?order_id=ORDER-00001\nHost: mycompany.com\nContent-Type: application/json\n{\n \"data\": {\n \"invoice\": {\n \"status\": \"paid\",\n \"id\": \"460b5e82-83c0-45f8-a8e3-6b3a5d261651\"\n }\n }\n}\nHeader: X-WEBHOOK-SIGNATURE
\nHeader: X-WEBHOOK-NONCE
\n<?php\n/* Verify Signature */\n$body_json = json_encode(json_decode(file_get_contents('php://input'),true), JSON_UNESCAPED_UNICODE);\n$method = \"POST\";\n$url = \"https://mycompany.com/payments/webhook?order_id=ORDER-00001\";\n$webhook_signature = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'];\n$nonce = $_SERVER['HTTP_X_WEBHOOK_NONCE'];\n$payload = $nonce . '+' . $method. '+' . $url . '+' . $body_json;\n$x_api_key = 'YOUR-X-API-KEY';\n$signature = hash_hmac('sha512', $payload, $x_api_key);\n \nif(strcmp($signature,$webhook_signature)==0) {\n print(\"Webhook Signature is verified\".PHP_EOL);\n} else {\n print(\"Webhook Signature is NOT verified\".PHP_EOL);\n return;\n} \nList All Invoices Info
\nitems per page
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"index page starting by 1 to first page
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"results order by ({\"created_at\": \"DESC\"} or ={\"created_at\": \"DESC\"})
\n","type":"text/plain"},"key":"order_by","value":"{\"created_at\": \"DESC\"}"}],"variable":[]}},"response":[{"id":"41722002-4121-41ab-833a-628751121d54","name":"List All","originalRequest":{"method":"GET","header":[{"key":"x-jwt-token","value":"eyJhbGciOiJIU....lzQWRta","type":"text"}],"url":{"raw":"https://api.olefoot.io/v3/payments/invoices?limit=5&page=1&order_by={\"created_at\": \"DESC\"}","host":["https://api.olefoot.io"],"path":["v3","payments","invoices"],"query":[{"key":"limit","value":"5","description":"items per page"},{"key":"page","value":"1","description":"index page starting by 1 to first page"},{"key":"order_by","value":"{\"created_at\": \"DESC\"}","description":"results order by ( {\"created_at\": \"DESC\"} or {\"created_at\": \"DESC\"} )"}]}},"status":"HTTP/200 OK","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"ok\",\r\n \"data\": {\r\n \"count\": 34,\r\n \"page\": 1,\r\n \"limit\": 5,\r\n \"invoices\": [\r\n {\r\n \"status\": \"pending\",\r\n \"id\": \"7b7ca460-7930-459f-882e-8dc615864579\",\r\n \"created_at\": \"2021-08-09T21:57:54.112Z\",\r\n \"updated_at\": \"2021-08-09T21:57:54.112Z\",\r\n \"amount\": 1000.17,\r\n \"currency\": \"USD\",\r\n \"metadata\": {\r\n \"customer_id\": \"123465\",\r\n \"customer_name\": \"John Doe\",\r\n \"customer_email\": \"john.doe@gmail.com\"\r\n },\r\n \"external_unique_id\": \"ORDER-00001\",\r\n \"payment_url\": \"https://--URL-HERE--/invoice/7b7ca460-7930-459f-882e-8dc615864579\",\r\n \"webhook_url\": \"https://mycompany.com/payments/webhook?order_id=ORDER-00001\"\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"id\": \"39cb8db6-de2a-4f95-a23d-b3e601ccda56\",\r\n \"created_at\": \"2021-08-09T21:57:54.112Z\",\r\n \"updated_at\": \"2021-08-09T21:57:54.112Z\",\r\n \"amount\": 1000.17,\r\n \"currency\": \"USD\",\r\n \"metadata\": {\r\n \"customer_id\": \"123465\",\r\n \"customer_name\": \"John Doe\",\r\n \"customer_email\": \"john.doe@gmail.com\"\r\n },\r\n \"external_unique_id\": \"ORDER-00001\",\r\n \"payment_url\": \"https://--URL-HERE--/invoice/39cb8db6-de2a-4f95-a23d-b3e601ccda56\",\r\n \"webhook_url\": \"https://mycompany.com/payments/webhook?order_id=ORDER-00002\"\r\n },\r\n {\r\n \"status\": \"pending\",\r\n \"id\": \"ab5f439c-93f3-4f19-9930-f600e9959a49\",\r\n \"created_at\": \"2021-08-09T21:57:54.112Z\",\r\n \"updated_at\": \"2021-08-09T21:57:54.112Z\",\r\n \"amount\": 1000.17,\r\n \"currency\": \"USD\",\r\n \"metadata\": {\r\n \"customer_id\": \"123465\",\r\n \"customer_name\": \"John Doe\",\r\n \"customer_email\": \"john.doe@gmail.com\"\r\n },\r\n \"external_unique_id\": \"ORDER-00001\",\r\n \"payment_url\": \"https://--URL-HERE--/invoice/ab5f439c-93f3-4f19-9930-f600e9959a49\",\r\n \"webhook_url\": \"https://mycompany.com/payments/webhook?order_id=ORDER-00003\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"493e5194-6164-4838-8533-7dd81cb0287b"},{"name":"Delete By Invoice Id","id":"4d863c58-7a23-409a-a42f-346ecf14d474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-jwt-token","value":"eyJhbGciOiJIU....lzQWRta","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.olefoot.io/v3/payments/invoice/:invoice_id","description":"Delete Invoice
\n