API to use Blox Payments API
\nComponents to the integration to the Bloxcross API
\nREST API for Requests
\nSocket API for Streaming Data & Alerts
\nREST API
\n• For requests which require an immediate response
• Synchronous Execution
• Success or Failure response with Data
Socket API:
\nUsed to subscribe to streaming Data
\nEvents are pushed to the Client socket
\nTwo base channels: market data & alerts
\nClient Journey
\nClients can Register with only basic information:
\nFname, lname, email, phone, pwd, domicile, language
\nAccount is created but PENDING_VERIFICATION
Main Portfolio is created but in HOLD state
Client must pass the following checks to be enables to do
any monetary transactions – deposit/withdraw/buy/sell:
ID Verification
\nVerify Phone
\nVerify Email
\nHave their ID Verified, validated & do a liveness teat to make sure it is a human
Pass KYC /AML
Rest API Considerations
\nRequest Data in JSON Format
\nReply Data in JSON Format
\nAll data via HTTPS
\nGET requests to return Data
\nPOST if any data needs to be sent to backend
\nA client can have multiple sessions open at the same time
\nIf a client has more than one session open, then all sessions will receive notifications (socket)
\nSocket Interface
\n• Use the same token generated by login to connect
• Session are verified to be valid
• Sessions are verified for token expiration or blocked clients
• Session are subscription based
• Two separate Channels: Market-data & Alerts
• Market-Data is high volume low latency perishable data with no guaranteed delivery
• Alerts channel is ordered (FIFO) guaranteed delivery to all active sessions
• Market Data channel data pushes based on subscription commands
• Alerts channel is single session created by default, but all sessions get the data
URLS
\nDevelopment URL is: https://api.bloxcross-dev.com
\nWebsocket Alerts Endpoint: wss://api.bloxcross-dev.com/subscribe
\nWebsocket market Data Endpoint: wss://api.bloxcross-dev.com/tickerplant
\nThe alerts arrive via push over the Alerts websocket connection. All messages have the same structure:
\nA header with information about the Message
\nThe Data for the message
\nHere is a Alert example in Java:
\n{\n \"header\": {\n \"msg_type\": \"ORDER_NEW\",\n \"level\": \"ALERT\",\n \"notes\": \"\"\n },\n \"data\": {\n \"oid\": \"eb94cd38-ad12-417d-befe-2a62c3f2bfda\",\n \"reserve_id\": 33370227094893060,\n \"user_oid\": \"880062851073121\",\n \"client_id\": \"3619f00d-32d4-4983-92f8-ebfd3a68898b\",\n \"symbol\": \"ETH-USD\",\n \"side\": \"SELL\",\n \"amount\": 1,\n \"quantity\": 0,\n \"order_state\": \"NEW\",\n \"order_action\": \"NEW\",\n \"type\": \"MARKET_BY_AMOUNT\",\n \"price\": 0,\n \"time_in_force\": null,\n \"valid_until\": null,\n \"stop_type\": null,\n \"data\": null,\n \"created_on\": \"2023-07-21T20:14:16.046382948\",\n \"portfolio_id\": \"5e85cab3-2745-43cb-9358-1fd2e81acd8c\",\n \"executed_quantity\": 0,\n \"fee_rate\": 100,\n \"spread\": 100,\n \"fee\": null,\n \"held_qty\": 0.0005,\n \"reserve_currency\": \"ETH\"\n }\n}\n\nThe header contains two key pieces of data:
\nmsg_type: the type of message
\nlevel: the importance of the message
\nmsg_type can be one of:
\nORDER_NEW,\nORDER_CANCEL,\nORDER_REJECTED,\nORDER_UPDATE,\nORDER_ERROR,\nEXECUTION,\nTRACKING_EXECUTION,\nDEPOSIT_INITIATED,\nDEPOSIT,\nDEPOSIT_REVERSED,\nWITHDRAW_INITIATED,\nWITHDRAW,\nWITHDRAW_REVERSED,\nINFO,\nROBBIE,\nKYC,\nAML,\nDISPLAY_TO_USER\n\nlevel can be one of:
\nINFO,\nWARN,\nALERT\n\nHere is an example in Java to connect to Alerts Websocket:
\nimport org.java_websocket.client.WebSocketClient;\nimport org.java_websocket.drafts.Draft;\nimport org.java_websocket.handshake.ServerHandshake;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\nimport java.io.IOException;\nimport java.net.URI;\nimport java.net.URISyntaxException;\nimport java.security.KeyManagementException;\nimport java.security.NoSuchAlgorithmException;\nimport java.util.Map;\nimport java.util.concurrent.Executors;\nimport java.util.concurrent.ScheduledExecutorService;\nimport static java.lang.System.exit;\npublic class TestClient\n extends WebSocketClient {\n private static Logger log = LoggerFactory.getLogger(TestClient.class);\n private final ScheduledExecutorService executorService = Executors.newScheduledThreadPool(1);\n public TestClient(\n URI serverUri,\n Draft draft\n ) {\n super(\n serverUri,\n draft\n );\n }\n public TestClient(URI serverURI) {\n super(serverURI);\n }\n public TestClient(\n URI serverUri,\n Map httpHeaders\n ) {\n super(\n serverUri,\n httpHeaders\n );\n }\n public static void main(String[] args)\n throws\n URISyntaxException,\n IOException,\n NoSuchAlgorithmException,\n KeyManagementException,\n InterruptedException {\n String host = \"api.bloxcross-dev.com\";;\n log.info(\">>> Connecting to: [wss://\" + host + \"/subscribe]\");\n TestClient c = new TestClient(new URI(\n \"wss://\" + host + \"/subscribe\"));\n c.connect();\n c.setConnectionLostTimeout(30);\n Thread.sleep(5000);\n c.send(\"{\\\"token\\\": \\\"yJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJtepdlSdXN0NjhAZ21haWwuY29tIiwibGFzdF9sb2dpbiI6IntcInRpbWVcIjpcIjIwMjMtMDctMjFUMTM6MDc6NTQuMjY4MDI4XCIsXCJjaXR5XCI6XCJTYW4gTWFyY29zXCIsXCJyZWdpb25cIjpcIkNhbGlmb3JuaWFcIixcImNvdW50cnlcIjpcIlVuaXRlZCBTdGF0ZXNcIixcImxvY2FsZVwiOlwiQW1lcmljYS9Mb3NfQW5nZWxlc1wifSIsInJvbGVzIjpbXSwiaXNzIjoic2VjdXJpdHkiLCJzZXNzaW9uX2lkIjoiMDIyY2Q4ODUtYjA5MS00YWFhLWI4ZDgtMTkxZmE2NTM3ZjA4IiwiY2xpZW50X2lkIjoiMzYxOWYwMGQtMzJkNC00OTgzLTkyZjgtZWJmZDNhNjg4OThiIiwicmVxdWlyZWRfMmZhXzJwcm9jZWVkIjoiU01TIiwibmJmIjoxNjg5OTcwMDc0LCJkb21pY2lsZSI6IkNPIiwiY3VycmVuY3kiOiJNWE4iLCJhdXRoX2Nob2ljZSI6ImF1dGhfZGVjbGluZWQiLCJleHAiOjE2OTUxNTQwNzQsImxhbmciOiJwb3IiLCJpYXQiOjE2ODk5NzAwNzQsImVtYWlsIjoibXhfdGVzdDY4QGdtYWlsLmNvbSJ9.h4_7MLtNiiymQnANJf6RhReoFdj_HmZl3vW9gAc2SA\\\"}\");\n }\n @Override\n public void onOpen(ServerHandshake handshakedata) {\n log.info(\"opened connection: \" + handshakedata.getHttpStatusMessage());\n }\n @Override\n public void onMessage(String message) {\n log.info(\"received: \" + message);\n }\n @Override\n public void onClose(\n int code,\n String reason,\n boolean remote\n ) {\n // The close codes are documented in class org.java_websocket.framing.CloseFrame\n log.info(\n \"Connection closed by \" + (remote ? \"remote peer\" : \"us\") + \" Code: \" + code + \" Reason: \"\n + reason);\n exit(-1);\n }\n @Override\n public void onError(Exception ex) {\n ex.printStackTrace();\n // if the error is fatal then onClose will be called additionally\n System.err.println(\"Error: \" + ex.getMessage());\n }\n}\n\nThe Market Data Ticker Plant publishes real time market data via Websocket Push. Once you connect to the Ticker Plant, you must send a subscription request for subscribing tp market data as follows:
\n{\n \"type\": \"subscribe\",\n \"channels\": [\n {\n \"name\": \"inside_market\",\n \"product_ids\": [\n \"BTC-USD\"\n ]\n }\n ]\n}\n\nHere is an example for connecting to Market Data Websocket in Java:
\nimport org.java_websocket.client.WebSocketClient;\nimport org.java_websocket.drafts.Draft;\nimport org.java_websocket.handshake.ServerHandshake;\nimport java.net.URI;\nimport java.net.URISyntaxException;\nimport java.nio.ByteBuffer;\npublic class TestClient\n extends WebSocketClient {\n public TestClient(\n URI serverUri,\n Draft draft\n ) {\n super(\n serverUri,\n draft\n );\n }\n public TestClient(URI serverURI) {\n super(serverURI);\n }\n public static void main(String[] args)\n throws\n URISyntaxException,\n InterruptedException {\n System.out.println(\"...Starting Client\");\n WebSocketClient client = new TestClient(new URI(\"wss://api.bloxcross-dev.com/tickerplant\"));\n client.connect();\n client.setConnectionLostTimeout(30);\n Thread.sleep(5000);\n client.send(\" {\\\"type\\\": \\\"subscribe\\\",\\\"channels\\\": [{\\\"name\\\": \\\"inside_market\\\",\\\"product_ids\\\": \"\n + \"[\\\"BTC-USD\\\"]}]}\");\n }\n @Override\n public void onOpen(ServerHandshake handshakedata) {\n System.out.println(\"new connection opened\");\n }\n @Override\n public void onClose(\n int code,\n String reason,\n boolean remote\n ) {\n System.out.println(\"closed with exit code \" + code + \" additional info: \" + reason);\n }\n @Override\n public void onMessage(String message) {\n System.out.println(\"received message: \" + message);\n }\n @Override\n public void onMessage(ByteBuffer message) {\n System.out.println(\"received ByteBuffer\");\n }\n @Override\n public void onError(Exception ex) {\n System.err.println(\"an error occurred:\" + ex);\n }\n}\n\nThis endpoint is used to register a user and respond with a welcome message. When a POST request is made to {{apiurl}}/register/hello, the server processes the request and returns a confirmation message indicating successful registration.
Upon a successful request, the API will return a status code of 200 along with a JSON response containing a friendly welcome message. This indicates that the user has been successfully registered and is now part of the system.
\n{\n \"message\": \"Hello There, Welcome to Blox! You have reached the right place... API Away!\"\n}\n\nThis endpoint is a sanity check that you are connecting to our API Server
\n","urlObject":{"path":["register","hello"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b139f10-8c75-488b-92c7-45fa8bd42350"},{"name":"2. Register Account Owner","id":"3c1925a1-b2a3-46ec-a24c-87709bfaa421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"KR1IeAL2DwGLyXcCwjMV4cclghlg2ltJHcxOdSAxJhGMZWFdUpJosldXxrOqZoTF"}],"body":{"mode":"raw","raw":"{\n \"fname\":\"Diego\",\n \"lname\":\"Test2\",\n \"email\":\"baezd@yahoo.com\",\n \"phone\":\"+12122561693\",\n \"password\":\"My$tandard15\",\n \"domicile\":\"CO\",\n \"language\":\"eng\",\n \"preferred_currency\": \"USD\",\n \"ref_code\": \"123456\",\n \"person_type\": \"business\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/v2/simple","description":"The user registration does not require Authorization and is used for all interactions with the system.
\nIMPORTANT: For verification purposes prior to Depositing/Paying/Withdrawing the user must perfomr KYC/AML which is confidectial. For the KYC/AML process to succeed, the First Name (fname) and Last Name (lname) must macth excatly the ID which will be presented during the validatin process.
\nThe Parameters are:
\nIMPORTANT: Password must have the folliwng complexity:
\nIMPORTANT: No two users can have the same email o phone number
\nOnce the User is created successfully the following Message will be returned:
\n{ \n\"success\": true, \n\"code\": 0, \n\"payload\": \"Success Registering baezd1@yahoo.com\"\n}\n\nOtherwise an Error code will be returned.
\n","urlObject":{"path":["register","v2","simple"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"bd1d230f-dffb-49d4-9b94-e29b46d59658","name":"Register","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fname\":\"Company\",\n \"lname\":\"Admin\",\n \"email\":\"me@yahoo.com\",\n \"phone\":\"+15653726254\",\n \"password\":\"My$tandard15\",\n \"domicile\":\"CO\",\n \"language\":\"eng\",\n \"person_type\": \"businness\",\n \"preferred_currency\": \"USD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/v2/simple"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Jun 2023 11:19:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"70"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 0,\n \"payload\": \"Success Registering me@yahoo.com\"\n}"},{"id":"4536fcac-e964-4d87-bed7-38a3aaab6fc0","name":"Register","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fname\":\"Company\",\n \"lname\":\"Admin\",\n \"email\":\"me@yahoo.com\",\n \"phone\":\"+15653726254\",\n \"password\":\"My$tandard15\",\n \"domicile\":\"CO\",\n \"language\":\"eng\",\n \"person_type\": \"businness\",\n \"preferred_currency\": \"USD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/v2/simple"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Jun 2023 11:19:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Unable to create Account"}],"_postman_id":"3c1925a1-b2a3-46ec-a24c-87709bfaa421"},{"name":"3. Login","event":[{"listen":"test","script":{"id":"ebf7f8c5-29f2-4b8a-8e5c-7ba58161db75","exec":["var res = JSON.parse(responseBody);","pm.environment.set('token', res.access_token);","pm.environment.set('bearer token', res.access_token);"],"type":"text/javascript","packages":{}}}],"id":"0eb8d5bd-73f1-4bea-b97f-8ea3f5897267","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"baezd@yahoo.com\",\r\n \"password\": \"My$tandard15\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/login","description":"This is used to login to the system. The login process is composed of three steps:
\nA good way to check if the user has been fully validated, is ti call Get Client Config and should return
\n\n\n\"required_2fa_2proceed\": \"NONE\",
\n
If it is not fully verified, then this Message will appear:
\n{\n \"state\": \"pending_2fa_verification\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"SMS\"\n}\n\nThis endpoint is used to confirm a user's phone number during the registration process. It ensures that the phone number provided by the user is valid and can be used for further communication.
\nMethod: POST
\nURL: {{apiurl}}/register/confirmPhone
Content-Type: application/x-www-form-urlencoded
The request body must include the following parameters:
\nphone: (string) The phone number that needs to be confirmed.
code: (string) The confirmation code sent to the user's phone number.
Upon successful confirmation, the response will include:
\nsuccess: (boolean) Indicates whether the phone number confirmation was successful.
message: (string) A message providing additional information about the confirmation process.
data: (object) An object containing any relevant data related to the confirmation, which may include user details or confirmation status.
In case of an error, the response will provide an error message detailing the issue encountered during the confirmation process.
\n","urlObject":{"path":["register","confirmPhone"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5e57416-edd0-4b85-87c8-ac665ba83bc3"},{"name":"5. Generate 2FA QR with SMS Code Copy","id":"8e3fc633-c19a-47ca-8cc3-fdc9b5a62a12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": 80603145\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/gen_2fa_qrcode_with_smscode","description":"This endpoint allows users to generate a Two-Factor Authentication (2FA) QR code using a provided SMS code. It is typically used during the setup of 2FA to enhance account security.
\nPOST
The request body must be in JSON format and should include the following parameter:
\nExample Request:
\n{\n \"code\": 92126252\n}\n\nUpon a successful request, the server responds with a status code of 200 and a JSON object containing the following fields:
qrcode (string): The generated QR code as a string. This will be empty if the generation fails.
\nkey (string): A unique key associated with the generated QR code. This will also be empty if the generation fails.
\nnotes (string): Additional notes or information related to the QR code generation. This will be empty if there are no additional notes.
\nExample Response:
\n{\n \"qrcode\": \"\",\n \"key\": \"\",\n \"notes\": \"\"\n}\n\nEnsure that the SMS code is valid before making the request, as an invalid code may result in an unsuccessful QR code generation.
\nYou can Convert the base64 QR Code using https://base64.guru/converter/decode/image
\n","urlObject":{"path":["register","gen_2fa_qrcode_with_smscode"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e3fc633-c19a-47ca-8cc3-fdc9b5a62a12"},{"name":"6. Logout Now","id":"cb02aeab-67cb-4554-9df4-02968d96d5a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{apiurl}}/logout","description":"This endpoint is used to log out a user from the application. When a user successfully logs out, their session is terminated, and they will no longer have access to protected resources until they log in again.
\nMethod: POST
Endpoint: {{apiurl}}/logout
The request body must be sent in application/x-www-form-urlencoded format and should include the following parameter:
userId (string): The unique identifier of the user who is logging out.Upon a successful logout, the response will contain the following:
\nstatus (string): Indicates the success or failure of the logout operation.
\nmessage (string): A descriptive message providing additional details about the logout process.
\n{\n \"status\": \"success\",\n \"message\": \"User logged out successfully.\"\n}\n\nEnsure that the request is made with valid user credentials to successfully log out.
\n","urlObject":{"path":["logout"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb02aeab-67cb-4554-9df4-02968d96d5a5"},{"name":"7. Login Again","event":[{"listen":"test","script":{"id":"ebf7f8c5-29f2-4b8a-8e5c-7ba58161db75","exec":["var res = JSON.parse(responseBody);","pm.environment.set('token', res.access_token);","pm.environment.set('bearer token', res.access_token);"],"type":"text/javascript","packages":{}}}],"id":"904292f7-f116-4bee-8d91-0a8edb4d2afc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"baezd@yahoo.com\",\r\n \"password\": \"My$tandard15\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/login","description":"This is used to login to the system. The login process is composed of three steps:
\nA good way to check if the user has been fully validated, is ti call Get Client Config and should return
\n\n\n\"required_2fa_2proceed\": \"NONE\",
\n
If it is not fully verified, then this Message will appear:
\n{\n \"state\": \"pending_2fa_verification\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"SMS\"\n}\n\nUsed to retrive User status nad information.
\nIf user is not loged in it will retturn:
\n{\n \"success\": false,\n \"code\": 1000074,\n \"payload\": \"Client Session Not Found\"\n}\n\nIf user is not fully verified via 2FA it will reply:
\n{\n \"state\": \"pending_2fa_verification\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"SMS\"\n}\n\nIf the user is validated it will retrieve the basic User infoormation.
\n{\n \"key\": \"e7050120-c535-4bd6-9fcc-7366f8239a82|c26ad25c-b6bc-496c-9f9e-904b01b06806\",\n \"active_session\": true,\n \"blacklisted\": false,\n \"email\": \"me@yahoo.com\",\n \"client_id\": \"e7050120-c535-4bd6-9fcc-7366f8239a82\",\n \"client_status\": \"PENDING_VERIFICATION\",\n \"language\": \"eng\",\n \"currency\": \"USD\",\n \"client_level\": \"NOVICE\",\n \"id_verified\": false,\n \"kyc_completed\": false,\n \"phone_validated\": true,\n \"email_validated\": false,\n \"fname\": \"company\",\n \"lname\": \"admin\",\n \"vouched_public_key\": \".Y1.~@59utQV#xf4LRsa~PEJaBz1wP\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"NONE\",\n \"phone\": \"+15653726254\",\n \"fees\": \"{\\\"BUY\\\": 100, \\\"HOLD\\\": 0, \\\"SELL\\\": 100, \\\"DEPOSIT\\\": 0, \\\"RELEASE\\\": 0, \\\"WITHDRAW\\\": 0, \\\"CREDIT_ADJUSTMENT\\\": 0, \\\"CONVERSION_DEPOSIT\\\": 0, \\\"CONVERSION_WITHDRAW\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_DEPOSIT\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_WITHDRAW\\\": 0}\",\n \"domicile\": \"CO\",\n \"fullName\": \"company admin\",\n \"clientVerified\": false\n}\n\nFields:
\nThis endpoint is used to validate a two-factor authentication (2FA) code provided by the user during the registration process. It ensures that the user has access to the second factor of authentication before proceeding with account creation or other sensitive actions.
\n{\n \"code\": \"208022\"\n}\n\nUpon successful validation of the 2FA code, the server will respond with a confirmation indicating that the code is valid. In case of an invalid code, an error message will be returned, specifying the nature of the error.
\nEnsure that the 2FA code is entered correctly and is not expired.
\nThis endpoint is crucial for enhancing the security of user accounts by requiring a second form of verification.
\nUsed to retrive User status nad information.
\nIf user is not loged in it will retturn:
\n{\n \"success\": false,\n \"code\": 1000074,\n \"payload\": \"Client Session Not Found\"\n}\n\nIf user is not fully verified via 2FA it will reply:
\n{\n \"state\": \"pending_2fa_verification\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"SMS\"\n}\n\nIf the user is validated it will retrieve the basic User infoormation.
\n{\n \"key\": \"e7050120-c535-4bd6-9fcc-7366f8239a82|c26ad25c-b6bc-496c-9f9e-904b01b06806\",\n \"active_session\": true,\n \"blacklisted\": false,\n \"email\": \"me@yahoo.com\",\n \"client_id\": \"e7050120-c535-4bd6-9fcc-7366f8239a82\",\n \"client_status\": \"PENDING_VERIFICATION\",\n \"language\": \"eng\",\n \"currency\": \"USD\",\n \"client_level\": \"NOVICE\",\n \"id_verified\": false,\n \"kyc_completed\": false,\n \"phone_validated\": true,\n \"email_validated\": false,\n \"fname\": \"company\",\n \"lname\": \"admin\",\n \"vouched_public_key\": \".Y1.~@59utQV#xf4LRsa~PEJaBz1wP\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"NONE\",\n \"phone\": \"+15653726254\",\n \"fees\": \"{\\\"BUY\\\": 100, \\\"HOLD\\\": 0, \\\"SELL\\\": 100, \\\"DEPOSIT\\\": 0, \\\"RELEASE\\\": 0, \\\"WITHDRAW\\\": 0, \\\"CREDIT_ADJUSTMENT\\\": 0, \\\"CONVERSION_DEPOSIT\\\": 0, \\\"CONVERSION_WITHDRAW\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_DEPOSIT\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_WITHDRAW\\\": 0}\",\n \"domicile\": \"CO\",\n \"fullName\": \"company admin\",\n \"clientVerified\": false\n}\n\nFields:
\nThis endpoint is used to confirm a user's phone registration. It accepts a POST request to the specified endpoint.
\n{{apiurl}}/register/confirmPhoneThe request body should be sent in application/x-www-form-urlencoded format and must include the following parameters:
phone (text): The phone number that needs to be confirmed.
\ncode (text): The confirmation code sent to the user's phone.
\nOn successful confirmation, the API will respond with a JSON object indicating the result of the operation. The response will typically include a success message or an error message if the confirmation fails.
\nEnsure that the phone number and confirmation code provided in the request are valid to receive the expected response.
\n","urlObject":{"path":["register","confirmPhone"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05370847-a3cb-4d6c-ad52-f67db9c76e20"},{"name":"12. Validate SMS Code Received","id":"13ce59f7-74e1-47c2-8dc8-db0e2fa83af6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\":\"86138915\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/validatePhone","description":"This endpoint is used to validate a phone number during the registration process. It checks if the provided code corresponds to the phone number that was submitted for registration.
\nMethod: POST
\nEndpoint: {{apiurl}}/register/validatePhone
The request body must be in JSON format and should include the following parameter:
\ncode (string): The validation code sent to the user's phone number. This code is used to verify the ownership of the phone number during registration.Upon successful validation, the response will contain information about the validation status. The structure of the response will typically include:
\nstatus (string): Indicates whether the validation was successful or failed.
message (string): A descriptive message regarding the validation result.
Ensure that the code provided in the request matches the one sent to the user's phone for successful validation.
Used to retrive User status nad information.
\nIf user is not loged in it will retturn:
\n{\n \"success\": false,\n \"code\": 1000074,\n \"payload\": \"Client Session Not Found\"\n}\n\nIf user is not fully verified via 2FA it will reply:
\n{\n \"state\": \"pending_2fa_verification\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"SMS\"\n}\n\nIf the user is validated it will retrieve the basic User infoormation.
\n{\n \"key\": \"e7050120-c535-4bd6-9fcc-7366f8239a82|c26ad25c-b6bc-496c-9f9e-904b01b06806\",\n \"active_session\": true,\n \"blacklisted\": false,\n \"email\": \"me@yahoo.com\",\n \"client_id\": \"e7050120-c535-4bd6-9fcc-7366f8239a82\",\n \"client_status\": \"PENDING_VERIFICATION\",\n \"language\": \"eng\",\n \"currency\": \"USD\",\n \"client_level\": \"NOVICE\",\n \"id_verified\": false,\n \"kyc_completed\": false,\n \"phone_validated\": true,\n \"email_validated\": false,\n \"fname\": \"company\",\n \"lname\": \"admin\",\n \"vouched_public_key\": \".Y1.~@59utQV#xf4LRsa~PEJaBz1wP\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"NONE\",\n \"phone\": \"+15653726254\",\n \"fees\": \"{\\\"BUY\\\": 100, \\\"HOLD\\\": 0, \\\"SELL\\\": 100, \\\"DEPOSIT\\\": 0, \\\"RELEASE\\\": 0, \\\"WITHDRAW\\\": 0, \\\"CREDIT_ADJUSTMENT\\\": 0, \\\"CONVERSION_DEPOSIT\\\": 0, \\\"CONVERSION_WITHDRAW\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_DEPOSIT\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_WITHDRAW\\\": 0}\",\n \"domicile\": \"CO\",\n \"fullName\": \"company admin\",\n \"clientVerified\": false\n}\n\nFields:
\nThis endpoint is used to confirm a user's email address during the registration process. It is typically called after a user has registered and received a confirmation email.
\nThe request must be sent as a form-data or x-www-form-urlencoded body, containing the following parameters:
\nemail (text): The email address of the user that needs to be confirmed.
\nconfirmationCode (text): A unique code sent to the user's email to verify their ownership of the email address.
\nUpon a successful request, the server will respond with a confirmation message indicating that the email address has been successfully verified. The response may include:
\nstatus: A string indicating the success or failure of the operation.
\nmessage: A descriptive message providing additional context about the result of the request.
\nEnsure that the email and confirmation code are correctly entered to avoid errors.
\nThis endpoint is crucial for completing the registration process and allowing users to access their accounts.
\nThis endpoint is used to validate an email registration by verifying a provided code.
\nMethod: POST
Endpoint: {{apiurl}}/register/validateEmail
The request body must be in JSON format and should contain the following parameter:
\n{\n \"code\": 88089780\n}\n\nThe expected response format for this endpoint is typically a JSON object indicating the success or failure of the email validation process. The specific structure of the response may vary based on the implementation but generally includes a status message and possibly additional data regarding the validation outcome.
\nEnsure that the code provided in the request body is valid and corresponds to the email registration process to receive an accurate response.
\n","urlObject":{"path":["register","validateEmail"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa25add2-21d1-4ddf-808b-9a8f838e8a9a"},{"name":"16. Get Client Config - Email Validated Copy","id":"edeab6b2-6a89-4f1e-97f5-848fe0b0d1b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{apiurl}}/client/config","description":"Used to retrive User status nad information.
\nIf user is not loged in it will retturn:
\n{\n \"success\": false,\n \"code\": 1000074,\n \"payload\": \"Client Session Not Found\"\n}\n\nIf user is not fully verified via 2FA it will reply:
\n{\n \"state\": \"pending_2fa_verification\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"SMS\"\n}\n\nIf the user is validated it will retrieve the basic User infoormation.
\n{\n \"key\": \"e7050120-c535-4bd6-9fcc-7366f8239a82|c26ad25c-b6bc-496c-9f9e-904b01b06806\",\n \"active_session\": true,\n \"blacklisted\": false,\n \"email\": \"me@yahoo.com\",\n \"client_id\": \"e7050120-c535-4bd6-9fcc-7366f8239a82\",\n \"client_status\": \"PENDING_VERIFICATION\",\n \"language\": \"eng\",\n \"currency\": \"USD\",\n \"client_level\": \"NOVICE\",\n \"id_verified\": false,\n \"kyc_completed\": false,\n \"phone_validated\": true,\n \"email_validated\": false,\n \"fname\": \"company\",\n \"lname\": \"admin\",\n \"vouched_public_key\": \".Y1.~@59utQV#xf4LRsa~PEJaBz1wP\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"NONE\",\n \"phone\": \"+15653726254\",\n \"fees\": \"{\\\"BUY\\\": 100, \\\"HOLD\\\": 0, \\\"SELL\\\": 100, \\\"DEPOSIT\\\": 0, \\\"RELEASE\\\": 0, \\\"WITHDRAW\\\": 0, \\\"CREDIT_ADJUSTMENT\\\": 0, \\\"CONVERSION_DEPOSIT\\\": 0, \\\"CONVERSION_WITHDRAW\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_DEPOSIT\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_WITHDRAW\\\": 0}\",\n \"domicile\": \"CO\",\n \"fullName\": \"company admin\",\n \"clientVerified\": false\n}\n\nFields:
\nThis is a DEVELOPMENT ONLY endpoint.
\nThis endpoint is used to approve a Know Your Customer (KYC) request for a client. It is typically called after the initial KYC information has been submitted and requires validation before the client can proceed with further transactions.
\nMethod: POST
\nEndpoint: {{apiurl}}/client/kyc_approve
The request body should be sent in application/x-www-form-urlencoded format and must include the following parameters:
client_id (string): The unique identifier of the client whose KYC is being approved.
approval_status (string): The status of the approval, indicating whether the KYC is approved or rejected.
comments (string, optional): Any additional comments or notes regarding the approval decision.
Upon successful processing of the request, the server will respond with a JSON object containing the following fields:
\nsuccess (boolean): Indicates whether the approval was successful.
message (string): A message providing additional information about the approval process.
data (object): Contains details of the approved KYC request, including the client_id and the approval_status.
{\n \"success\": true,\n \"message\": \"KYC approval successful.\",\n \"data\": {\n \"client_id\": \"12345\",\n \"approval_status\": \"approved\"\n }\n}\n\nThis endpoint is crucial for ensuring that client identities are verified and compliant with regulatory requirements before engaging in financial activities.
\n","urlObject":{"path":["client","kyc_approve"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3aac689d-027f-494b-879e-bece3a4ffad0"},{"name":"18. Get Client Config - KYC Completed","id":"2836ffcc-3022-458e-a0b2-f7d79809e90d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{apiurl}}/client/config","description":"Used to retrive User status nad information.
\nIf user is not loged in it will retturn:
\n{\n \"success\": false,\n \"code\": 1000074,\n \"payload\": \"Client Session Not Found\"\n}\n\nIf user is not fully verified via 2FA it will reply:
\n{\n \"state\": \"pending_2fa_verification\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"SMS\"\n}\n\nIf the user is validated it will retrieve the basic User infoormation.
\n{\n \"key\": \"e7050120-c535-4bd6-9fcc-7366f8239a82|c26ad25c-b6bc-496c-9f9e-904b01b06806\",\n \"active_session\": true,\n \"blacklisted\": false,\n \"email\": \"me@yahoo.com\",\n \"client_id\": \"e7050120-c535-4bd6-9fcc-7366f8239a82\",\n \"client_status\": \"PENDING_VERIFICATION\",\n \"language\": \"eng\",\n \"currency\": \"USD\",\n \"client_level\": \"NOVICE\",\n \"id_verified\": false,\n \"kyc_completed\": false,\n \"phone_validated\": true,\n \"email_validated\": false,\n \"fname\": \"company\",\n \"lname\": \"admin\",\n \"vouched_public_key\": \".Y1.~@59utQV#xf4LRsa~PEJaBz1wP\",\n \"auth_choice\": \"auth_pending\",\n \"required_2fa_2proceed\": \"NONE\",\n \"phone\": \"+15653726254\",\n \"fees\": \"{\\\"BUY\\\": 100, \\\"HOLD\\\": 0, \\\"SELL\\\": 100, \\\"DEPOSIT\\\": 0, \\\"RELEASE\\\": 0, \\\"WITHDRAW\\\": 0, \\\"CREDIT_ADJUSTMENT\\\": 0, \\\"CONVERSION_DEPOSIT\\\": 0, \\\"CONVERSION_WITHDRAW\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_DEPOSIT\\\": 0, \\\"INTRA_ACCOUNT_TRANSFER_WITHDRAW\\\": 0}\",\n \"domicile\": \"CO\",\n \"fullName\": \"company admin\",\n \"clientVerified\": false\n}\n\nFields:
\nInitial Registration Steps
\nThe user registration does not require Authorization and is used for all interactions with the system.
\nIMPORTANT: For verification purposes prior to Depositing/Paying/Withdrawing the user must perfomr KYC/AML which is confidectial. For the KYC/AML process to succeed, the First Name (fname) and Last Name (lname) must macth excatly the ID which will be presented during the validatin process.
\nThe Parameters are:
\n\"fname\": First Name of the user registering
\n\"lname\": Last Name
\n\"email\": Email of the user
\n\"phone\": Phone number, it must begin with a '+country_code', a full list of the Countrycodes can be retrieved by calling the REFERENCE->Get List of All Countries
\n\"password\":\"Password
\n\"domicile\": \"gec code\" a full list of the Countrycodes can be retrieved by calling the REFERENCE->Get List of All Countries
\n\"language\":\"alpha3_b code\", a full list of the Countrycodes can be retrieved by calling the REFERENCE->Get List of All Languages
\n\"preferred_currency\": \"Currency id\" , a full list of the Countrycodes can be retrieved by calling the REFERENCE->Get List of All Currencies
\nIMPORTANT: Password must have the folliwng complexity:
\nAt least 8 characters,
\nAt least one Upper Case,
\nAt least one Lower case,
\nAt least One Digit,
\nAt least One Special Character,
\nNo alphabetical sequence,
\nNo numerical sequence,
\nNo USQwerty sequence,
\nNo more than 2 repeated characters,
\nNo spaces
\nIMPORTANT: No two users can have the same email o phone number
\nOnce the User is created successfully the following Message will be returned:
\n{ \n\"success\": true, \n\"code\": 0, \n\"payload\": \"Success Registering baezd1@yahoo.com\"\n}\n\nOtherwise an Error code will be returned.
\n","_postman_id":"9dc60c80-8c4a-4b51-bcf4-d9a22415f4a4"},{"name":"[II] Send Corporate Information","item":[{"name":"19. Register corporation","id":"021e8fa0-90ea-429a-a930-314014d5120a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"business_name","value":"My Business Name","type":"text"},{"key":"trade_name","value":"My Trade Name Yasser","type":"text"},{"key":"business_address_1","value":"123 Main St","type":"text"},{"key":"business_address_2","value":"Suite 400 123","type":"text"},{"key":"country","value":"US","type":"text"},{"key":"region","value":"NY","type":"text"},{"key":"city","value":"New York","type":"text"},{"key":"postal_code","value":"10001","type":"text"},{"key":"incorporation_date","value":"2020-05-15","type":"text"},{"key":"incorporation_country","value":"US","type":"text"},{"key":"is_regulated","value":"true","type":"text"},{"key":"is_licensed","value":"false","type":"text"},{"key":"nature_of_business","value":"Technology Services","type":"text"},{"key":"serviced_countries","value":"US,CA,MX","type":"text"},{"key":"operates_in_restricted_countries","value":"false","type":"text"},{"key":"has_peps","value":"false","type":"text"},{"key":"corporate_phone","value":"+1-212-555-1234","type":"text"},{"key":"customer_service_phone","value":"+1-212-555-5678","type":"text"},{"key":"business_type","value":"LLC","type":"text"},{"key":"business_number","value":"98-7654321","type":"text"},{"key":"company_websites","value":"https://www.mybusiness.com","type":"text"},{"key":"marketing_websites","value":"https://www.mybusinesspromo.com","type":"text"},{"key":"submitter_first_name","value":"John","type":"text"},{"key":"submitter_last_name","value":"Doe","type":"text"},{"key":"submitter_email","value":"omes@gmail.com","type":"text"},{"key":"articles_of_incorporation","type":"file","src":"/Users/yasserlluberes/Desktop/A - invoice - christian.pdf"},{"key":"shareholder_register","type":"file","src":"/path/to/shareholder_register.pdf"},{"key":"certificate_of_incorporation","type":"file","src":"/path/to/certificate_of_incorporation.pdf"},{"key":"certificate_of_good_standing","type":"file","src":"/path/to/certificate_of_good_standing.pdf"},{"key":"business_description_letter","type":"file","src":"/path/to/business_description_letter.pdf"},{"key":"last_three_bank_statements","type":"file","src":"/path/to/last_three_bank_statements.pdf"},{"key":"proof_of_business_address","type":"file","src":"/path/to/proof_of_business_address.pdf"},{"key":"financial_statements_or_tax_returns","type":"file","src":"/path/to/financial_statements_or_tax_returns.pdf"},{"key":"corporate_organizational_structure","type":"file","src":"/path/to/corporate_organizational_structure.pdf"},{"key":"license","type":"file","src":"/path/to/license.pdf"},{"key":"amlKycPolicies","type":"file","src":"/path/to/aml_kyc_policies.pdf"},{"key":"clientId","value":"your client id","type":"text"}]},"url":"{{apiurl}}/register/register-coorporate","description":"This API endpoint is used to register a corporate entity by submitting various business-related details along with required documentation.
\nMethod: POST
\nURL: {{apiurl}}/register/register-coorporate
Content-Type: multipart/form-data
The request body must include the following parameters:
\nbusiness_name: The official name of the business.
\ntrade_name: The trade name under which the business operates.
\nbusiness_address_1: The primary address of the business.
\nbusiness_address_2: Additional address information (if applicable).
\ncountry: The country where the business is registered.
\nregion: The state or region of the business location.
\ncity: The city where the business is located.
\npostal_code: The postal code for the business address.
\nincorporation_date: The date when the business was incorporated.
\nincorporation_country: The country of incorporation.
\nis_regulated: Indicates if the business is regulated (true/false).
\nis_licensed: Indicates if the business is licensed (true/false).
\nnature_of_business: A brief description of the business activities.
\nserviced_countries: A comma-separated list of countries serviced by the business.
\noperates_in_restricted_countries: Indicates if the business operates in restricted countries (true/false).
\nhas_peps: Indicates if the business has Politically Exposed Persons (true/false).
\ncorporate_phone: The corporate contact phone number.
\ncustomer_service_phone: The customer service contact phone number.
\nbusiness_type: The type of business entity (e.g., LLC, Corporation).
\nbusiness_number: The business registration number.
\ncompany_websites: URLs of the company's official websites.
\nmarketing_websites: URLs of the company's marketing websites.
\nsubmitter_first_name: The first name of the person submitting the registration.
\nsubmitter_last_name: The last name of the person submitting the registration.
\nsubmitter_email: The email address of the person submitting the registration.
\narticles_of_incorporation: PDF file containing the articles of incorporation.
\nshareholder_register: PDF file of the shareholder register.
\ncertificate_of_incorporation: PDF file of the certificate of incorporation.
\ncertificate_of_good_standing: PDF file of the certificate of good standing.
\nbusiness_description_letter: PDF file containing a business description letter.
\nlast_three_bank_statements: PDF file of the last three bank statements.
\nproof_of_business_address: PDF file proving the business address.
\nfinancial_statements_or_tax_returns: PDF file of financial statements or tax returns.
\ncorporate_organizational_structure: PDF file of the corporate organizational structure.
\nlicense: PDF file of the business license.
\namlKycPolicies: PDF file of AML/KYC policies.
\nThe response for this API call will typically include a confirmation of registration or an error message detailing any issues encountered during the registration process. The exact structure of the response will depend on the implementation but will generally include a success indicator and any relevant error messages.
\nThis API allows businesses to register by providing essential information and documentation, facilitating compliance with regulatory requirements and enabling the business to operate legally.
\n","urlObject":{"path":["register","register-coorporate"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"021e8fa0-90ea-429a-a930-314014d5120a"}],"id":"a3b2e88d-1d5b-4f5e-b74c-7ca1b7aebd94","_postman_id":"a3b2e88d-1d5b-4f5e-b74c-7ca1b7aebd94","description":""},{"name":"[III] Add Assets","item":[{"name":"20. [DEV_ONLY] Desposit USD","id":"bd69e422-5857-4df6-a579-c0ed3d1dbc44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"portfolio_name\": \"My Portfolio\",\n\"instrument\": \"USD\",\n\"qty\": 25,\n\"cost_basis\": 1,\n\"from\": \"Treasury\",\n\"notes\": \"Dev Deposit\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/portfolio/deposit","description":"This is a DEVELOPMENT ONLY endpoint
\nThis endpoint allows users to add a deposit to a specified portfolio. The deposit details include the instrument type, quantity, cost basis, source of funds, and any additional notes.
\nThe request body must be in JSON format and include the following parameters:
\nportfolio_name (string): The name of the portfolio to which the deposit is being added.
\ninstrument (string): The type of instrument for the deposit (e.g., currency).
\nqty (number): The quantity of the instrument being deposited.
\ncost_basis (number): The cost basis for the deposited quantity.
\nfrom (string): The source from which the funds are being deposited (e.g., Treasury).
\nnotes (string): Any additional notes regarding the deposit.
\nUpon a successful request, the API will return a confirmation of the deposit addition, typically including a success message and details of the transaction. The exact structure of the response may vary, but it will generally confirm that the deposit has been processed and may include the updated portfolio balance or transaction ID.
\nEnsure that the portfolio specified in the portfolio_name exists before making the request.
Validate all input parameters to prevent errors during processing.
\nThis endpoint is typically used in financial applications where users manage their investment portfolios.
\nThis is a DEVELOPMENT ONLY endpoint
\nThis endpoint allows users to add a deposit to a specified portfolio.
\nThe request body must be in JSON format and should include the following parameters:
\nportfolio_name (string): The name of the portfolio to which the deposit is being made.
\ninstrument (string): The type of instrument being deposited (e.g., cryptocurrency, stock).
\nqty (number): The quantity of the instrument being deposited.
\ncost_basis (number): The cost basis for the instrument being deposited.
\nfrom (string): The source from which the funds are coming (e.g., Treasury, Savings).
\nnotes (string): Any additional notes regarding the deposit.
\nUpon a successful request, the API will return a confirmation of the deposit action along with relevant details about the transaction. The exact structure of the response may vary, but it will typically include information such as the transaction ID and the updated portfolio balance.
\nEnsure that the portfolio name provided exists in the system before making the deposit.
\nVerify that the quantity and cost basis are accurate to avoid discrepancies in the portfolio's financial records.
\nUsed to retrieve current balances
\nMethod: POST
URL: {{apiurl}}/portfolio/get_portfolio_balances
Content-Type: application/jsonThe request body must be in JSON format and should include the following parameter:
\n{\n \"portfolio_name\": \"<NAME_OF_PORTFOLIO>\"\n}\n\nParameters:
\nThe response will return an array of objects, each representing an asset in the portfolio with the following structure:
\n[\n {\n \"base_currency\": \"<BASE_CURRENCY>\",\n \"qty\": <CURRENT_QTY>,\n \"pnl\": <TOTAL_PNL_FOR_THIS_SYMBOL>\n }\n]\n\nFields:
\nbase_currency (string): The currency of the asset.
qty (number): The current quantity of the asset.
pnl (number): The total profit and loss for this asset since the portfolio was opened.
Example Response:
\n[\n {\n \"base_currency\": \"BTC\",\n \"qty\": 0.0,\n \"pnl\": 7.500\n },\n {\n \"base_currency\": \"USD\",\n \"qty\": 90304.480,\n \"pnl\": 0\n }\n]\n\nIf the asset is a currency (e.g., USD-USD), the PNL will always be zero (0).
\nThe PNL is calculated across all transactions since the portfolio was opened.
\nTo get the current PNL:
\nIf qty = 0, then current_pnl = pnl
If qty > 0, then current_pnl = pnl + (qty \\* current_asset_market_price)
Method: POST
\nParameters in Body:
{
\"portfolio_name\": \"\"
}
Return: for each asset one entry with:
{
\"base_currency\": \"\",
\"qty\": ,
\"pnl\":
}
Example:
[
[
{\n \"base_currency\": \"BTC\",\n \"qty\": 0.0,\n \"pnl\": 7.500\n },\n {\n \"base_currency\": \"USD\",\n \"qty\": 90304.480,\n \"pnl\": 0\n }\n\n ]
]
If the asset is currency, such as USD-USD then the PNL will always be Zero (0).
The pnl is calculated across all transactions since portfolio was opened.
To get the current pnl do as follows:
qty = 0 => current_pnl = pnl
\nqty > 0 => current_pnl = (pnl)+(qty*currnet_asset_market_price)
\nThis API endpoint retrieves all transactions associated with a specified portfolio. Each transaction is returned individually.
\nPOST
Content-Type: application/json (specifies the media type of the resource)The request body must be in JSON format and include the following parameter:
\nportfolio_name (string): The name of the portfolio for which transactions are being requested.
\nThe response will contain an array of transaction objects, each representing a transaction associated with the specified portfolio. The structure of each transaction object is as follows:
\n{\n \"portfolio_id\": \"<PORTFOLIO_ID>\",\n \"qty\": <QUANTITY>,\n \"symbol\": \"<SYMBOL>\",\n \"transaction_id\": <TRANSACTION_ID>,\n \"price\": <PRICE>,\n \"from\": \"<FROM_ACCOUNT_ID>\",\n \"to\": \"<TO_ACCOUNT_ID>\",\n \"transaction_type\": \"<TRANSACTION_TYPE>\",\n \"data\": {},\n \"base_currency\": \"<BASE_CURRENCY>\"\n}\n\n[\n {\n \"portfolio_id\": \"b0d40b46-adb8-420d-8158-6493ca1d29b3\",\n \"qty\": 1.5,\n \"symbol\": \"BTC-USD\",\n \"transaction_id\": 213578159726241,\n \"price\": 3231.34,\n \"from\": \"7c2f55ac-571c-46a1-a780-37df9b36e203\",\n \"to\": \"b0d40b46-adb8-420d-8158-6493ca1d29b3\",\n \"transaction_type\": \"BUY\",\n \"data\": {},\n \"base_currency\": \"BTC\"\n }\n]\n\nThis endpoint is useful for tracking the performance and history of transactions within a specific portfolio.
\n","urlObject":{"path":["portfolio","get_portfolio_transactions"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"20759627-5349-47e3-8449-379a69d48281"}],"id":"11b378f0-8b17-4a39-98db-e13e5c21833e","_postman_id":"11b378f0-8b17-4a39-98db-e13e5c21833e","description":""},{"name":"25. Logout","id":"1157704d-87fb-4239-b662-deac55911cd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{apiurl}}/logout","urlObject":{"path":["logout"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1157704d-87fb-4239-b662-deac55911cd6"}],"id":"cd440716-cb0d-4f75-b86b-b817ce4ac879","description":"All interactions with the system, past the iniital registration, require a registered user. This applies to:
\nAdministrators setting Up a Payment Company or Entity
\nContent or Service Providers
\nClients who will purchase or subscribe to products
\nThe registration is a three step process:
\nRegister the User (Register)
\nValidate the Phone Number (Confirm to Send a code + Validate to validate the code)
\nValidate the Email (Confirm to Send a code + Validate to validate the code)
\nOnce the Email and Phone are validated, everytime the user logs in there is a 2FA process to validate the loogin, with SMS being the default method to receive the code. The code is always validated using the Validae method.
\nThis is a guided set of calls to get a basic workign environment.
\n","_postman_id":"cd440716-cb0d-4f75-b86b-b817ce4ac879"},{"name":"SECURITY","item":[{"name":"SMS","item":[{"name":"Send 2FA Code via SMS","id":"d878d1a7-880d-4b03-9794-5baa910f31bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{apiurl}}/register/confirmPhone","description":"This endpoint is used to confirm a user's phone registration. It is a POST request sent to {{apiurl}}/register/confirmPhone.
The request body must include the following parameters:
\nphoneNumber (text): The phone number that needs to be confirmed.
\nconfirmationCode (text): The code sent to the user's phone for verification.
\nUpon successful confirmation, the API will return a response indicating the success of the operation. The expected response will typically include:
\nstatus: Indicates the success or failure of the confirmation process.
\nmessage: A descriptive message providing additional information about the confirmation status.
\nMake sure to provide valid values for the phone number and confirmation code to ensure successful processing of the request.
\n","urlObject":{"path":["register","confirmPhone"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d878d1a7-880d-4b03-9794-5baa910f31bc"},{"name":"Validate SMS Code","id":"a9dc40f1-c89b-4bb9-b9e7-39519036d50f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\":\"86138915\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/validatePhone","description":"This endpoint is used to validate a phone number during the registration process. It checks if the provided verification code is correct for the specified phone number.
\nPOST{{apiurl}}/register/validatePhoneapplication/jsonThe request body must be a JSON object containing the following parameter:
\n{\n \"code\": \"86138915\"\n}\nThe expected response format is typically a JSON object indicating the success or failure of the validation process. The specific structure of the response will depend on the implementation, but it generally includes information about whether the validation was successful and any relevant messages.
\nEnsure that the verification code is valid and corresponds to the phone number being registered. Invalid codes will result in a failure response.
\n","urlObject":{"path":["register","validatePhone"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9dc40f1-c89b-4bb9-b9e7-39519036d50f"},{"name":"Send 2FA Code via SMS - Not logedin","id":"772f5f3d-5efd-48cb-b1de-b21c1e28ce2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\":\"82167826\",\n \"send_to\": \"+12122561693\",\n \"language\": \"eng\",\n \"code_validation\": \"dq322\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/validatePhoneUnsigned","description":"This endpoint is used to validate a phone number during the registration process. It checks the provided verification code against the one sent to the specified phone number.
\nThe request must be sent as a JSON object in the body with the following parameters:
\nUpon successful validation, the server will respond with a confirmation of the validation status. The response will typically include:
\nThis endpoint is used to confirm a user's phone number during the registration process. It sends a validation code to the specified phone number, allowing the user to verify their contact information.
\nMethod: POST
\nEndpoint: {{apiurl}}/register/confirmPhoneUnsigned
Content-Type: application/json
\nThe request body should be in JSON format and include the following parameters:
\nsendto (string): The phone number to which the validation code will be sent. It must be in a valid format, including the country code.
\nlanguage (string): The language in which the validation message should be sent. Common values include \"eng\" for English.
\ncode_validation (string): The validation code that the user needs to confirm their phone number.
\n{\n \"sendto\": \"+19086359385\",\n \"language\": \"eng\",\n \"code_validation\": \"2oj201\"\n}\n\nUpon a successful request, the API will return a response indicating the status of the phone confirmation process. The structure of the response typically includes:
\nstatus (string): Indicates whether the confirmation was successful or if there was an error.
\nmessage (string): A descriptive message providing additional information about the status.
\n{\n \"status\": \"success\",\n \"message\": \"Phone number confirmed successfully.\"\n}\n\nThis endpoint is crucial for ensuring that users have access to the phone number they provided, enhancing the security and integrity of the registration process.
\n","urlObject":{"path":["register","confirmPhoneUnsigned"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"506e26e1-3b4f-4bc6-8385-783439eb241f"},{"name":"Send User sms 2fa Code","id":"0057b17e-62d9-418b-bed3-8133ed49693e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{apiurl}}/register/send_2fa_code","description":"POST
This endpoint is used to send a Two-Factor Authentication (2FA) code to a user during the registration process. It is an essential security measure to ensure that the user is verified.
\nThe request body must include the following parameters:
\nemail (text): The email address of the user to whom the 2FA code will be sent.
\nphone_number (text): The phone number of the user, if applicable, for sending the 2FA code via SMS.
\nUpon a successful request, the server will respond with a status indicating the outcome of the operation. The response will typically include:
\nstatus: Indicates whether the request was successful or failed.
\nmessage: A descriptive message providing additional information about the request status.
\n{\n \"status\": \"success\",\n \"message\": \"2FA code sent successfully.\"\n}\n\nEnsure that all required parameters are included in the request body to receive the expected response.
\n","urlObject":{"path":["register","send_2fa_code"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0057b17e-62d9-418b-bed3-8133ed49693e"}],"id":"cb689ae2-09f3-4117-9bd0-a59865ac0eca","_postman_id":"cb689ae2-09f3-4117-9bd0-a59865ac0eca","description":""},{"name":"EMAIL","item":[{"name":"Send 2FA Code via Email","id":"70f21ac9-b780-4033-9559-d54f84f311b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/confirmEmail","description":"This endpoint is used to confirm a user's email address during the registration process. It is typically called after a user has registered and received a confirmation email containing a unique token.
\nThe request must be sent as a POST request to the endpoint {{apiurl}}/register/confirmEmail. The body of the request should be formatted as application/x-www-form-urlencoded and must include the following parameters:
token (string): The unique token sent to the user's email address for verification.
\nemail (string): The email address of the user who is confirming their registration.
\ntoken=your_unique_token\nemail=user@example.com\n\nUpon successful confirmation of the email, the API will respond with a JSON object containing the following fields:
\nsuccess (boolean): Indicates whether the email confirmation was successful.
\nmessage (string): A message providing additional information about the result of the confirmation process.
\n{\n \"success\": true,\n \"message\": \"Email confirmed successfully.\"\n}\n\nIn case of an error, the response will also include a success field set to false and an appropriate error message detailing the issue.
This endpoint is used to validate an email registration by checking a unique code provided by the user.
\nHTTP Method: POST
Endpoint: {{apiurl}}/register/validateEmail
The request requires a JSON payload containing the following parameter:
\n{\n \"code\": 88089780\n}\n\nUpon successful validation, the server will respond with a confirmation message indicating whether the email validation was successful or not. The response will typically be in JSON format, containing a status and any relevant messages.
\nEnsure that the correct code is provided to receive the appropriate validation response.
\n","urlObject":{"path":["register","validateEmail"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe00297d-7874-4fc2-93d0-c488266d04ff"},{"name":"Send 2FA Code via Email - Not logedin","id":"3507d88a-eaf5-4eb5-b0aa-7df570c424c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sendto\": \"dbaez@bloxcross.com\",\n \"language\": \"eng\",\n \"code_validation\": \"2oj201\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/confirmEmailUnsigned","description":"This endpoint is used to confirm a user's email address during the registration process. It is typically called after a user has initiated the registration and received a confirmation code via email.
\nMethod: POST
\nURL: {{apiurl}}/register/confirmEmailUnsigned
Content-Type: application/json
\nThe request body should be in JSON format and contain the following parameters:
\nsendto (string): The email address to which the confirmation code was sent.
\nlanguage (string): The language preference of the user (e.g., \"eng\" for English).
\ncode_validation (string): The validation code that the user needs to confirm their email.
\nExample Request Body:
\n{\n \"sendto\": \"user@example.com\",\n \"language\": \"eng\",\n \"code_validation\": \"your_validation_code\"\n}\n\nUpon successful email confirmation, the server will respond with a JSON object indicating the result of the operation. The exact structure of the response may vary, but it generally includes fields indicating success or failure, along with any relevant messages or data.
\nExpected Response Example:
\n{\n \"success\": true,\n \"message\": \"Email confirmed successfully.\"\n}\n\nIn case of an error, the response will include an error message detailing the issue encountered during the confirmation process.
\nMake sure to handle the response appropriately based on the success or failure of the email confirmation.
\n","urlObject":{"path":["register","confirmEmailUnsigned"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3507d88a-eaf5-4eb5-b0aa-7df570c424c4"},{"name":"Validate Email Code - Not logedin","id":"9b0bb807-954c-474e-bb6c-df2b80ed7da8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"10589715\",\n \"send_to\": \"dbaez@bloxcross.com\",\n \"language\": \"eng\",\n \"code_validation\": \"dq322\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/validateEmailUnsigned","description":"This endpoint is used to validate an email address during the registration process. It checks the provided code against the system to ensure that the email can be processed further.
\nPOST
\n{{apiurl}}/register/validateEmailUnsigned
The request body must be in JSON format and include the following parameters:
\ncode (string): A unique code associated with the email validation process.
\nsend_to (string): The email address to which the validation code is sent.
\nlanguage (string): The language preference for the validation message.
\ncode_validation (string): A secondary code used for validation purposes.
\nThe response will typically include a status indicating the success or failure of the email validation process. The exact structure of the response may vary, but it will generally provide feedback on whether the validation was successful.
\nMake sure to provide valid data for each parameter to ensure the request is processed correctly.
\n","urlObject":{"path":["register","validateEmailUnsigned"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b0bb807-954c-474e-bb6c-df2b80ed7da8"}],"id":"666302a8-39d4-47f8-ad27-729e8cc1949a","_postman_id":"666302a8-39d4-47f8-ad27-729e8cc1949a","description":""},{"name":"GAUTH","item":[{"name":"Validate Authenticator code","id":"27513387-a2a4-4246-9149-a7b2035c2d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"98423704\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/validate_2fa_code","description":"This endpoint is used to validate a two-factor authentication (2FA) code provided by the user during the registration process.
\nUpon successful validation of the 2FA code, the response will indicate whether the code is valid. The exact structure of the response will depend on the implementation, but it generally includes a success message or an error message if the code is invalid.
\nEnsure that the 2FA code is entered correctly and is still valid, as these codes often have a time limit.
\nThis endpoint is a critical step in the registration process to enhance security.
\nThis endpoint generates a QR code for two-factor authentication (2FA) setup. It is typically used during the registration or account setup process to enhance security by requiring a second form of verification.
\nUpon a successful request, the server will respond with a QR code image that can be scanned by a 2FA application. The response will typically include:
\nEnsure that the user has a compatible 2FA application installed to scan the QR code.
\nThis endpoint is crucial for enhancing account security and should be implemented during user registration or security settings updates.
\nThis endpoint allows users to generate a Two-Factor Authentication (2FA) QR code using a provided email verification code. It is typically used during the setup of 2FA to enhance account security.
\nMethod: POST
\nURL: {{apiurl}}/register/gen_2fa_qrcode_with_emailcode
The request body must be in JSON format and should include the following parameter:
\nExample Request Body:
\n{\n \"code\": 88089780\n}\n\nUpon a successful request, the response will typically include a QR code in a specified format, which the user can scan to complete the 2FA setup. The exact structure of the response body will depend on the implementation but will generally include:
\nA success status indicating the QR code was generated successfully.
\nThe QR code data or URL that can be used to display the QR code.
\nMake sure to handle any potential errors that may arise, such as invalid or expired codes, to ensure a smooth user experience.
\n","urlObject":{"path":["register","gen_2fa_qrcode_with_emailcode"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eec6cdb0-ed1d-4553-8679-9c5e366779ae"},{"name":"Generate 2FA QR with SMS Code","id":"8afa74cb-6ba8-4225-ba7e-70cc02c5b5e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": 49158327\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/gen_2fa_qrcode_with_smscode","description":"POST /register/gen_2fa_qrcode_with_smscodeThis endpoint is used to generate a two-factor authentication (2FA) QR code using a provided SMS code. It enhances the security of user accounts by requiring a second form of verification during the login process.
\nThe request must contain a JSON object with the following parameter:
\n{\n \"code\": 49158327\n}\n\nUpon a successful request, the response will typically include a QR code representation that can be scanned by an authentication app. The exact structure of the response may vary, but it generally contains the necessary information to complete the 2FA setup.
\nMake sure to handle any errors appropriately, as the request may fail if the provided code is incorrect or expired.
\n","urlObject":{"path":["register","gen_2fa_qrcode_with_smscode"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8afa74cb-6ba8-4225-ba7e-70cc02c5b5e9"},{"name":"Always On 2FA","id":"380002d1-89c7-42da-b302-502219dbe58d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/always_on_2fa","description":"This endpoint allows users to enable the \"Always On\" two-factor authentication (2FA) feature for their accounts. By using this endpoint, users can enhance the security of their accounts by ensuring that 2FA is always required for login.
\nThe request must be sent as x-www-form-urlencoded and includes the following parameters:
user_id (text): The unique identifier for the user who is enabling the \"Always On\" 2FA.
\nmethod (text): The method of two-factor authentication to be used (e.g., SMS, email, authenticator app).
\nenabled (text): A flag indicating whether the 2FA feature should be enabled (typically set to 'true').
\nUpon successful execution, the API will return a response indicating the status of the request. The response will include:
\nstatus: A string indicating the success or failure of the operation (e.g., \"success\" or \"error\").
\nmessage: A descriptive message providing additional context about the operation (e.g., confirmation of 2FA being enabled).
\nEnsure that the user ID provided is valid and corresponds to an existing user in the system.
\nThe method specified must be supported by the system for two-factor authentication.
\nThis feature is intended for users who want to enforce an additional layer of security consistently.
\nMake sure to handle the response appropriately based on the status returned to provide feedback to the user.
\n","urlObject":{"path":["register","always_on_2fa"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"380002d1-89c7-42da-b302-502219dbe58d"},{"name":"Decline 2FA","id":"f3aa4bc1-176c-4ab5-bea6-b5dc0e69a01d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/decline_2fa","description":"This endpoint allows users to decline the two-factor authentication (2FA) process during registration. This action can be useful for users who prefer not to enable 2FA for their accounts at this stage.
\nMethod: POST
\nEndpoint: {{apiurl}}/register/decline_2fa
The request body should be formatted as x-www-form-urlencoded or form-data and must include the following parameters:
user_id (text): The unique identifier of the user who is declining the 2FA.
reason (text): A brief explanation of why the user is declining the 2FA.
Upon successfully processing the request, the server will return a response indicating the result of the operation.
\nstatus (string): Indicates whether the request was successful or if there was an error.
\nmessage (string): Provides additional information about the outcome of the request.
\n{\n \"status\": \"success\",\n \"message\": \"Two-factor authentication has been declined.\"\n}\n\nEnsure that the user_id provided corresponds to a valid user in the system.
The reason parameter is optional but recommended for better user feedback and support.
This endpoint allows users to change their password. It requires the current password and the new password to be provided in the request body.
\nMethod: POST
\nURL: {{apiurl}}/register/change_pwd
Content-Type: application/json
\ncurrent_password (string): The user's current password. This is required to authenticate the user's request for changing the password.
\nnew_password (string): The new password that the user wishes to set. This should meet any security requirements specified by the application (e.g., length, complexity).
\nOn a successful password change, the API will return a response indicating the success of the operation. The exact structure of the response may vary based on implementation but typically includes a status message.
\nEnsure that the new password is secure and meets the application’s password policy.
\nIf the current password is incorrect, the API will respond with an error message indicating the failure.
\nIt is advisable to handle errors gracefully in the application to inform users of any issues during the password change process.
\nReset phone verified flag. Need to verify.
\n","urlObject":{"path":["register","change_phone"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"db0ccb3c-d160-4056-80e6-20b0df222ba2"},{"name":"Change Email","id":"7c756bf1-c64c-4162-8f80-d7902243b25e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"new_email\":\"me@last.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/change_email","description":"Reset email verified flag. Need to verify.
\n","urlObject":{"path":["register","change_email"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c756bf1-c64c-4162-8f80-d7902243b25e"},{"name":"Lost Password","id":"58e27f08-3006-43e8-8d2a-a6ae95714078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"me@last.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/lost_pwd","description":"This endpoint allows users to initiate the process of recovering their lost password by providing their registered email address. Upon successful submission, the system will typically send a password reset link or further instructions to the provided email.
\nMethod: POST
\nURL: {{apiurl}}/register/lost_pwd
The request body must be in JSON format and should include the following parameter:
\nemail (string): The email address associated with the user's account. This is required for the password recovery process.Example Request Body:
\n{\n \"email\": \"user@example.com\"\n}\n\nThe response structure will vary based on the success or failure of the request. Generally, you can expect the following:
\nSuccess Response: A confirmation message indicating that an email has been sent for password recovery.
\nError Response: An error message detailing the reason for the failure, such as an invalid email address or if the email is not registered.
\nEnsure that the email provided is valid and corresponds to an existing account to receive the password reset instructions.
\nThe response will be in JSON format, providing clarity on the outcome of the request.
\nThis endpoint is crucial for user account management and security, enabling users to regain access to their accounts in case they forget their passwords.
\n","urlObject":{"path":["register","lost_pwd"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58e27f08-3006-43e8-8d2a-a6ae95714078"},{"name":"Register Device-App ID","id":"b749ff9e-c23b-4c8c-be4d-89e3788606de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"uuid\": \"uuid\",\n \"token\": \"token2\",\n \"device_model\": \"My iphone\" \n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/client/register_device_app","description":"This endpoint allows clients to register a device application with the server. The registration process requires specific device information to be sent in the request body.
\nPOST
\n{{apiurl}}/client/register_device_app
The request body must be in JSON format and include the following parameters:
\nuuid (string): A unique identifier for the device.
\ntoken (string): A token associated with the device for authentication purposes.
\ndevice_model (string): The model of the device being registered.
\nUpon successful registration, the server will respond with a confirmation message or status indicating the result of the registration process. The exact structure of the response will depend on the implementation but typically includes a success flag and any relevant messages.
\nEnsure that all parameters are provided correctly to avoid errors during the registration process.
\n","urlObject":{"path":["client","register_device_app"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b749ff9e-c23b-4c8c-be4d-89e3788606de"},{"name":"Change Name","id":"89c75441-7a82-42e0-9002-16eef0c0d06d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fname\": \"Jack\",\n \"lname\": \"Reacher\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/client/update_name","description":"This endpoint allows you to update the first and last name of a client in the system.
\nMethod: POST
\nURL: {{apiurl}}/client/update_name
Content-Type: application/json
\nThe request body must be in JSON format and should contain the following parameters:
\n{\n \"fname\": \"Jack\",\n \"lname\": \"Reacher\"\n}\n\nUpon successful execution, the API will return a response indicating the status of the update operation. The expected response structure may include:
\nA success message confirming the name update.
\nAny relevant error messages if the update fails.
\nEnsure that both fname and lname are provided in the request body.
The names should not contain any special characters that are not allowed by the system.
\nThis endpoint is intended for client name updates only; other client details should be updated using their respective endpoints.
\nThis endpoint allows clients to delete their accounts from the system. It requires a specific code to identify the account to be deleted and an optional notes field for any additional comments regarding the account deletion.
\nMethod: POST
\nURL: {{apiurl}}/client/delete_account
Request Body:
\ncode (string, required): A unique identifier for the account that is to be deleted. This code is essential for processing the deletion request.
notes (string, optional): A field where users can provide feedback or reasons for account deletion. This can help the service improve its offerings.
{\n \"code\": \"52020153\",\n \"notes\": \"Tired of this!\"\n}\n\nUpon successful deletion of the account, the API will return a response indicating the status of the operation. The response will typically include a success message or confirmation that the account has been deleted.
\nEnsure that the code provided is accurate, as it directly correlates to the account being deleted.
\nThe notes field is optional but can be beneficial for the service's understanding of user experiences and reasons for leaving.
\nOnce an account is deleted, this action is usually irreversible. Please proceed with caution.
\nThis endpoint allows clients to deactivate their account. It requires a POST request to the specified URL.
\ncode (string): A unique identifier for the account that is being deactivated. This code is essential for verifying the account to be deactivated.
\nnotes (string): An optional field where users can provide feedback or reasons for deactivating their account. This can help the service improve its offerings.
\n{\n \"code\": \"52020153\",\n \"notes\": \"Tired of this!\"\n}\n\nUpon successful deactivation of the account, the server will return a response indicating the status of the operation. The response typically includes confirmation of the account deactivation and may contain additional information or instructions.
\nEnsure that the account code provided is accurate to avoid errors in the deactivation process.
\nProviding notes is optional but can be beneficial for service improvement.
\nSecurity related Endpoints
\n","_postman_id":"5a03e1ff-e4cf-439b-a202-fbeb3646b439"},{"name":"ACCOUNTS","item":[{"name":"CORPORATE","item":[{"name":"BASE ACCOUNT","item":[{"name":"register-coorporate-with-data","id":"9dde2caf-bdf2-4654-96cf-ca27f7c0f408","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"business_name","value":"My Business Name","type":"text"},{"key":"trade_name","value":"My Trade Name","type":"text"},{"key":"business_address_1","value":"123 Main St","type":"text"},{"key":"business_address_2","value":"Suite 400","type":"text"},{"key":"country","value":"US","type":"text"},{"key":"region","value":"NY","type":"text"},{"key":"city","value":"New York","type":"text"},{"key":"postal_code","value":"10001","type":"text"},{"key":"incorporation_date","value":"2020-05-15","type":"text"},{"key":"incorporation_country","value":"US","type":"text"},{"key":"is_regulated","value":"true","type":"text"},{"key":"is_licensed","value":"false","type":"text"},{"key":"nature_of_business","value":"Technology Services","type":"text"},{"key":"serviced_countries","value":"US,CA,MX","type":"text"},{"key":"operates_in_restricted_countries","value":"false","type":"text"},{"key":"has_peps","value":"false","type":"text"},{"key":"corporate_phone","value":"+1-212-555-1234","type":"text"},{"key":"customer_service_phone","value":"+1-212-555-5678","type":"text"},{"key":"business_type","value":"LLC","type":"text"},{"key":"business_number","value":"98-7654321","type":"text"},{"key":"company_websites","value":"https://www.mybusiness.com","type":"text"},{"key":"marketing_websites","value":"https://www.mybusinesspromo.com","type":"text"},{"key":"submitter_first_name","value":"John","type":"text"},{"key":"submitter_last_name","value":"Doe","type":"text"},{"key":"submitter_email","value":"john.doe@mybusiness.com","type":"text"},{"key":"articles_of_incorporation","type":"file","src":"/Users/yasserlluberes/main.py"},{"key":"shareholder_register","type":"file","src":"/Users/yasserlluberes/mock-data-business/SHAREHOLDER_REGISTER.txt"},{"key":"certificate_of_incorporation","type":"file","src":"/Users/yasserlluberes/mock-data-business/CERTIFICATE_OF_INCORPORATION.txt"},{"key":"certificate_of_good_standing","type":"file","src":"/Users/yasserlluberes/mock-data-business/CERTIFICATE_OF_GOOD_STANDING.txt"},{"key":"business_description_letter","type":"file","src":"/Users/yasserlluberes/mock-data-business/BUSINESS_DESCRIPTION_LETTER.txt"},{"key":"last_three_bank_statements","type":"file","src":"/Users/yasserlluberes/mock-data-business/LAST_THREE_BANK_STATEMENTS.txt"},{"key":"proof_of_business_address","type":"file","src":"/Users/yasserlluberes/mock-data-business/PROOF_OF_BUSINESS_ADDRESS.txt"},{"key":"financial_statements_or_tax_returns","type":"file","src":"/Users/yasserlluberes/mock-data-business/FINANCIAL_STATEMENTS_OR_TAX_RETURNS.txt"},{"key":"corporate_organizational_structure","type":"file","src":"/Users/yasserlluberes/mock-data-business/CORPORATE_ORGANIZATIONAL_STRUCTURE.txt"},{"key":"license","type":"file","src":"/Users/yasserlluberes/mock-data-business/LICENSE.txt"},{"key":"amlKycPolicies","type":"file","src":"/Users/yasserlluberes/mock-data-business/AML_KYC_POLICIES.txt"},{"key":"clientId","value":"1d0166f2-7b7f-4f22-b2c9-329a1bb84978","type":"text"}]},"url":"https://api.bloxcross-dev.com/register/register-coorporate","description":"Generated from cURL: curl -X POST http://localhost:8080/register-coorporate
-H \"Content-Type: multipart/form-data\"
-F \"business_name=My Business Name\"
-F \"trade_name=My Trade Name\"
-F \"business_address_1=123 Main St\"
-F \"business_address_2=Suite 400\"
-F \"country=US\"
-F \"region=NY\"
-F \"city=New York\"
-F \"postal_code=10001\"
-F \"incorporation_date=2020-05-15\"
-F \"incorporation_country=US\"
-F \"is_regulated=true\"
-F \"is_licensed=false\"
-F \"nature_of_business=Technology Services\"
-F \"serviced_countries=US,CA,MX\"
-F \"operates_in_restricted_countries=false\"
-F \"has_peps=false\"
-F \"corporate_phone=+1-212-555-1234\"
-F \"customer_service_phone=+1-212-555-5678\"
-F \"business_type=LLC\"
-F \"business_number=98-7654321\"
-F \"company_websites=https://www.mybusiness.com\"
-F \"marketing_websites=https://www.mybusinesspromo.com\"
-F \"submitter_first_name=John\"
-F \"submitter_last_name=Doe\"
-F \"submitter_email=john.doe@mybusiness.com\"
-F \"articles_of_incorporation=@/path/to/articles_of_incorporation.pdf\"
-F \"shareholder_register=@/path/to/shareholder_register.pdf\"
-F \"certificate_of_incorporation=@/path/to/certificate_of_incorporation.pdf\"
-F \"certificate_of_good_standing=@/path/to/certificate_of_good_standing.pdf\"
-F \"business_description_letter=@/path/to/business_description_letter.pdf\"
-F \"last_three_bank_statements=@/path/to/last_three_bank_statements.pdf\"
-F \"proof_of_business_address=@/path/to/proof_of_business_address.pdf\"
-F \"financial_statements_or_tax_returns=@/path/to/financial_statements_or_tax_returns.pdf\"
-F \"corporate_organizational_structure=@/path/to/corporate_organizational_structure.pdf\"
-F \"license=@/path/to/license.pdf\"
-F \"amlKycPolicies=@/path/to/aml_kyc_policies.pdf\"
GET
\nhttps://api.bloxcross-dev.com/register/retrieve-coorporate-info/1d0166f2-7b7f-4f22-b2c9-329a1bb84978
application/jsonThis API call does not require a request body as it is a GET request. The necessary information is included in the URL.
\nThe expected response is in JSON format and will contain the corporate information associated with the provided identifier.
\n{\n \"business_name\": \"Example Business\",\n \"trade_name\": \"Example Trade\",\n \"business_address\": {\n \"address_1\": \"123 Example St\",\n \"address_2\": \"Suite 100\",\n \"city\": \"Example City\",\n \"region\": \"Example Region\",\n \"country\": \"Example Country\",\n \"postal_code\": \"12345\"\n },\n \"incorporation_details\": {\n \"date\": \"2020-05-15\",\n \"country\": \"Example Country\"\n },\n \"contact_info\": {\n \"corporate_phone\": \"+1-123-456-7890\",\n \"customer_service_phone\": \"+1-123-456-7891\",\n \"submitter\": {\n \"first_name\": \"Example\",\n \"last_name\": \"User\",\n \"email\": \"example.user@business.com\"\n }\n },\n \"business_type\": \"LLC\",\n \"business_number\": \"12-3456789\",\n \"websites\": {\n \"company\": \"https://www.examplebusiness.com\",\n \"marketing\": \"https://www.examplepromo.com\"\n },\n \"documents\": {\n \"articles_of_incorporation\": \"link_to_document\",\n \"shareholder_register\": \"link_to_document\",\n \"certificate_of_incorporation\": \"link_to_document\",\n \"certificate_of_good_standing\": \"link_to_document\",\n \"business_description_letter\": \"link_to_document\",\n \"last_three_bank_statements\": \"link_to_document\",\n \"proof_of_business_address\": \"link_to_document\",\n \"financial_statements_or_tax_returns\": \"link_to_document\",\n \"corporate_organizational_structure\": \"link_to_document\",\n \"license\": \"link_to_document\",\n \"amlKycPolicies\": \"link_to_document\"\n }\n}\n\nEnsure that the identifier in the URL is valid to retrieve the correct corporate information.
\nThe response will include various details about the business, including contact information, incorporation details, and links to relevant documents.
\nFull Corporate Account under your umbrella.
\nThese accounts have their logins and have to be fully KYB
\n","_postman_id":"51405f2e-ed1a-4191-954a-e605de1f43b8"},{"name":"DIDA (Digital Deposit Account)","item":[{"name":"Webhooks","item":[{"name":"Get All Event Types","id":"0130813d-1c51-4392-b21c-a64a513fa2d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{apiUrl}}/portfolio/webhooks/eventTypes","urlObject":{"path":["portfolio","webhooks","eventTypes"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0130813d-1c51-4392-b21c-a64a513fa2d4"},{"name":"Subscribe Dida [DEPRECATED]","id":"415c61b0-e32a-41c2-8ed0-dc422c2819c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"eventType\": \"DEPOSIT\",\n \"callbackUrl\": \"https://webhook.site/eec748d0-2041-4112-8225-2ae386c68cec\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/portfolio/webhooks/subscribe/{{account}}","urlObject":{"path":["portfolio","webhooks","subscribe","{{account}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"415c61b0-e32a-41c2-8ed0-dc422c2819c4"},{"name":"Subscribe","id":"100eae2d-db66-4998-b07f-a2723b6295c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"eventType\": \"DEPOSIT\",\n \"callbackUrl\": \"https://webhook.site/84e9d9bc-50c1-4fdd-8602-284ef82ed444\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/portfolio/webhooks/subscribe","urlObject":{"path":["portfolio","webhooks","subscribe"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"100eae2d-db66-4998-b07f-a2723b6295c9"}],"id":"a1fe67d3-22e3-425d-873d-db9d0a5d3736","_postman_id":"a1fe67d3-22e3-425d-873d-db9d0a5d3736","description":""},{"name":"Am I enabled to Create dida Accounts?","id":"8b5b569e-104a-497e-b50e-492ff82e8add","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{apiUrl}}/accounts/dida_account/am_i_enabled","urlObject":{"path":["accounts","dida_account","am_i_enabled"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b5b569e-104a-497e-b50e-492ff82e8add"},{"name":"New DIDA","id":"32ee1d86-3c0e-4c0d-9e2a-00db026c0ed6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"KR1IeAL2DwGLyXcCwjMV4cclghlg2ltJHcxOdSAxJhGMZWFdUpJosldXxrOqZoTF"}],"body":{"mode":"raw","raw":"{\n \"dida_name\": \"demo account - demo 43\",\n \"dida_email\": \"yllub3eres@bloxcross.com\",\n \"dida_phone\": \"+143348183343\",\n \"kyc_required\": false,\n \"rails_enabled\": [\n {\n \"rail\": \"crypto\",\n \"enabled\": false\n },\n {\n \"rail\": \"card\",\n \"enabled\": false\n }, \n \n {\n \"rail\":\"local_rail\",\n \"enabled\": false\n }\n ],\n \"account_status\": \"AVAILABLE\",\n \"dida_preffered_currency\": \"USD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/accounts/dida_account/new","urlObject":{"path":["accounts","dida_account","new"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"32ee1d86-3c0e-4c0d-9e2a-00db026c0ed6"},{"name":"Get DIDA","id":"094eb127-0377-4a26-be1a-635e946a7ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/accounts/dida_account/get_account/{{account}}","urlObject":{"path":["accounts","dida_account","get_account","{{account}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"094eb127-0377-4a26-be1a-635e946a7ad5"},{"name":"Get All DIDA's","id":"f4e712d9-cdf6-4813-976f-7c66893ddd2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{apiUrl}}/accounts/dida_account/get_all","urlObject":{"path":["accounts","dida_account","get_all"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4e712d9-cdf6-4813-976f-7c66893ddd2f"},{"name":"Update DIDA [LOCKED]","id":"ccc617c3-0eb6-434d-a22e-4113ab739953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account_id\": \"dwosdsdfadakf\",\n \"dida_name\": \"Joe Jackson\",\n \"dida_email\": \"joej@gmail.com\",\n \"dida_phone\": \"+15846327845\",\n \"kyc_required\": true,\n \"rails_enabled\": [\n {\n \"rail\": \"crypto\",\n \"enabled\": true\n }\n ],\n \"notes\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/accounts/dida_account/update","urlObject":{"path":["accounts","dida_account","update"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccc617c3-0eb6-434d-a22e-4113ab739953"},{"name":"Enable Crypto Rails","id":"b4269e24-1621-48e0-b4f5-54c589f24c91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account_id\": \"fefc6a25-374b-4f6a-b716-337ce8fb9839\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/accounts/dida_account/enable_crypto_rails","urlObject":{"path":["accounts","dida_account","enable_crypto_rails"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4269e24-1621-48e0-b4f5-54c589f24c91"},{"name":"Enable Card Rails","id":"b7d9421d-af70-4a42-bc52-252cdb043004","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account_id\": \"88e2ac4b-2c17-45e5-bb69-aedf93fcf1ff\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/accounts/dida_account/enable_card_rails","urlObject":{"path":["accounts","dida_account","enable_card_rails"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7d9421d-af70-4a42-bc52-252cdb043004"},{"name":"Enable Local Rails","id":"af616536-16bd-4b7d-af34-f4d8a2d24a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account_id\": \"6638b45d-2d7b-4e12-b68a-5064aeb97fd8\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/accounts/dida_account/enable_local_rails","urlObject":{"path":["accounts","dida_account","enable_local_rails"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"af616536-16bd-4b7d-af34-f4d8a2d24a34"},{"name":"Get DIDA Transactions","id":"5091f1bb-ae84-4c26-82f1-ecb28671ea29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/accounts/dida_account/get_transactions/{{account}}","urlObject":{"path":["accounts","dida_account","get_transactions","{{account}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5091f1bb-ae84-4c26-82f1-ecb28671ea29"},{"name":"Get Inbound Wallet DIDA","id":"1dfa73e9-948d-4008-9a45-664ffab563ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqcmlvc0BibG94Y3Jvc3MuY29tIiwiY29tcGFueV9pZCI6Ijg5MDNiZWZiLTMyMmEtNDk4NS1hMGM2LTc1ZTEyN2IxYThkOCIsImxhc3RfbG9naW4iOiJ7XCJ0aW1lXCI6XCIyMDI1LTA3LTE1VDE5OjE5OjMwLjI4NTMwNFwiLFwiY2l0eVwiOlwiWmFyYWdvemFcIixcInJlZ2lvblwiOlwiQXJhZ29uXCIsXCJjb3VudHJ5XCI6XCJTcGFpblwiLFwibG9jYWxlXCI6XCJFdXJvcGUvTWFkcmlkXCJ9Iiwicm9sZXMiOlsiUk9MRV9EZWZhdWx0IFVzZXIiLCJQRVJNX2Nhbl9wYXlfdmVuZG9yIiwiUEVSTV9jYW5fcGF5X3BlZXIiLCJQRVJNX2Nhbl9kZXBvc2l0X2JhbmsiLCJQRVJNX2Nhbl9kZXBvc2l0X2NyeXB0byIsIlBFUk1fY2FuX2RlcG9zaXRfY2FzaCIsIlBFUk1fY2FuX3dpdGhkcmF3X2JhbmsiLCJQRVJNX2Nhbl93aXRoZHJhd19jcnlwdG8iLCJQRVJNX2Nhbl93aXRoZHJhd19jYXNoIiwiUEVSTV9jYW5fcGF5X21lX2NyZWRpdF9jYXJkIiwiUEVSTV9jYW5fcGF5X21lX3BsdWdpbnMiLCJQRVJNX2Nhbl9jb252ZXJ0IiwiUEVSTV9jYW5fcG9ydGZvbGlvX2Fzc2V0cyAiLCJQRVJNX2Nhbl9wb3J0Zm9saW9faGlzdG9yeSJdLCJpc3MiOiJzZWN1cml0eSIsInNlc3Npb25faWQiOiJjOWExZjg0MS0zMjk2LTQ3YTctYjJlZi01Y2U3NzJiNjViNzEiLCJzdWJfYWNjb3VudCI6ZmFsc2UsImNsaWVudF9pZCI6IjY1N2UzMjMwLTE5NDMtNGFkOS1iNDkxLTNhYjg0OTgzNjczMCIsInJlcXVpcmVkXzJmYV8ycHJvY2VlZCI6IkdPT0dMRV9BVVRIIiwibmJmIjoxNzUyNTk5OTcwLCJ1c2VyX2lkIjo0MzEzLCJkb21pY2lsZSI6IkNPIiwiY3VycmVuY3kiOiJVU0QiLCJhdXRoX2Nob2ljZSI6ImF1dGhfZW5hYmxlZCIsImV4cCI6MTc1Nzc4Mzk3MCwibGFuZyI6ImVuZyIsImlhdCI6MTc1MjU5OTk3MCwiZW1haWwiOiJqcmlvc0BibG94Y3Jvc3MuY29tIn0.4G0RIwa2zPwFC4OOULtvXLzS3-3f79JMBFPdnFwRz0w"}],"body":{"mode":"raw","raw":"{\n \"coin\":\"USDT\",\n \"blockchain\": \"trx\",\n \"didaId\":\"b845d800-0707-4834-aa43-ec4ff9a90bfd\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/wallets/get_dida_inbound_wallet","description":"Generated from cURL: curl --location 'https://api.bloxcross-dev.com/wallets/get_dida_inbound_wallet'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqcmlvc0BibG94Y3Jvc3MuY29tIiwiY29tcGFueV9pZCI6Ijg5MDNiZWZiLTMyMmEtNDk4NS1hMGM2LTc1ZTEyN2IxYThkOCIsImxhc3RfbG9naW4iOiJ7XCJ0aW1lXCI6XCIyMDI1LTA3LTE1VDE5OjE5OjMwLjI4NTMwNFwiLFwiY2l0eVwiOlwiWmFyYWdvemFcIixcInJlZ2lvblwiOlwiQXJhZ29uXCIsXCJjb3VudHJ5XCI6XCJTcGFpblwiLFwibG9jYWxlXCI6XCJFdXJvcGUvTWFkcmlkXCJ9Iiwicm9sZXMiOlsiUk9MRV9EZWZhdWx0IFVzZXIiLCJQRVJNX2Nhbl9wYXlfdmVuZG9yIiwiUEVSTV9jYW5fcGF5X3BlZXIiLCJQRVJNX2Nhbl9kZXBvc2l0X2JhbmsiLCJQRVJNX2Nhbl9kZXBvc2l0X2NyeXB0byIsIlBFUk1fY2FuX2RlcG9zaXRfY2FzaCIsIlBFUk1fY2FuX3dpdGhkcmF3X2JhbmsiLCJQRVJNX2Nhbl93aXRoZHJhd19jcnlwdG8iLCJQRVJNX2Nhbl93aXRoZHJhd19jYXNoIiwiUEVSTV9jYW5fcGF5X21lX2NyZWRpdF9jYXJkIiwiUEVSTV9jYW5fcGF5X21lX3BsdWdpbnMiLCJQRVJNX2Nhbl9jb252ZXJ0IiwiUEVSTV9jYW5fcG9ydGZvbGlvX2Fzc2V0cyAiLCJQRVJNX2Nhbl9wb3J0Zm9saW9faGlzdG9yeSJdLCJpc3MiOiJzZWN1cml0eSIsInNlc3Npb25faWQiOiJjOWExZjg0MS0zMjk2LTQ3YTctYjJlZi01Y2U3NzJiNjViNzEiLCJzdWJfYWNjb3VudCI6ZmFsc2UsImNsaWVudF9pZCI6IjY1N2UzMjMwLTE5NDMtNGFkOS1iNDkxLTNhYjg0OTgzNjczMCIsInJlcXVpcmVkXzJmYV8ycHJvY2VlZCI6IkdPT0dMRV9BVVRIIiwibmJmIjoxNzUyNTk5OTcwLCJ1c2VyX2lkIjo0MzEzLCJkb21pY2lsZSI6IkNPIiwiY3VycmVuY3kiOiJVU0QiLCJhdXRoX2Nob2ljZSI6ImF1dGhfZW5hYmxlZCIsImV4cCI6MTc1Nzc4Mzk3MCwibGFuZyI6ImVuZyIsImlhdCI6MTc1MjU5OTk3MCwiZW1haWwiOiJqcmlvc0BibG94Y3Jvc3MuY29tIn0.4G0RIwa2zPwFC4OOULtvXLzS3-3f79JMBFPdnFwRz0w'
--data '{\n \"coin\":\"BTC\",\n \"blockchain\": \"btc\",\n \"didaId\":\"38934abe-6433-4bc5-8e50-c4524b68b95a\"\n}'
Blox account holder can create n number of DiDa accounts to
receive Payments.
Create a Digital Deposit Account to be able to know who paid you.
\nThis is for Outside initiated Payments
\nThese are no-login account (or Reports only), Deposit-only
accounts, no Payouts or any other services enabled
Enable Auto-Consolidation – as deposits come in, send to Blox
Holder account - or Manual
Types of account:
\nKYC/KYB required
\nNo KYB
\nTypes of Payment rails:
\nCrypto
\nCard
\nLocal Rails
\nBlox Account holder will see Deposits in his regular account, but
with the added information of:
Who it was from
\nRail used
\nBlox account holder can disable any DiDa account
Blox client can run reports per DiDa Account as well as aggregate
reports
When Deposits come in, the following process happens:
\nDEPOSIT registered in the DiDa Portfolio
\nWITHDRAW from DiDa and DEPOSIT to Blox Account
Holder
Notification generated for Blox Account Holder
\nIf Digital Assets Deposited, then Deposit is transferred
from the DiDa vault to the Blox Account vault
Full Blox account, under an account Parent
Only available to enabled clients with this Service Enabled
Parent account can:
• Create/Delete Child Accounts
• View Child Accounts
• Set Rates
• Debit/Credit Adjustments to Child Accounts
• Enable/Disable Modules
• Enable/Disable Sources/Hold/Destinations
• Run reports individually or in aggregate
Enhanced security for Parent manager
All Child Accounts need to be KYC/KYB cleared
There are two modes to create a Child Account:
Gen-Link: Create a link for Client to Register
\nGen-Account: Create an account and send a password
reset Link
Client still required to provide KYC/KYB Information and validate
email/phone to fully use account
Another Portfolio Account
\nOnly accessible to this Entity/User
\nNo separate Login, added to the same login
\nLimited, more Sub-Accounts will be charged
\nBlox account holder can disable any Sub account
\nBlox client can run reports per Sub Account as well as aggregate
reports
Corporate Accounts can be of these types:
\nBase Accounts: independent Corporate Accounts
\nDigital Deposit Account (DiDa): This is for Outside initiated Payments. These are no-login account (or Reports only), Deposit-only
accounts, no Payouts or any other services enabled
Child Accounts: Full Blox account, under an account Parent
\nSub-Accounts: A second Portfolio Account. Only accessible to this Entity/User. No separate Login, added to the same login
\nDIDA, Child and Sub Accounts need to be Enabled
\n","_postman_id":"63c12c9f-e11b-4385-9bb4-677fbe379177"},{"name":"INDIVIDUAL","item":[{"name":"INDIVIDUAL ACCOUNT","item":[{"name":"New individualAccount","id":"207a844b-d6fb-48ce-a2cf-f1a5faad2223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"KR1IeAL2DwGLyXcCwjMV4cclghlg2ltJHcxOdSAxJhGMZWFdUpJosldXxrOqZoTF","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fname\":\"Diego\",\n \"lname\":\"Test2\",\n \"email\":\"baezd@yahoo.com\",\n \"phone\":\"+12122561693\",\n \"password\":\"My$tandard15\",\n \"domicile\":\"CO\",\n \"language\":\"eng\",\n \"preferred_currency\": \"USD\",\n \"ref_code\": \"123456\",\n \"person_type\": \"individual\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/register/v2/simple","description":"This endpoint allows for the registration of a new user in the system. It utilizes the HTTP POST method to submit user information.
\nEndpoint: {{apiurl}}/register/v2/simple
The request body must be in JSON format and include the following parameters:
\nfname (string): The first name of the user.
\nlname (string): The last name of the user.
\nemail (string): The email address of the user.
\nphone (string): The phone number of the user, including the country code.
\npassword (string): The password for the user's account.
\ndomicile (string): The user's place of residence, typically represented by a state or region code.
\nlanguage (string): The preferred language of the user.
\npreferred_currency (string): The currency the user prefers for transactions.
\nref_code (string): A referral code, if applicable.
\nperson_type (string): Indicates whether the user is an individual or a business.
\nUpon successful registration, the API will return a response indicating the status of the request, typically in JSON format. The response will include relevant details about the registration outcome, such as success confirmation or error messages if applicable.
\nEnsure that all required parameters are provided in the request body to avoid errors during the registration process.
\n","urlObject":{"path":["register","v2","simple"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"207a844b-d6fb-48ce-a2cf-f1a5faad2223"},{"name":"[LOCKED] New Account - Send Link","id":"052280ba-dfa5-49c0-a026-fb7d7687c72c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{apiurl}}/v202506/account/individual/new_link","urlObject":{"path":["v202506","account","individual","new_link"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"052280ba-dfa5-49c0-a026-fb7d7687c72c"},{"name":"[LOCKED] New Account - Send Password Change Only","id":"0152ef7b-d9af-4072-a05a-3f4dade64a07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{apiurl}}/v202506/account/individual/new_on_behalf","urlObject":{"path":["v202506","account","individual","new_on_behalf"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0152ef7b-d9af-4072-a05a-3f4dade64a07"}],"id":"b36f4e4d-ed37-4a44-ba0b-a38a9854bc7f","_postman_id":"b36f4e4d-ed37-4a44-ba0b-a38a9854bc7f","description":""}],"id":"3c79e114-7663-4015-8882-62494cb96d4d","_postman_id":"3c79e114-7663-4015-8882-62494cb96d4d","description":""}],"id":"e5543741-b4c6-4c09-af6f-113adc41d723","description":"All interactions with the system, past the iniital registration, require a registered user. This applies to:
\nAdministrators setting Up a Payment Company or Entity
\nContent or Service Providers
\nClients who will purchase or subscribe to products
\nThe registration is a three step process:
\nRegister the User (Register)
\nValidate the Phone Number (Confirm to Send a code + Validate to validate the code)
\nValidate the Email (Confirm to Send a code + Validate to validate the code)
\nOnce the Email and Phone are validated, everytime the user logs in there is a 2FA process to validate the loogin, with SMS being the default method to receive the code. The code is always validated using the Validae method.
\nYou can open Individual Accounts or Corporate Accounts with Blox.
\n","_postman_id":"e5543741-b4c6-4c09-af6f-113adc41d723"},{"name":"DEPOSIT","item":[{"name":"[DEV_ONLY] deposit","id":"2f91f5a6-f5b3-4e98-9d1a-83e8b3c88f21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"portfolio_name\": \"My Portfolio\",\n\"instrument\": \"USDT\",\n\"qty\": 5000005,\n\"cost_basis\": 1,\n\"from\": \"Treasury\",\n\"notes\": \"Dev Deposit\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/portfolio/deposit","description":"This is development only ENDPOINT
\nThis endpoint allows users to add a deposit to a specified portfolio. It is designed to facilitate the management of financial instruments within a user's portfolio by recording deposits with relevant details.
\nMethod: POST
Endpoint: {{apiurl}}/portfolio/deposit
Request Body:
The request body must be in JSON format and include the following parameters:
portfolio_name (string): The name of the portfolio to which the deposit is being added.
\ninstrument (string): The type of financial instrument being deposited (e.g., currency, stock).
\nqty (number): The quantity of the instrument being deposited.
\ncost_basis (number): The cost basis for the deposited quantity, representing the original value of the asset.
\nfrom (string): The source from which the deposit is made (e.g., Treasury).
\nnotes (string): Any additional notes regarding the deposit.
\nExample Request Body:
\n{\n \"portfolio_name\": \"My Portfolio\",\n \"instrument\": \"USDT\",\n \"qty\": 5000005,\n \"cost_basis\": 1,\n \"from\": \"Treasury\",\n \"notes\": \"Dev Deposit\"\n}\n\nThe response will contain the details of the deposit that has been added to the portfolio. The structure of the response typically includes confirmation of the deposit along with any relevant metadata, such as:
\nstatus (string): Indicates the success or failure of the deposit operation.
\nmessage (string): A message providing additional information about the result of the request.
\ndeposit_id (string): A unique identifier for the deposit transaction.
\nThis endpoint is essential for users looking to manage their portfolios effectively by keeping track of deposits and ensuring accurate financial records.
\n","urlObject":{"path":["portfolio","deposit"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f91f5a6-f5b3-4e98-9d1a-83e8b3c88f21"}],"id":"3b8e1016-3aae-4896-9400-1a3d6ee9f591","_postman_id":"3b8e1016-3aae-4896-9400-1a3d6ee9f591","description":""},{"name":"WITHDRAW","item":[{"name":"[DEV_ONLY] withdraw","id":"570fef79-5188-40e4-b4c2-c8c59787ea74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"portfolio_name\": \"My Portfolio\",\n\"withdraw_to\": \"My Wallet at another custodian\",\n\"instrument\": \"USD\",\n\"qty\": 943260.00578009,\n\"notes\": \"Wired from Chase\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/portfolio/withdraw","description":"This is a DEVELOPMENT ONLY endpoint
\nThis endpoint allows users to withdraw funds from a specified portfolio. The request requires details about the portfolio, the destination for the withdrawal, the instrument type, the quantity to withdraw, and any additional notes.
\nportfolio_name (string): The name of the portfolio from which funds are being withdrawn.
\nwithdraw_to (string): The destination where the withdrawn amount will be sent, such as a wallet or bank account.
\ninstrument (string): The type of currency or asset to be withdrawn (e.g., USD).
\nqty (number): The quantity of the specified instrument to withdraw.
\nnotes (string): Additional information or instructions related to the withdrawal.
\nUpon a successful request, the API will return a confirmation of the withdrawal, including details such as the transaction ID and the status of the operation. In case of an error, an appropriate error message will be provided.
\nEnsure that the portfolio name and withdrawal destination are correctly specified to avoid errors.
\nThe quantity must be within the available balance in the portfolio.
\nAdditional notes can be used to provide context or instructions for the withdrawal process.
\nperson_type is one of: individual, business
\n","urlObject":{"path":["vendors","new_vendor"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"31171d6a-28c9-4669-bbf4-b9edee46f887","name":"Create Vendor","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vendor_name\": \"Vendor_4\",\n \"vendor_last_name\":\"vendorLastName\",\n \"vendor_email\": \"vendor_4@gmail.com\",\n \"vendor_phone\": \"+19853253544\",\n \"vendor_location\": \"US\",\n \"vendor_phone_country\": \"US\",\n \"vendor_address\": \"\",\n \"vendor_city\":\"\",\n \"vendor_sub_division\":\"\",\n \"vendor_postal_code\":\"\",\n \"person_type\":\"individual\",\n \"web_site\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/vendors/new_vendor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:44:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 0,\n \"payload\": \"3d3a2e57-f61b-461e-a188-46bc4d9debed\"\n}"}],"_postman_id":"dfefe7d0-4a32-4afb-ab55-fbb295f099a1"},{"name":"Get My Vendors","id":"186f7b20-eed3-4236-a856-e84ddd7b301d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/my_vendors","description":"Returns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nMetadata MUST include all fileds for this pay_method_typ[e which are labeled \"mandatory\": true
\n","urlObject":{"path":["vendors","new_vendor_account"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"15092eb6-a3e8-40b9-94eb-71237ea65c7c","name":"Create Vendor Payment Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"pay_account_name\": \"BofA-9999=ach2\",\n \"pay_method_type\": \"ach\",\n \"client_vendor_id\": \"298ec5b8-be7c-44c4-a918-2f75f18b7fe0\",\n \"metadata\": {\n \"acount_name\": \"Sal Mobile\",\n \"routing_number\": \"547596521\",\n \"account_number\": \"54871213465\",\n \"account_type\": \"CHECKING\",\n \"account_class\": \"BUSINESS\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/vendors/new_vendor_account"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:45:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"143"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"code\": 1000000,\n \"payload\": \"Payment Method Already Exists for this vendor, Only one Pay-Method-Type per vendor allowed: [ach] \"\n}"},{"id":"e3bfd98e-367e-40d2-b1b9-fef9e0d7457f","name":"Create Vendor Payment Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"pay_account_name\": \"BofA-7632-ach\",\n \"pay_method_type\": \"ach\",\n \"client_vendor_id\": \"73c79d25-dc0b-4949-8c51-29fc9ca47808\",\n \"metadata\": {\n \"acount_name\": \"Sal Mobile\",\n \"routing_number\": \"547596521\",\n \"account_number\": \"54871213465\",\n \"account_type\": \"CHECKING\",\n \"account_class\": \"BUSINESS\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/vendors/new_vendor_account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:46:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 0,\n \"payload\": \"2c355d95-7baf-419f-9305-6ef09b68e243\"\n}"}],"_postman_id":"583c3f75-5c82-4fed-85a2-f5fdeaa93b1f"},{"name":"Get My Vendor Accounts","id":"c17bb03e-2e22-4486-992a-2fc78852972b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/vendors/my_vendor_accounts","description":"Returns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\n\nThe 2fa code must be generate from other endpoint
\n","urlObject":{"path":["vendors","pay_vendor_with_2fa"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"493d7fd3-ece1-4c2b-9d1e-19f019d2ae66","name":"Pay Vendor","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"payment_account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\",\n \"amount\": 480,\n \"pay_currency\": \"USD\",\n \"source_currency\": \"ETH\",\n \"description\":\"Pay 1\",\n \"external_memo\": \"For you\",\n \"metadata\": {\n \"purpose\": \"For me\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/vendors/pay_vendor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:46:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"106"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"code\": 1000212,\n \"payload\": \"No Vendor Account Found: 2c777e8f-bbe5-4416-ad2a-e2079061a30d\"\n}"},{"id":"aa43ae29-e22b-41ed-8af7-a6ef4256b59c","name":"Pay Vendor","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"payment_account_id\": \"a130b7f5-63eb-4de1-b3ef-65375e1c813b\",\n \"amount\": 480,\n \"pay_currency\": \"USD\",\n \"source_currency\": \"ETH\",\n \"description\":\"Pay 1\",\n \"external_memo\": \"For you\",\n \"metadata\": {\n \"purpose\": \"For me\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/vendors/pay_vendor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:47:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 0,\n \"payload\": \"Payment Request Sent \"\n}"}],"_postman_id":"70827b04-9947-45f1-9fdf-0b930a7f928a"},{"name":"Get Vendor Payment Activity","id":"0e3a3c35-c0d0-4804-9ef8-535f11748f5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vendor_id\": \"31684efc-f829-40f9-ae6b-984ae899957b\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_vendor_payments","description":"experience is one of: TRADED_BEFORE, NEVER_TRADED_BEFORE, PREFER_NOT_DIVULGE;
\n","urlObject":{"path":["payments","get_vendor_payments"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"73ebcf7e-aa5f-4dcc-b69a-984d2274a523","name":"Get Vendor Payments","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vendor_id\": \"31684efc-f829-40f9-ae6b-984ae899957b\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_vendor_payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:47:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"553"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"creation_time\": \"2023-07-11T06:50:46.11939+00:00\",\n \"vendor\": \"vendor_3\",\n \"account\": \"chase-6404-wire\",\n \"account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\",\n \"description\": \"Pay 1\",\n \"amount\": 5,\n \"paid_with\": \"0.0026767569697398 ETH @ 1867.932000\",\n \"notes\": \"{\\\"purpose\\\":\\\"For me\\\"}\"\n },\n {\n \"creation_time\": \"2023-07-11T06:49:30.298482+00:00\",\n \"vendor\": \"vendor_3\",\n \"account\": \"chase-6404-wire\",\n \"account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\",\n \"description\": \"Pay 1\",\n \"amount\": 4.8,\n \"paid_with\": \"0.0025718676259733 ETH @ 1866.348000\",\n \"notes\": \"{\\\"purpose\\\":\\\"For me\\\"}\"\n }\n]"}],"_postman_id":"0e3a3c35-c0d0-4804-9ef8-535f11748f5f"},{"name":"Get Vendor Account Payment Activity","id":"012cade2-629c-4873-91cd-a0fa35b88db5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vendor_account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_vendor_account_payments","description":"experience is one of: TRADED_BEFORE, NEVER_TRADED_BEFORE, PREFER_NOT_DIVULGE;
\n","urlObject":{"path":["payments","get_vendor_account_payments"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"582cf91f-629e-48a1-bafa-7cabb83fe34c","name":"Get Vendor Account Payments","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vendor_account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_vendor_account_payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:48:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"553"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"creation_time\": \"2023-07-11T06:50:46.11939+00:00\",\n \"vendor\": \"vendor_3\",\n \"account\": \"chase-6404-wire\",\n \"account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\",\n \"description\": \"Pay 1\",\n \"amount\": 5,\n \"paid_with\": \"0.0026767569697398 ETH @ 1867.932000\",\n \"notes\": \"{\\\"purpose\\\":\\\"For me\\\"}\"\n },\n {\n \"creation_time\": \"2023-07-11T06:49:30.298482+00:00\",\n \"vendor\": \"vendor_3\",\n \"account\": \"chase-6404-wire\",\n \"account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\",\n \"description\": \"Pay 1\",\n \"amount\": 4.8,\n \"paid_with\": \"0.0025718676259733 ETH @ 1866.348000\",\n \"notes\": \"{\\\"purpose\\\":\\\"For me\\\"}\"\n }\n]"}],"_postman_id":"012cade2-629c-4873-91cd-a0fa35b88db5"},{"name":"Close Vendor Account","id":"6f1b6d94-5bf1-43c9-8e42-e4d553839eb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_vendor_id\": \"18d011cb-1371-4bbb-bd1d-27d65720339b\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/close_vendor_account","description":"experience is one of: TRADED_BEFORE, NEVER_TRADED_BEFORE, PREFER_NOT_DIVULGE;
\n","urlObject":{"path":["payments","close_vendor_account"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"1f8056f0-0c14-413f-a0d5-e141489ef6e4","name":"Get Vendor Payments","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vendor_id\": \"31684efc-f829-40f9-ae6b-984ae899957b\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_vendor_payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jul 2023 08:47:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"553"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"creation_time\": \"2023-07-11T06:50:46.11939+00:00\",\n \"vendor\": \"vendor_3\",\n \"account\": \"chase-6404-wire\",\n \"account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\",\n \"description\": \"Pay 1\",\n \"amount\": 5,\n \"paid_with\": \"0.0026767569697398 ETH @ 1867.932000\",\n \"notes\": \"{\\\"purpose\\\":\\\"For me\\\"}\"\n },\n {\n \"creation_time\": \"2023-07-11T06:49:30.298482+00:00\",\n \"vendor\": \"vendor_3\",\n \"account\": \"chase-6404-wire\",\n \"account_id\": \"2c777e8f-bbe5-4416-ad2a-e2079061a30d\",\n \"description\": \"Pay 1\",\n \"amount\": 4.8,\n \"paid_with\": \"0.0025718676259733 ETH @ 1866.348000\",\n \"notes\": \"{\\\"purpose\\\":\\\"For me\\\"}\"\n }\n]"}],"_postman_id":"6f1b6d94-5bf1-43c9-8e42-e4d553839eb7"}],"id":"6aad591c-cc28-4f44-87cc-ba4e58f36558","description":"External Payments are defined an transfering Assets to external destinations such as banks
\n","_postman_id":"6aad591c-cc28-4f44-87cc-ba4e58f36558"},{"name":"In-Network Payments","item":[{"name":"Check Peer","id":"9d782107-203c-4428-921c-37dd0bd35e90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key\":\"scataudella@bloxcross.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/v2/check_peer","description":"This method returns the name, phone and email of a peer given a phone or an email
\nbody:
\nMethond to send Value to another Blox User
\nPre-Requisites: It requires that a 2FA code is sent to the Sending client using the clients default 2FA method. For example if the client is using SMS to validate login then the method
\nReturns
\n - Human Readable Instructions\n\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\n\nPOST https://api.blox.services/wallets/get_inbound_wallet
Content-Type: application/jsonAuthorization: BearerThe request body should be a JSON object containing the following parameters:
\ncoin (string): The identifier for the cryptocurrency. Example: \"USDC\".blockchain (string): The blockchain network for the transaction. Example: \"eth\".{\n \"coin\": \"USDC\",\n \"blockchain\": \"eth\"\n}\n\nThe response will be a JSON object containing the details of the inbound wallet, including the wallet address, the blockchain network, and a QR code for easy access.
\n{\n \"inbound_address\": \"0x907B4410bB5Ba13586C46106090831775BA826bd\",\n \"blockchain\": \"eth\",\n \"qr_code\": \"iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQAQAAAACoxAthAAAB+klEQVR4Xu2XMZKEMAwEfRHP4KnmqTzDEZxnJGCBvbpSiJgOjI3UjqbEblnDlOuL/5ESRUoUKVGkRJESRUoUKVGkRJECluIM/TAPS6lrK1h++nGrVSlZFTuze4aH7mm0d6cWKadzEgW58G4esfMbECeGSEpyxctlRGDYKOU9ympDYio4YmasUl6g8Mny2NjNG3DXcGqRklBxrOe8bDUpSZVPplL6kGBgOC6uSLnydMUDY+EYG/4hNGz57bDjLkvJpqDSvcqY+KTwu+zInZScCiqWmZ4LdDMwmwdugZGSSDmGRPVw+DXbcUcKyKUwHFMhA2/wHRXinpRsyh3cwCHBEJURt1pFyneeqyAhbOwfi8niAfBu4mJ/HYgUkElZ0Y2BYAlheR8hNj2kZFYIPJYnbEi1SvvrYyHl8cqCIiLBwCAr3uhyZX6kZFV45miwITEiITMnBap450hJqMx7LtBYkZXVdrwQRylpFTymAg+NzrG7/VCUkkY5WDAfHJsZ/s5vlbKVN56vLNeE2PSwZUD3l3EhJY1S+ZwHLMdosAKVcguMnaVkUK7haJ/5IVLeoGDxLwa8seGPY5PyCqXHhD8Ze2pmTg9cYyGSklXh0xUEBj24pu+QFSmZFWdAdLaF0fGq7aRkVCJIiSIlipQoUqJIiSIlipQoUqJIifILkLf6r7Kc+hsAAAAASUVORK5CYII=\"\n}\n\ninbound_address (string): The address of the inbound wallet.blockchain (string): The blockchain network associated with the wallet. Example: \"eth\".qr_code (string): A base64 encoded image of a QR code representing the inbound address for easy scanning.curl --location 'https://api.blox.services/wallets/get_inbound_wallet' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer ' \\\n--data '{\n \"coin\": \"USDC\",\n \"blockchain\": \"eth\"\n}'\n\nAuthorization header contains a valid JWT token.coin should be specified as a string representing the cryptocurrency.blockchain should be specified as a string representing the blockchain network.This endpoint is used to retrieve the inbound wallet address for a specific cryptocurrency on a specified blockchain network. The response includes the wallet address and a QR code for convenient access and use.
\n","urlObject":{"path":["wallets","get_inbound_wallet"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bad4fba-2ea5-4c98-ab57-ef4a93dc6670"},{"name":"withdraw Coins to wallet","id":"fd036a50-e53c-4b4e-a8ff-1ddd20a99491","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"portfolio_id\": \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\",\n \"target_wallet_address\":\"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\",\n \"token\":\"ETH\",\n \"blockchain\": \"eth\",\n \"qty\": 0.014\n\n}\n","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/wallets/withdraw_crypto","description":"POST https://api.blox.services/wallets/withdraw_crypto
Content-Type: application/jsonAuthorization: BearerThe request body should be a JSON object containing the following parameters:
\nportfolio_id (string): The unique identifier for the portfolio. Example: \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\".target_wallet_address (string): The address of the target wallet to which the cryptocurrency will be sent. Example: \"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\".token (string): The identifier for the cryptocurrency. Example: \"ETH\".blockchain (string): The blockchain network for the transaction. Example: \"eth\".qty (number): The quantity of the cryptocurrency to be withdrawn. Example: 0.01.fee (number): The transaction fee for the withdrawal. Example: 0.00015.{\n \"portfolio_id\": \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\",\n \"target_wallet_address\": \"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\",\n \"token\": \"ETH\",\n \"blockchain\": \"eth\",\n \"qty\": 0.01,\n \"fee\": 0.00015\n}\n\nThe response will be a JSON object indicating the success of the withdrawal request, along with a response code and any additional payload.
\n{\n \"success\": true,\n \"code\": 0,\n \"payload\": \"\"\n}\n\nsuccess (boolean): Indicates whether the withdrawal was successful.code (number): The response code. Example: 0.payload (string): Additional information or payload related to the response. In this case, it is an empty string.curl --location 'https://api.blox.services/wallets/withdraw_crypto' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer ' \\\n--data '{\n \"portfolio_id\": \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\",\n \"target_wallet_address\": \"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\",\n \"token\": \"ETH\",\n \"blockchain\": \"eth\",\n \"qty\": 0.01,\n \"fee\": 0.00015\n}'\n\nAuthorization header contains a valid JWT token.portfolio_id should be a valid UUID representing the user's portfolio.target_wallet_address should be a valid wallet address on the specified blockchain.token should be specified as a string representing the cryptocurrency.blockchain should be specified as a string representing the blockchain network.qty should be specified as a number representing the quantity of cryptocurrency to be withdrawn.fee should be specified as a number representing the transaction fee for the withdrawal.This endpoint is used to withdraw a specified amount of cryptocurrency from a user's portfolio to a target wallet address on a specified blockchain network. The response indicates the success of the withdrawal request.
\n","urlObject":{"path":["wallets","withdraw_crypto"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"35042ec3-d08e-4801-a16a-a31e399a4b99","name":"withdraw Coins XLM","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"portfolio_id\": \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\",\n \"target_wallet_address\":\"GBKWVINUOPUY2AORT3AFYTOEVDWTIVVAXKYEO2CUC4FYSX2R7ZJRSQNB\",\n \"token\":\"XLM\",\n \"blockchain\": \"xlm\",\n \"qty\": 0.014\n\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.bloxcross-dev.com/wallets/withdraw_crypto"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fd036a50-e53c-4b4e-a8ff-1ddd20a99491"},{"name":"withdraw Coins 2fa Copy","id":"730f9d62-fdf6-4c67-9f77-b12094a6b7ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"portfolio_id\": \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\",\n \"target_wallet_address\":\"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\",\n \"token\":\"ETH\",\n \"blockchain\": \"eth\",\n \"qty\": 0.01,\n \"fee\": 0.00015,\n \"code\": \"316898\"\n\n\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/wallets/withdraw_with_2fa","description":"POST https://api.blox.services/wallets/withdraw_with_2fa
Content-Type: application/jsonAuthorization: BearerThe request body should be a JSON object containing the following parameters:
\nportfolio_id (string): The unique identifier for the portfolio. Example: \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\".target_wallet_address (string): The address of the target wallet to which the cryptocurrency will be sent. Example: \"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\".token (string): The identifier for the cryptocurrency. Example: \"ETH\".blockchain (string): The blockchain network for the transaction. Example: \"eth\".qty (number): The quantity of the cryptocurrency to be withdrawn. Example: 0.01.fee (number): The transaction fee for the withdrawal. Example: 0.00015.code (string): The 2FA code required for authorization. Example: \"316898\".{\n \"portfolio_id\": \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\",\n \"target_wallet_address\": \"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\",\n \"token\": \"ETH\",\n \"blockchain\": \"eth\",\n \"qty\": 0.01,\n \"fee\": 0.00015,\n \"code\": \"316898\"\n}\n\nThe response will be a JSON object indicating the success of the withdrawal request, along with a response code and any additional payload.
\n{\n \"success\": true,\n \"code\": 0,\n \"payload\": \"\"\n}\n\nsuccess (boolean): Indicates whether the withdrawal was successful.code (number): The response code. Example: 0.payload (string): Additional information or payload related to the response. In this case, it is an empty string.curl --location 'https://api.blox.services/wallets/withdraw_with_2fa' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer ' \\\n--data '{\n \"portfolio_id\": \"97429fa8-4bf1-46c4-a28c-bf4b7a1494ba\",\n \"target_wallet_address\": \"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\",\n \"token\": \"ETH\",\n \"blockchain\": \"eth\",\n \"qty\": 0.01,\n \"fee\": 0.00015,\n \"code\": \"316898\"\n}'\n\nAuthorization header contains a valid JWT token.portfolio_id should be a valid UUID representing the user's portfolio.target_wallet_address should be a valid wallet address on the specified blockchain.token should be specified as a string representing the cryptocurrency.blockchain should be specified as a string representing the blockchain network.qty should be specified as a number representing the quantity of cryptocurrency to be withdrawn.fee should be specified as a number representing the transaction fee for the withdrawal.code should be specified as a string representing the 2FA code required for authorization.This endpoint is used to withdraw a specified amount of cryptocurrency from a user's portfolio to a target wallet address on a specified blockchain network, with an additional layer of security provided by two-factor authentication (2FA). The response indicates the success of the withdrawal request.
\n","urlObject":{"path":["wallets","withdraw_with_2fa"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"730f9d62-fdf6-4c67-9f77-b12094a6b7ff"},{"name":"Get token inbound Networks","id":"34ff3608-623a-4dee-b55f-af5182c7a49e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"coin\": \"BTC\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/wallets/get_inbound_networks_for_token","description":"This endpoint allows users to retrieve information about the inbound networks available for a specified cryptocurrency token.
\nMethod: POST
\nEndpoint: {{apiurl}}/wallets/get_inbound_networks_for_token
Request Body: The request must include a JSON payload with the following structure:
\ncoin (string): The symbol of the cryptocurrency for which the inbound networks are being queried (e.g., \"BTC\" for Bitcoin).Example Request Body:
\n{\n \"coin\": \"BTC\"\n}\n\nUpon a successful request, the server will respond with a status code of 200 and a JSON array containing details about the inbound networks for the specified token. The structure of the response is as follows:
An array of objects, where each object contains:
\ncoin (string): The symbol of the cryptocurrency.
blockchain (string): The blockchain associated with the token.
native_token (boolean): Indicates if the token is a native token on the blockchain.
description (string): A brief description of the token or network.
wallet_direction (string): The direction of the wallet (e.g., inbound or outbound).
Example Response:
\n[\n {\n \"coin\": \"\",\n \"blockchain\": \"\",\n \"native_token\": true,\n \"description\": \"\",\n \"wallet_direction\": \"\"\n }\n]\n\nThis endpoint is useful for developers and users who need to understand the available networks for a specific cryptocurrency, enabling them to make informed decisions regarding wallet operations.
\n","urlObject":{"path":["wallets","get_inbound_networks_for_token"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"34ff3608-623a-4dee-b55f-af5182c7a49e"},{"name":"Get token Outbound Networks","id":"346ecc72-ea88-404f-b2f3-04a1cc5d780f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"coin\": \"BTC\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/wallets/get_outbound_networks_for_token","description":"This endpoint retrieves the outbound networks associated with a specified cryptocurrency token. It is particularly useful for applications that need to understand the available networks for transferring a given token.
\nMethod: POST
\nURL: {{apiurl}}/wallets/get_outbound_networks_for_token
Content-Type: application/json
\nThe request body must be in JSON format and should include the following parameter:
\n\"BTC\".Example Request Body:
\n{\n \"coin\": \"BTC\"\n}\n\nOn a successful request, the server responds with a status code of 200 and a JSON array containing the outbound networks for the specified token. The structure of the response is as follows:
\ncoin (string): The symbol of the cryptocurrency.
\nblockchain (string): The blockchain associated with the outbound network.
\nnative_token (boolean): Indicates whether the token is a native token on the blockchain.
\ndescription (string): A brief description of the network.
\nwallet_direction (string): The direction of the wallet (e.g., inbound or outbound).
\nExample Response:
\n[\n {\n \"coin\": \"\",\n \"blockchain\": \"\",\n \"native_token\": true,\n \"description\": \"\",\n \"wallet_direction\": \"\"\n }\n]\n\nThis endpoint is essential for applications that need to facilitate transactions involving specific cryptocurrencies, allowing developers to dynamically retrieve network information based on the token provided.
\n","urlObject":{"path":["wallets","get_outbound_networks_for_token"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"346ecc72-ea88-404f-b2f3-04a1cc5d780f"},{"name":"Validate Address","id":"267cddfe-69d4-4bfa-8470-d47dddba3868","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"coin\": \"usdt\",\n \"blockchain\": \"trx\",\n \"address2validate\": \"TJFxhq46QwTpXbA1dq9nNbzFfKgSmmWFVd\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/wallets/validate_address","description":"Returns the levels of service and fee for each, for example:
\n{
\n\"standard\":{\"fee\":0.001,\"estimated_time\":10000},
\n\"fast\": {\"fee\":0.01,\"estimated_time\":5000},
\n\"expedited\": {\"fee\":0.015,\"estimated_time\":1000}
\n\"fee_optimized\": {\"fee\":0.005,\"estimated_time\":25000},
\n}
\n","urlObject":{"path":["wallets","validate_address"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"267cddfe-69d4-4bfa-8470-d47dddba3868"},{"name":"validate_address_btrace","id":"47a06be8-635b-487f-b778-a9bb4ba41baf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"address2validate\" : \"0xae835a376cbc417bea93c146ce5b8e9c835b3851\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/wallets/validate_address_btrace","description":"This endpoint validates a cryptocurrency wallet address to ensure it is correctly formatted and potentially usable. It is specifically designed to check the validity of addresses for a given blockchain.
\nMethod: POST
\nEndpoint: {{apiurl}}/wallets/validate_address_btrace
Content-Type: application/json
\nThe request body should be a JSON object containing the following parameter:
\naddress2validate (string): The wallet address that needs to be validated. This address should conform to the expected format for the specific blockchain.Example Request Body:
\n{\n \"address2validate\": \"0xae835a376cbc417bea93c146ce5b ...\"\n}\n\nOn successful validation, the API responds with a JSON object structured as follows:
\nsuccess (boolean): Indicates whether the validation was successful.
code (integer): A status code representing the result of the validation.
payload (string): Additional information or data related to the validation (if applicable). This may be empty.
Example Response:
\n{\n \"success\": true,\n \"code\": 0,\n \"payload\": \"\"\n}\n\n200 OK: The request was successful, and the address is valid.
\nOther status codes may indicate errors or issues with the request.
\nThis endpoint is useful for applications that require validation of wallet addresses before performing transactions or other operations involving cryptocurrency.
\n","urlObject":{"path":["wallets","validate_address_btrace"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"46a9fba8-d89d-4663-880d-9fa63c92cc5a","name":"valid address","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"address2validate\" : \"1AN3AMhN6rfKhtDcYAaoBEsTdNbBfFB5uw\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/wallets/validate_address_btrace"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"47a06be8-635b-487f-b778-a9bb4ba41baf"},{"name":"btrace-risk_score","id":"2b03972f-f399-4ed9-a898-d7f8a39d889e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"F272BC1381511CA8343093A4F3BA9EDA14C0B673","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": \"0xae835a376cbc417bea93c146ce5b8e9c835b3851\"\n}","options":{"raw":{"language":"json"}}},"url":"https://btrace.amlcrypto.io/api/v2/risk_score","urlObject":{"protocol":"https","path":["api","v2","risk_score"],"host":["btrace","amlcrypto","io"],"query":[],"variable":[]}},"response":[{"id":"7b0de32b-ae71-4ac8-9818-568c86a73b8b","name":"btrace-risk_score-455","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address\": \"0xcD82656b537189E76d54Eaf34df2B04209BdD8fA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://btrace.amlcrypto.io/api/v2/risk_score"},"code":455,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"This address has no transactions\"\n}"},{"id":"6ef1b3ab-28c3-46d9-974a-ae7064791214","name":"btrace-risk_score-200","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address\": \"0xae835a376cbc417bea93c146ce5b8e9c835b3851\"\n}","options":{"raw":{"language":"json"}}},"url":"https://btrace.amlcrypto.io/api/v2/risk_score"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"0xae835a376cbc417bea93c146ce5b8e9c835b3851\",\n \"report_hash\": \"100b5eb8-27e1-42ef-9936-7105e3bb27a5\",\n \"check_date\": \"2024-12-04 11:30:59\",\n \"data\": {\n \"risk_level\": \"Medium\",\n \"risk_score\": 69,\n \"transactions\": {\n \"description\": \"No info\",\n \"value\": 20,\n \"details\": null\n },\n \"counterparty\": {\n \"description\": \"Interact with high risk addresses\",\n \"value\": 77,\n \"details\": [\n {\n \"address\": \"0x5984c42f1c8514a75e9e5a236f14b3f705d0e2e9\",\n \"type\": \"sanctions\",\n \"address_name\": \"Garantex_deposit_0x5984\"\n },\n {\n \"address\": \"0x178a7e3c51f26b6f232fc35b7c8fae84be27d814\",\n \"type\": \"sanctions\",\n \"address_name\": \"Garantex_deposit_0x178a\"\n },\n {\n \"address\": \"0x332cdbe24c2cf4e774b804ab20e36d3b33da78d8\",\n \"type\": \"sanctions\",\n \"address_name\": \"Garantex_deposit_0x332c\"\n },\n {\n \"address\": \"0x3349f4fb93f1898197d3714f3f5764551996621a\",\n \"type\": \"sanctions\",\n \"address_name\": \"Garantex_deposit_0x3349\"\n },\n {\n \"address\": \"0xa27782b40f4db1675f8d6edaf6bf7560bd31f943\",\n \"type\": \"sanctions\",\n \"address_name\": \"Garantex_deposit_0xa277\"\n }\n ]\n },\n \"social_rating\": {\n \"description\": \"This address is assigned to account on btrace.amlcrypto.io\",\n \"value\": 34,\n \"details\": null\n }\n }\n}"},{"id":"5755b0c0-92b0-4708-9166-c93a8a6c99b3","name":"btrace-risk_score-422","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-API-Key","value":"F272BC1381511CA8343093A4F3BA9EDA14C0B673","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": \"0xae835a376cbc417bea93c146ce5b8e9c835b3851\"\n}","options":{"raw":{"language":"json"}}},"url":"https://btrace.amlcrypto.io/api/v2/risk_score"},"code":422,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\",\n 0\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"2b03972f-f399-4ed9-a898-d7f8a39d889e"},{"name":"EstimateFee","id":"00af6c33-4256-45ea-8fa4-a71e397b67fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assetId\": \"ETH\",\n \"blockchain\": \"eth\",\n \"amount\": \"0.100000\" \n}\n"},"url":"{{apiurl}}/wallets/estimateFee","description":"POST https://api.blox.services/wallets/estimateFee
Content-Type: application/jsonAuthorization: BearerThe request body should be a JSON object containing the following parameters:
\nassetId (string): The identifier for the asset. Example: \"ETH\".blockchain (string): The blockchain network for the transaction. Example: \"eth\".amount (string): The amount of the asset to be transferred. Example: \"0.100000\".{\n \"assetId\": \"ETH\",\n \"blockchain\": \"eth\",\n \"amount\": \"0.100000\"\n}\n\nThe response will be a JSON object containing the estimated fees for different levels of transaction urgency. Each level will include the cost of the transaction in the same asset as specified in the request.
\n{\n \"urgent\": {\n \"cost\": \"0.0004664341038\"\n },\n \"fast\": {\n \"cost\": \"0.0004664341038\"\n },\n \"normal\": {\n \"cost\": \"0.0004664341038\"\n }\n}\n\nurgent (object): Contains the cost of the transaction if processed urgently.cost (string): The estimated fee for an urgent transaction.fast (object): Contains the cost of the transaction if processed quickly but not as urgent.cost (string): The estimated fee for a fast transaction.normal (object): Contains the cost of the transaction if processed normally.cost (string): The estimated fee for a normal transaction.curl --location 'https://api.blox.services/wallets/estimateFee' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer ' \\\n--data '{\n \"assetId\": \"ETH\",\n \"blockchain\": \"eth\",\n \"amount\": \"0.100000\"\n}'\n\nAuthorization header contains a valid JWT token.amount should be specified as a string to ensure precision is maintained.This endpoint is used to estimate the transaction fee for transferring a specified amount of an asset on a particular blockchain network. The response provides fee estimates for different levels of urgency, allowing users to choose the most appropriate option for their needs.
\n","urlObject":{"path":["wallets","estimateFee"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"d7e0d2e1-81ce-49e4-b0f3-850894ab801f","name":"EstimatedFee","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assetId\": \"USDT\",\n \"blockchain\": \"eth\" \n}"},"url":"https://api.bloxcross-dev.com/v2/fireblocks/estimatedFee"},"status":"Ok","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Apr 2024 23:22:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"86"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Request-ID","value":"c90659c8d9c064f82e966635bcd7fb87"},{"key":"ETag","value":"W/\"56-5G8HeTRnHoFbrYWiAO2Tt42mSp8\""},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"low\": {\n \"gasPrice\": \"5.004\"\n },\n \"medium\": {\n \"gasPrice\": \"5.004\"\n },\n \"high\": {\n \"gasPrice\": \"5.004\"\n }\n}"}],"_postman_id":"00af6c33-4256-45ea-8fa4-a71e397b67fa"},{"name":"calculateFee","id":"c4cbb216-8e23-4f70-9e23-218bf9d06e7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assetId\": \"USDT\",\n \"blockchain\": \"trx\",\n \"amount\": \"0.100000\" \n}\n"},"url":"{{apiurl}}/wallets/calculateFee","description":"POST https://api.blox.services/wallets/estimateFee
Content-Type: application/jsonAuthorization: BearerThe request body should be a JSON object containing the following parameters:
\nassetId (string): The identifier for the asset. Example: \"ETH\".blockchain (string): The blockchain network for the transaction. Example: \"eth\".amount (string): The amount of the asset to be transferred. Example: \"0.100000\".{\n \"assetId\": \"ETH\",\n \"blockchain\": \"eth\",\n \"amount\": \"0.100000\"\n}\n\nThe response will be a JSON object containing the estimated fees for different levels of transaction urgency. Each level will include the cost of the transaction in the same asset as specified in the request.
\n{\n \"urgent\": {\n \"cost\": \"0.0004664341038\"\n },\n \"fast\": {\n \"cost\": \"0.0004664341038\"\n },\n \"normal\": {\n \"cost\": \"0.0004664341038\"\n }\n}\n\nurgent (object): Contains the cost of the transaction if processed urgently.cost (string): The estimated fee for an urgent transaction.fast (object): Contains the cost of the transaction if processed quickly but not as urgent.cost (string): The estimated fee for a fast transaction.normal (object): Contains the cost of the transaction if processed normally.cost (string): The estimated fee for a normal transaction.curl --location 'https://api.blox.services/wallets/estimateFee' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer ' \\\n--data '{\n \"assetId\": \"ETH\",\n \"blockchain\": \"eth\",\n \"amount\": \"0.100000\"\n}'\n\nAuthorization header contains a valid JWT token.amount should be specified as a string to ensure precision is maintained.This endpoint is used to estimate the transaction fee for transferring a specified amount of an asset on a particular blockchain network. The response provides fee estimates for different levels of urgency, allowing users to choose the most appropriate option for their needs.
\n","urlObject":{"path":["wallets","calculateFee"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[{"id":"631387c9-ce1a-4fdf-affb-687f78ed2679","name":"EstimatedFee","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assetId\": \"USDT\",\n \"blockchain\": \"eth\" \n}"},"url":"https://api.bloxcross-dev.com/v2/fireblocks/estimatedFee"},"status":"Ok","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Apr 2024 23:22:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"86"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Request-ID","value":"c90659c8d9c064f82e966635bcd7fb87"},{"key":"ETag","value":"W/\"56-5G8HeTRnHoFbrYWiAO2Tt42mSp8\""},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"low\": {\n \"gasPrice\": \"5.004\"\n },\n \"medium\": {\n \"gasPrice\": \"5.004\"\n },\n \"high\": {\n \"gasPrice\": \"5.004\"\n }\n}"}],"_postman_id":"c4cbb216-8e23-4f70-9e23-218bf9d06e7f"},{"name":"convert_Estimate","id":"61917e4d-e15a-43af-a5d3-16a8c768b09b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"0.010\",\n \"from_currency\": \"ETH_TEST5\",\n \"to_currency\": \"USD\",\n \"desired_lock_time_in_secs\": 10\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/portfolio/swap/convert_estimate","description":"This endpoint is used to estimate the conversion of one currency to another within a specified lock time.
\namount (number): The amount of currency to be converted.
from_currency (string): The currency code from which the conversion will be made.
to_currency (string): The currency code to which the conversion will be made.
desired_lock_time_in_secs (number): The desired lock time for the conversion in seconds.
Example:
\n{\n \"amount\": 1,\n \"from_currency\": \"ETH\",\n \"to_currency\": \"USD\",\n \"desired_lock_time_in_secs\": 10\n}\n\nThe response will be a JSON object with the estimated details of the conversion process.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"estimated_amount\": {\n \"type\": \"number\",\n \"description\": \"The estimated amount of the target currency after conversion.\"\n },\n \"estimated_fee\": {\n \"type\": \"number\",\n \"description\": \"The estimated fee for the conversion.\"\n },\n \"lock_time_in_secs\": {\n \"type\": \"number\",\n \"description\": \"The lock time for the conversion in seconds.\"\n }\n }\n}\n\nThis endpoint allows you to create an external wallet for the Fireblocks platform.
\naddress (string): The address of the external wallet.
currency (string): The currency of the external wallet.
blockchain (string): The blockchain of the external wallet.
Example:
\n{\n \"address\": \"0xcD82656b537189E76d54Eaf34df2 ...\",\n \"currency\": \"ETH\",\n \"blockchain\": \"eth\"\n}\n\nThe response for this request is not available. However, you can refer to the JSON schema for the response structure.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"walletId\": {\n \"type\": \"string\"\n }\n // Add more properties as per the actual response\n }\n}\n\nGet current Balances for all assets in the portfolio.
\nMethod: POST
\nParameters in Body: \n {\n \"portfolio_name\": \"\"\n }
\nReturn: for each asset one entry with:
{\n \"base_currency\": \"\",\n \"qty\": ,\n \"pnl\": \n }
If the asset is currency, such as USD-USD then the PNL will always be Zero (0).\nThe pnl is calculated across all transactions since portfolio was opened. \nTo get the current pnl do as follows:
\nGet current Balances for all assets in the portfolio.
\nMethod: POST
\nParameters in Body: \n {\n \"portfolio_name\": \"\"\n }
\nReturn: for each asset one entry with:
{\n \"base_currency\": \"\",\n \"qty\": ,\n \"pnl\": \n }
If the asset is currency, such as USD-USD then the PNL will always be Zero (0).\nThe pnl is calculated across all transactions since portfolio was opened. \nTo get the current pnl do as follows:
\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nParams:
\n{\ndirection: \"in|out\",\ncountry: \"2-letter code\",\npaymentMethodType: \"bank|digitalWallet|card|emoney|cash\"\n}\nNotes:
\ndirectUsage:\n - boolean\n Returns payment method types that can be used without having been previously stored.
\ndirection:\n - string\n Enum: \"in\" \"out\"\n Query variable to filter payment method types by the direction of the funds (in/out).
\nResponse Sample:\n\n[\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"balotoin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efectyin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntoredin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Puntored\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"superpagosin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Super Pagos\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"westernunionin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Western Union\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"baloto-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efecty-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntored-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Punto Red\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n}\n]
\n","urlObject":{"path":["payments","find_payment_providers"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca8d8e35-b75b-47ac-8ee4-c4bd9e175f4d"},{"name":"Deposit Allowed Instruments","id":"695d5835-7861-4af0-abd1-719018ef6e83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_deposit_instruments","urlObject":{"path":["payments","get_deposit_instruments"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"695d5835-7861-4af0-abd1-719018ef6e83"},{"name":"Holding Allowed Instruments","id":"e38ba10a-900f-4192-9d5b-18e8e580efeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_hold_instruments","urlObject":{"path":["payments","get_hold_instruments"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e38ba10a-900f-4192-9d5b-18e8e580efeb"},{"name":"Withdraw Allowed Instruments","id":"c96fe922-20e0-4af6-88ce-2dedf5b6ba0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/get_withdraw_instruments","urlObject":{"path":["payments","get_withdraw_instruments"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c96fe922-20e0-4af6-88ce-2dedf5b6ba0b"},{"name":"Countries Ebanled for Deposit","id":"a8819745-86cf-4c5c-90c9-dacc21918838","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/deposit_enabled_countries","description":"Returns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nReturns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\nParams:
\n{\ndirection: \"in|out\",\ncountry: \"2-letter code\",\npaymentMethodType: \"bank|digitalWallet|card|emoney|cash\"\n}\nNotes:
\ndirectUsage:\n - boolean\n Returns payment method types that can be used without having been previously stored.
\ndirection:\n - string\n Enum: \"in\" \"out\"\n Query variable to filter payment method types by the direction of the funds (in/out).
\nResponse Sample:\n\n[\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"balotoin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efectyin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntoredin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Puntored\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"superpagosin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Super Pagos\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"westernunionin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Western Union\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"baloto-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efecty-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntored-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Punto Red\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n}\n]
\n","urlObject":{"path":["payments","validate_routing_number"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e656c96-3589-42f4-8e14-8d85207ae3d4"},{"name":"Validate SWIFT Code","id":"ab7c5c74-7f5c-40b2-babb-a19dc2138612","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"swift\": \"CHASUS33\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/validate_swift","description":"Params:
\n{\ndirection: \"in|out\",\ncountry: \"2-letter code\",\npaymentMethodType: \"bank|digitalWallet|card|emoney|cash\"\n}\nNotes:
\ndirectUsage:\n - boolean\n Returns payment method types that can be used without having been previously stored.
\ndirection:\n - string\n Enum: \"in\" \"out\"\n Query variable to filter payment method types by the direction of the funds (in/out).
\nResponse Sample:\n\n[\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"balotoin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efectyin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntoredin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Puntored\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"superpagosin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Super Pagos\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"westernunionin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Western Union\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"baloto-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efecty-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntored-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Punto Red\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n}\n]
\n","urlObject":{"path":["payments","validate_swift"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab7c5c74-7f5c-40b2-babb-a19dc2138612"},{"name":"Validate IBAN Number","id":"fdeb7202-6ae3-421a-9be9-0ff97537d8b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"iban\": \"DE16200700000532013000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/validate_iban","description":"Params:
\n{\ndirection: \"in|out\",\ncountry: \"2-letter code\",\npaymentMethodType: \"bank|digitalWallet|card|emoney|cash\"\n}\nNotes:
\ndirectUsage:\n - boolean\n Returns payment method types that can be used without having been previously stored.
\ndirection:\n - string\n Enum: \"in\" \"out\"\n Query variable to filter payment method types by the direction of the funds (in/out).
\nResponse Sample:\n\n[\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"balotoin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efectyin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntoredin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Puntored\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"superpagosin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Super Pagos\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"westernunionin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Western Union\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"baloto-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efecty-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntored-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Punto Red\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n}\n]
\n","urlObject":{"path":["payments","validate_iban"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fdeb7202-6ae3-421a-9be9-0ff97537d8b8"},{"name":"Search Bank SWIFT Code","id":"9f92a8db-c30e-4b22-adc0-1caaaec76089","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"bank_name\": \"Signature bank\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/search_bank_swift","description":"Params:
\n{\ndirection: \"in|out\",\ncountry: \"2-letter code\",\npaymentMethodType: \"bank|digitalWallet|card|emoney|cash\"\n}\nNotes:
\ndirectUsage:\n - boolean\n Returns payment method types that can be used without having been previously stored.
\ndirection:\n - string\n Enum: \"in\" \"out\"\n Query variable to filter payment method types by the direction of the funds (in/out).
\nResponse Sample:\n\n[\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"balotoin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efectyin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntoredin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Puntored\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"superpagosin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Super Pagos\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"westernunionin-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Western Union\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"baloto-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Baloto\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"efecty-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Efecty\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n},\n{\n \"country\": \"CO\",\n \"currency\": \"COP\",\n \"directUsage\": true,\n \"direction\": \"in\",\n \"fields\": [\n {\n \"description\": \"Expiration days\",\n \"fieldType\": \"input\",\n \"isUserField\": false,\n \"mandatory\": false,\n \"name\": \"expiration_days\",\n \"regex\": \".*\",\n \"validOptions\": []\n }\n ],\n \"imageURL\": null,\n \"paymentMethodType\": \"puntored-co\",\n \"paymentMethodTypeClass\": \"cash\",\n \"paymentMethodTypeDescription\": \"Punto Red\",\n \"paymentMethodTypePos\": [],\n \"paymentMethodTypeStatus\": \"available\",\n \"protected\": false,\n \"storable\": false\n}\n]
\n","urlObject":{"path":["payments","search_bank_swift"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f92a8db-c30e-4b22-adc0-1caaaec76089"},{"name":"Time Periods","id":"29bd1ca9-8416-4a02-9ae0-df7ed3f3d5a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{apiurl}}/refdata/time_periods","urlObject":{"path":["refdata","time_periods"],"host":["{{apiurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"29bd1ca9-8416-4a02-9ae0-df7ed3f3d5a0"},{"name":"Country List","id":"3fcd2d59-c5fb-4cca-aec6-b3a4cbeb9217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{apiurl}}/payments/payment_countries","description":"Returns:
\n {\n \"transaction_id\": \"saksjsq-0io2wq-qdldksa\"\n }\n