{ "item": [ { "id": "0f01493e-7fa8-41ed-b5ea-46e6f950d0ba", "name": "Payin", "description": { "content": "Resources that are related to Payin.", "type": "text/plain" }, "item": [ { "id": "8ad11dcf-e254-4b1c-b1f8-3ea5999d318e", "name": "Convert Fiat to Crypto Session", "request": { "name": "Convert Fiat to Crypto Session", "description": { "content": "This endpoint initiates Noah's hosted session for automated fiat-to-crypto workflows.\n\nThe solution creates a hosted session where customers can set up a workflow that automatically converts incoming fiat currency from bank deposits into cryptocurrency and sends the acquired crypto to a specified wallet address on the specified network. The workflow triggers automatically whenever a bank transfer is made to the designated bank account.\n\nUse the endpoint to retrieve a response consisting of a URL, which you pass to your customer so that they can configure their automated conversion workflow through a hosted session. Deposited amounts are traded for the specified cryptocurrency at current market prices after application of fees.\n\n**Notes**:\n\n * On-chain operations are irreversible, and market prices may fluctuate significantly, impacting the final payout amount.\n * Although this workflow should continue working with the original FormSession, Noah cannot guarantee FormSession longevity. For this reason, generate a new FormSession each time you present the customer with the onchain deposit address.\n * If the customer reuses the onchain address after the FormSession becomes invalid, the transfer will fail but funds will not be lost.", "type": "text/plain" }, "url": { "path": ["hosted-workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"\",\n \"DestinationAddress\": {\n \"Address\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"\"\n },\n {\n \"FiatCurrencyCode\": \"\"\n }\n ],\n \"CryptoCurrency\": \"\",\n \"Network\": \"\",\n \"UI\": {\n \"CryptoOptions\": [\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n },\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n }\n ],\n \"CryptoOptionsConfig\": {\n \"AutoSelect\": {\n \"value\": \"\"\n }\n }\n },\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\"\n },\n \"BusinessFees\": {\n \"key_0\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b9a25d99-20d4-4a06-af78-78ee74b99545", "name": "HostedURL successfully created.", "originalRequest": { "url": { "path": ["hosted-workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"UI\": {\n \"CryptoOptions\": [\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n },\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n }\n ],\n \"CryptoOptionsConfig\": {\n \"AutoSelect\": {\n \"value\": \"\"\n }\n }\n },\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"https://RvYyCupevLuaxruOIdjwoCF.texlXJTZZ8Y4ihKSzAz5gkmWyc32MEeoIIVcmyqKXYyp\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 9281.169442541363,\n \"key_1\": 2715,\n \"key_2\": 4547\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n \"string\",\n \"string\"\n ]\n },\n \"OnboardingStatus\": \"ReviewPending\",\n \"MissingSteps\": [\n \"string\",\n \"string\"\n ],\n \"Verifications\": {\n \"Type\": \"Individual\",\n \"Status\": \"string\",\n \"EntityVerifications\": [\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n },\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n }\n ],\n \"ActionsRequired\": [\n \"SourceOfWealth\",\n \"IncorrectTaxID\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86e7fa9-34b3-48cd-aebf-e5ff2a747cd7", "name": "Bad request", "originalRequest": { "url": { "path": ["hosted-workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"UI\": {\n \"CryptoOptions\": [\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n },\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n }\n ],\n \"CryptoOptionsConfig\": {\n \"AutoSelect\": {\n \"value\": \"\"\n }\n }\n },\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e7f35c1-d64b-4d29-a4f6-c36b18941485", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["hosted-workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"UI\": {\n \"CryptoOptions\": [\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n },\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n }\n ],\n \"CryptoOptionsConfig\": {\n \"AutoSelect\": {\n \"value\": \"\"\n }\n }\n },\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b974ecfd-7fac-4699-8cb5-123bd6de727a", "name": "Internal server error", "originalRequest": { "url": { "path": ["hosted-workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"UI\": {\n \"CryptoOptions\": [\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n },\n {\n \"CryptoCurrency\": {\n \"value\": \"\"\n },\n \"Network\": {\n \"value\": \"\"\n }\n }\n ],\n \"CryptoOptionsConfig\": {\n \"AutoSelect\": {\n \"value\": \"\"\n }\n }\n },\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98a5eec3-2cdb-4bff-b1b6-1510e5678b74", "name": "Convert Fiat to Crypto", "request": { "name": "Convert Fiat to Crypto", "description": { "content": "This endpoint establishes an automated workflow that converts incoming fiat currency from bank deposits into cryptocurrency and sends the acquired crypto to a specified wallet address.\n\nThe solution requires a CustomerID, FiatCurrency, CryptoCurrency, Network, and DestinationAddress, with the deposited fiat amounts traded for the specified cryptocurrency at current market prices after application of fees.\n\nThe customer must already exist before using this endpoint.\n\nFollow the step-by-step guides:\n * [Bank Onramp via USD Virtual Account](/recipes/payin/bank-onramp-us)\n * [Bank Onramp via EUR Virtual Account](/recipes/payin/bank-onramp-eu)\n\n**Notes**:\n\n * On-chain operations are irreversible, and market prices may fluctuate significantly, impacting the final crypto amount.\n * Although this workflow should continue working with the original bank deposit setup, Noah cannot guarantee indefinite longevity of the configuration. For this reason, verify the workflow is still active before directing new deposits.", "type": "text/plain" }, "url": { "path": ["workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CustomerID\": \"\",\n \"FiatCurrency\": \"\",\n \"CryptoCurrency\": \"\",\n \"Network\": \"\",\n \"DestinationAddress\": {\n \"Address\": \"\"\n },\n \"BusinessFees\": {\n \"key_0\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n },\n \"key_1\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n },\n \"key_2\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n },\n \"key_3\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "73f7c9f0-0344-4801-a6da-fe1e7b01a8e6", "name": "Created rule", "originalRequest": { "url": { "path": ["workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatCurrency\": \"USD\",\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PaymentMethodID\": \"\",\n \"PaymentMethodType\": \"BankLocal\",\n \"AccountNumber\": \"string\",\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"Fee\": {\n \"FiatCurrencyCode\": \"USD\",\n \"TotalFeePct\": \"10.1\",\n \"TotalFeeBase\": \"10.1\",\n \"TotalFeeMin\": \"10.1\"\n },\n \"VirtualAccountID\": \"\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"Reference\": \"string\",\n \"AccountHolderName\": \"string\",\n \"BankCode\": \"string\",\n \"BankName\": \"string\",\n \"BankAddress\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": \"US\",\n \"Street2\": \"\"\n },\n \"RelatedPaymentMethods\": [\n {\n \"PaymentMethodID\": \"\",\n \"PaymentMethodType\": \"BankLocal\",\n \"Fee\": {\n \"FiatCurrencyCode\": {\n \"value\": \"\"\n },\n \"TotalFeePct\": {\n \"value\": \"\"\n },\n \"TotalFeeBase\": {\n \"value\": \"\"\n },\n \"TotalFeeMin\": {\n \"value\": \"\"\n }\n },\n \"Details\": {\n \"AccountNumber\": {\n \"value\": \"\"\n },\n \"BankCode\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"PaymentMethodID\": \"\",\n \"PaymentMethodType\": \"BankLocal\",\n \"Fee\": {\n \"FiatCurrencyCode\": {\n \"value\": \"\"\n },\n \"TotalFeePct\": {\n \"value\": \"\"\n },\n \"TotalFeeBase\": {\n \"value\": \"\"\n },\n \"TotalFeeMin\": {\n \"value\": \"\"\n }\n },\n \"Details\": {\n \"AccountNumber\": {\n \"value\": \"\"\n },\n \"BankCode\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf7e22a4-256b-4dd0-a8d5-a2cab2984b36", "name": "Bad request", "originalRequest": { "url": { "path": ["workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatCurrency\": \"USD\",\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6713fd71-532d-4550-9b3a-17bcd8f6ac9e", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatCurrency\": \"USD\",\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac625701-b506-4371-a54e-64df73ad1a39", "name": "Forbidden. The customer is not currently eligible for virtual account issuance, such as when an individual is in compliance review.", "originalRequest": { "url": { "path": ["workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatCurrency\": \"USD\",\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"create customer account\",\n \"Detail\": \"Customer is in compliance review with the external provider\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Forbidden\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a313776e-c56d-4db3-b08b-186facb01b9f", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatCurrency\": \"USD\",\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84b4ad99-86d5-45fe-9283-03249d14d47a", "name": "Internal server error", "originalRequest": { "url": { "path": ["workflows", "bank-deposit-to-onchain-address"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatCurrency\": \"USD\",\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n },\n \"BusinessFees\": {\n \"BankAch\": {\n \"FeePct\": \"0.2\"\n },\n \"BankFedwire\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b665ec3-9a47-41ee-83a3-77dcae5b6fc0", "name": "Simulate Fiat Deposit", "request": { "name": "Simulate Fiat Deposit", "description": { "content": "This endpoint creates a simulated fiat deposit in the sandbox environment for testing purposes.\n\nThe solution requires a FiatAmount, `CustomerID` reference, and payment method specifications to trigger configured workflows, rules, and webhook integrations.\n\nUse the endpoint to test automated processes and validate business logic without real money transfers, supporting various fiat currencies and deposit scenarios.\n\nFollow the step-by-step guides:\n * [Bank Onramp via USD Virtual Account](/recipes/payin/bank-onramp-us)\n * [Bank Onramp via EUR Virtual Account](/recipes/payin/bank-onramp-eu)", "type": "text/plain" }, "url": { "path": ["sandbox", "fiat-deposit", "simulate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PaymentMethodID\": \"\",\n \"FiatAmount\": \"\",\n \"FiatCurrency\": \"\",\n \"Reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1938fe4d-4373-416b-b194-c8469e68e299", "name": "Fiat deposit created successfully", "originalRequest": { "url": { "path": ["sandbox", "fiat-deposit", "simulate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PaymentMethodID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"FiatCurrency\": \"USD\",\n \"Reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FiatDepositID\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6671df0-772c-458c-8254-0519b977d04f", "name": "Bad request", "originalRequest": { "url": { "path": ["sandbox", "fiat-deposit", "simulate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PaymentMethodID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"FiatCurrency\": \"USD\",\n \"Reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61a49b80-3759-426c-a60f-90db2e32c41d", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["sandbox", "fiat-deposit", "simulate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PaymentMethodID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"FiatCurrency\": \"USD\",\n \"Reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "632720be-db65-4028-8782-4c5f8cc3af96", "name": "Internal server error", "originalRequest": { "url": { "path": ["sandbox", "fiat-deposit", "simulate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"PaymentMethodID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"FiatCurrency\": \"USD\",\n \"Reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "69dc5678-25da-4ca0-bf92-0bdd6f1f99a9", "name": "Payout", "description": { "content": "Resources that are related to Payout.", "type": "text/plain" }, "item": [ { "id": "9b394a2b-e7f8-4e01-a900-b2079ebe0f97", "name": "Convert Crypto to Fiat Session", "request": { "name": "Convert Crypto to Fiat Session", "description": { "content": "This endpoint initiates Noah's hosted session for automated crypto-to-fiat workflows.\n\nThe solution creates a hosted session where customers can set up a workflow that automatically converts incoming cryptocurrency from onchain deposits into fiat currency and sends the acquired fiat to their payment method. The workflow triggers automatically when cryptocurrency is deposited to the designated onchain address.\n\nUse the endpoint to retrieve a response consisting of a URL, which you pass to your customer so that they can configure their automated conversion workflow through a hosted session. Deposited amounts are traded for the specified fiat currency at current market prices after application of fees.\n\n**Notes**:\n\n * On-chain operations are irreversible, and market prices may fluctuate significantly, impacting the final payout amount.\n * Although this workflow should continue working with the original FormSession, Noah cannot guarantee FormSession longevity. For this reason, generate a new FormSession each time you present the customer with the onchain deposit address.\n * If the customer reuses the onchain address after the FormSession becomes invalid, the transfer will fail but funds will not be lost.", "type": "text/plain" }, "url": { "path": ["hosted-workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"\",\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"\",\n \"Network\": \"\",\n \"FiatAmount\": \"\",\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"BusinessFee\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "290cdb78-534d-44d8-9f01-51356a0e8a99", "name": "HostedURL successfully created.", "originalRequest": { "url": { "path": ["hosted-workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\"\n },\n \"BusinessFee\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"https://RvYyCupevLuaxruOIdjwoCF.texlXJTZZ8Y4ihKSzAz5gkmWyc32MEeoIIVcmyqKXYyp\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 9281.169442541363,\n \"key_1\": 2715,\n \"key_2\": 4547\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n \"string\",\n \"string\"\n ]\n },\n \"OnboardingStatus\": \"ReviewPending\",\n \"MissingSteps\": [\n \"string\",\n \"string\"\n ],\n \"Verifications\": {\n \"Type\": \"Individual\",\n \"Status\": \"string\",\n \"EntityVerifications\": [\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n },\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n }\n ],\n \"ActionsRequired\": [\n \"SourceOfWealth\",\n \"IncorrectTaxID\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f754311-0b64-4a08-9e35-6612e6ad9254", "name": "Bad request", "originalRequest": { "url": { "path": ["hosted-workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\"\n },\n \"BusinessFee\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4422751-85e1-4609-b846-6825cfe8efb3", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["hosted-workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\"\n },\n \"BusinessFee\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2225adc9-2b28-44d6-8adc-31391ea80a01", "name": "Internal server error", "originalRequest": { "url": { "path": ["hosted-workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\"\n },\n \"BusinessFee\": {\n \"FeeBase\": \"5\",\n \"FeePct\": \"0.1\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79cda8d0-74d9-441b-af72-1b0452b8a758", "name": "Customer Account Recovery Session", "request": { "name": "Customer Account Recovery Session", "description": { "content": "This endpoint initiates Noah's hosted session for customer account fund recovery.\n\nThe solution creates a hosted session where customers can sell cryptocurrency funds currently held in their customer account and receive fiat payouts via available channels. This is used as a fallback mechanism when orchestrated workflows fail to disburse funds.\n\nUse the endpoint to retrieve a response consisting of a URL, which you pass to your customer so that they can recover their funds through a hosted session.", "type": "text/plain" }, "url": { "path": ["hosted-workflows", "recovery"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"\"\n },\n {\n \"FiatCurrencyCode\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "45e12db3-a364-424d-938a-684a7dbf7d52", "name": "HostedURL successfully created.", "originalRequest": { "url": { "path": ["hosted-workflows", "recovery"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"https://fOqcvYvGYNSAdaOdcgMxOKAM.ddjcWqmHT0oj7Ia5dScED9HA1F0,sWcwdFa3n,DSEk48mVs78cy.eUldTMfp8OYdn\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a56871b-de04-49b4-bd33-8162f18e0f78", "name": "Bad request", "originalRequest": { "url": { "path": ["hosted-workflows", "recovery"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64d580d4-7c4d-4b87-b6d2-cd1f60112803", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["hosted-workflows", "recovery"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78fe359b-a9b8-44c8-b151-dc33369e5e7a", "name": "Internal server error", "originalRequest": { "url": { "path": ["hosted-workflows", "recovery"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3acdedb8-3ad6-449b-926e-c7239b02bd60", "name": "Onchain Deposit to Fiat Payout", "request": { "name": "Onchain Deposit to Fiat Payout", "description": { "content": "This endpoint establishes an automated workflow that converts incoming cryptocurrency deposits into fiat currency payouts.\n\nThe solution requires configuration of source cryptocurrency, a FormSessionID for payout instructions, recipient payment method details, and conversion parameters, with deposited amounts traded for the specified fiat currency at current market prices after application of fees.\n\nThe customer must already exist before using this endpoint.\n\n **Notes**: \n * On-chain operations are irreversible, and market prices may fluctuate significantly, impacting the final payout amount.\n * Although this workflow should continue working with the original FormSession, Noah cannot guarantee FormSession longevity. For this reason, generate a new FormSession each time you present the customer with the onchain deposit address.\n * If the customer reuses the onchain address after the FormSession becomes invalid, the transfer will fail but funds will not be lost.\n * To charge a per-transaction business fee, set it on [`POST /transactions/sell/prepare`](/api-reference/prepare-sell-transaction). It is stored on the FormSession and applied to this workflow, so the fee summary you show the customer at prepare time matches what is charged.", "type": "text/plain" }, "url": { "path": ["workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Trigger\": {\n \"Type\": \"\",\n \"Conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"SourceAddress\": \"\",\n \"Expiry\": \"\",\n \"Nonce\": \"\",\n \"ForeignBridge\": false\n },\n \"CustomerID\": \"\",\n \"CryptoCurrency\": \"\",\n \"FormSessionID\": \"\",\n \"FiatAmount\": \"\",\n \"ExternalID\": \"\",\n \"BusinessFee\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n },\n \"RefundAddress\": {\n \"Address\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8d31bcf1-cd4b-4d64-bd5c-b9dc4f8b66cb", "name": "Workflow created", "originalRequest": { "url": { "path": ["workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Trigger\": {\n \"Type\": \"\",\n \"Conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"SourceAddress\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\",\n \"Expiry\": \"2024-04-16T08:00:55Z\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"ForeignBridge\": false\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"CryptoCurrency\": \"BTC\",\n \"FormSessionID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n },\n \"RefundAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Conditions\": [\n {\n \"AmountConditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"AmountConditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"CryptoCurrency\": \"USDC\",\n \"Network\": \"Ethereum\",\n \"DestinationAddress\": {\n \"Address\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"SourceAddress\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\",\n \"RuleID\": \"75b27940-e9c6-a2a1-d7c6-1d0e7e44b68c\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81e6e86-1eb9-4819-bb8f-8b433e894799", "name": "Bad request", "originalRequest": { "url": { "path": ["workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Trigger\": {\n \"Type\": \"\",\n \"Conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"SourceAddress\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\",\n \"Expiry\": \"2024-04-16T08:00:55Z\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"ForeignBridge\": false\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n },\n \"RefundAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb88b876-9ea1-46a8-a9b1-b863ad943231", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Trigger\": {\n \"Type\": \"\",\n \"Conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"SourceAddress\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\",\n \"Expiry\": \"2024-04-16T08:00:55Z\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"ForeignBridge\": false\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n },\n \"RefundAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "359884dd-0fb1-4188-ad78-c37817fd12dc", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Trigger\": {\n \"Type\": \"\",\n \"Conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"SourceAddress\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\",\n \"Expiry\": \"2024-04-16T08:00:55Z\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"ForeignBridge\": false\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n },\n \"RefundAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97972e0b-1787-4b78-ad9e-7a4a5b3e0a30", "name": "Internal server error", "originalRequest": { "url": { "path": ["workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Trigger\": {\n \"Type\": \"\",\n \"Conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"SourceAddress\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\",\n \"Expiry\": \"2024-04-16T08:00:55Z\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"ForeignBridge\": false\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n },\n \"RefundAddress\": {\n \"Address\": \"0x71C7656EC7ab88b098defB751B7401B5f6d8976F\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "450db929-cf59-4f3c-a41c-06b8c52cee7b", "name": "Create Sell Transaction", "request": { "name": "Create Sell Transaction", "description": { "content": "This endpoint initiates an immediate transaction to sell specified cryptocurrency and send the resulting fiat currency to a designated payout method.\n\nUse this endpoint to convert a crypto balance into fiat and send it to a beneficiary (e.g., bank transfer, card payout, wallet) with real-time execution, dynamic payout-form submission for payment methods, immediate balance updates, and end-to-end transaction tracking.\n\n**Note:** This endpoint is only available to customers created under the Reliance Model. Before you get started with this endpoint, Noah must have authorized your usage of the Reliance Model. For more details on this process, see the [Compliance Overview](/getting-started/kyc). When using the Standard Model, use the [Onchain Deposit to Fiat Payout](onchain-deposit-to-fiat-payout) endpoint.\n\nFollow the step-by-step guides:\n * [Direct Payout to US Business](/recipes/payout/global-payouts-business)\n * [Direct Payout to Individual Customer](/recipes/payout/global-payouts-individual)", "type": "text/plain" }, "url": { "path": ["transactions", "sell"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CryptoAuthorizedAmount\": \"\",\n \"CryptoCurrency\": \"\",\n \"FormSessionID\": \"\",\n \"Nonce\": \"\",\n \"FiatAmount\": \"\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e26bf02a-4a44-4f14-a823-9fea144cefba", "name": "Sell request successful", "originalRequest": { "url": { "path": ["transactions", "sell"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoAuthorizedAmount\": \"10.1\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Transaction\": {\n \"ID\": \"b237e7c8-5ee3-c74b-a1db-f67c926a797d\",\n \"Network\": \"Ethereum\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"USDC\",\n \"PublicID\": \"string\",\n \"SubStatus\": \"UnderReview\",\n \"RFI\": {\n \"Status\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": {\n \"value\": \"\"\n }\n },\n \"FiatPayment\": {\n \"Amount\": {\n \"value\": \"\"\n },\n \"FeeAmount\": {\n \"value\": \"\"\n },\n \"FiatCurrency\": {\n \"value\": \"\"\n },\n \"Rate\": {\n \"value\": \"\"\n },\n \"FiatDepositID\": \"string\",\n \"PaymentSystemID\": \"string\"\n },\n \"Orchestration\": {\n \"RuleID\": \"string\",\n \"RuleExecutionID\": \"string\"\n },\n \"FiatPaymentMethod\": {\n \"ID\": \"string\",\n \"PaymentMethodCategory\": {\n \"value\": \"\"\n },\n \"DisplayDetails\": {\n \"value\": \"\"\n },\n \"Country\": {\n \"value\": \"\"\n },\n \"CustomerID\": {\n \"value\": \"\"\n },\n \"Capabilities\": {\n \"value\": \"\"\n },\n \"AccountHolderDetails\": {\n \"value\": \"\"\n },\n \"IssuerDetails\": {\n \"value\": \"\"\n }\n },\n \"Breakdown\": [\n {\n \"Type\": {\n \"value\": \"\"\n },\n \"Amount\": {\n \"value\": \"\"\n },\n \"FixedAmount\": {\n \"value\": \"\"\n },\n \"VariableAmount\": {\n \"value\": \"\"\n }\n },\n {\n \"Type\": {\n \"value\": \"\"\n },\n \"Amount\": {\n \"value\": \"\"\n },\n \"FixedAmount\": {\n \"value\": \"\"\n },\n \"VariableAmount\": {\n \"value\": \"\"\n }\n }\n ],\n \"AdjustmentFor\": {\n \"AdjustedTransactionID\": \"bbdbeb9f-ef46-39cd-2972-b5a3db5cdd34\",\n \"AdjustmentID\": \"e92f8579-fc68-7567-c618-3a3598b0eb56\",\n \"Reason\": \"string\"\n },\n \"Refunds\": [\n {\n \"RefundID\": {\n \"value\": \"\"\n },\n \"RefundedAmount\": {\n \"value\": \"\"\n },\n \"Currency\": {\n \"value\": \"\"\n },\n \"RequestTime\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n }\n },\n {\n \"RefundID\": {\n \"value\": \"\"\n },\n \"RefundedAmount\": {\n \"value\": \"\"\n },\n \"Currency\": {\n \"value\": \"\"\n },\n \"RequestTime\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n }\n }\n ],\n \"Reverses\": \"01a7574a-4476-9fc7-0eca-176604b0ce7f\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cdc8701-532c-4c1d-b1c7-e87f710c84fd", "name": "Bad request", "originalRequest": { "url": { "path": ["transactions", "sell"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoAuthorizedAmount\": \"10.1\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5963b51f-dcfc-4762-8c10-b21a50ebfbea", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["transactions", "sell"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoAuthorizedAmount\": \"10.1\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462a904d-5691-45fe-b45d-6720e3359d7f", "name": "Payment required. The response Type is `InsufficientBalance` when the account balance is below the requested amount.", "originalRequest": { "url": { "path": ["transactions", "sell"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoAuthorizedAmount\": \"10.1\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"validate account balance\",\n \"Detail\": \"The account balance is below the requested amount\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"InsufficientBalance\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e3790b4-97a0-464f-9ce1-da13b6c68657", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["transactions", "sell"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoAuthorizedAmount\": \"10.1\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b413e0bc-7008-4e64-8252-893051911ff1", "name": "Internal server error", "originalRequest": { "url": { "path": ["transactions", "sell"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoAuthorizedAmount\": \"10.1\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"FiatAmount\": \"10.1\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2810966-65e8-4990-987e-71fd863aeacb", "name": "Prepare Sell Transaction", "request": { "name": "Prepare Sell Transaction", "description": { "content": "This endpoint calculates and validates the required inputs for a sell transaction, including accurate pricing estimates, fees, and limits.\n\nUse the endpoint to pre-validate a crypto-to-fiat sell by generating a FormSessionID, retrieving real-time price/fee/limit estimates, computing the required CryptoAuthorizedAmount, and validating payout-form inputs.\n\nThis enables the subsequent Create Sell call to execute deterministically within your slippage, balance, and compliance constraints, with no funds being removed at this stage.\n\nFollow the step-by-step guides:\n * [Direct Payout to US Business](/recipes/payout/global-payouts-business)\n * [Direct Payout to Individual Customer](/recipes/payout/global-payouts-individual)", "type": "text/plain" }, "url": { "path": ["transactions", "sell", "prepare"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"\",\n \"FormSessionID\": \"\",\n \"PaymentMethodID\": \"\",\n \"CustomerID\": \"\",\n \"FiatAmount\": \"\",\n \"CryptoAmount\": \"\",\n \"Quoted\": false,\n \"Form\": {\n \"key_0\": 1248.6125042587325\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"Self\": \"\",\n \"BusinessFee\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f3496f44-6e34-43f9-910e-e266f1e7e32d", "name": "Sell request data", "originalRequest": { "url": { "path": ["transactions", "sell", "prepare"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"PaymentMethodID\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatAmount\": \"10.1\",\n \"CryptoAmount\": \"10.1\",\n \"Quoted\": false,\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"Self\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FormSessionID\": \"\",\n \"TotalFee\": \"10.1\",\n \"CryptoAmountEstimate\": \"10.1\",\n \"CryptoAuthorizedAmount\": \"10.1\",\n \"NextStep\": {\n \"StepID\": \"Cob\",\n \"StepType\": \"DataEntry\",\n \"Schema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allOf\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"Quote\": {\n \"SignedQuote\": \"string\",\n \"Expiry\": \"2024-04-16T08:00:55Z\"\n },\n \"CryptoCurrency\": \"USDC\",\n \"FiatCurrency\": \"USD\",\n \"FiatAmount\": \"10.1\",\n \"Rate\": \"10.1\",\n \"Breakdown\": [\n {\n \"Type\": \"string\",\n \"Amount\": \"10.1\",\n \"FixedAmount\": \"10.1\",\n \"VariableAmount\": \"10.1\"\n },\n {\n \"Type\": \"string\",\n \"Amount\": \"10.1\",\n \"FixedAmount\": \"10.1\",\n \"VariableAmount\": \"10.1\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f28eadba-d960-4024-b7c9-9883fcd2e09b", "name": "Bad request", "originalRequest": { "url": { "path": ["transactions", "sell", "prepare"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"PaymentMethodID\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatAmount\": \"10.1\",\n \"CryptoAmount\": \"10.1\",\n \"Quoted\": false,\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"Self\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d58fbf32-0845-444b-93d6-b78bd7d86983", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["transactions", "sell", "prepare"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"PaymentMethodID\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatAmount\": \"10.1\",\n \"CryptoAmount\": \"10.1\",\n \"Quoted\": false,\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"Self\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b79921c-88dc-4012-b64c-4c0dfe3059b4", "name": "Payment required. The response Type is `InsufficientBalance` when the account balance is below the requested amount.", "originalRequest": { "url": { "path": ["transactions", "sell", "prepare"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"PaymentMethodID\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatAmount\": \"10.1\",\n \"CryptoAmount\": \"10.1\",\n \"Quoted\": false,\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"Self\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"validate account balance\",\n \"Detail\": \"The account balance is below the requested amount\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"InsufficientBalance\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "996b6c6f-6aac-4990-a196-bf29184aca5a", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["transactions", "sell", "prepare"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"PaymentMethodID\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatAmount\": \"10.1\",\n \"CryptoAmount\": \"10.1\",\n \"Quoted\": false,\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"Self\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "652cc77e-ac17-4cf3-8c40-e576543d47b1", "name": "Internal server error", "originalRequest": { "url": { "path": ["transactions", "sell", "prepare"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ChannelID\": \"\",\n \"CryptoCurrency\": \"USDC\",\n \"FormSessionID\": \"\",\n \"PaymentMethodID\": \"\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"FiatAmount\": \"10.1\",\n \"CryptoAmount\": \"10.1\",\n \"Quoted\": false,\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"Self\": \"\",\n \"BusinessFee\": {\n \"FeePct\": \"0.1\",\n \"FeeBase\": \"5\",\n \"FiatCurrency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "918096bd-9685-425f-82f3-6940375c9531", "name": "Transactions", "description": { "content": "Resources that are related to transactions.", "type": "text/plain" }, "item": [ { "id": "d3596615-2f04-4d44-a1cc-97d6943abc58", "name": "Transactions", "request": { "name": "Transactions", "description": { "content": "This endpoint retrieves a paginated list of transaction history for the Business User's account. Optionally filter by a specific customer by providing `CustomerID`, or by creation time with `CreatedFrom` / `CreatedTo`.", "type": "text/plain" }, "url": { "path": ["transactions"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "CustomerID", "value": "" }, { "disabled": false, "key": "CreatedFrom", "value": "", "description": "Return only transactions created on or after this timestamp." }, { "disabled": false, "key": "CreatedTo", "value": "", "description": "Return only transactions created on or before this timestamp." }, { "disabled": false, "key": "PageSize", "value": "20" }, { "disabled": false, "key": "PageToken", "value": "" }, { "disabled": false, "key": "SortDirection", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5f2bced0-91fb-4ec3-b35e-1e46e5ac4da1", "name": "List of transactions", "originalRequest": { "url": { "path": ["transactions"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "CreatedFrom", "value": "2024-04-16T08:00:55Z" }, { "key": "CreatedTo", "value": "2024-04-16T08:00:55Z" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Items\": [\n {\n \"ID\": \"5e7c567c-f56d-b735-bb45-9e2890c49a36\",\n \"Network\": \"Solana\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"BTC\",\n \"PublicID\": \"string\",\n \"SubStatus\": \"UnderReview\",\n \"RFI\": {\n \"Status\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"string\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": {\n \"value\": \"\"\n }\n },\n \"FiatPayment\": {\n \"Amount\": {\n \"value\": \"\"\n },\n \"FeeAmount\": {\n \"value\": \"\"\n },\n \"FiatCurrency\": {\n \"value\": \"\"\n },\n \"Rate\": {\n \"value\": \"\"\n },\n \"FiatDepositID\": {\n \"value\": \"\"\n },\n \"PaymentSystemID\": {\n \"value\": \"\"\n }\n },\n \"Orchestration\": {\n \"RuleID\": {\n \"value\": \"\"\n },\n \"RuleExecutionID\": {\n \"value\": \"\"\n }\n },\n \"FiatPaymentMethod\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"PaymentMethodCategory\": {\n \"value\": \"\"\n },\n \"DisplayDetails\": {\n \"value\": \"\"\n },\n \"Country\": {\n \"value\": \"\"\n },\n \"CustomerID\": {\n \"value\": \"\"\n },\n \"Capabilities\": {\n \"value\": \"\"\n },\n \"AccountHolderDetails\": {\n \"value\": \"\"\n },\n \"IssuerDetails\": {\n \"value\": \"\"\n }\n },\n \"Breakdown\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"AdjustmentFor\": {\n \"AdjustedTransactionID\": {\n \"value\": \"\"\n },\n \"AdjustmentID\": {\n \"value\": \"\"\n },\n \"Reason\": {\n \"value\": \"\"\n }\n },\n \"Refunds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"Reverses\": \"7fab7bc7-140c-f117-d59f-c0edd4638d76\"\n },\n {\n \"ID\": \"078c19a6-37be-3f8d-6a03-5486dd437957\",\n \"Network\": \"Solana\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"BTC\",\n \"PublicID\": \"string\",\n \"SubStatus\": \"UnderReview\",\n \"RFI\": {\n \"Status\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"st\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": {\n \"value\": \"\"\n }\n },\n \"FiatPayment\": {\n \"Amount\": {\n \"value\": \"\"\n },\n \"FeeAmount\": {\n \"value\": \"\"\n },\n \"FiatCurrency\": {\n \"value\": \"\"\n },\n \"Rate\": {\n \"value\": \"\"\n },\n \"FiatDepositID\": {\n \"value\": \"\"\n },\n \"PaymentSystemID\": {\n \"value\": \"\"\n }\n },\n \"Orchestration\": {\n \"RuleID\": {\n \"value\": \"\"\n },\n \"RuleExecutionID\": {\n \"value\": \"\"\n }\n },\n \"FiatPaymentMethod\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"PaymentMethodCategory\": {\n \"value\": \"\"\n },\n \"DisplayDetails\": {\n \"value\": \"\"\n },\n \"Country\": {\n \"value\": \"\"\n },\n \"CustomerID\": {\n \"value\": \"\"\n },\n \"Capabilities\": {\n \"value\": \"\"\n },\n \"AccountHolderDetails\": {\n \"value\": \"\"\n },\n \"IssuerDetails\": {\n \"value\": \"\"\n }\n },\n \"Breakdown\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"AdjustmentFor\": {\n \"AdjustedTransactionID\": {\n \"value\": \"\"\n },\n \"AdjustmentID\": {\n \"value\": \"\"\n },\n \"Reason\": {\n \"value\": \"\"\n }\n },\n \"Refunds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"Reverses\": \"d62b7ab8-b0b5-1a20-cd97-59f3819889dd\"\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e8efb29-8b2e-4c0a-93b5-2e875c49cb3e", "name": "Bad request", "originalRequest": { "url": { "path": ["transactions"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "CreatedFrom", "value": "2024-04-16T08:00:55Z" }, { "key": "CreatedTo", "value": "2024-04-16T08:00:55Z" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56e6ea22-a0fd-4834-93aa-764675ac999e", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["transactions"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "CreatedFrom", "value": "2024-04-16T08:00:55Z" }, { "key": "CreatedTo", "value": "2024-04-16T08:00:55Z" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89b5c2f9-8d42-4872-bca2-4694188c508f", "name": "Internal server error", "originalRequest": { "url": { "path": ["transactions"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "CreatedFrom", "value": "2024-04-16T08:00:55Z" }, { "key": "CreatedTo", "value": "2024-04-16T08:00:55Z" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef6f1554-be89-4859-9935-d847621ef933", "name": "Transaction by ID", "request": { "name": "Transaction by ID", "description": { "content": "This endpoint retrieves the details of a single transaction by `TransactionID`.", "type": "text/plain" }, "url": { "path": ["transactions", ":TransactionID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "TransactionID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6d9a9707-d72f-49c4-824b-46b4963aa2b6", "name": "Transaction details", "originalRequest": { "url": { "path": ["transactions", ":TransactionID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "TransactionID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"19e5c423-2fe5-2049-639c-75d074ee5f77\",\n \"Network\": \"Solana\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"BTC\",\n \"PublicID\": \"string\",\n \"SubStatus\": \"UnderReview\",\n \"RFI\": {\n \"Status\": \"AwaitingCustomer\",\n \"Type\": \"Manual\"\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"string\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": \"BD4v6DaDE1YNWGKusnXn6SHrZZN2GHRn7bDxPoH5a9EB\"\n },\n \"FiatPayment\": {\n \"Amount\": \"10.1\",\n \"FeeAmount\": \"10.1\",\n \"FiatCurrency\": \"USD\",\n \"Rate\": \"10.1\",\n \"FiatDepositID\": \"string\",\n \"PaymentSystemID\": \"string\"\n },\n \"Orchestration\": {\n \"RuleID\": \"string\",\n \"RuleExecutionID\": \"string\"\n },\n \"FiatPaymentMethod\": {\n \"ID\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"DisplayDetails\": {\n \"value\": \"\"\n },\n \"Country\": \"US\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"Capabilities\": {\n \"PayoutTo\": false,\n \"PayoutFrom\": false,\n \"PayinTo\": true\n },\n \"AccountHolderDetails\": {\n \"Type\": {\n \"value\": \"\"\n },\n \"Name\": {\n \"value\": \"\"\n },\n \"NameLocal\": \"string\",\n \"BusinessName\": \"string\"\n },\n \"IssuerDetails\": {\n \"Name\": \"string\"\n }\n },\n \"Breakdown\": [\n {\n \"Type\": \"string\",\n \"Amount\": \"10.1\",\n \"FixedAmount\": \"10.1\",\n \"VariableAmount\": \"10.1\"\n },\n {\n \"Type\": \"string\",\n \"Amount\": \"10.1\",\n \"FixedAmount\": \"10.1\",\n \"VariableAmount\": \"10.1\"\n }\n ],\n \"AdjustmentFor\": {\n \"AdjustedTransactionID\": \"90a5e505-527f-9b10-a4da-6c352156f118\",\n \"AdjustmentID\": \"130c23fb-1565-7d02-8d83-a5969e835ec7\",\n \"Reason\": \"string\"\n },\n \"Refunds\": [\n {\n \"RefundID\": \"string\",\n \"RefundedAmount\": \"10.1\",\n \"Currency\": \"BTC\",\n \"RequestTime\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\"\n },\n {\n \"RefundID\": \"string\",\n \"RefundedAmount\": \"10.1\",\n \"Currency\": \"BTC\",\n \"RequestTime\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\"\n }\n ],\n \"Reverses\": \"430304f7-46fd-b6a1-a2f0-9e74150c9670\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12d6eb21-5f72-4c04-be6e-32537aff69af", "name": "Bad request", "originalRequest": { "url": { "path": ["transactions", ":TransactionID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "TransactionID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce053b54-65cc-4cbf-bde4-4ec397107f82", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["transactions", ":TransactionID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "TransactionID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "152ceec7-d800-43fa-8016-be60ecdb7004", "name": "Internal server error", "originalRequest": { "url": { "path": ["transactions", ":TransactionID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "TransactionID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4d65f8a-c188-4993-aa04-ec469f33045f", "name": "Create Withdraw Transaction", "request": { "name": "Create Withdraw Transaction", "description": { "content": "This endpoint initiates an on-chain cryptocurrency withdrawal.\n\nUse this endpoint to send crypto from a business account balance to a beneficiary. The server computes the network fee, debits the gross amount (including the network fee) from the account balance, and tracks the withdrawal end-to-end.", "type": "text/plain" }, "url": { "path": ["transactions", "withdraw"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"\",\n \"Network\": \"\",\n \"Amount\": \"\",\n \"DestinationAddress\": {\n \"Address\": \"\"\n },\n \"Nonce\": \"\",\n \"TravelRule\": {\n \"Beneficiary\": {\n \"value\": \"\"\n },\n \"Originator\": {\n \"value\": \"\"\n },\n \"OriginatingVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n },\n \"BeneficiaryVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"GrossAmount\": false,\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aa3fcc94-09f8-4ace-9023-62013d189767", "name": "Withdraw request successful", "originalRequest": { "url": { "path": ["transactions", "withdraw"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"Amount\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": \"BD4v6DaDE1YNWGKusnXn6SHrZZN2GHRn7bDxPoH5a9EB\"\n },\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"TravelRule\": {\n \"Beneficiary\": {\n \"value\": \"\"\n },\n \"Originator\": {\n \"value\": \"\"\n },\n \"OriginatingVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n },\n \"BeneficiaryVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"GrossAmount\": false,\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"customer_name\": \"John Doe\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Transaction\": {\n \"ID\": \"a05f943a-e2af-bda6-237b-9c0f9d256cab\",\n \"Network\": \"Solana\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"BTC\",\n \"PublicID\": \"string\",\n \"SubStatus\": \"UnderReview\",\n \"RFI\": {\n \"Status\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n },\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": {\n \"value\": \"\"\n }\n },\n \"FiatPayment\": {\n \"Amount\": {\n \"value\": \"\"\n },\n \"FeeAmount\": {\n \"value\": \"\"\n },\n \"FiatCurrency\": {\n \"value\": \"\"\n },\n \"Rate\": {\n \"value\": \"\"\n },\n \"FiatDepositID\": \"string\",\n \"PaymentSystemID\": \"string\"\n },\n \"Orchestration\": {\n \"RuleID\": \"string\",\n \"RuleExecutionID\": \"string\"\n },\n \"FiatPaymentMethod\": {\n \"ID\": \"string\",\n \"PaymentMethodCategory\": {\n \"value\": \"\"\n },\n \"DisplayDetails\": {\n \"value\": \"\"\n },\n \"Country\": {\n \"value\": \"\"\n },\n \"CustomerID\": {\n \"value\": \"\"\n },\n \"Capabilities\": {\n \"value\": \"\"\n },\n \"AccountHolderDetails\": {\n \"value\": \"\"\n },\n \"IssuerDetails\": {\n \"value\": \"\"\n }\n },\n \"Breakdown\": [\n {\n \"Type\": {\n \"value\": \"\"\n },\n \"Amount\": {\n \"value\": \"\"\n },\n \"FixedAmount\": {\n \"value\": \"\"\n },\n \"VariableAmount\": {\n \"value\": \"\"\n }\n },\n {\n \"Type\": {\n \"value\": \"\"\n },\n \"Amount\": {\n \"value\": \"\"\n },\n \"FixedAmount\": {\n \"value\": \"\"\n },\n \"VariableAmount\": {\n \"value\": \"\"\n }\n }\n ],\n \"AdjustmentFor\": {\n \"AdjustedTransactionID\": \"ecd3e3fe-4ec0-09ae-708b-0557c2855c63\",\n \"AdjustmentID\": \"18e9e78d-fa88-2bd0-7105-7b8674b14b91\",\n \"Reason\": \"string\"\n },\n \"Refunds\": [\n {\n \"RefundID\": {\n \"value\": \"\"\n },\n \"RefundedAmount\": {\n \"value\": \"\"\n },\n \"Currency\": {\n \"value\": \"\"\n },\n \"RequestTime\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n }\n },\n {\n \"RefundID\": {\n \"value\": \"\"\n },\n \"RefundedAmount\": {\n \"value\": \"\"\n },\n \"Currency\": {\n \"value\": \"\"\n },\n \"RequestTime\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n }\n }\n ],\n \"Reverses\": \"30577cac-7e13-037f-ec7f-23146a1205fb\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eb570e0-4ae4-46ff-8f93-c6f678949f8d", "name": "Bad request", "originalRequest": { "url": { "path": ["transactions", "withdraw"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"Amount\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": \"BD4v6DaDE1YNWGKusnXn6SHrZZN2GHRn7bDxPoH5a9EB\"\n },\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"TravelRule\": {\n \"Beneficiary\": {\n \"value\": \"\"\n },\n \"Originator\": {\n \"value\": \"\"\n },\n \"OriginatingVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n },\n \"BeneficiaryVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"GrossAmount\": false,\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"customer_name\": \"John Doe\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20d23230-aae7-472e-a40b-5b5d8f40ea7d", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["transactions", "withdraw"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"Amount\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": \"BD4v6DaDE1YNWGKusnXn6SHrZZN2GHRn7bDxPoH5a9EB\"\n },\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"TravelRule\": {\n \"Beneficiary\": {\n \"value\": \"\"\n },\n \"Originator\": {\n \"value\": \"\"\n },\n \"OriginatingVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n },\n \"BeneficiaryVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"GrossAmount\": false,\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"customer_name\": \"John Doe\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e32e218-2cb3-4f71-9823-279beef63854", "name": "Payment required. The response Type is `InsufficientBalance` when the account balance is below the requested amount.", "originalRequest": { "url": { "path": ["transactions", "withdraw"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"Amount\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": \"BD4v6DaDE1YNWGKusnXn6SHrZZN2GHRn7bDxPoH5a9EB\"\n },\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"TravelRule\": {\n \"Beneficiary\": {\n \"value\": \"\"\n },\n \"Originator\": {\n \"value\": \"\"\n },\n \"OriginatingVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n },\n \"BeneficiaryVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"GrossAmount\": false,\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"customer_name\": \"John Doe\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"validate account balance\",\n \"Detail\": \"The account balance is below the requested amount\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"InsufficientBalance\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "328118f6-7bad-4f9f-aaa8-472789863ae4", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["transactions", "withdraw"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"Amount\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": \"BD4v6DaDE1YNWGKusnXn6SHrZZN2GHRn7bDxPoH5a9EB\"\n },\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"TravelRule\": {\n \"Beneficiary\": {\n \"value\": \"\"\n },\n \"Originator\": {\n \"value\": \"\"\n },\n \"OriginatingVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n },\n \"BeneficiaryVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"GrossAmount\": false,\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"customer_name\": \"John Doe\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5cd1cc1-32d8-4a45-8b07-812f31d64586", "name": "Internal server error", "originalRequest": { "url": { "path": ["transactions", "withdraw"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"BTC\",\n \"Network\": \"Solana\",\n \"Amount\": \"10.1\",\n \"DestinationAddress\": {\n \"Address\": \"BD4v6DaDE1YNWGKusnXn6SHrZZN2GHRn7bDxPoH5a9EB\"\n },\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"TravelRule\": {\n \"Beneficiary\": {\n \"value\": \"\"\n },\n \"Originator\": {\n \"value\": \"\"\n },\n \"OriginatingVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n },\n \"BeneficiaryVASP\": {\n \"Name\": \"\",\n \"RegistrationNumber\": \"\",\n \"RegistrationCountry\": {\n \"value\": \"\"\n },\n \"RegisteredAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"GrossAmount\": false,\n \"ExternalID\": \"\",\n \"Metadata\": {\n \"customer_name\": \"John Doe\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "27acbf7a-8236-4583-bfc1-d70f9f9e9f37", "name": "Onboarding", "description": { "content": "Resources that are related to Onboarding.", "type": "text/plain" }, "item": [ { "id": "515c07f7-6c0d-4e67-afd5-c93ebeeffae1", "name": "Customer by ID", "request": { "name": "Customer by ID", "description": { "content": "This endpoint retrieves the details of a specific customer by their `CustomerID`.", "type": "text/plain" }, "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1c92a9bc-4ea1-4945-8822-b4b992db454e", "name": "Customer details retrieved successfully", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"Individual\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"DateOfBirth\": \"2024-04-16\",\n \"FullName\": {\n \"FirstName\": \"str\",\n \"LastName\": \"string\",\n \"MiddleName\": \"string\"\n },\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"string\",\n \"City\": \"string\",\n \"PostCode\": \"str\",\n \"State\": \"string\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"string\"\n },\n \"Verifications\": {\n \"Type\": \"Individual\",\n \"Status\": {\n \"value\": \"\"\n },\n \"EntityVerifications\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"ActionsRequired\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"Metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"Agreements\": [\n {\n \"Name\": {\n \"value\": \"\"\n },\n \"Version\": {\n \"value\": \"\"\n },\n \"Accepted\": {\n \"value\": \"\"\n },\n \"AcceptedAt\": {\n \"value\": \"\"\n }\n },\n {\n \"Name\": {\n \"value\": \"\"\n },\n \"Version\": {\n \"value\": \"\"\n },\n \"Accepted\": {\n \"value\": \"\"\n },\n \"AcceptedAt\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ee6aa14-0885-4cb4-8642-68ac7a2c9865", "name": "Bad request", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69be7e6c-4a18-4018-ac4a-0cd02c5ff7dc", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "523c3088-54dd-4d6d-bc01-41280f0bc76d", "name": "Internal server error", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c24b4f44-4626-4277-ae60-6ae540ed8a0a", "name": "Create/Update Customer", "request": { "name": "Create/Update Customer", "description": { "content": "This endpoint initiates [Noah's Reliance Model onboarding flow](/getting-started/kyc#reliance-model). Customers created from this endpoint must have a valid KYC status at the point of passing this data to Noah, and when executing a transaction. A unique `CustomerID` must be provided to enable unique identification in Noah. Customers are approved synchronously from the API call, and are immediately available to transact.\n\nBefore you get started with this endpoint, Noah must have authorized your usage of the Reliance Model. For more details on this process, see the [Compliance Overview](/getting-started/kyc).\n\nFollow the step-by-step guide: [Reliance Onboarding Recipe](/recipes/onboarding/reliance-onboarding)\n\nNote: Customers created from this endpoint are not able to process USD payments. In this case, follow the step-by-step guide for onboarding for USD payments: [Hosted Onboarding Recipe](/recipes/onboarding/hosted-onboarding)", "type": "text/plain" }, "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"FullName\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\"\n },\n \"DateOfBirth\": \"\",\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"\"\n },\n \"Email\": \"\",\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8c77e114-cb4b-4b5c-a096-5999801999e7", "name": "Customer created", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"FullName\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\"\n },\n \"DateOfBirth\": \"2024-04-16\",\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"\"\n },\n \"Email\": \"\",\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "289e758c-a9fe-4588-b9b8-b2e7b13cf6e2", "name": "Customer updated", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"FullName\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\"\n },\n \"DateOfBirth\": \"2024-04-16\",\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"\"\n },\n \"Email\": \"\",\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2abf818-3a7c-4257-a4e9-1d9dc3d15702", "name": "Bad request", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"FullName\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\"\n },\n \"DateOfBirth\": \"2024-04-16\",\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"\"\n },\n \"Email\": \"\",\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82412f50-06f6-4f63-9908-82784269d97f", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"FullName\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\"\n },\n \"DateOfBirth\": \"2024-04-16\",\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"\"\n },\n \"Email\": \"\",\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7251c039-6005-4326-ab9a-5135803e5a9f", "name": "Conflict. A customer with this CustomerID already exists.", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"FullName\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\"\n },\n \"DateOfBirth\": \"2024-04-16\",\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"\"\n },\n \"Email\": \"\",\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"create customer\",\n \"Detail\": \"customer already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Duplicate\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6235067f-3976-4939-9ecf-b7f6d745a403", "name": "Internal server error", "originalRequest": { "url": { "path": ["customers", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"FullName\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"MiddleName\": \"\"\n },\n \"DateOfBirth\": \"2024-04-16\",\n \"Identities\": [\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n },\n {\n \"IssuingCountry\": {\n \"value\": \"\"\n },\n \"IDNumber\": {\n \"value\": \"\"\n },\n \"IDType\": {\n \"value\": \"\"\n },\n \"IssuedDate\": {\n \"value\": \"\"\n },\n \"ExpiryDate\": {\n \"value\": \"\"\n }\n }\n ],\n \"PrimaryResidence\": {\n \"Street\": \"\",\n \"City\": \"\",\n \"PostCode\": \"\",\n \"State\": \"\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"\"\n },\n \"Email\": \"\",\n \"PhoneNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "824a549a-69b1-4dc2-83ef-65dd459b5260", "name": "Create Onboarding Session", "request": { "name": "Create Onboarding Session", "description": { "content": "This endpoint initiates [Noah's Standard Model onboarding flow](/getting-started/kyc#standard-model). Through this solution, Noah establishes direct contractual relationships with your end customers, handling all KYB/KYC verification and Terms and Conditions acceptance on your behalf.\n\nUse the endpoint to retrieve a response consisting of a URL, which you pass to your customer so that they can enter their details in a Hosted Onboarding session.\n\nThe returned `HostedURL` includes a session JWT. Individual hosted onboarding sessions expire **1 hour** after creation. Business hosted onboarding sessions expire **24 hours** after creation — when the customer already exists, this follows the stored customer type; otherwise it follows `CustomerType`. Generate the URL on demand rather than storing unused links. After expiry, call this endpoint again to mint a new session.\n\nFollow the step-by-step guide: [Hosted Onboarding Recipe](/recipes/onboarding/hosted-onboarding)\n\n:::info\nAdditional KYC applications for users who have already completed KYC will be rejected. Duplicate applications are flagged as a fraud prevention measure. If a user has already completed KYC, do not initiate another KYC session. Instead, retrieve the user's existing verification status. For details, see [KYC Platform](/api-concepts/kyc).\n:::\n\nNote: Customers needing to process USD payments must make use of Hosted Onboarding, rather than using [Reliance Onboarding](/api-reference/create-update-customer).", "type": "text/plain" }, "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\",\n \"key_8\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"\"\n },\n {\n \"FiatCurrencyCode\": \"\"\n }\n ],\n \"Form\": {\n \"key_0\": 9074.856545187451,\n \"key_1\": 9993\n },\n \"CustomerType\": \"\",\n \"Locale\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "01daf658-d98d-4bf9-a305-d6d52305191d", "name": "Hosted onboarding session request successful. The `OnboardingStatus` field indicates an action is required to complete the onboarding.", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"CustomerType\": \"\",\n \"Locale\": \"es\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"https://RvYyCupevLuaxruOIdjwoCF.texlXJTZZ8Y4ihKSzAz5gkmWyc32MEeoIIVcmyqKXYyp\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 9281.169442541363,\n \"key_1\": 2715,\n \"key_2\": 4547\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n \"string\",\n \"string\"\n ]\n },\n \"OnboardingStatus\": \"ReviewPending\",\n \"MissingSteps\": [\n \"string\",\n \"string\"\n ],\n \"Verifications\": {\n \"Type\": \"Individual\",\n \"Status\": \"string\",\n \"EntityVerifications\": [\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n },\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n }\n ],\n \"ActionsRequired\": [\n \"SourceOfWealth\",\n \"IncorrectTaxID\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83f7b26a-66c3-45e2-bd96-8e9ccecbbdd0", "name": "Customer created", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"CustomerType\": \"\",\n \"Locale\": \"es\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9bb5fb8-2645-4504-8da1-b357d822882f", "name": "Onboarding in progress. The review will be processed asynchronously and a webhook will be sent when the review is complete or has advanced to the next step.", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"CustomerType\": \"\",\n \"Locale\": \"es\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d1e9919-2237-4a66-b021-b413821532a3", "name": "Bad request", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"CustomerType\": \"\",\n \"Locale\": \"es\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92454263-28cf-499a-8f49-f394423c15f9", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"CustomerType\": \"\",\n \"Locale\": \"es\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0f94f0c-9961-49c7-80a6-258fd2e3f1ae", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"CustomerType\": \"\",\n \"Locale\": \"es\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac87e5f2-ebc8-4186-9814-bd8feef00817", "name": "Internal server error", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Form\": {\n \"key_0\": \"string\"\n },\n \"CustomerType\": \"\",\n \"Locale\": \"es\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a68bc11d-deea-49ce-aa30-edcf8ded752c", "name": "Prefill Customer Details", "request": { "name": "Prefill Customer Details", "description": { "content": "Use the Prefill Customer Details endpoint to create a Customer and submit any KYC/KYB information you have already collected.\n\nPrefill allows you to pre-populate known data before initiating the [Hosted Onboarding](/recipes/onboarding/hosted-onboarding) flow, which will gather any remaining required information to collect missing compliance data through dynamic forms or hosted sessions, Terms and Conditions acceptance for regulatory compliance, and Fiat currency selection.\n\nThe `Type` parameter defines the known data for prefilling a customer's Hosted Onboarding session, which can be one of the following.\n\n* **`SumSubToken`.** Follow the step-by-step guide: [Token Share Onboarding Recipe](/recipes/onboarding/token-share-onboarding).\n\n* **`BusinessCustomerPrefill`.** Follow the step-by-step guide: [Business Customer Prefill Recipe](/recipes/onboarding/business-customer-prefill).\n\n* **`IndividualCustomerPrefill`.** Follow the step-by-step guide: [Individual Customer Prefill Recipe](/recipes/onboarding/individual-customer-prefill)", "type": "text/plain" }, "url": { "path": ["onboarding", ":CustomerID", "prefill"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"Token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1417c93f-ecad-49c2-9376-f3d56688812b", "name": "Data processed", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"Token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b0870ce-26bb-4ec4-8d3b-2818a1fc1aaa", "name": "Bad request", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"Token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4f77e6-3061-408a-b264-e67456275b7b", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"Token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00889a3c-9570-41b9-bfab-4bcca5a869ed", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"Token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfaae63c-dc1d-441b-85c9-9d05fa6f210c", "name": "Internal server error", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": \"\",\n \"Token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c50cd451-3944-4581-bd10-b50c5fbdc30e", "name": "Get Document Upload URL", "request": { "name": "Get Document Upload URL", "description": { "content": "Get a URL to upload a document programmatically to add documents to KYC onboarding flows.\n\nMultiple types of documents are supported, using the `Type` parameter described below, both for individual users and company documents for business users.\n\nThe response consists of a URL, together with the date and time at which it will expire, which should be used like this, for example:\n\n`curl -X PUT -H 'Content-Type: image/png' --upload-file image.png '{{URL}}'`\n\n**Note**: If a document is double-sided, submit two images and set up the optional `Side` property (`Front` and `Back`).", "type": "text/plain" }, "url": { "path": ["onboarding", ":CustomerID", "prefill", "documents", "upload-url"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "Type", "value": "", "description": "(Required) Document type." }, { "disabled": false, "key": "Side", "value": "", "description": "Document side." }, { "disabled": false, "key": "CountryCode", "value": "", "description": "(Required) " }, { "disabled": false, "key": "AssociateID", "value": "", "description": "The ID of the affiliated party associated with the document." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) Customer ID for the onboarding session." } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c56bf3d0-85b4-4bcc-a3fb-de7976df7755", "name": "Document upload URL successfully created.", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill", "documents", "upload-url"], "host": ["{{baseUrl}}"], "query": [ { "key": "Type", "value": "" }, { "key": "Side", "value": "" }, { "key": "CountryCode", "value": "US" }, { "key": "AssociateID", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) Customer ID for the onboarding session." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"PresignedURL\": \"http://nG.imdah5Ac6hX+tnMSdquzk78MgA7hnWXy-FvZHpOhTWLjvCPSc+NR\",\n \"ExpiresAt\": \"2024-04-16T08:00:55Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95ff5068-c03b-4359-95a7-895ad6d7dcf4", "name": "Bad request", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill", "documents", "upload-url"], "host": ["{{baseUrl}}"], "query": [ { "key": "Type", "value": "" }, { "key": "Side", "value": "" }, { "key": "CountryCode", "value": "US" }, { "key": "AssociateID", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) Customer ID for the onboarding session." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2827aa2-757e-405d-b042-be8900531f76", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill", "documents", "upload-url"], "host": ["{{baseUrl}}"], "query": [ { "key": "Type", "value": "" }, { "key": "Side", "value": "" }, { "key": "CountryCode", "value": "US" }, { "key": "AssociateID", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) Customer ID for the onboarding session." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f55881b-5427-4851-ba02-a4aa680ef304", "name": "Internal server error", "originalRequest": { "url": { "path": ["onboarding", ":CustomerID", "prefill", "documents", "upload-url"], "host": ["{{baseUrl}}"], "query": [ { "key": "Type", "value": "" }, { "key": "Side", "value": "" }, { "key": "CountryCode", "value": "US" }, { "key": "AssociateID", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) Customer ID for the onboarding session." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bbe640ee-27af-4291-81ce-ecc590b72f16", "name": "Customers", "request": { "name": "Customers", "description": { "content": "This endpoint retrieves a paginated list of customers for the Business User's account. `Agreements` is not returned on list items; use `GET /customers/{CustomerID}` or Customer webhooks for agreement state.", "type": "text/plain" }, "url": { "path": ["customers"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "PageSize", "value": "20" }, { "disabled": false, "key": "PageToken", "value": "" }, { "disabled": false, "key": "SortDirection", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a63058c5-7115-410e-a87f-22effb04dd44", "name": "List of customers", "originalRequest": { "url": { "path": ["customers"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Items\": [\n {\n \"Type\": {\n \"value\": \"\"\n },\n \"CustomerID\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"DateOfBirth\": {\n \"value\": \"\"\n },\n \"FullName\": {\n \"value\": \"\"\n },\n \"Identities\": {\n \"value\": \"\"\n },\n \"PrimaryResidence\": {\n \"value\": \"\"\n },\n \"Verifications\": {\n \"value\": \"\"\n },\n \"Metadata\": {\n \"value\": \"\"\n },\n \"Agreements\": {\n \"value\": \"\"\n }\n },\n {\n \"Type\": {\n \"value\": \"\"\n },\n \"CustomerID\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"DateOfBirth\": {\n \"value\": \"\"\n },\n \"FullName\": {\n \"value\": \"\"\n },\n \"Identities\": {\n \"value\": \"\"\n },\n \"PrimaryResidence\": {\n \"value\": \"\"\n },\n \"Verifications\": {\n \"value\": \"\"\n },\n \"Metadata\": {\n \"value\": \"\"\n },\n \"Agreements\": {\n \"value\": \"\"\n }\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "890e7c77-f7f8-4549-9ead-bccb1fb5b2b8", "name": "Bad request", "originalRequest": { "url": { "path": ["customers"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f26a351-c792-4ead-81d9-7c3e19d4d9e4", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["customers"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b696a901-db79-495b-b560-30f1b53934d9", "name": "Internal server error", "originalRequest": { "url": { "path": ["customers"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "SortDirection", "value": "DESC" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "06051fcd-13d3-483d-a068-885e501517a6", "name": "PSP Payments", "description": { "content": "Resources that are related to PSP Payments.", "type": "text/plain" }, "item": [], "event": [] }, { "id": "39fc9c97-c2c7-4268-9a8e-beacd8fd06ea", "name": "Utilities", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3c0417bc-2556-4f05-b99d-2960e795f946", "name": "Help Desk Session", "request": { "name": "Help Desk Session", "description": { "content": "This endpoint creates a help desk session for the customer.", "type": "text/plain" }, "url": { "path": ["help", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70a511a3-5949-4b3a-bf64-e38b37305176", "name": "Help Desk Session", "originalRequest": { "url": { "path": ["help", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"https://oAl.azB9nYwkGtwhzoO4lz5dez4suP-C6XnUwRhJSDQZgSHM5-A7ptjyWQiN0+E\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 2326.8783651976046,\n \"key_1\": true\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n \"string\",\n \"string\"\n ]\n },\n \"OnboardingStatus\": \"AgreementsRequired\",\n \"MissingSteps\": [\n \"string\",\n \"string\"\n ],\n \"Verifications\": {\n \"Type\": \"Business\",\n \"Status\": \"string\",\n \"EntityVerifications\": [\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n },\n {\n \"Entity\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Created\": {\n \"value\": \"\"\n },\n \"Modified\": {\n \"value\": \"\"\n },\n \"Model\": {\n \"value\": \"\"\n },\n \"RejectionData\": {\n \"value\": \"\"\n }\n }\n ],\n \"ActionsRequired\": [\n \"ProofOfAddressReupload\",\n \"ProofOfAddressReupload\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "475650b5-a2ed-4c89-8c77-892c6529aa65", "name": "Bad request", "originalRequest": { "url": { "path": ["help", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f1de98a-489e-45aa-a889-b8f01309472c", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["help", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04f5e8a9-5050-40c0-9287-550ab132547e", "name": "Internal server error", "originalRequest": { "url": { "path": ["help", ":CustomerID"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "CustomerID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3136451e-35b9-4aaf-b9af-16aca4c49a28", "name": "Balances", "request": { "name": "Balances", "description": { "content": "This endpoint retrieves a paginated list of balances for the Business User's account.", "type": "text/plain" }, "url": { "path": ["balances"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "PageSize", "value": "20" }, { "disabled": false, "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bb1dbe1b-66f4-4d57-b33a-254fc3f3066e", "name": "List of balances", "originalRequest": { "url": { "path": ["balances"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Items\": [\n {\n \"AccountType\": \"Current\",\n \"CryptoCurrency\": \"USDC\",\n \"Available\": \"10.1\",\n \"Total\": \"10.1\"\n },\n {\n \"AccountType\": \"Current\",\n \"CryptoCurrency\": \"USDC\",\n \"Available\": \"10.1\",\n \"Total\": \"10.1\"\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67bb98cf-fc75-49ed-a617-a6d37b77cf8e", "name": "Bad request", "originalRequest": { "url": { "path": ["balances"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f642b6-d2de-4200-90cc-70a1ee5b8f0e", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["balances"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0615780b-3717-4044-a009-d8f2e60969af", "name": "Internal server error", "originalRequest": { "url": { "path": ["balances"], "host": ["{{baseUrl}}"], "query": [ { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93abc7f2-1556-4e78-b4e8-a9ed9a5df4ca", "name": "Dynamic Form", "request": { "name": "Dynamic Form", "description": { "content": "This endpoint provides a [JSONForm](https://jsonforms.io/) schema needed to configure payment methods for transactions on a specified channel. Use this schema to dynamically generate forms based on the selected payment method. The `ChannelID` parameter, obtainable from the Supported Channels endpoint, specifies the target channel for which the form is generated.\n\nFollow the step-by-step guides:\n * [Direct Payout to US Business](/recipes/payout/global-payouts-business)\n * [Direct Payout to Individual Customer](/recipes/payout/global-payouts-individual)\n\n**Note:** It is not possible to fetch schemas for channels where the `PaymentMethodType` is set to `TokenizedCard`, as the API does not directly accept credit card details.", "type": "text/plain" }, "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "CustomerID", "value": "" }, { "disabled": false, "key": "PaymentMethodID", "value": "" }, { "disabled": false, "key": "Self", "value": "", "description": "When true, first-party form shaping applies. Omitted or false uses the channel's SupportedParties." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9e77df6e-6f55-43fd-a89f-198f179eb46c", "name": "Payment method form schema", "originalRequest": { "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "Self", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": false,\n \"key_1\": false\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n \"string\",\n \"string\"\n ]\n },\n \"FormMetadata\": {\n \"ContentHash\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33e2de7c-0664-4d19-9fe5-65068677b472", "name": "Bad request", "originalRequest": { "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "Self", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2ad4436-80f4-4a5d-ae2f-4b27e3c9942e", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "Self", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b30d0d11-a798-454c-bfad-ee9e8b51c784", "name": "Internal server error", "originalRequest": { "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "Self", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "764f2a7f-18d9-4766-984e-2d48f4ed2acf", "name": "Get Channel by ID", "request": { "name": "Get Channel by ID", "description": { "content": "This endpoint retrieves detailed information about a specific channel by its ID.\n\nThe endpoint returns a single channel with calculated fees, limits, and processing information for the specified cryptocurrency and optional fiat amount.\n\nUse this endpoint when you know the specific channel ID and want to get detailed information about that channel.", "type": "text/plain" }, "url": { "path": ["channels", ":ChannelID"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "CryptoCurrency", "value": "", "description": "(Required) Cryptocurrency (prod/sandbox):\n * BTC/BTC_TEST\n * USDC/USDC_TEST\n" }, { "disabled": false, "key": "FiatAmount", "value": "", "description": "The fiat amount for which to calculate channel details and fees" }, { "disabled": false, "key": "CustomerID", "value": "", "description": "Customer ID for personalized channel information and payment methods" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) The ID of the channel to retrieve" } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "68d488bd-2a3b-46e0-a297-3e086b2a9d01", "name": "Channel details", "originalRequest": { "url": { "path": ["channels", ":ChannelID"], "host": ["{{baseUrl}}"], "query": [ { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) The ID of the channel to retrieve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"PaymentMethodType\": \"BankLocal\",\n \"FiatCurrency\": \"USD\",\n \"Country\": \"US\",\n \"FeeConfig\": {\n \"Fixed\": \"10.1\",\n \"Percentage\": \"10.1\",\n \"FiatCurrency\": \"USD\"\n },\n \"Limits\": {\n \"MinLimit\": \"10.1\",\n \"MaxLimit\": \"10.1\"\n },\n \"Rate\": \"10.1\",\n \"ProcessingSeconds\": 718,\n \"Calculated\": {\n \"TotalFee\": \"10.1\"\n },\n \"CryptoLimits\": {\n \"MinLimit\": \"10.1\",\n \"MaxLimit\": \"10.1\"\n },\n \"PaymentMethods\": [\n {\n \"ID\": \"string\",\n \"PaymentMethodType\": \"BankLocal\",\n \"Details\": {\n \"value\": \"\"\n },\n \"AccountHolderDetails\": {\n \"Type\": {\n \"value\": \"\"\n },\n \"Name\": {\n \"value\": \"\"\n },\n \"NameLocal\": {\n \"value\": \"\"\n },\n \"BusinessName\": {\n \"value\": \"\"\n }\n },\n \"IssuerDetails\": {\n \"Name\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"ID\": \"string\",\n \"PaymentMethodType\": \"BankLocal\",\n \"Details\": {\n \"value\": \"\"\n },\n \"AccountHolderDetails\": {\n \"Type\": {\n \"value\": \"\"\n },\n \"Name\": {\n \"value\": \"\"\n },\n \"NameLocal\": {\n \"value\": \"\"\n },\n \"BusinessName\": {\n \"value\": \"\"\n }\n },\n \"IssuerDetails\": {\n \"Name\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"ProcessingTier\": \"Standard\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": false\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n \"string\",\n \"string\"\n ]\n },\n \"FormMetadata\": {\n \"ContentHash\": \"string\"\n },\n \"Issuer\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ba8697-095c-494b-a19a-5164f178e988", "name": "Bad request", "originalRequest": { "url": { "path": ["channels", ":ChannelID"], "host": ["{{baseUrl}}"], "query": [ { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) The ID of the channel to retrieve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a438dfae-383c-453e-8771-cf5c8c7ff00b", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["channels", ":ChannelID"], "host": ["{{baseUrl}}"], "query": [ { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) The ID of the channel to retrieve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e535b027-1653-4e6f-a81b-1b34ca55855d", "name": "Channel not found", "originalRequest": { "url": { "path": ["channels", ":ChannelID"], "host": ["{{baseUrl}}"], "query": [ { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) The ID of the channel to retrieve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61b44701-cd4c-44c2-82fe-ec5c884c66be", "name": "Internal server error", "originalRequest": { "url": { "path": ["channels", ":ChannelID"], "host": ["{{baseUrl}}"], "query": [ { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) The ID of the channel to retrieve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66f204de-850c-43d2-b3a0-992ee9c29b74", "name": "Channels", "request": { "name": "Channels", "description": { "content": "This endpoint provides the list of supported channels for selling crypto into fiat.\n\nFollow the step-by-step guides:\n * [Direct Payout to US Business](/recipes/payout/global-payouts-business)\n * [Direct Payout to Individual Customer](/recipes/payout/global-payouts-individual)", "type": "text/plain" }, "url": { "path": ["channels", "sell"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "Country", "value": "" }, { "disabled": false, "key": "CryptoCurrency", "value": "", "description": "(Required) " }, { "disabled": false, "key": "FiatCurrency", "value": "", "description": "Supported fiat ISO_4217 3 letter currency codes." }, { "disabled": false, "key": "FiatAmount", "value": "" }, { "disabled": false, "key": "CustomerID", "value": "" }, { "disabled": false, "key": "PaymentMethodID", "value": "" }, { "disabled": false, "key": "PageSize", "value": "20" }, { "disabled": false, "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d698a937-bb7a-429e-b5ec-3f6e583656bb", "name": "List of channels", "originalRequest": { "url": { "path": ["channels", "sell"], "host": ["{{baseUrl}}"], "query": [ { "key": "Country", "value": "US" }, { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatCurrency", "value": "USD" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Items\": [\n {\n \"ID\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"PaymentMethodType\": \"BankLocal\",\n \"FiatCurrency\": \"USD\",\n \"Country\": \"US\",\n \"FeeConfig\": {\n \"Fixed\": {\n \"value\": \"\"\n },\n \"Percentage\": {\n \"value\": \"\"\n },\n \"FiatCurrency\": {\n \"value\": \"\"\n }\n },\n \"Limits\": {\n \"MinLimit\": {\n \"value\": \"\"\n },\n \"MaxLimit\": {\n \"value\": \"\"\n }\n },\n \"Rate\": \"10.1\",\n \"ProcessingSeconds\": 8283,\n \"Calculated\": {\n \"TotalFee\": {\n \"value\": \"\"\n }\n },\n \"CryptoLimits\": {\n \"MinLimit\": {\n \"value\": \"\"\n },\n \"MaxLimit\": {\n \"value\": \"\"\n }\n },\n \"PaymentMethods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"ProcessingTier\": \"Standard\",\n \"FormSchema\": {\n \"$schema\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n }\n },\n \"FormMetadata\": {\n \"ContentHash\": {\n \"value\": \"\"\n }\n },\n \"Issuer\": \"string\"\n },\n {\n \"ID\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"PaymentMethodType\": \"BankLocal\",\n \"FiatCurrency\": \"USD\",\n \"Country\": \"US\",\n \"FeeConfig\": {\n \"Fixed\": {\n \"value\": \"\"\n },\n \"Percentage\": {\n \"value\": \"\"\n },\n \"FiatCurrency\": {\n \"value\": \"\"\n }\n },\n \"Limits\": {\n \"MinLimit\": {\n \"value\": \"\"\n },\n \"MaxLimit\": {\n \"value\": \"\"\n }\n },\n \"Rate\": \"10.1\",\n \"ProcessingSeconds\": 4308,\n \"Calculated\": {\n \"TotalFee\": {\n \"value\": \"\"\n }\n },\n \"CryptoLimits\": {\n \"MinLimit\": {\n \"value\": \"\"\n },\n \"MaxLimit\": {\n \"value\": \"\"\n }\n },\n \"PaymentMethods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"ProcessingTier\": \"Priority\",\n \"FormSchema\": {\n \"$schema\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n }\n },\n \"FormMetadata\": {\n \"ContentHash\": {\n \"value\": \"\"\n }\n },\n \"Issuer\": \"string\"\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69b47f1c-1c38-4464-8df8-f7c213f32478", "name": "Bad request", "originalRequest": { "url": { "path": ["channels", "sell"], "host": ["{{baseUrl}}"], "query": [ { "key": "Country", "value": "US" }, { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatCurrency", "value": "USD" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf2de1d9-8677-4e00-a1a7-ffa4b19aaf66", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["channels", "sell"], "host": ["{{baseUrl}}"], "query": [ { "key": "Country", "value": "US" }, { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatCurrency", "value": "USD" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc689589-3519-4c1f-a3b3-180bc975a341", "name": "Internal server error", "originalRequest": { "url": { "path": ["channels", "sell"], "host": ["{{baseUrl}}"], "query": [ { "key": "Country", "value": "US" }, { "key": "CryptoCurrency", "value": "BTC" }, { "key": "FiatCurrency", "value": "USD" }, { "key": "FiatAmount", "value": "10.1" }, { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "value": "" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "431bd617-a33d-4f63-a253-1feb24266da9", "name": "Countries", "request": { "name": "Countries", "description": { "content": "This endpoint retrieves the complete list of countries where Sell operations are supported.\n\nThe response is useful for enabling customers to select their desired Country+FiatCurrency combination for receiving payouts.\n\nAfter making a selection, obtain the channels for the chosen Country+FiatCurrency using `GET /channels/sell`.\n\nFollow the step-by-step guides:\n * [Direct Payout to US Business](/recipes/payout/global-payouts-business)\n * [Direct Payout to Individual Customer](/recipes/payout/global-payouts-individual)", "type": "text/plain" }, "url": { "path": ["channels", "sell", "countries"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "CustomerID", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b6e14bc7-d507-4e92-8d58-16c351f1ba62", "name": "List of countries", "originalRequest": { "url": { "path": ["channels", "sell", "countries"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AR\": [\n \"ARS\"\n ],\n \"BR\": [\n \"BRL\"\n ],\n \"MX\": [\n \"MXN\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f4e561a-84d5-4943-9ca0-d277916b6af0", "name": "Bad request", "originalRequest": { "url": { "path": ["channels", "sell", "countries"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad279a14-fd35-4024-898e-e28c38dd8bfc", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["channels", "sell", "countries"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dad07e4-7f5a-44a1-8443-0cd08fbb2595", "name": "Internal server error", "originalRequest": { "url": { "path": ["channels", "sell", "countries"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bc830b2-b200-4c90-a087-a14d09889d26", "name": "Prices", "request": { "name": "Prices", "description": { "content": "This endpoint lets you retrieve real-time information about a conversion between two supported currencies, including the rate before and after the Noah Fee is applied.\n\nDuring a Noah Hosted Checkout session, real-time `/prices` data is used to calculate the fees and thus the final amount a customer will pay. If neither SourceAmount or DestinationAmount is defined, the fee is not available.", "type": "text/plain" }, "url": { "path": ["prices"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "SourceCurrency", "value": "", "description": "(Required) The source currency to convert from." }, { "disabled": false, "key": "DestinationCurrency", "value": "", "description": "(Required) The destination currency to convert to. (prod/sandbox):\n * BTC/BTC_TEST\n * USDC/USDC_TEST\n" }, { "disabled": false, "key": "SourceAmount", "value": "", "description": "Only one of `SourceAmount` or `DestinationAmount` can be defined. When this amount is specified, the response `DestinationAmount` field indicates how much you will get for this, after the deduction of any fees." }, { "disabled": false, "key": "DestinationAmount", "value": "", "description": "Only one of `SourceAmount` or `DestinationAmount` can be defined. When this amount is specified, the response `SourceAmount` field indicates how much you will need to sell to get this and cover any fees." }, { "disabled": false, "key": "PaymentMethodCategory", "value": "" }, { "disabled": false, "key": "Country", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "90805b41-5a96-45cd-a1db-1d795cc0b52e", "name": "Price estimate successful. Response includes the rate of currency exchange before and after fees are subtracted.", "originalRequest": { "url": { "path": ["prices"], "host": ["{{baseUrl}}"], "query": [ { "key": "SourceCurrency", "value": "USD" }, { "key": "DestinationCurrency", "value": "BTC" }, { "key": "SourceAmount", "value": "10.1" }, { "key": "DestinationAmount", "value": "10.1" }, { "key": "PaymentMethodCategory", "value": "Bank" }, { "key": "Country", "value": "US" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Items\": [\n {\n \"PaymentMethodCategory\": \"Bank\",\n \"Rate\": \"10.1\",\n \"UpdatedAt\": \"2024-04-16T08:00:55Z\",\n \"TotalFee\": \"10.1\",\n \"BusinessFee\": \"10.1\",\n \"SourceAmount\": \"10.1\",\n \"DestinationAmount\": \"10.1\",\n \"CryptoFeeBreakdown\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"PaymentMethodCategory\": \"Bank\",\n \"Rate\": \"10.1\",\n \"UpdatedAt\": \"2024-04-16T08:00:55Z\",\n \"TotalFee\": \"10.1\",\n \"BusinessFee\": \"10.1\",\n \"SourceAmount\": \"10.1\",\n \"DestinationAmount\": \"10.1\",\n \"CryptoFeeBreakdown\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08ce5783-b596-4766-9808-c48f6cb1d686", "name": "Bad request", "originalRequest": { "url": { "path": ["prices"], "host": ["{{baseUrl}}"], "query": [ { "key": "SourceCurrency", "value": "USD" }, { "key": "DestinationCurrency", "value": "BTC" }, { "key": "SourceAmount", "value": "10.1" }, { "key": "DestinationAmount", "value": "10.1" }, { "key": "PaymentMethodCategory", "value": "Bank" }, { "key": "Country", "value": "US" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78b582f3-2cf3-436b-941b-6fb7684e8c59", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["prices"], "host": ["{{baseUrl}}"], "query": [ { "key": "SourceCurrency", "value": "USD" }, { "key": "DestinationCurrency", "value": "BTC" }, { "key": "SourceAmount", "value": "10.1" }, { "key": "DestinationAmount", "value": "10.1" }, { "key": "PaymentMethodCategory", "value": "Bank" }, { "key": "Country", "value": "US" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddef7cac-3654-40b0-b1e7-5e5c3b90d259", "name": "Internal server error", "originalRequest": { "url": { "path": ["prices"], "host": ["{{baseUrl}}"], "query": [ { "key": "SourceCurrency", "value": "USD" }, { "key": "DestinationCurrency", "value": "BTC" }, { "key": "SourceAmount", "value": "10.1" }, { "key": "DestinationAmount", "value": "10.1" }, { "key": "PaymentMethodCategory", "value": "Bank" }, { "key": "Country", "value": "US" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e640f54-3d9c-4ba1-8998-da78f35cac52", "name": "Payment Methods", "request": { "name": "Payment Methods", "description": { "content": "This endpoint retrieves a paginated list of payment methods for a specific customer.", "type": "text/plain" }, "url": { "path": ["payment-methods"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "CustomerID", "value": "", "description": "(Required) " }, { "disabled": false, "key": "PageSize", "value": "20" }, { "disabled": false, "key": "PageToken", "value": "" }, { "disabled": false, "key": "Capability", "value": "", "description": "Filter payment methods by capability" } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "defd2882-7c78-4e44-b22e-e4f6366e568f", "name": "List of fiat payment methods", "originalRequest": { "url": { "path": ["payment-methods"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "Capability", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Items\": [\n {\n \"ID\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"DisplayDetails\": {\n \"value\": \"\"\n },\n \"Country\": \"US\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"Capabilities\": {\n \"PayoutTo\": {\n \"value\": \"\"\n },\n \"PayoutFrom\": {\n \"value\": \"\"\n },\n \"PayinTo\": {\n \"value\": \"\"\n }\n },\n \"AccountHolderDetails\": {\n \"Type\": {\n \"value\": \"\"\n },\n \"Name\": {\n \"value\": \"\"\n },\n \"NameLocal\": {\n \"value\": \"\"\n },\n \"BusinessName\": {\n \"value\": \"\"\n }\n },\n \"IssuerDetails\": {\n \"Name\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"ID\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"DisplayDetails\": {\n \"value\": \"\"\n },\n \"Country\": \"US\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"Capabilities\": {\n \"PayoutTo\": {\n \"value\": \"\"\n },\n \"PayoutFrom\": {\n \"value\": \"\"\n },\n \"PayinTo\": {\n \"value\": \"\"\n }\n },\n \"AccountHolderDetails\": {\n \"Type\": {\n \"value\": \"\"\n },\n \"Name\": {\n \"value\": \"\"\n },\n \"NameLocal\": {\n \"value\": \"\"\n },\n \"BusinessName\": {\n \"value\": \"\"\n }\n },\n \"IssuerDetails\": {\n \"Name\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257aa5ec-f8d8-4764-8844-9eaa885f5950", "name": "Bad request", "originalRequest": { "url": { "path": ["payment-methods"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "Capability", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18d934a5-ac9e-4c7e-95e4-18331890b231", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["payment-methods"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "Capability", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6029364-8df5-4626-9def-79e11c9d5f80", "name": "Internal server error", "originalRequest": { "url": { "path": ["payment-methods"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" }, { "key": "Capability", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c68c9450-1e7a-48ad-8a9f-c34d80013ba8", "name": "Virtual Accounts", "request": { "name": "Virtual Accounts", "description": { "content": "Returns a paginated list of virtual accounts for a customer. Each virtual account contains the payment methods linked to the same virtual account identifier and status of the virtual account.", "type": "text/plain" }, "url": { "path": ["virtual-accounts"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "CustomerID", "value": "", "description": "(Required) Customer whose virtual accounts should be returned." }, { "disabled": false, "key": "PageSize", "value": "20", "description": "Maximum number of virtual accounts to return." }, { "disabled": false, "key": "PageToken", "value": "", "description": "Token from a previous response used to retrieve the next page." } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c8cd073a-a829-47ce-8f88-a3d086d999cf", "name": "Paginated virtual account list", "originalRequest": { "url": { "path": ["virtual-accounts"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Items\": [\n {\n \"VirtualAccountID\": \"v\",\n \"Status\": \"Active\",\n \"PaymentMethods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"VirtualAccountID\": \"dlUCRNYKRI\",\n \"Status\": \"Active\",\n \"PaymentMethods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ff7ad9-7e4a-4e00-9c3f-7ee5cbe8e7ac", "name": "Bad request", "originalRequest": { "url": { "path": ["virtual-accounts"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c52af6b9-698e-4b22-bb69-c0228a16034f", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["virtual-accounts"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bac3f435-75a2-4178-ac56-51cefa6a3952", "name": "Internal server error", "originalRequest": { "url": { "path": ["virtual-accounts"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PageSize", "value": "20" }, { "key": "PageToken", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b20cc151-91a3-4903-a4e5-81a4baa1d6b4", "name": "Close Virtual Account", "request": { "name": "Close Virtual Account", "description": { "content": "Request closure of one of your virtual accounts. Returns `202 Accepted` when closure has been requested or is already in progress, and `200 OK` when the virtual account is already closed.", "type": "text/plain" }, "url": { "path": ["virtual-accounts", ":VirtualAccountID", "close"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to close." } ] }, "header": [ { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "29974b7b-62a8-41d6-9466-a7d72d9ab352", "name": "Virtual account is already closed.", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "close"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to close." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"VirtualAccountID\": \"\",\n \"Status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "015aa9b8-bca9-40c6-aa1e-b53c3acda2e9", "name": "Close request accepted. The virtual account is pending closure.", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "close"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to close." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"VirtualAccountID\": \"\",\n \"Status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b35d7b6-850a-4bc9-966f-e8179f1d0ee1", "name": "Bad request", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "close"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to close." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e52de490-fa18-4744-acc9-2ab83cfa35d8", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "close"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to close." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a5a9335-069d-46a3-bb90-fd88f54ce4e3", "name": "Conflict. This attempt did not apply. Retry the same request; a repeated 409 means the stored state cannot accept the change, so the request must change.", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "close"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to close." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Action\": \"repo create rule\",\n \"Detail\": \"rule trigger index already exists\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5c736b9-c717-41cf-a45e-a1265dc3d2bd", "name": "Internal server error", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "close"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to close." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "(Required) Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).", "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Type\": \"InvalidMessage\",\n \"Instance\": \"string\",\n \"Action\": \"string\",\n \"Detail\": \"string\",\n \"Extensions\": {\n \"Request\": {},\n \"Features\": {\n \"key_0\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n \"RequestExtension\": {\n \"Body\": [\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n },\n {\n \"Reason\": {\n \"value\": \"\"\n },\n \"Description\": {\n \"value\": \"\"\n },\n \"Field\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"DenyExtension\": [\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"Reason\": \"string\",\n \"Description\": \"string\",\n \"Principal\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n },\n \"Subtype\": {\n \"value\": \"\"\n }\n },\n \"Resource\": {\n \"ID\": {\n \"value\": \"\"\n },\n \"Type\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "exec": [ "const jsrsasign = require('jsrsasign');", "const CryptoJS = require('crypto-js');", "", "const apiKey = pm.collectionVariables.get('apiKey');", "if (!apiKey) {", " throw new Error('Set the apiKey collection variable.');", "}", "", "pm.request.headers.upsert({ key: 'X-Api-Key', value: apiKey });", "", "const privateKey = pm.collectionVariables.get('privateKey');", "if (!privateKey) {", " pm.request.headers.remove('Api-Signature');", " return;", "}", "", "const resolvedUrl = pm.variables.replaceIn(pm.request.url.toString());", "const url = new URL(resolvedUrl);", "", "let bodyHash;", "const rawBody = pm.request.body && pm.request.body.mode === 'raw' ? pm.request.body.raw : '';", "if (rawBody) {", " const resolvedBody = pm.variables.replaceIn(rawBody);", " bodyHash = CryptoJS.SHA256(resolvedBody).toString(CryptoJS.enc.Hex);", "}", "", "const queryParams = {};", "for (const [key, value] of url.searchParams.entries()) {", " queryParams[key] = value;", "}", "", "const now = Math.floor(Date.now() / 1000);", "const payload = {", " aud: 'https://api.noah.com',", " iat: now,", " exp: now + 5 * 60,", " method: pm.request.method,", " path: url.pathname,", "};", "if (Object.keys(queryParams).length > 0) {", " payload.queryParams = queryParams;", "}", "if (bodyHash) {", " payload.bodyHash = bodyHash;", "}", "", "const header = { alg: 'ES384', typ: 'JWT' };", "const signature = jsrsasign.KJUR.jws.JWS.sign('ES384', JSON.stringify(header), JSON.stringify(payload), privateKey);", "", "pm.request.headers.upsert({ key: 'Api-Signature', value: signature });" ], "type": "text/javascript" } } ], "variable": [ { "type": "string", "value": "https://api.sandbox.noah.com/v1", "key": "baseUrl" }, { "key": "sandboxBaseUrl", "type": "string", "value": "https://api.sandbox.noah.com/v1" }, { "key": "prodBaseUrl", "type": "string", "value": "https://api.noah.com/v1" }, { "key": "apiKey", "type": "string", "value": "" }, { "key": "privateKey", "type": "string", "value": "" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "adcdba4f-30c3-4eee-a8c9-517b6abb2e43", "name": "NOAH Business API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Noah Business API is organised around REST, using resource-oriented URLs. It accepts JSON-encoded request bodies and returns JSON-encoded responses. All our endpoints follow REST conventions and use standard HTTP response codes, authentication and methods.\n\nPlease follow the links in the navigation to find out more about each resource and endpoint.\n\nOur full OpenApi v3 Schema can be exported using the button above.", "type": "text/plain" } } }