{ "item": [ { "id": "fc03b365-4080-4721-bce2-f0efd18f70ff", "name": "Payin", "description": { "content": "Resources that are related to Payin.", "type": "text/plain" }, "item": [ { "id": "ac653b7e-6eca-4e35-8726-186a309dd3d7", "name": "Create Crypto Payin Session", "request": { "name": "Create Crypto Payin Session", "description": { "content": "This endpoint initiates Noah’s hosted checkout session for cryptocurrency payments.\n\nThe solution creates a hosted session where customers make cryptocurrency payments through Noah’s hosted checkout page, requiring properties such as a `CustomerID` for customer identification, CryptoCurrency type (like USDC or Bitcoin), Amount specifications, and return/cancel URLs for post-payment redirection.\n\nUse the endpoint to retrieve a response consisting of a checkout URL, which you pass to your customer so that they can complete their cryptocurrency payment through a hosted session.\n\nThe hosted flow handles the complete payment process with real-time status updates via Webhooks.", "type": "text/plain" }, "url": { "path": ["checkout", "payin", "crypto"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Digitally signed JWT.", "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 \"CryptoAmount\": \"\",\n \"CustomerID\": \"\",\n \"ReturnURL\": \"\",\n \"LineItems\": [\n {\n \"Description\": \"\",\n \"Quantity\": {\n \"value\": \"\"\n },\n \"UnitAmount\": {\n \"value\": \"\"\n },\n \"TotalAmount\": {\n \"value\": \"\"\n }\n }\n ],\n \"Nonce\": \"\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1ea3e8a6-5944-4cdb-97ec-dea200751e20", "name": "Checkout request created", "originalRequest": { "url": { "path": ["checkout", "payin", "crypto"], "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"USDC\",\n \"CryptoAmount\": \"10.1\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ReturnURL\": \"\",\n \"LineItems\": [\n {\n \"Description\": \"\",\n \"Quantity\": {\n \"value\": \"\"\n },\n \"UnitAmount\": {\n \"value\": \"\"\n },\n \"TotalAmount\": {\n \"value\": \"\"\n }\n }\n ],\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\n \"ExternalID\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"http://UqEZrJVKrTqpKAQkbeURLdI.mnsop6PX-WAlRBX7wKPJMoOc\",\n \"CheckoutSession\": {\n \"CheckoutSessionID\": \"string\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"Status\": \"string\",\n \"Created\": \"1973-04-01T23:37:37.331Z\",\n \"ReturnURL\": \"\",\n \"SourceCurrency\": \"BTC\",\n \"DestinationCurrency\": \"BTC\",\n \"LineItems\": [\n {\n \"value\": \"\"\n }\n ],\n \"Type\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"SourceAmount\": \"10.1\",\n \"DestinationAmount\": \"10.1\",\n \"AuthorizedAmount\": \"10.1\",\n \"ExternalID\": \"string\",\n \"Expiry\": \"1985-10-15T03:17:58.057Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c11c5ab-9f2b-4ead-9579-33d52884cd9d", "name": "Bad request", "originalRequest": { "url": { "path": ["checkout", "payin", "crypto"], "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"USDC\",\n \"CryptoAmount\": \"10.1\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ReturnURL\": \"\",\n \"LineItems\": [\n {\n \"Description\": \"\",\n \"Quantity\": {\n \"value\": \"\"\n },\n \"UnitAmount\": {\n \"value\": \"\"\n },\n \"TotalAmount\": {\n \"value\": \"\"\n }\n }\n ],\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\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 }\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": "4bce7ee3-c163-4419-bc77-cce7c039a0cd", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["checkout", "payin", "crypto"], "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"USDC\",\n \"CryptoAmount\": \"10.1\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ReturnURL\": \"\",\n \"LineItems\": [\n {\n \"Description\": \"\",\n \"Quantity\": {\n \"value\": \"\"\n },\n \"UnitAmount\": {\n \"value\": \"\"\n },\n \"TotalAmount\": {\n \"value\": \"\"\n }\n }\n ],\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\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 }\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": "df4890f2-b2f2-4bad-bedc-b94230728c99", "name": "Internal server error", "originalRequest": { "url": { "path": ["checkout", "payin", "crypto"], "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CryptoCurrency\": \"USDC\",\n \"CryptoAmount\": \"10.1\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ReturnURL\": \"\",\n \"LineItems\": [\n {\n \"Description\": \"\",\n \"Quantity\": {\n \"value\": \"\"\n },\n \"UnitAmount\": {\n \"value\": \"\"\n },\n \"TotalAmount\": {\n \"value\": \"\"\n }\n }\n ],\n \"Nonce\": \"dc879b38-494b-4de7-98a9-068703144328\",\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 }\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": "62c42e59-37e4-480e-a985-587e840d0370", "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": "Digitally signed JWT.", "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 },\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 }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d1ca9207-a81f-4c9b-b1d3-2c3c92330036", "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": "Digitally signed JWT.", "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 },\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://qxkKFHwLJxBAo.doocQczXtIpcAFFod7ZD8G,NjwWoFjo3ZmMnZczOqEJXpFXcVUoL+D,sLXY7pucW1LoxtAAIa\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 6240.262171050177\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 \"IncorrectTaxID\",\n \"DocumentReupload\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc8d6080-2d1d-49bf-acb9-cb1303430b1c", "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": "Digitally signed JWT.", "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 },\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 }\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": "8c18874a-c5ec-42ef-894b-39b07a384507", "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": "Digitally signed JWT.", "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 },\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 }\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": "1ddc188e-a04e-4e01-8659-6fa34e9a47b5", "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": "Digitally signed JWT.", "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 },\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 }\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": "83588e12-b319-4059-8d88-2b1bafafeff5", "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": "Digitally signed JWT.", "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 }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "55d72f3f-3bbd-4a48-88bd-a34c4b4d9ee2", "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": "Digitally signed JWT.", "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 \"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": "099a55d2-84fb-44e0-bf7f-07081a77afe1", "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": "Digitally signed JWT.", "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 }\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": "21e0abcb-ef1a-4eb9-ae58-aa821fa968c5", "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": "Digitally signed JWT.", "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 }\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": "915e225e-1dab-4e3a-9177-01f6f9380a81", "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": "Digitally signed JWT.", "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\",\n \"Instance\": \"9bbe5ce1-aa6a-4650-ae2b-084f4e1f229c\",\n \"Type\": \"Forbidden\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2190cb8b-8dc7-4356-8816-ad363cc9e25c", "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": "Digitally signed JWT.", "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 }\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": "c08f1da3-f2f7-4a26-9d08-2f8e474bc19e", "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": "Digitally signed JWT.", "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": "61fa4a79-2dcf-4219-96b8-ea68a7004d2f", "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": "Digitally signed JWT.", "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": "204fae89-bdb7-49a2-a479-4022c2d44cb2", "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": "Digitally signed JWT.", "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 }\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": "1894996c-4a87-4576-9a41-ed99ddada4f9", "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": "Digitally signed JWT.", "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 }\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": "a74bb170-9bef-4e35-8740-4e00d7aea457", "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": "Digitally signed JWT.", "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 }\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": "72eee955-df6c-4c32-9c58-b8b1d344362f", "name": "Payout", "description": { "content": "Resources that are related to Payout.", "type": "text/plain" }, "item": [ { "id": "7846e774-ee05-4292-b1b0-55c73fa896d4", "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": "Digitally signed JWT.", "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 }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "19c92ebf-9f08-41ce-8fdf-8560038a23da", "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": "Digitally signed JWT.", "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}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"https://qxkKFHwLJxBAo.doocQczXtIpcAFFod7ZD8G,NjwWoFjo3ZmMnZczOqEJXpFXcVUoL+D,sLXY7pucW1LoxtAAIa\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 6240.262171050177\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 \"IncorrectTaxID\",\n \"DocumentReupload\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61bb2abc-8886-4351-8578-748435c53fb3", "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": "Digitally signed JWT.", "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}", "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 }\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": "2480c892-25d8-4979-b9a9-ee37ff1d227e", "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": "Digitally signed JWT.", "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}", "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 }\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": "2b1fd89b-8662-4c28-ac72-801008423244", "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": "Digitally signed JWT.", "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}", "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 }\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": "8e420403-a121-4a16-a9bc-15e7ada06709", "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": "Digitally signed JWT.", "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": "f4a43fd4-0929-4dcb-94d1-960fec490913", "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": "Digitally signed JWT.", "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://HoerWPlDyWCjr.szqNqKAPvceLnUAxM5a1XuHBIH.kykEQA9nZS2mKFU.BJeHNSS5LBz\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50428274-40a4-46e8-a3a2-aba4627b14c2", "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": "Digitally signed JWT.", "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 }\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": "b965cba1-bf51-4333-99af-25fc142a03fc", "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": "Digitally signed JWT.", "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 }\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": "50b75402-e082-42b7-911f-8c64244241e1", "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": "Digitally signed JWT.", "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 }\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": "128c56f8-978b-4225-8aac-cc70b6e2a519", "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.", "type": "text/plain" }, "url": { "path": ["workflows", "onchain-deposit-to-payment-method"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Digitally signed JWT.", "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 },\n \"CustomerID\": \"\",\n \"CryptoCurrency\": \"\",\n \"FormSessionID\": \"\",\n \"FiatAmount\": \"\",\n \"ExternalID\": \"\",\n \"BusinessFee\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "42d741c8-5356-469d-a9c9-8a89713a8e6a", "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": "Digitally signed JWT.", "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 },\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}", "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\": \"9e6ef1eb-500a-50cb-3859-6fa0dc0c0fba\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ba53be5-b2d2-4e21-a644-2f4d9076a4ec", "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": "Digitally signed JWT.", "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 },\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}", "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 }\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": "0542e0f8-b421-4933-bfe7-59ab4de464db", "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": "Digitally signed JWT.", "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 },\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}", "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 }\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": "ea42c5ec-8665-40ce-aa6e-3912c5b1e615", "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": "Digitally signed JWT.", "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 },\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}", "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 }\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": "9412e347-ce7f-4ba6-bcfa-5f57a56bb712", "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": "Digitally signed JWT.", "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": "b57de528-17c6-4407-93c2-e28739d8f449", "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": "Digitally signed JWT.", "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\": \"4cc22afa-c15d-655e-c860-590072e3093c\",\n \"Network\": \"Ethereum\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"USDC\",\n \"PublicID\": \"string\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\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 },\n {\n \"Type\": {\n \"value\": \"\"\n },\n \"Amount\": {\n \"value\": \"\"\n }\n }\n ],\n \"AdjustmentFor\": {\n \"AdjustedTransactionID\": \"d488298d-eaa7-91b4-daf5-b529d2ac4af0\",\n \"AdjustmentID\": \"79ab27ab-ec19-70a9-7bdf-2a5e0d3c73f4\",\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\": \"3e496ec8-c24a-b839-84e5-86da7bfc7c4d\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbe95eff-8ec4-41a6-a86f-ddeb18c2071c", "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": "Digitally signed JWT.", "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 }\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": "c715fedf-5787-4062-98e9-a1064973c856", "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": "Digitally signed JWT.", "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 }\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": "2182764e-0672-4bb3-a376-8d09a22ed46c", "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": "Digitally signed JWT.", "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 }\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": "d53b7184-1a6a-49c1-b54d-fa8d81b29be0", "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": "Digitally signed JWT.", "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\": true\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\n \"BusinessFee\": {\n \"FeeBase\": \"\",\n \"FeePct\": \"\",\n \"FiatCurrency\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6261039b-7564-4deb-b62b-0c9a6e6b99f8", "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": "Digitally signed JWT.", "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\": 8374.592751630727,\n \"key_1\": 9783.412546947033\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\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\": \"Vop\",\n \"StepType\": \"Ack\",\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 },\n {\n \"Type\": \"string\",\n \"Amount\": \"10.1\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "128ee4ad-b3ef-4255-bcbf-6d5fa2b648c1", "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": "Digitally signed JWT.", "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\": 8374.592751630727,\n \"key_1\": 9783.412546947033\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\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 }\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": "d19849d0-f8ac-436b-bc40-8e28dd5a80fe", "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": "Digitally signed JWT.", "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\": 8374.592751630727,\n \"key_1\": 9783.412546947033\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\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 }\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": "7f82dffd-55af-4478-8dbd-c127810d34a2", "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": "Digitally signed JWT.", "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\": 8374.592751630727,\n \"key_1\": 9783.412546947033\n },\n \"DelayedSell\": \"\",\n \"Version\": \"\",\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 }\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": "deec3713-5e9c-43f9-99b8-02994dcfcc2f", "name": "Transactions", "description": { "content": "Resources that are related to transactions.", "type": "text/plain" }, "item": [ { "id": "1ad4c7f7-c9b9-40db-8b06-eec29d437124", "name": "Transactions", "request": { "name": "Transactions", "description": { "content": "This endpoint retrieves a paginated list of transaction history for the Business User's account.", "type": "text/plain" }, "url": { "path": ["transactions"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "PageSize", "value": "20" }, { "disabled": false, "key": "PageToken", "value": "" }, { "disabled": false, "key": "SortDirection", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a16fd241-ea3c-46be-b957-2144b6e08416", "name": "List of transactions", "originalRequest": { "url": { "path": ["transactions"], "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": "Digitally signed JWT.", "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\": \"79cb9d7d-df0c-a5b9-17b4-5e55bdd3916e\",\n \"Network\": \"Solana\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"BTC\",\n \"PublicID\": \"string\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"string\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\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\": \"3970b49a-e3e8-8996-60f5-50af3ae70b4e\"\n },\n {\n \"ID\": \"05135e99-587e-65fe-dfa3-572e0335753c\",\n \"Network\": \"Solana\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"BTC\",\n \"PublicID\": \"string\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"stri\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\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\": \"afd5e562-48d0-ef40-6ba5-7aeb1953908f\"\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "651f1b30-e3bd-4d31-bf4b-6ad38eeb2bb6", "name": "Bad request", "originalRequest": { "url": { "path": ["transactions"], "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": "Digitally signed JWT.", "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 }\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": "b4750af7-8e3e-4886-9a45-cf34757707d1", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["transactions"], "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": "Digitally signed JWT.", "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 }\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": "6edc0790-c800-4381-92fb-9191cf43176d", "name": "Internal server error", "originalRequest": { "url": { "path": ["transactions"], "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": "Digitally signed JWT.", "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 }\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": "77fe5b28-0de3-47c2-a973-59341a3b184f", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7a866f62-f3ed-4c67-9530-573607176d0f", "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": "Digitally signed JWT.", "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\": \"6f8eb773-1c31-08b2-252f-2e8104cec224\",\n \"Network\": \"Solana\",\n \"Created\": \"2024-04-16T08:00:55Z\",\n \"Status\": \"Settled\",\n \"Direction\": \"In\",\n \"CryptoCurrency\": \"BTC\",\n \"PublicID\": \"string\",\n \"CustomerID\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"ExternalID\": \"string\",\n \"Amount\": \"10.1\",\n \"NetworkFee\": \"10.1\",\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\": true,\n \"PayoutFrom\": true,\n \"PayinTo\": false\n },\n \"AccountHolderDetails\": {\n \"Name\": {\n \"value\": \"\"\n }\n },\n \"IssuerDetails\": {\n \"Name\": \"string\"\n }\n },\n \"Breakdown\": [\n {\n \"Type\": \"string\",\n \"Amount\": \"10.1\"\n },\n {\n \"Type\": \"string\",\n \"Amount\": \"10.1\"\n }\n ],\n \"AdjustmentFor\": {\n \"AdjustedTransactionID\": \"b92bdbd2-65cf-0bf8-495e-733d9815f609\",\n \"AdjustmentID\": \"c36b4ab3-215f-630c-a697-8a4d3d6e5374\",\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\": \"df60c1dd-1d81-c54f-c663-25dd72881629\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9484cb2-14de-45e8-81e2-3b2ae54631eb", "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": "Digitally signed JWT.", "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 }\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": "ac297b68-3576-40d4-9306-5ebc067cabf9", "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": "Digitally signed JWT.", "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 }\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": "2228ec25-bdc0-4685-aa08-166a8efdf2a5", "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": "Digitally signed JWT.", "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 }\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": "7db495d7-99ca-4844-a92d-f7864fcab13b", "name": "Onboarding", "description": { "content": "Resources that are related to Onboarding.", "type": "text/plain" }, "item": [ { "id": "99f8061b-c3d9-4c4b-9633-3785ddb3b1e9", "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": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "89d3f919-a3df-44fb-822a-1b697c06d95a", "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": "" }, { "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\": \"string\",\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\": \"stri\",\n \"State\": \"string\",\n \"Country\": {\n \"value\": \"\"\n },\n \"Street2\": \"string\"\n },\n \"Verifications\": {\n \"Type\": \"Business\",\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f9e10d6-c99a-441a-a3cd-986f5322757d", "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": "Digitally signed JWT.", "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": "d3fc6457-f12b-402e-b5f8-bb87cd030cff", "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": "Digitally signed JWT.", "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": "3982c691-a4f8-4b2a-802f-487af6f03541", "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": "Digitally signed JWT.", "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": "424394e7-70c9-4085-9e50-2835bc1bb172", "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": "Digitally signed JWT.", "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 }\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": "d3021929-4ef3-4d7b-a451-5c92094a445c", "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": "Digitally signed JWT.", "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 }\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": "df73ea86-c698-4648-b76a-3bd325cf2c25", "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": "Digitally signed JWT.", "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 }\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": "d5bb35e4-6206-4fbf-8749-5ef4a4c27a69", "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\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": "Digitally signed JWT.", "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 \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"\"\n },\n {\n \"FiatCurrencyCode\": \"\"\n }\n ],\n \"Metadata\": {\n \"key_0\": \"\"\n },\n \"Form\": {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": \"string\"\n },\n \"CustomerType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "32c11368-1703-49a4-8b89-9f5ed3fce544", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"Form\": {\n \"key_0\": 241,\n \"key_1\": true\n },\n \"CustomerType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"HostedURL\": \"https://qxkKFHwLJxBAo.doocQczXtIpcAFFod7ZD8G,NjwWoFjo3ZmMnZczOqEJXpFXcVUoL+D,sLXY7pucW1LoxtAAIa\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 6240.262171050177\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 \"IncorrectTaxID\",\n \"DocumentReupload\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbdbf306-01df-45c7-940a-3fc4212b7cc6", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"Form\": {\n \"key_0\": 241,\n \"key_1\": true\n },\n \"CustomerType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a50052d-d20e-43fe-94d6-acdbad4043ce", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"Form\": {\n \"key_0\": 241,\n \"key_1\": true\n },\n \"CustomerType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f47ce951-a4cb-4ef6-b2d8-95254c2840b1", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"Form\": {\n \"key_0\": 241,\n \"key_1\": true\n },\n \"CustomerType\": \"\"\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 }\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": "6f8a17bb-a7a6-4044-ba1e-c1897835bb62", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"Form\": {\n \"key_0\": 241,\n \"key_1\": true\n },\n \"CustomerType\": \"\"\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 }\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": "b885bb53-cf89-45aa-a6e8-35119aed2777", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ReturnURL\": \"\",\n \"FiatOptions\": [\n {\n \"FiatCurrencyCode\": \"USD\"\n },\n {\n \"FiatCurrencyCode\": \"USD\"\n }\n ],\n \"Metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\"\n },\n \"Form\": {\n \"key_0\": 241,\n \"key_1\": true\n },\n \"CustomerType\": \"\"\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 }\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": "cb40ec0c-709c-4fef-93b5-c7f1fba73848", "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": "Digitally signed JWT.", "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": "1b7c1398-e8d4-49e9-b2fc-84a8d98b6ca0", "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": "Digitally signed JWT.", "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": "c88c52e1-d6d2-4833-b743-a8cacf5db7ab", "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": "Digitally signed JWT.", "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 }\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": "47b83eb3-989d-434a-9487-09099a88d02e", "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": "Digitally signed JWT.", "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 }\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": "861efbac-0030-4f6c-8f8f-95abbc709053", "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": "Digitally signed JWT.", "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 }\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": "78c89310-6aba-4296-90b3-e021087a02d6", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "636c8b5b-f64c-4d6a-98ad-d3a4b6436927", "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": "Digitally signed JWT.", "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\": \"https://DZSa.wydDP7caW87YQDaII+ApYHoTXiqG1ZxzjzPYMbdYWxPJxLu,LYwC-ATpCeH5oc2w0\",\n \"ExpiresAt\": \"2024-04-16T08:00:55Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c9af24d-e5b4-41be-9ae3-3bf3c9ea3bad", "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": "Digitally signed JWT.", "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 }\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": "b74a33d7-87a3-4d39-ae54-0c3d9fbb7342", "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": "Digitally signed JWT.", "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 }\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": "6ff91bd4-e793-4bff-9612-adeaf23d24dc", "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": "Digitally signed JWT.", "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 }\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": "af792de9-5cb0-4590-b869-d4a4ff7b59b2", "name": "Customers", "request": { "name": "Customers", "description": { "content": "This endpoint retrieves a paginated list of customers for the Business User's account.", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6eab6cae-4f25-4493-af22-c31687535b01", "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": "Digitally signed JWT.", "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 },\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 }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffbd898c-7a7e-426a-9151-501342956704", "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": "Digitally signed JWT.", "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 }\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": "fb6f5bcc-efe8-4a6a-b474-5dafb8bbb74d", "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": "Digitally signed JWT.", "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 }\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": "e0022eb8-1bd8-471b-9469-b55ce7ed1b05", "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": "Digitally signed JWT.", "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 }\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": "ea0a0ce4-0f36-41ef-96f1-bd8e9e90ff17", "name": "PSP Payments", "description": { "content": "Resources that are related to PSP Payments.", "type": "text/plain" }, "item": [], "event": [] }, { "id": "4280f098-8ecc-4d51-9309-36c4faf7c422", "name": "Utilities", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "875afdf7-69a0-401b-9d78-2e1be876ffdb", "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": "Digitally signed JWT.", "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": "94a31a60-433a-4e34-8bd9-0cd5e006ef05", "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": "Digitally signed JWT.", "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\": \"http://qEqBqPtqCqnPiDHPZijaOmwgpU.ncmKU7KtzszMd8xhaaUv+CQ4FNSeHpLE+nWhT-jMIP7MGMdJU7zPd,jFkVW85l3NvFwcvZQB4F\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": \"string\"\n },\n \"title\": \"string\",\n \"description\": \"string\",\n \"required\": [\n \"string\",\n \"string\"\n ]\n },\n \"OnboardingStatus\": \"ReviewNotStarted\",\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": "78d6f349-a092-462c-89b4-45aab9efcd9b", "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": "Digitally signed JWT.", "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 \"key_1\": [\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": "d786570b-27b6-441c-8065-e5c2426ee119", "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": "Digitally signed JWT.", "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 }\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": "312ed02a-c8db-4a37-bbc9-d2022cc317e6", "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": "Digitally signed JWT.", "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 }\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": "54f676b0-8bf5-4532-9e8b-daa93e3f5530", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0a892565-c1f8-4a28-93c2-be718f165e7f", "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": "Digitally signed JWT.", "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": "6dec222b-7f23-491e-9b9c-6e0908a52a5b", "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": "Digitally signed JWT.", "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 }\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": "522986ae-7842-4681-8e68-6a9a75ddb071", "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": "Digitally signed JWT.", "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 }\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": "94c335e7-374b-4409-9bd1-6ac7713ff1d2", "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": "Digitally signed JWT.", "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 }\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": "a3f39df2-564a-46b8-864b-917d83bf03b2", "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. For credit card payments, refer to the [Hosted Checkout](../recipes/payout/hosted-checkout) solution.", "type": "text/plain" }, "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "CustomerID", "value": "" }, { "disabled": false, "key": "PaymentMethodID", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ChannelID", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "98b862f4-1479-491d-a4b6-3625f1ee48a0", "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": "" } ], "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": "Digitally signed JWT.", "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\": 7791.768918750455,\n \"key_1\": true,\n \"key_2\": 6594.784900655161,\n \"key_3\": 1369\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": "287581cb-3bfd-48dc-9152-b18706c44cb7", "name": "Bad request", "originalRequest": { "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "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": "Digitally signed JWT.", "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 }\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": "365fc466-9a73-44c4-ba2a-9815862d4c24", "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": "" } ], "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": "Digitally signed JWT.", "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 }\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": "8aecb387-45a1-48ad-b0b8-572000e6ee0b", "name": "Internal server error", "originalRequest": { "url": { "path": ["channels", ":ChannelID", "form"], "host": ["{{baseUrl}}"], "query": [ { "key": "CustomerID", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "PaymentMethodID", "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": "Digitally signed JWT.", "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 }\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": "49214a27-1d7c-4e6c-b2d4-b5baf5132c54", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "66daa53f-21f7-4634-82f6-15296502746a", "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": "Digitally signed JWT.", "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 \"Limits\": {\n \"MinLimit\": \"10.1\",\n \"MaxLimit\": \"10.1\"\n },\n \"Rate\": \"10.1\",\n \"ProcessingSeconds\": 6291,\n \"Calculated\": {\n \"TotalFee\": \"10.1\"\n },\n \"PaymentMethods\": [\n {\n \"ID\": \"string\",\n \"PaymentMethodType\": \"BankLocal\",\n \"Details\": {\n \"value\": \"\"\n },\n \"AccountHolderDetails\": {\n \"Name\": {\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 \"Name\": {\n \"value\": \"\"\n }\n },\n \"IssuerDetails\": {\n \"Name\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"ProcessingTier\": \"Priority\",\n \"FormSchema\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"key_0\": 5867.535130343937,\n \"key_1\": 2269,\n \"key_2\": true\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": "ae2d22d5-f825-4a9c-8d3f-dbfb3f0e8f06", "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": "Digitally signed JWT.", "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 }\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": "b02e7dc2-4151-4672-9f5b-6c9e0e78f1ca", "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": "Digitally signed JWT.", "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 }\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": "0c98cd06-9750-4928-a32d-124256d81660", "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": "Digitally signed JWT.", "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": "f87b7cdb-fa9a-40fc-be81-da49dbbbc8b9", "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": "Digitally signed JWT.", "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 }\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": "f738bde3-c480-4acd-a50d-d5fc9073b479", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1bbe1551-c51c-4769-848c-7d09b85b08e4", "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": "Digitally signed JWT.", "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 \"Limits\": {\n \"MinLimit\": {\n \"value\": \"\"\n },\n \"MaxLimit\": {\n \"value\": \"\"\n }\n },\n \"Rate\": \"10.1\",\n \"ProcessingSeconds\": 1977,\n \"Calculated\": {\n \"TotalFee\": {\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 \"ID\": \"string\",\n \"PaymentMethodCategory\": \"Bank\",\n \"PaymentMethodType\": \"BankLocal\",\n \"FiatCurrency\": \"USD\",\n \"Country\": \"US\",\n \"Limits\": {\n \"MinLimit\": {\n \"value\": \"\"\n },\n \"MaxLimit\": {\n \"value\": \"\"\n }\n },\n \"Rate\": \"10.1\",\n \"ProcessingSeconds\": 5485,\n \"Calculated\": {\n \"TotalFee\": {\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": "1963d4de-e2f0-4b14-822f-2db05e2bcaa3", "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": "Digitally signed JWT.", "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 }\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": "26224962-b933-4290-b29f-25565d4e51d5", "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": "Digitally signed JWT.", "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 }\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": "6ee6bc20-c13f-4b47-997b-9f1521efb369", "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": "Digitally signed JWT.", "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 }\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": "caa31c38-9cf4-42c3-8641-9246c60fbb9d", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7b823559-a504-457d-be7e-93b57536410e", "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": "Digitally signed JWT.", "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": "6f8d1f81-56fd-42b2-a915-125463d9b6ec", "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": "Digitally signed JWT.", "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 }\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": "ec3d447f-be14-46a4-955a-17834f4a9130", "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": "Digitally signed JWT.", "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 }\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": "b2d0f6ff-a3e9-422d-a4c1-e14cf0d89f30", "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": "Digitally signed JWT.", "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 }\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": "8f7fcb52-12fa-4eea-8677-6e5a6d62d960", "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": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1576d6b0-685d-4469-9886-32061e087ea6", "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": "" }, { "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": "13727a6d-11ce-4afd-b352-eff9eed45254", "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": "" }, { "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 }\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": "c5f81ff9-3794-4c22-b31a-ee06af87f5aa", "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": "" }, { "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 }\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": "cafd3771-b8ef-4514-b6f9-126ec9c2e933", "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": "" }, { "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 }\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": "02fa6ea4-bec3-44f5-9078-03a90b9c5d4a", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "df6d76bb-9f21-4bca-8be8-2bc647546c0f", "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": "Digitally signed JWT.", "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 \"Name\": {\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 \"Name\": {\n \"value\": \"\"\n }\n },\n \"IssuerDetails\": {\n \"Name\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"PageToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbe77bb7-d27f-423c-bad7-17e6fbbae425", "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": "Digitally signed JWT.", "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 }\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": "ecb89ed1-4d2b-4f99-a806-1bda1e4d5af1", "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": "Digitally signed JWT.", "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 }\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": "666a84ac-1771-4baf-99ba-a06da684eaee", "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": "Digitally signed JWT.", "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 }\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": "775040a4-583f-45e1-a532-b31d3533e5ee", "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": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2f26f313-36f1-4507-bb08-a58e76e6058a", "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": "Digitally signed JWT.", "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\": \"a0S\",\n \"Status\": \"Active\",\n \"PaymentMethods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"VirtualAccountID\": \"w\",\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": "e1692ae5-d686-4ab8-892a-204b4df0098c", "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": "Digitally signed JWT.", "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 }\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": "ec73797e-76eb-4665-909e-2d407bec1754", "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": "Digitally signed JWT.", "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 }\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": "40a0db05-b2c2-445f-8f7b-0881ce7add71", "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": "Digitally signed JWT.", "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 }\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": "2191495a-2cdd-49f3-b81a-a4a9ecd61c82", "name": "Update Virtual Account Status", "request": { "name": "Update Virtual Account Status", "description": { "content": "Request closure of a virtual account. Set `Status` to `Closed`. Returns `202 Accepted` when closure is newly requested or already pending, and `200 OK` when the virtual account is already fully closed.", "type": "text/plain" }, "url": { "path": ["virtual-accounts", ":VirtualAccountID", "status"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to update." } ] }, "header": [ { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6fab0bd8-8e7f-4a54-9862-2cbb82937960", "name": "Virtual account is already fully closed.", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "status"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Status\": \"Closed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"VirtualAccountID\": \"\",\n \"Status\": \"PendingClosure\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "093a5d5b-4d7e-45f6-b51c-b06b348bf0de", "name": "Close request accepted. The virtual account is pending closure.", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "status"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Status\": \"Closed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"VirtualAccountID\": \"\",\n \"Status\": \"PendingClosure\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704f0fd9-d58b-47a5-945d-2b144b4a9604", "name": "Bad request", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "status"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Status\": \"Closed\"\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 }\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": "9fc7bfa8-c3d2-4391-8b26-b052864631d8", "name": "Client is not authorized to perform this action", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "status"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Status\": \"Closed\"\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 }\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": "1c54304b-0b14-406f-a43b-86fd6ede54a1", "name": "Internal server error", "originalRequest": { "url": { "path": ["virtual-accounts", ":VirtualAccountID", "status"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "VirtualAccountID", "description": "(Required) Virtual account identifier to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" }, { "disabled": false, "description": "Digitally signed JWT.", "key": "Api-Signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Status\": \"Closed\"\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 }\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": "83d81a46-27dc-4456-8b94-9ba240359a88", "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" } } }