{ "info": { "name": "DattaRemit API", "description": "The DattaRemit API — the Cybrid-compatible Bank and Organization surfaces,\ngenerated from the OpenAPI specs. Same paths, fields, GUIDs and error bodies as\nCybrid.\n\n## Set two keys before you run anything\n\nNothing here works until these are filled in — set them in the collection\nvariables, or import the environment file alongside this collection. Use\n`sk_test_` keys; nothing here is safe to run against production.\n\n| Variable | Scope | Used by |\n|---|---|---|\n| `secret_key` | `bank` | The Bank API folder |\n| `organization_secret_key` | `organization` | The Organization API folder |\n\n**Two keys, not one.** The scopes are disjoint by design — a bank key cannot\nmanage the organization and an organization key cannot move money — so no single\ncredential can run the whole collection. The Organization folder overrides auth to\nuse the second variable; leave it empty and it answers `403 invalid_scopes`.\n\nCreate both in the dashboard under **API keys**, choosing the scope from the\ndropdown — locally that is , also carried in the environment as\n`api_keys_url`. Until `secret_key` is set, every request stops in the pre-request\nscript with that reminder rather than returning an unhelpful 401.\n\n## Which server you are hitting\n\n`bank_url` / `organization_url` on the collection point at production. The\nenvironment file that ships beside it (**DattaRemit — local sandbox**) overrides\nthem with the local server, so selecting the environment keeps a run off the live\nhost.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{secret_key}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const value = (name) =>", " pm.environment.get(name) || pm.collectionVariables.get(name) || \"\";", "const where = value(\"api_keys_url\") || \"http://localhost:3000/api-keys\";", "", "if (!value(\"secret_key\")) {", " throw new Error(", " \"secret_key is not set. Create a bank-scope sk_test_ key at \" + where +", " \" (Dashboard -> API keys -> Create key), then paste it into the environment.\"", " );", "}", "", "// Only the Organization folder needs the second key, so this is a", "// warning rather than a stop.", "if (!value(\"organization_secret_key\")) {", " console.warn(", " \"organization_secret_key is not set — the Organization API folder will \" +", " \"answer 403 invalid_scopes. Create an organization-scope key at \" + where + \".\"", " );", "}" ] } } ], "variable": [ { "key": "bank_url", "value": "https://bank.dattaremit.com", "type": "string" }, { "key": "organization_url", "value": "https://organization.dattaremit.com", "type": "string" }, { "key": "secret_key", "value": "", "type": "string" }, { "key": "organization_secret_key", "value": "", "type": "string" } ], "item": [ { "name": "1 · Bank API", "description": "The Cybrid-compatible Bank API. Base URL {{bank_url}}, bank key.", "item": [ { "name": "Accounts", "item": [ { "name": "POST Create Account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/accounts", "host": [ "{{bank_url}}" ], "path": [ "api", "accounts" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"trading\",\n \"asset\": \"string\",\n \"name\": \"string\",\n \"customer_guid\": \"string\",\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates an account.\n\n## Account Type\n\nAn Account is tied to a specific cryptocurrency or fiat and is comprised of transactions and a current balance.\n\nAn account is required to allow a Bank or Customer to hold cryptocurrency or a Customer to hold fiat on the Cybrid Platform.\n\nAt present, accounts can be created as `trading`, `storage` or `fiat ` accounts and are required before a Customer can generate quotes or execute a `trade` or `transfer`.\n\nTo create accounts for your Bank, omit the `customer_guid` parameter in the request body. To create accounts for your Customers, include the `customer_guid` parameter in the request body.\n\nAt the bank level, `invoice_operations` accounts can be configured to pre-fund your customers' Lightning Network operations.\n\n## Asset\n\nThe asset is the specific cryptocurrency or fiat that the account holds, e.g., 'BTC' for Bitcoin or `USD` for US dollars. See the Symbols API for a complete list of cryptocurrencies and fiat supported. \n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the account details in our private store |\n| created | The Platform has created the account |\n\n\n\nRequired scope: **accounts:execute**" } }, { "name": "GET List Accounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/accounts", "host": [ "{{bank_url}}" ], "path": [ "api", "accounts" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "owner", "value": "", "disabled": true, "description": "The owner of the entity." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated account_guids to list accounts for." }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated account_types to list accounts for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list accounts for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list accounts for." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list accounts for." }, { "key": "include_balances", "value": "", "disabled": true, "description": "Whether to include account balances in the response." } ] }, "description": "Retrieves a list of accounts. Records are sorted by creation date in descending order.\n\nRequired scope: **accounts:read**" } }, { "name": "GET Get Account", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/accounts/:account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "accounts", ":account_guid" ], "query": [ { "key": "include_balances", "value": "", "disabled": true, "description": "Whether to include account balances in the response." } ] }, "description": "Retrieves an account.\n\nRequired scope: **accounts:read**" } }, { "name": "PATCH Patch Account", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/accounts/:account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "accounts", ":account_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an account.\n\nRequired scope: **accounts:write**" } } ] }, { "name": "Assets", "item": [ { "name": "GET Get assets list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/assets", "host": [ "{{bank_url}}" ], "path": [ "api", "assets" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "code", "value": "", "disabled": true, "description": "Comma separated codes to list assets for." } ] }, "description": "Retrieves a listing of assets." } } ] }, { "name": "Banks", "item": [ { "name": "POST Create Bank", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/banks", "host": [ "{{bank_url}}" ], "path": [ "api", "banks" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"sandbox\",\n \"name\": \"string\",\n \"supported_trading_symbols\": [\n \"string\"\n ],\n \"supported_fiat_account_assets\": [\n \"string\"\n ],\n \"supported_country_codes\": [\n \"string\"\n ],\n \"features\": [\n \"attestation_identity_records\"\n ],\n \"supported_payout_symbols\": [\n {\n \"primary_asset\": \"string\",\n \"counter_asset\": \"string\",\n \"country_code\": \"string\",\n \"participants_type\": \"C2C\",\n \"route\": \"bank_account\"\n }\n ],\n \"cors_allowed_origins\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a bank.\n\n## Bank Type\n\nBank's can be created in either `sandbox` or `production` mode. Sandbox Banks will not transact in real fiat dollars or cryptocurrencies.\n\nVia the API, only `sandbox` banks can be created. In order to enable a `production` bank please contact [Support](mailto:support@cybrid.app).\n\n\n\nRequired scope: **banks:execute**" } }, { "name": "GET Get banks list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/banks", "host": [ "{{bank_url}}" ], "path": [ "api", "banks" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated types to list banks for." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list banks for." } ] }, "description": "Retrieves a listing of bank. Records are sorted by creation date in descending order.\n\nRequired scope: **banks:read**" } }, { "name": "GET Get Bank", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/banks/:bank_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "banks", ":bank_guid" ] }, "description": "Retrieves a bank.\n\nRequired scope: **banks:read**" } }, { "name": "PATCH Patch Bank", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/banks/:bank_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "banks", ":bank_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"supported_trading_symbols\": [\n \"string\"\n ],\n \"supported_payout_symbols\": [\n {\n \"primary_asset\": \"string\",\n \"counter_asset\": \"string\",\n \"country_code\": \"string\",\n \"participants_type\": \"C2C\",\n \"route\": \"bank_account\"\n }\n ],\n \"cors_allowed_origins\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a bank.\n\nRequired scope: **banks:write**" } } ] }, { "name": "Counterparties", "item": [ { "name": "POST Create Counterparty", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/counterparties", "host": [ "{{bank_url}}" ], "path": [ "api", "counterparties" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"business\",\n \"address\": {\n \"country_code\": \"string\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"subdivision\": \"string\",\n \"postal_code\": \"string\"\n },\n \"customer_guid\": \"string\",\n \"name\": {\n \"full\": \"string\",\n \"first\": \"string\",\n \"middle\": \"string\",\n \"last\": \"string\"\n },\n \"aliases\": [\n {\n \"full\": \"string\"\n }\n ],\n \"date_of_birth\": \"1990-04-12\",\n \"email_address\": \"string\",\n \"identification_numbers\": [\n {\n \"type\": \"drivers_license\",\n \"issuing_country_code\": \"string\",\n \"identification_number\": \"string\",\n \"issuing_subdivision\": \"string\"\n }\n ],\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a counterparty.\n\n## Counterparty Type\n\nCounterparty resources are an abstraction for real world individuals and businesses that are not directly on the Cybrid Platform.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the counterparty details in our private store |\n| unverified | The Platform has not yet verified the counterparty's identity |\n| verified | The Platform has verified the counterparty's identity |\n| rejected | The Platform was not able to successfully verify the counterparty's identity |\n\n\n\nRequired scope: **counterparties:execute**" } }, { "name": "GET Get counterparties list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/counterparties", "host": [ "{{bank_url}}" ], "path": [ "api", "counterparties" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated types to list counterparties for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list counterparties for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list counterparties for." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated counterparty_guids to list counterparties for." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list counterparties for." }, { "key": "include_pii", "value": "", "disabled": true, "description": "Include PII in the response (requires **counterparties:pii:read** scope)." } ] }, "description": "Retrieves a listing of counterparties. Records are sorted by creation date in descending order.\n\nRequired scope: **counterparties:read**\nOptional scope: **counterparties:pii:read**." } }, { "name": "GET Get Counterparty", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/counterparties/:counterparty_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "counterparties", ":counterparty_guid" ], "query": [ { "key": "include_pii", "value": "", "disabled": true, "description": "Include PII in the response (requires **counterparties:pii:read** scope)." } ] }, "description": "Retrieves a counterparty.\n\nRequired scope: **counterparties:read**\nOptional scope: **counterparties:pii:read**." } } ] }, { "name": "Customers", "item": [ { "name": "POST Create Customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/customers", "host": [ "{{bank_url}}" ], "path": [ "api", "customers" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"business\",\n \"address\": {\n \"street\": \"string\",\n \"city\": \"string\",\n \"country_code\": \"string\",\n \"street2\": \"string\",\n \"subdivision\": \"string\",\n \"postal_code\": \"string\"\n },\n \"phone_number\": \"string\",\n \"email_address\": \"string\",\n \"identification_numbers\": [\n {\n \"type\": \"drivers_license\",\n \"issuing_country_code\": \"string\",\n \"identification_number\": \"string\",\n \"issuing_subdivision\": \"string\"\n }\n ],\n \"name\": {\n \"first\": \"string\",\n \"middle\": \"string\",\n \"last\": \"string\",\n \"full\": \"string\"\n },\n \"date_of_birth\": \"1990-04-12\",\n \"aliases\": [\n {\n \"full\": \"string\"\n }\n ],\n \"website\": \"string\",\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a customer.\n\n## Customer Type\n\nCustomer resources are an abstraction for real world individuals and businesses on the Cybrid Platform and are used throughout the platform to perform high level operations, e.g., create a quote, execute a trade, etc..\n\nCustomers can have additional resources attached to them, e.g., identity verifications, accounts, etc.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the customer details in our private store |\n| unverified | The Platform has not yet verified the customer's identity |\n| verified | The Platform has verified the customer's identity |\n| rejected | The Platform was not able to successfully verify the customer's identity |\n| frozen | The customer has been frozen on the Platform |\n\n\n\nRequired scope: **customers:execute**" } }, { "name": "GET Get customers list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/customers", "host": [ "{{bank_url}}" ], "path": [ "api", "customers" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated types to list customers for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list customers for." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list customers for." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list customers for." }, { "key": "include_pii", "value": "", "disabled": true, "description": "Include PII in the response (requires **customers:pii:read** scope)." } ] }, "description": "Retrieves a listing of customers. Records are sorted by creation date in descending order.\n\nRequired scope: **customers:read**\nOptional scope: **customers:pii:read**." } }, { "name": "GET Get Customer", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/customers/:customer_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "customers", ":customer_guid" ], "query": [ { "key": "include_pii", "value": "", "disabled": true, "description": "Include PII in the response (requires **customers:pii:read** scope)." } ] }, "description": "Retrieves a customer.\n\nRequired scope: **customers:read**\nOptional scope: **customers:pii:read**." } }, { "name": "PATCH Patch Customer", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/customers/:customer_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "customers", ":customer_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"unverified\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a customer.\n\nRequired scope: **customers:write**" } } ] }, { "name": "DepositAddresses", "item": [ { "name": "POST Create Deposit Address", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/deposit_addresses", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_addresses" ] }, "body": { "mode": "raw", "raw": "{\n \"account_guid\": \"string\",\n \"name\": \"string\",\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a deposit address.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the deposit address details in our private store |\n| created | The Platform has created the deposit address |\n\n\n\nRequired scope: **deposit_addresses:execute**" } }, { "name": "GET List Deposit Addresses", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/deposit_addresses", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_addresses" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated guids to list deposit addresses for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list deposit addresses for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list deposit addresses for." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list deposit addresses for." } ] }, "description": "Retrieves a list of deposit addresses. Records are sorted by creation date in descending order.\n\nRequired scope: **deposit_addresses:read**" } }, { "name": "GET Get Deposit Address", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/deposit_addresses/:deposit_address_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_addresses", ":deposit_address_guid" ] }, "description": "Retrieves a deposit address.\n\nRequired scope: **deposit_addresses:read**" } }, { "name": "PATCH Patch Deposit Address", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/deposit_addresses/:deposit_address_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_addresses", ":deposit_address_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a deposit address.\n\nRequired scope: **deposit_addresses:write**" } } ] }, { "name": "DepositBankAccounts", "item": [ { "name": "POST Create Deposit Bank Account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/deposit_bank_accounts", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_bank_accounts" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"main\",\n \"account_guid\": \"string\",\n \"name\": \"string\",\n \"customer_guid\": \"string\",\n \"parent_deposit_bank_account_guid\": \"string\",\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a deposit bank account.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the deposit bank account details in our private store |\n| created | The Platform has created the deposit bank account |\n\n\n\nRequired scope: **deposit_bank_accounts:execute**" } }, { "name": "GET List Deposit Bank Accounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/deposit_bank_accounts", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_bank_accounts" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated guids to list deposit bank accounts for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list deposit bank accounts for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list deposit bank accounts for." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list deposit bank accounts for." }, { "key": "unique_memo_id", "value": "", "disabled": true, "description": "Comma separated unique memo ids to list deposit bank accounts for." }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated types to list deposit bank accounts for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list deposit bank accounts for." }, { "key": "parent_deposit_bank_account_guid", "value": "", "disabled": true, "description": "Comma separated guids for parent accounts to list deposit bank accounts for." } ] }, "description": "Retrieves a list of deposit bank accounts. Records are sorted by creation date in descending order.\n\nRequired scope: **deposit_bank_accounts:read**" } }, { "name": "DELETE Delete Deposit Bank Account", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{bank_url}}/api/deposit_bank_accounts/:deposit_bank_account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_bank_accounts", ":deposit_bank_account_guid" ] }, "description": "Deletes a deposit bank account.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| deleting | The Platform is deleting the deposit bank account and closing the associated provider account |\n| deleted | The Platform has deleted the deposit bank account |\n\n\n\nRequired scope: **deposit_bank_accounts:execute**" } }, { "name": "GET Get Deposit Bank Account", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/deposit_bank_accounts/:deposit_bank_account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_bank_accounts", ":deposit_bank_account_guid" ] }, "description": "Retrieves a deposit bank account.\n\nRequired scope: **deposit_bank_accounts:read**" } }, { "name": "PATCH Patch Deposit Bank Account", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/deposit_bank_accounts/:deposit_bank_account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "deposit_bank_accounts", ":deposit_bank_account_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a deposit bank account.\n\nRequired scope: **deposit_bank_accounts:write**" } } ] }, { "name": "Executions", "item": [ { "name": "POST Create Execution", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/executions", "host": [ "{{bank_url}}" ], "path": [ "api", "executions" ] }, "body": { "mode": "raw", "raw": "{\n \"plan_guid\": \"string\",\n \"sardine_session_guid\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates an execution.\n\n## Create a plan execution\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the execution details in our private store |\n| executing | The Platform is executing the plan |\n| completed | The Platform has successfully completed the plan execution |\n| failed | The Platform was not able to successfully complete the plan execution |\n\n## Remittance failure codes\n\n| Code | Description |\n|------|-------------|\n| compliance_rejection | The payout was rejected due to a compliance or sanctions screening hit |\n| invalid_destination | The payout was rejected because the beneficiary details are invalid or not accepted by the payout partner |\n| party_name_invalid | The payout was rejected due to invalid sender or beneficiary name fields |\n| cancelled | The payout was cancelled |\n| reversed | The payout was reversed |\n| external_vendor_error | The payout failed due to vendor-side limits, transient unavailability, or duplicate detection |\n| market_volatility | The payout failed due to market volatility preventing quote execution |\n| no_quote | The payout failed because no valid payout quote was available |\n| internal_server_error | The payout failed due to an internal platform error |\n| invalid_quote_amount | The payout failed due to an invalid quote amount |\n| not_filled | The payout could not be filled |\n\n\n\nRequired scope: **executions:execute**" } }, { "name": "GET Get executions list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/executions", "host": [ "{{bank_url}}" ], "path": [ "api", "executions" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated execution_guids to list executions for." }, { "key": "plan_guid", "value": "", "disabled": true, "description": "Comma separated plan_guids to list executions for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list executions for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list executions for." }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated types to list executions for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list executions for." }, { "key": "source_account_guid", "value": "", "disabled": true, "description": "Comma separated source account guids to list executions for." }, { "key": "destination_account_guid", "value": "", "disabled": true, "description": "Comma separated destination account guids to list executions for." }, { "key": "created_at_gte", "value": "", "disabled": true, "description": "Created at start date-time inclusive lower bound, ISO8601." }, { "key": "created_at_lt", "value": "", "disabled": true, "description": "Created at end date-time exclusive upper bound, ISO8601." }, { "key": "updated_at_gte", "value": "", "disabled": true, "description": "Updated at start date-time inclusive lower bound, ISO8601." }, { "key": "updated_at_lt", "value": "", "disabled": true, "description": "Updated at end date-time exclusive upper bound, ISO8601." } ] }, "description": "Retrieves a listing of executions. Records are sorted by creation date in descending order.\n\nRequired scope: **executions:read**" } }, { "name": "GET Get Execution", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/executions/:execution_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "executions", ":execution_guid" ] }, "description": "Retrieves a execution.\n\nRequired scope: **executions:read**" } } ] }, { "name": "ExternalBankAccounts", "item": [ { "name": "POST Create ExternalBankAccount", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/external_bank_accounts", "host": [ "{{bank_url}}" ], "path": [ "api", "external_bank_accounts" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"account_kind\": \"plaid\",\n \"customer_guid\": \"string\",\n \"asset\": \"string\",\n \"plaid_public_token\": \"string\",\n \"plaid_account_id\": \"string\",\n \"plaid_processor_token\": \"string\",\n \"plaid_institution_id\": \"string\",\n \"plaid_account_mask\": \"string\",\n \"plaid_account_name\": \"string\",\n \"counterparty_guid\": \"string\",\n \"counterparty_bank_account\": {\n \"routing_number_type\": \"CPA\",\n \"routing_number\": \"string\",\n \"account_number\": \"string\"\n },\n \"counterparty_name\": {\n \"first\": \"string\",\n \"middle\": \"string\",\n \"last\": \"string\",\n \"full\": \"string\"\n },\n \"counterparty_address\": {\n \"street\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"subdivision\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\"\n },\n \"counterparty_email_address\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create an ExternalBankAccount.\n\n## Account creation\n\nAccounts can be created for a Bank or a Customer.\n\nTo create accounts for your Bank, omit the `customer_guid` parameter in the request body. To create accounts for your Customers, include the `customer_guid` parameter in the request body.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the external bank account details in our private store |\n| completed | The Platform has created the external bank account |\n| unverified | The external bank account is created, but it has not yet been verified |\n| failed | The Platform was not able to successfully create the external bank account |\n| refresh_required | The Platform has created the external bank account, but needs to be refreshed |\n| deleting | The Platform is deleting the external bank account |\n| deleted | The Platform has deleted the external bank account |\n\n## Failure codes\n\n| Code | Description |\n|------|-------------|\n| invalid_routing_number | The provided routing number is invalid |\n| invalid_account_number | The account number is invalid |\n| invalid_account_type | The account type is invalid |\n| duplicate | An account with the same details already exists |\n| plaid_processor_token | An account could not be created due to an invalid Plaid processor token or an error with Plaid |\n| plaid_multiple_accounts | The supplied Plaid token is associated with multiple accounts. Must only be a single account. |\n| create_failed | The bank account and associated holder could not be created correctly |\n| unverified_counterparty | The counterparty account is unverified |\n\n\n\nRequired scope: **external_bank_accounts:execute**" } }, { "name": "GET Get external bank accounts list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/external_bank_accounts", "host": [ "{{bank_url}}" ], "path": [ "api", "external_bank_accounts" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated external_bank_account_guids to list external_bank_accounts for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list external_bank_accounts for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list external_bank_accounts for." }, { "key": "counterparty_guid", "value": "", "disabled": true, "description": "Comma separated counterparty_guids to list external_bank_accounts for." }, { "key": "asset", "value": "", "disabled": true, "description": "Comma separated assets to list external_bank_accounts for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list external_bank_accounts for. Filtering by \"completed\" and \"unverified\" states is only supported for individual customer accounts." } ] }, "description": "Retrieves a listing of external bank accounts. Records are sorted by creation date in descending order.\n\nRequired scope: **external_bank_accounts:read**" } }, { "name": "DELETE Delete External Bank Account", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{bank_url}}/api/external_bank_accounts/:external_bank_account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "external_bank_accounts", ":external_bank_account_guid" ] }, "description": "Deletes an external bank account.\n\nRequired scope: **external_bank_accounts:execute**" } }, { "name": "GET Get External Bank Account", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/external_bank_accounts/:external_bank_account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "external_bank_accounts", ":external_bank_account_guid" ], "query": [ { "key": "force_balance_refresh", "value": "", "disabled": true, "description": "Force the balance on the account to be retrieved." }, { "key": "include_balances", "value": "", "disabled": true, "description": "Include balance information in the response. If `force_balance_refresh` is `true`, the most up to date balance will be returned. If `force_balance_refresh` is `false`, the cached balance will be returned. `balance_updated_at` in the response will provide the timestamp the balance was last updated." }, { "key": "include_pii", "value": "", "disabled": true, "description": "Include the account holder's PII in the response (requires **external_bank_accounts:pii:read** scope)." } ] }, "description": "Retrieves an external bank account.\n\n## ExternalBankAccount retrieval\n\nWhen retrieving an external bank account and include_balances is set to true, the Platform will attempt to retrieve the balance from the account's financial institution.\n\nIf force_balance_refresh is set to true, the Platform will always attempt to retrieve the most up to date balance from the account's financial institution. If force_balance_refresh is set to false, the Platform will return the cached balance.\n\nIf while getting the balance the Platform determines that the account needs to be refreshed, the Platform will return a 422 status code with the message \"Bank account refresh required\" and the ExternalBankAccount will be put into the refresh_required state.\n\nIf while getting the balance the Platform determines that the account is no longer valid, the Platform will return a 422 status code with the message \"Bank account can no longer be used and is being deleted. It must be re-added\" and the ExternalBankAccount will be deleted.\n\nWhen retrieving an external bank account and include_pii is set to true, the Platform will include the account holder's information in the response.\n\n\n\nRequired scope: **external_bank_accounts:read**\nOptional scope: **external_bank_accounts:pii:read**." } }, { "name": "PATCH Patch ExternalBankAccount", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/external_bank_accounts/:external_bank_account_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "external_bank_accounts", ":external_bank_account_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"completed\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Patch an external bank account.\n\nRequired scope: **external_bank_accounts:write**" } } ] }, { "name": "ExternalWallets", "item": [ { "name": "POST Create ExternalWallet", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/external_wallets", "host": [ "{{bank_url}}" ], "path": [ "api", "external_wallets" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"asset\": \"string\",\n \"address\": \"string\",\n \"customer_guid\": \"string\",\n \"counterparty_guid\": \"string\",\n \"tag\": \"string\",\n \"expected_behaviours\": [\n \"force_review\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Create an ExternalWallet.\n\n## Wallet creation\n\nExternal Wallets can be created for a Bank or a Customer.\n\nTo create a wallet for your Bank, omit the `customer_guid` parameter in the request body. To create a wallet for your Customers, include the `customer_guid` parameter in the request body.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the external wallet details in our private store |\n| pending | The Platform is waiting for the external wallet to be created |\n| reviewing | The Platform is reviewing the external wallet for compliance |\n| completed | The Platform has created the external wallet |\n| failed | The Platform was not able to successfully create the external wallet |\n| deleting | The Platform is deleting the external wallet |\n| deleted | The Platform has deleted the external wallet |\n\n## Failure Codes\n\n| Code | Description |\n|-------|-------------|\n| invalid_address | The provided wallet address is invalid |\n| prohibited_address | The provided wallet address failed screening |\n\n\n\nExternal wallets can be added to the bank by leaving the customer_guid blank. External wallets added to the bank can be used by any customer of the bank.\n\nExternal wallets can also be added to a specific customer by providing the customer_guid. External wallets added to a customer can only be used by that customer.\n\nRequired scope: **external_wallets:execute**" } }, { "name": "GET Get external wallets list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/external_wallets", "host": [ "{{bank_url}}" ], "path": [ "api", "external_wallets" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "owner", "value": "", "disabled": true, "description": "The owner of the entity." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated external_wallet_guids to list external_wallets for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list external_wallets for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list external_wallets for." }, { "key": "counterparty_guid", "value": "", "disabled": true, "description": "Comma separated counterparty_guids to list external_wallets for." }, { "key": "asset", "value": "", "disabled": true, "description": "Comma separated assets to list external_wallets for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list external_wallets for." } ] }, "description": "Retrieves a listing of external wallets. Records are sorted by creation date in descending order.\n\nRequired scope: **external_wallets:read**" } }, { "name": "DELETE Delete External Wallet", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{bank_url}}/api/external_wallets/:external_wallet_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "external_wallets", ":external_wallet_guid" ] }, "description": "Deletes an external wallet.\n\nRequired scope: **external_wallets:execute**" } }, { "name": "GET Get External Wallet", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/external_wallets/:external_wallet_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "external_wallets", ":external_wallet_guid" ] }, "description": "Retrieves an external_wallet.\n\nRequired scope: **external_wallets:read**" } }, { "name": "PATCH Patch External Wallet", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/external_wallets/:external_wallet_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "external_wallets", ":external_wallet_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an external_wallet.\n\nRequired scope: **external_wallets:write**" } } ] }, { "name": "Files", "item": [ { "name": "POST Create File", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/files", "host": [ "{{bank_url}}" ], "path": [ "api", "files" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"drivers_license_front\",\n \"customer_guid\": \"string\",\n \"filename\": \"string\",\n \"content_type\": \"image/jpeg\",\n \"data\": \"string\",\n \"metadata\": {\n \"part\": \"front\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a file.\n\n## Data\n\nThe attribute contains the base64 encoded file content. The value needs to be smaller than 10MB otherwise the Platform will reject the request. To upload files larger than 10MB do not provide the content and use the returned upload URL to provide the file.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the file in our private store |\n| completed | The Platform has completed storing the file |\n| failed | The Platform failed to store the file |\n\n\n\nRequired scope: **files:execute**" } }, { "name": "GET List Files", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/files", "host": [ "{{bank_url}}" ], "path": [ "api", "files" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated file_guids to list files for." }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated file types to list files for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated file states to list files for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list files for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list files for." } ] }, "description": "Retrieves a list of files. Records are sorted by creation date in descending order.\n\nRequired scope: **files:read**" } }, { "name": "GET Get File", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/files/:file_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "files", ":file_guid" ], "query": [ { "key": "include_download_url", "value": "", "disabled": true, "description": "Include download information in response. Note, the files:pii:read scope is required if this parameter is set." } ] }, "description": "Retrieves a file.\n\nRequired scopes: **files:read, files:pii:read**" } } ] }, { "name": "IdentityVerifications", "item": [ { "name": "POST Create Identity Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/identity_verifications", "host": [ "{{bank_url}}" ], "path": [ "api", "identity_verifications" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"kyc\",\n \"customer_guid\": \"string\",\n \"expected_behaviours\": [\n \"passed_immediately\"\n ],\n \"method\": \"watchlists\",\n \"counterparty_guid\": \"string\",\n \"country_code\": \"string\",\n \"require_tax_id\": false,\n \"name\": {\n \"first\": \"string\",\n \"middle\": \"string\",\n \"last\": \"string\",\n \"full\": \"string\"\n },\n \"address\": {\n \"street\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"subdivision\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\"\n },\n \"date_of_birth\": \"1990-04-12\",\n \"identification_numbers\": [\n {\n \"type\": \"drivers_license\",\n \"issuing_country_code\": \"string\",\n \"identification_number\": \"string\",\n \"issuing_subdivision\": \"string\"\n }\n ],\n \"aliases\": [\n {\n \"full\": \"string\"\n }\n ],\n \"phone_number\": \"string\",\n \"email_address\": \"string\",\n \"website\": \"string\",\n \"nature_of_business\": \"string\",\n \"director_customer_guids\": [\n \"string\"\n ],\n \"ultimate_beneficial_owners\": [\n {\n \"customer_guid\": \"string\",\n \"ownership_percentage\": 1\n }\n ],\n \"supporting_file_guids\": [\n \"string\"\n ],\n \"registered_address\": {\n \"street\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"subdivision\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\"\n },\n \"business_industry\": \"string\",\n \"business_funds_source\": \"string\",\n \"business_funds_destination\": \"string\",\n \"occupation\": \"string\",\n \"biometrics_verified\": false,\n \"external_bank_account_guid\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates an Identity Verification.\n\n## Identity Verifications\n\nIdentity Verifications confirm an individual's identity with for the purpose of inclusion on the platform. This know-your-customer (KYC) process is a requirement for individuals to be able to transact. At present, we offer support for Cybrid performing the verification or working with partners to accept their KYC/AML process and have it attested to in our platform.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the identity verification details in our private store |\n| waiting | The Platform is waiting for the customer to start the identity verification process |\n| pending | The Platform is waiting for the customer to finish the identity verification process |\n| reviewing | The Platform is waiting for compliance to review the identity verification results |\n| expired | The identity verification process has expired |\n| completed | The identity verification process has been completed |\n\n## Outcome\n\n| State | Description |\n|-------|-------------|\n| passed | The customer has passed the identity verification process |\n| failed | The customer has failed the identity verification process |\n\n## Failure Codes\n\n| Code | Description |\n|-------|-------------|\n| id_check_failure | Failure due to an issue verifying the provided ID |\n| id_quality_check_failure | Failure due to an issue verifying the provided ID based on the image quality |\n| id_barcode_check_failure | Failure due to an issue verifying the provided ID based on the barcode |\n| id_mrz_check_failure | Failure due to an issue verifying the provided ID based on the machine-readable zone (MRZ) |\n| id_presence_check_failure | Failure due to an issue verifying the provided ID based on the presence of the ID |\n| id_expiration_check_failure | Failure due to an issue verifying the provided ID based on the expiration date |\n| id_double_side_check_failure | Failure due to an issue verifying the provided ID based on both sides not being provided |\n| id_type_allowed_check_failure | Failure due to an issue verifying the provided ID based on the type provided |\n| id_country_allowed_check_failure | Failure due to an issue verifying the provided ID based on the issuing country |\n| id_digital_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a digital replica |\n| id_paper_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a paper replica |\n| database_check_failure | Failure due to an issue verifying the provided information against authoritative data sources |\n| selfie_failure | Failure due to an issue verifying the provided selfie photo |\n| selfie_pose_check_failure | Failure due to an issue verifying the provided selfie photo based on incorrect poses |\n| selfie_quality_check_failure | Failure due to an issue verifying the provided selfie photo based on the image quality |\n| country_comparison_check_failure | Failure due the customer verification being performed out of country |\n| duplicate_person_check_failure | Failure due to a customer already existing for this person |\n| prohibited_person_check_failure | Failure due to a person being on prohibited from accessing the service |\n| name_check_failure | Failure due to an issue verifying the name of the person |\n| address_check_failure | Failure due to an issue verifying the address of the person |\n| account_number_check_failure | Failure due to an issue verifying the account number of the person |\n| dob_check_failure | Failure due to an issue verifying the date of birth of the person |\n| id_number_check_failure | Failure due to an issue verifying an identification number of the person |\n| phone_number_check_failure | Failure due to an issue verifying the phone number of the person |\n| email_address_check_failure | Failure due to an issue verifying the email address of the person |\n| document_type_check_failure | Failure due to the type of document provided not being the correct type |\n| document_quality_check_failure | Failure due to an issue verifying the document based on the image quality |\n| document_check_failure | Failure due to an issue verifying the documents |\n| name_comparison_check_failure | Failure due to a mismatch between the name on the customer account and the name on the provided documents |\n| compliance_rejection | Failure due to compliance rejecting the identity verification |\n| review_required | The verification is inconclusive and requires a manual review |\n| user_canceled | Failure due to the user canceling the identity verification |\n| plaid_failure | Failure due to an issue interacting with Plaid |\n| plaid_item_login_required | Failure due to the Plaid token for the account requiring re-login |\n| plaid_invalid_product | Failure due to the Plaid product not being supported (contact support) |\n| plaid_no_accounts | Failure due to the Plaid token having access to no accounts |\n| plaid_item_not_found | Failure due to Plaid not being able to find the associated account |\n| decision_timeout | Failure due to an issue verifying the email address of the person |\n| requested_failure | In sandbox, the caller requested that the process failed |\n| deleted_account | Failure due to the bank account having been deleted before a decision was made |\n|pep_check_failure| Failure due to the person being on a Politically Exposed Persons (PEP) list |\n|media_check_failure| Failure due to the person being on Adverse Media list |\n|watchlist_check_failure| Failure due to the person being on a known government or international watchlist or sanctions list |\n\n\n\nRequired scope: **identity_verifications:execute**" } }, { "name": "GET List Identity Verifications", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/identity_verifications", "host": [ "{{bank_url}}" ], "path": [ "api", "identity_verifications" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated guids to list identity verifications for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list identity verifications for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list identity verifications for." }, { "key": "counterparty_guid", "value": "", "disabled": true, "description": "Comma separated counterparty_guids to list identity verifications for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list identity verifications for." }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated types to list identity verifications for." }, { "key": "method", "value": "", "disabled": true, "description": "Comma separated methods to list identity verifications for." } ] }, "description": "Retrieves a list of identity verifications. Records are sorted by creation date in descending order.\n\nRequired scope: **identity_verifications:read**" } }, { "name": "GET Get Identity Verification", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/identity_verifications/:identity_verification_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "identity_verifications", ":identity_verification_guid" ], "query": [ { "key": "include_pii", "value": "", "disabled": true, "description": "Include PII in the response (requires **identity_verifications:pii:read** scope)." } ] }, "description": "Retrieves an identity verification.\n\nRequired scope: **identity_verifications:read**\nOptional scope: **identity_verifications:pii:read**." } } ] }, { "name": "Invoices", "item": [ { "name": "POST Create Invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/invoices", "host": [ "{{bank_url}}" ], "path": [ "api", "invoices" ] }, "body": { "mode": "raw", "raw": "{\n \"asset\": \"string\",\n \"customer_guid\": \"string\",\n \"receive_amount\": 1,\n \"deliver_amount\": 1,\n \"account_guid\": \"string\",\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a invoice.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the invoice details in our private store |\n| unpaid | The invoice is unpaid. Payment instructions can be generated for an invoice in this state |\n| cancelling | The invocie is in the process of being cancelled |\n| cancelled | The invoice has been cancelled | \n| settling | The invoice has been paid and the funds associated with this invoice are in the process of being settled |\n| paid | The invoice has been paid and the funds associated with this invoice have been settled | \n\n\n\nRequired scope: **invoices:execute**" } }, { "name": "GET List Invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/invoices", "host": [ "{{bank_url}}" ], "path": [ "api", "invoices" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated guids to list invoices for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list invoices for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list invoices for." }, { "key": "account_guid", "value": "", "disabled": true, "description": "Comma separated account_guids to list invoices for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list invoices for." }, { "key": "asset", "value": "", "disabled": true, "description": "Comma separated assets to list invoices for." }, { "key": "environment", "value": "", "disabled": true }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list invoices for." } ] }, "description": "Retrieves a list of invoices. Records are sorted by creation date in descending order.\n\nRequired scope: **invoices:read**" } }, { "name": "DELETE Cancel Invoice", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{bank_url}}/api/invoices/:invoice_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "invoices", ":invoice_guid" ] }, "description": "Cancels an invoice.\n\nRequired scope: **invoices:execute**" } }, { "name": "GET Get Invoice", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/invoices/:invoice_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "invoices", ":invoice_guid" ] }, "description": "Retrieves a invoice.\n\nRequired scope: **invoices:read**" } } ] }, { "name": "PaymentInstructions", "item": [ { "name": "POST Create Payment Instruction", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/payment_instructions", "host": [ "{{bank_url}}" ], "path": [ "api", "payment_instructions" ] }, "body": { "mode": "raw", "raw": "{\n \"invoice_guid\": \"string\",\n \"expected_behaviour\": \"invoice_paid_immediately\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a payment instruction.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the payment instruction details in our private store |\n| created | The Platform has created the payment instruction |\n| expired | The PaymentInstruction is no longer valid |\n\n\n\nRequired scope: **invoices:write**" } }, { "name": "GET List Payment Instructions", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/payment_instructions", "host": [ "{{bank_url}}" ], "path": [ "api", "payment_instructions" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated guids to list payment instructions for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list payment instructions for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list payment instructions for." }, { "key": "invoice_guid", "value": "", "disabled": true, "description": "Comma separated invoice_guids to list payment instructions for." } ] }, "description": "Retrieves a list of payment instructions. Records are sorted by creation date in descending order.\n\nRequired scope: **invoices:read**" } }, { "name": "GET Get Payment Instruction", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/payment_instructions/:payment_instruction_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "payment_instructions", ":payment_instruction_guid" ] }, "description": "Retrieves a payment_instruction.\n\nRequired scope: **invoices:read**" } } ] }, { "name": "PersonaSessions", "item": [ { "name": "POST Create Persona Session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/persona_sessions", "host": [ "{{bank_url}}" ], "path": [ "api", "persona_sessions" ] }, "body": { "mode": "raw", "raw": "{\n \"persona_inquiry_id\": \"string\",\n \"identity_verification_guid\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a Persona session.\n\nRequired scope: **persona_sessions:execute**" } } ] }, { "name": "Plans", "item": [ { "name": "POST Create Plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/plans", "host": [ "{{bank_url}}" ], "path": [ "api", "plans" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"remittance\",\n \"source_account\": {\n \"guid\": \"string\",\n \"amount\": 1,\n \"payment_rail\": \"ach\"\n },\n \"destination_account\": {\n \"guid\": \"string\",\n \"amount\": 1,\n \"payment_rail\": \"ach\"\n },\n \"bank_guid\": \"string\",\n \"customer_guid\": \"string\",\n \"travel_rule_info\": {\n \"ultimate_originating_party_guid\": \"string\",\n \"ultimate_receiving_party_guid\": \"string\"\n },\n \"purpose_of_transaction\": \"computer_services\",\n \"labels\": [\n \"string\"\n ],\n \"supporting_documents\": [\n {\n \"type\": \"invoice\",\n \"file_guids\": [\n \"string\"\n ],\n \"document_reference_number\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a plan.\n\n## Create a plan\n\nPlans can be created for a Bank or a Customer.\n\nTo create plan for your Bank, omit the `customer_guid` parameter in the request body. To create plans for your Customers, include the `customer_guid` parameter in the request body.\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the plan details in our private store |\n| planning | The Platform is currently building the plan |\n| completed | The Platform has successfully completed the plan |\n| failed | The Platform was not able to successfully complete the plan |\n\n\n\nRequired scope: **plans:execute**" } }, { "name": "GET Get plans list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/plans", "host": [ "{{bank_url}}" ], "path": [ "api", "plans" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated plan_guids to list plans for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list plans for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list plans for." }, { "key": "type", "value": "", "disabled": true, "description": "Comma separated types to list plans for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list plans for." }, { "key": "source_account_guid", "value": "", "disabled": true, "description": "Comma separated source account guids to list plans for." }, { "key": "destination_account_guid", "value": "", "disabled": true, "description": "Comma separated destination account guids to list plans for." }, { "key": "created_at_gte", "value": "", "disabled": true, "description": "Created at start date-time inclusive lower bound, ISO8601." }, { "key": "created_at_lt", "value": "", "disabled": true, "description": "Created at end date-time exclusive upper bound, ISO8601." }, { "key": "updated_at_gte", "value": "", "disabled": true, "description": "Updated at start date-time inclusive lower bound, ISO8601." }, { "key": "updated_at_lt", "value": "", "disabled": true, "description": "Updated at end date-time exclusive upper bound, ISO8601." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list plans for." } ] }, "description": "Retrieves a listing of plans. Records are sorted by creation date in descending order.\n\nRequired scope: **plans:read**" } }, { "name": "GET Get Plan", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/plans/:plan_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "plans", ":plan_guid" ] }, "description": "Retrieves a plan.\n\nRequired scope: **plans:read**" } } ] }, { "name": "Prices", "item": [ { "name": "GET Get Price", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/prices", "host": [ "{{bank_url}}" ], "path": [ "api", "prices" ], "query": [ { "key": "symbol", "value": "", "disabled": true, "description": "Comma separated trading symbols to list prices for." }, { "key": "trading_symbol", "value": "", "disabled": true, "description": "Comma separated trading symbols to list prices for." }, { "key": "payout_symbol", "value": "", "disabled": true, "description": "Comma separated payout symbols to list prices for." }, { "key": "payout_country_code", "value": "", "disabled": true, "description": "Comma separated payout country codes to list prices for." }, { "key": "payout_participants_type", "value": "", "disabled": true, "description": "Comma separated payout participants types to list prices for." }, { "key": "payout_route", "value": "", "disabled": true, "description": "Comma separated payout routes to list prices for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "The bank identifier to retrieve prices for." } ] }, "description": "Retrieves a listing of symbol prices.\n\n## Symbols\n\nSymbol are pairs and are in the format asset-counter_asset, e.g., 'BTC-USD' for the Bitcoin/ USD pair. See the Symbols API for a complete list of cryptocurrencies supported.\n\n\n\nRequired scope: **prices:read**" } } ] }, { "name": "Quotes", "item": [ { "name": "POST Create Quote", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/quotes", "host": [ "{{bank_url}}" ], "path": [ "api", "quotes" ] }, "body": { "mode": "raw", "raw": "{\n \"product_type\": \"trading\",\n \"bank_guid\": \"string\",\n \"customer_guid\": \"string\",\n \"receive_amount\": 1,\n \"deliver_amount\": 1,\n \"asset\": \"string\",\n \"network_address\": \"string\",\n \"fees\": [\n {\n \"type\": \"spread\",\n \"spread_fee\": 1,\n \"fixed_fee\": 1\n }\n ],\n \"side\": \"deposit\",\n \"destination_account_guid\": \"string\",\n \"payment_rail\": \"ach\",\n \"symbol\": \"string\",\n \"destination_accounts\": [\n {\n \"type\": \"external_wallet\",\n \"guid\": \"string\",\n \"receive_amount\": 1,\n \"deliver_amount\": 1\n }\n ],\n \"reference_trade_guid\": \"string\",\n \"source_account_guid\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a quote.\n\n## Quote creation\n\nQuotes can be created for a Bank or a Customer.\n\nTo create quotes for your Bank, omit the `customer_guid` parameter in the request body. To create quotes for your Customers, include the `customer_guid` parameter in the request body.\n\n## Failure codes\n\n| Code | Description |\n|------|-------------|\n| invalid_amount | The amount on the invoice is unprocessable |\n| insufficient_balance | There are insufficient funds to process the quote |\n| invalid_invoice | The invoice cannot be processed |\n\n\n\nRequired scope: **quotes:execute**" } }, { "name": "GET Get quotes list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/quotes", "host": [ "{{bank_url}}" ], "path": [ "api", "quotes" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated quote_guids to list quotes for." }, { "key": "product_type", "value": "", "disabled": true, "description": "Comma separated product_types to list accounts for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list quotes for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list quotes for." }, { "key": "side", "value": "", "disabled": true, "description": "Comma separated sides to list quotes for." } ] }, "description": "Retrieves a listing of quotes. Records are sorted by creation date in descending order.\n\nRequired scope: **quotes:read**" } }, { "name": "GET Get Quote", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/quotes/:quote_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "quotes", ":quote_guid" ] }, "description": "Retrieves a quote.\n\nRequired scope: **quotes:read**" } } ] }, { "name": "SardineSessions", "item": [ { "name": "POST Create Sardine Session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/sardine_sessions", "host": [ "{{bank_url}}" ], "path": [ "api", "sardine_sessions" ] }, "body": { "mode": "raw", "raw": "{\n \"customer_guid\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a Sardine session.\n\nRequired scope: **sardine_sessions:execute**" } } ] }, { "name": "Symbols", "item": [ { "name": "GET Get Symbols list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/symbols", "host": [ "{{bank_url}}" ], "path": [ "api", "symbols" ] }, "description": "Retrieves a listing of symbols.Required scope: **prices:read**" } } ] }, { "name": "Trades", "item": [ { "name": "POST Create Trade", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/trades", "host": [ "{{bank_url}}" ], "path": [ "api", "trades" ] }, "body": { "mode": "raw", "raw": "{\n \"quote_guid\": \"string\",\n \"trade_type\": \"platform\",\n \"fiat_account_guid\": \"string\",\n \"expected_error\": \"expired_quote\",\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a trade.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the trade details in our private store |\n| pending | The Platform has stored the trade details and is processing it |\n| executed | The Platform has processed the trade and needs to settle it |\n| settling | The Platform has executed the trade and is settling the funds |\n| cancelled | The Platform has cancelled the trade |\n| completed | The Platform has successfully completed the trade |\n| failed | The Platform was not able to successfully complete the trade |\n\n## Failure codes\n\n| Code | Description |\n|------|-------------|\n| non_sufficient_funds | The delivery account does not have enough funds to complete the trade |\n| unsupported | The trading pair is not supported for this customer |\n| limit_exceeded | The customer is over the limits that have been set for them for this activity |\n| daily_limit_exceeded | The customer is over their daily limits for this activity |\n| weekly_limit_exceeded | The customer is over their weekly limits for this activity |\n| monthly_limit_exceeded | The customer is over their monthly limits for this activity |\n| expired_quote | The quote expired before it could be executed |\n| market_volatility | The quote could not be executed due to market volatility |\n| not_filled | The trade could not be filled based on the amounts specified |\n\n\n\nRequired scope: **trades:execute**" } }, { "name": "GET Get trades list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/trades", "host": [ "{{bank_url}}" ], "path": [ "api", "trades" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated trade_guids to list trades for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list trades for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list trades for." }, { "key": "account_guid", "value": "", "disabled": true, "description": "Comma separated account_guids to list trades for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list trades for." }, { "key": "side", "value": "", "disabled": true, "description": "Comma separated sides to list trades for." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list trades for." }, { "key": "created_at_gte", "value": "", "disabled": true, "description": "Created at start date-time inclusive lower bound, ISO8601." }, { "key": "created_at_lt", "value": "", "disabled": true, "description": "Created at end date-time exclusive upper bound, ISO8601." }, { "key": "updated_at_gte", "value": "", "disabled": true, "description": "Updated at start date-time inclusive lower bound, ISO8601." }, { "key": "updated_at_lt", "value": "", "disabled": true, "description": "Updated at end date-time exclusive upper bound, ISO8601." } ] }, "description": "Retrieves a listing of trades. Records are sorted by creation date in descending order.\n\nRequired scope: **trades:read**" } }, { "name": "GET Get Trade", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/trades/:trade_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "trades", ":trade_guid" ] }, "description": "Retrieves a trade.\n\nRequired scope: **trades:read**" } } ] }, { "name": "Transfers", "item": [ { "name": "POST Create Transfer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/transfers", "host": [ "{{bank_url}}" ], "path": [ "api", "transfers" ] }, "body": { "mode": "raw", "raw": "{\n \"quote_guid\": \"string\",\n \"transfer_type\": \"funding\",\n \"external_bank_account_guid\": \"string\",\n \"fiat_account_guid\": \"string\",\n \"send_as_deposit_bank_account_guid\": \"string\",\n \"payment_rail\": \"ach\",\n \"beneficiary_memo\": \"string\",\n \"security_question\": \"string\",\n \"security_answer\": \"string\",\n \"source_participants\": [\n {\n \"type\": \"bank\",\n \"amount\": 1,\n \"guid\": \"string\"\n }\n ],\n \"destination_participants\": [\n {\n \"type\": \"bank\",\n \"amount\": 1,\n \"guid\": \"string\"\n }\n ],\n \"sardine_session_guid\": \"string\",\n \"bank_fiat_account_guid\": \"string\",\n \"customer_fiat_account_guid\": \"string\",\n \"source_account_guid\": \"string\",\n \"destination_account_guid\": \"string\",\n \"external_wallet_guid\": \"string\",\n \"customer_guid\": \"string\",\n \"network_fee_account_guid\": \"string\",\n \"expected_behaviours\": [\n \"force_review\"\n ],\n \"labels\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a transfer.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the transfer details in our private store |\n| reviewing | The Platform is reviewing the transfer for compliance |\n| pending | The Platform is executing the transfer |\n| completed | The Platform has successfully completed the transfer |\n| failed | The Platform was not able to successfully complete the transfer |\n\n## Failure codes\n\n| Code | Description |\n|------|-------------|\n| amount_too_low | The transfer was rejected due to the amount being too low |\n| cancelled | The transfer was manually cancelled |\n| compliance_rejection | The transfer was rejected for compliance reasons |\n| internal_error | An internal error occurred while processing the transfer, please try again |\n| invalid_address | The destination address is invalid for transfer |\n| invalid_balance | There was insufficient balance for all required currencies to complete the transfer |\n| return_risk_exceeded | The risk of return is too high for this activity to be completed |\n| limit_exceeded | The customer is over the limits that have been set for them for this activity |\n| daily_limit_exceeded | The customer is over their daily limits for this activity |\n| weekly_limit_exceeded | The customer is over their weekly limits for this activity |\n| monthly_limit_exceeded | The customer is over their monthly limits for this activity |\n| network_fee_too_low | The transfer was rejected due to the network fee being too low |\n| non_sufficient_funds | The customer does not have enough funds to complete the transfer |\n| party_name_invalid | The transfer's associated external bank account has an invalid party name |\n| payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account |\n| payment_request_expired | The payment request expired before it could be completed |\n| plaid_access_not_granted | See the description from Plaid [here](https://plaid.com/docs/errors/item/#access_not_granted) |\n| plaid_institution_not_responding | See the description from Plaid [here](https://plaid.com/docs/errors/institution/#institution_not_responding) |\n| plaid_internal_server_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error) |\n| plaid_item_not_found | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_found) |\n| plaid_item_not_supported | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_supported) |\n| plaid_multiple_accounts | Multiple accounts were selected through Plaid Link. |\n| plaid_no_accounts | See the description from Plaid [here](https://plaid.com/docs/errors/item/#no_accounts) |\n| plaid_none_balances_error | The transfer was rejected due to an error with the balances retrieved by Plaid |\n| plaid_unknown_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#unknown_error) |\n| refresh_required | The transfer's associated external_bank_account needs to be reconnected via Plaid |\n| invalid_destination | Issues with the destination details (invalid, closed, blocked) |\n| customer_action_required | Authorization declined or customer action required |\n| external_vendor_error | Unexpected error occurred with an external vendor or partner service during transfer processing |\n| reversed | The transfer was reversed |\n\n## Failure codes that will result in a state change for the associated external bank account\n\n| Code | Description |\n|------|-------------|\n| refresh_required | The transfer was rejected due to the external bank account needing to be refreshed. The external bank account will be put in the state `refresh_required` |\n| plaid_access_not_granted | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` |\n| plaid_item_not_found | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` |\n| plaid_item_not_supported | The transfer was rejected because the account is not supported. A different account should be connected via Plaid. The external bank account will be put in the state `deleted` |\n| plaid_multiple_accounts | The transfer was rejected because multiple accounts were selected through Plaid Link. Only one account must be selected. The external bank account will be put in the state `deleted` |\n| plaid_no_accounts | The transfer was rejected because no compatible accounts could be found. The external bank account will be put in the state `deleted` |\n\n\n\nRequired scope: **transfers:execute**" } }, { "name": "GET Get transfers list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/transfers", "host": [ "{{bank_url}}" ], "path": [ "api", "transfers" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated transfer_guids to list transfers for." }, { "key": "transfer_type", "value": "", "disabled": true, "description": "Comma separated transfer_types to list accounts for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list transfers for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list transfers for." }, { "key": "account_guid", "value": "", "disabled": true, "description": "Comma separated account_guids to list transfers for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list transfers for." }, { "key": "side", "value": "", "disabled": true, "description": "Comma separated sides to list transfers for." }, { "key": "label", "value": "", "disabled": true, "description": "Comma separated labels to list transfers for." }, { "key": "txn_hash", "value": "", "disabled": true, "description": "Comma separated transaction hashes to list transfers for." }, { "key": "created_at_gte", "value": "", "disabled": true, "description": "Created at start date-time inclusive lower bound, ISO8601" }, { "key": "created_at_lt", "value": "", "disabled": true, "description": "Created at end date-time exclusive upper bound, ISO8601." }, { "key": "updated_at_gte", "value": "", "disabled": true, "description": "Created at start date-time inclusive lower bound, ISO8601" }, { "key": "updated_at_lt", "value": "", "disabled": true, "description": "Created at end date-time exclusive upper bound, ISO8601." } ] }, "description": "Retrieves a listing of transfers. Records are sorted by creation date in descending order.\n\nRequired scope: **transfers:read**" } }, { "name": "GET Get Transfer", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/transfers/:transfer_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "transfers", ":transfer_guid" ] }, "description": "Retrieves a transfer.\n\nRequired scope: **transfers:read**" } }, { "name": "PATCH Patch Transfer", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{bank_url}}/api/transfers/:transfer_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "transfers", ":transfer_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"source_participants\": [\n {\n \"type\": \"bank\",\n \"amount\": 1,\n \"guid\": \"string\"\n }\n ],\n \"destination_participants\": [\n {\n \"type\": \"bank\",\n \"amount\": 1,\n \"guid\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a transfer.\n\nRequired scope: **transfers:write**" } } ] }, { "name": "Workflows", "item": [ { "name": "POST Create Workflow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{bank_url}}/api/workflows", "host": [ "{{bank_url}}" ], "path": [ "api", "workflows" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"plaid\",\n \"kind\": \"link_token_create\",\n \"customer_guid\": \"string\",\n \"external_bank_account_guid\": \"string\",\n \"language\": \"en\",\n \"link_customization_name\": \"string\",\n \"redirect_uri\": \"string\",\n \"android_package_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a workflow.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the workflow details in our private store |\n| completed | The Platform has created the workflow |\n| failed | The workflow was not completed successfully |\n\n## Plaid\n\n| Param | Description |\n|-------|-------------|\n| redirect_uri | All URIs must be registered with Cybrid. For local testing use `http://localhost:4200/bank-account-connect` |\n\n\n\nRequired scope: **workflows:execute**" } }, { "name": "GET Get workflows list", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/workflows", "host": [ "{{bank_url}}" ], "path": [ "api", "workflows" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated workflow_guids to list workflows for." }, { "key": "bank_guid", "value": "", "disabled": true, "description": "Comma separated bank_guids to list workflows for." }, { "key": "customer_guid", "value": "", "disabled": true, "description": "Comma separated customer_guids to list workflows for." } ] }, "description": "Retrieves a listing of workflows. Records are sorted by creation date in descending order.\n\nRequired scope: **workflows:read**" } }, { "name": "GET Get Workflow", "request": { "method": "GET", "header": [], "url": { "raw": "{{bank_url}}/api/workflows/:workflow_guid", "host": [ "{{bank_url}}" ], "path": [ "api", "workflows", ":workflow_guid" ] }, "description": "Retrieves a workflow.\n\nRequired scope: **workflows:read**" } } ] } ] }, { "name": "2 · Organization API", "description": "The Cybrid-compatible Organization API. Base URL {{organization_url}}, organization key.", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{organization_secret_key}}", "type": "string" } ] }, "item": [ { "name": "Organizations", "item": [ { "name": "GET Get organization", "request": { "method": "GET", "header": [], "url": { "raw": "{{organization_url}}/api/organizations/:organization_guid", "host": [ "{{organization_url}}" ], "path": [ "api", "organizations", ":organization_guid" ] }, "description": "Retrieve an organization.\n\nRequired scope: **organizations:read**" } }, { "name": "PATCH Patch organization", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{organization_url}}/api/organizations/:organization_guid", "host": [ "{{organization_url}}" ], "path": [ "api", "organizations", ":organization_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update an organization.\n\nRequired scope: **organizations:write**" } } ] }, { "name": "SubscriptionDeliveries", "item": [ { "name": "POST Create SubscriptionDelivery", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{organization_url}}/api/subscription_deliveries/", "host": [ "{{organization_url}}" ], "path": [ "api", "subscription_deliveries", "" ] }, "body": { "mode": "raw", "raw": "{\n \"subscription_event_guid\": \"string\",\n \"subscription_guid\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a SubscriptionDelivery.\n\n## Subscription Delivery\n\nCreate a SubscriptionDelivery to retry the delivery of a SubscriptionEvent to a Subscription.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the SubscriptionDelivery details in our private store |\n| completed | The Platform has successfully delivered the SubscriptionEvent to specified Subscription |\n| failing | The Platform is failing to deliver the SubscriptionDelivery, a new attempt will be made (see `next_attempt_at`) |\n| failed | The Platform has failed to deliver the SubscriptionDelivery, no more attempts will be made |\n\n\n\nRequired scope: **subscription_events:execute" } }, { "name": "GET Get Subscription Delivery ", "request": { "method": "GET", "header": [], "url": { "raw": "{{organization_url}}/api/subscription_deliveries/:subscription_delivery_guid", "host": [ "{{organization_url}}" ], "path": [ "api", "subscription_deliveries", ":subscription_delivery_guid" ] }, "description": "Retrieves a subscription delivery.\n\nRequired scope: **subscription_events:read**" } }, { "name": "GET Get subscription deliveries list", "request": { "method": "GET", "header": [], "url": { "raw": "{{organization_url}}/api/subscription_deliveries", "host": [ "{{organization_url}}" ], "path": [ "api", "subscription_deliveries" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated subscription_delivery_guids to list subscription deliveries for." }, { "key": "subscription_event_guid", "value": "", "disabled": true, "description": "Comma separated subscription_event_guids to list subscription deliveries for." }, { "key": "subscription_guid", "value": "", "disabled": true, "description": "Comma separated subscription_guids to list subscription deliveries for." }, { "key": "state", "value": "", "disabled": true, "description": "Comma separated states to list subscription deliveries for." }, { "key": "event_type", "value": "", "disabled": true, "description": "Comma separated event types to list subscription deliveries for." }, { "key": "completed_at_gte", "value": "", "disabled": true, "description": "ISO8601 datetime; only deliveries completed at or after this time are returned." }, { "key": "completed_at_lt", "value": "", "disabled": true, "description": "ISO8601 datetime; only deliveries completed before this time are returned." } ] }, "description": "Retrieves a listing of subscription deliveries s.\n\nRequired scope: **subscription_events:read**" } } ] }, { "name": "SubscriptionEvents", "item": [ { "name": "GET Get Subscription Event ", "request": { "method": "GET", "header": [], "url": { "raw": "{{organization_url}}/api/subscription_events/:subscription_event_guid", "host": [ "{{organization_url}}" ], "path": [ "api", "subscription_events", ":subscription_event_guid" ] }, "description": "Retrieves a Subscription Event.\n\nRequired scope: **subscription_events:read**" } }, { "name": "GET Get subscription events list", "request": { "method": "GET", "header": [], "url": { "raw": "{{organization_url}}/api/subscription_events", "host": [ "{{organization_url}}" ], "path": [ "api", "subscription_events" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated subscription_event_guids to list subscription events for." } ] }, "description": "Retrieves a listing of subscription events s.\n\nRequired scope: **subscription_events:read**" } } ] }, { "name": "Subscriptions", "item": [ { "name": "POST Create Subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "A fresh key per request. Retrying a timed-out request needs the SAME key — replace this with your own reference when that matters." } ], "url": { "raw": "{{organization_url}}/api/subscriptions/", "host": [ "{{organization_url}}" ], "path": [ "api", "subscriptions", "" ] }, "body": { "mode": "raw", "raw": "{\n \"environment\": \"sandbox\",\n \"type\": \"webhook\",\n \"name\": \"string\",\n \"url\": \"string\",\n \"recipient\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a Subscription.\n\n## Subscription creation\n\nSubscriptions can be created for webhook endpoints.\n\n## State\n\n| State | Description |\n|-------|-------------|\n| storing | The Platform is storing the subscription details in our private store |\n| completed | The Platform has created the subscription |\n| failed | The Platform was not able to successfully create the subscription |\n\n\n\nRequired scope: **subscriptions:execute" } }, { "name": "DELETE Delete Subscription", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{organization_url}}/api/subscriptions/:subscription_guid", "host": [ "{{organization_url}}" ], "path": [ "api", "subscriptions", ":subscription_guid" ] }, "description": "Deletes a subscription.\n\nRequired scope: **subscriptions:execute**" } }, { "name": "GET Get Subscription ", "request": { "method": "GET", "header": [], "url": { "raw": "{{organization_url}}/api/subscriptions/:subscription_guid", "host": [ "{{organization_url}}" ], "path": [ "api", "subscriptions", ":subscription_guid" ] }, "description": "Retrieves a subscription.\n\nRequired scope: **subscriptions:read**" } }, { "name": "PATCH Patch subscription", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{organization_url}}/api/subscriptions/:subscription_guid", "host": [ "{{organization_url}}" ], "path": [ "api", "subscriptions", ":subscription_guid" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a subscription.\n\nRequired scope: **subscriptions:write**" } }, { "name": "GET Get subscriptions list", "request": { "method": "GET", "header": [], "url": { "raw": "{{organization_url}}/api/subscriptions", "host": [ "{{organization_url}}" ], "path": [ "api", "subscriptions" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "The page index to retrieve." }, { "key": "per_page", "value": "", "disabled": true, "description": "The number of entities per page to return." }, { "key": "guid", "value": "", "disabled": true, "description": "Comma separated subscription_guids to list subscriptions for." }, { "key": "environment", "value": "", "disabled": true, "description": "Environment to list subscriptions for." }, { "key": "state", "value": "", "disabled": true, "description": "State to list subscriptions for." } ] }, "description": "Retrieves a listing of subscriptions.\n\nRequired scope: **subscriptions:read**" } } ] } ] } ] }