{ "item": [ { "name": "Accounts", "description": "", "item": [ { "id": "ca15b9a6-e24a-41e4-b1b2-04493eb7f99b", "name": "Create Account", "request": { "name": "Create Account", "description": { "content": "Create a new account.\n\n### Account status and lifecycle\n\nThe `status` field reflects where the account is in its lifecycle. Possible values are:\n\n- `PROVISIONING`: the account is being set up and is not yet operational.\n- `ACTIVE`: the account is operational.\n- `SUSPENDED`: operations are temporarily disabled (e.g. compliance, fraud, legal hold or review).\n- `CLOSED`: terminal state — the account has been closed.\n- `REJECTED`: terminal state — onboarding was deliberately denied (KYC/KYB/compliance).\n\nDepending on the rail, a new account may be returned as `ACTIVE` right away, or start in `PROVISIONING` and move to `ACTIVE` once setup finishes. The `status` in this endpoint's response is the account's initial state.\n\nEvery time the status changes afterwards, a webhook is sent as an HTTP `POST` to the `status_callback_url` provided in the request body. The body of that webhook is the account object, using the same schema as the [Get Account Details](ref:v1_2_get_account_) response. No webhook is sent for the initial state, nor when an update leaves the status unchanged.\n\n### Testing in sandbox\n\nAccount creation is currently synchronous: the account's status is returned directly in this endpoint's response. In the sandbox, create the account with `label` set to `SIMULATE_STATUS_` (e.g. `SIMULATE_STATUS_SUSPENDED`) to have it created directly in that status, or to `SIMULATE_PROVISIONING_FLOW` to simulate the `PROVISIONING` → `ACTIVE` transition and its webhook.", "type": "text/plain" }, "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"BRLA_BASE\",\n \"country\": \"AR\",\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"INTERNAL_TRANSFER\"\n ],\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"idempotency_key\": \"\",\n \"owner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "0ca3924d-7131-4446-9a77-a73090f74696", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"BRLA_BASE\",\n \"country\": \"AR\",\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"INTERNAL_TRANSFER\"\n ],\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"idempotency_key\": \"\",\n \"owner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"bank\": \"\",\n \"currency\": \"SGD\",\n \"country\": \"BR\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"idempotency_key\": \"\",\n \"company_id\": \"\",\n \"account_number\": \"\",\n \"enabled\": true,\n \"account_type\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\",\n \"funding_instructions\": {\n \"type\": \"fiat\",\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"bank_code\": \"\",\n \"br_code\": \"\",\n \"breb_key\": \"\",\n \"ted_brl\": {\n \"bank_code\": \"\",\n \"branch_number\": \"\",\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_document\": \"\"\n },\n \"pix_key_brl\": {\n \"pix_key\": \"\"\n },\n \"br_code_brl\": {\n \"br_code\": \"\"\n },\n \"fps_gbp\": {\n \"account_number\": \"\",\n \"sort_code\": \"\",\n \"account_holder_name\": \"\"\n },\n \"iban\": \"\",\n \"bic\": \"\"\n },\n \"balance_details\": {\n \"total\": \"\",\n \"available\": \"\",\n \"last_update\": \"\"\n },\n \"is_virtual_account\": false,\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"owner_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6558d0d5-64f4-430c-b2ad-e1ec0647f685", "name": "Bad Request", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"BRLA_BASE\",\n \"country\": \"AR\",\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"INTERNAL_TRANSFER\"\n ],\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"idempotency_key\": \"\",\n \"owner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fa9b018-8b57-4f29-a39d-9de2d32cb54e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"BRLA_BASE\",\n \"country\": \"AR\",\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"INTERNAL_TRANSFER\"\n ],\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"idempotency_key\": \"\",\n \"owner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60002798-270e-49fa-b550-78b5ed1aab54", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"BRLA_BASE\",\n \"country\": \"AR\",\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"INTERNAL_TRANSFER\"\n ],\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"idempotency_key\": \"\",\n \"owner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55d64695-18c2-4961-bc69-295c52196a3d", "name": "List Accounts", "request": { "name": "List Accounts", "description": { "content": "Retrieves a paginated list of accounts.", "type": "text/plain" }, "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Search using the account ID; ignores other parameters", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Search using the account owner ID", "type": "text/plain" }, "key": "owner_id", "value": "" }, { "disabled": false, "description": { "content": "Search across account label, alias, and num_cta. If the value is an integer, also matches the account ID exactly.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "f08bb84c-e4e0-4034-bc5c-8b8fd24107a3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Search using the account ID; ignores other parameters", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Search using the account owner ID", "type": "text/plain" }, "key": "owner_id", "value": "" }, { "disabled": false, "description": { "content": "Search across account label, alias, and num_cta. If the value is an integer, also matches the account ID exactly.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"bank\": \"\",\n \"currency\": \"USD\",\n \"country\": \"US\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"idempotency_key\": \"\",\n \"company_id\": \"\",\n \"account_number\": \"\",\n \"enabled\": true,\n \"account_type\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\",\n \"funding_instructions\": {\n \"type\": \"fiat\",\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"bank_code\": \"\",\n \"br_code\": \"\",\n \"breb_key\": \"\",\n \"ted_brl\": {\n \"bank_code\": \"\",\n \"branch_number\": \"\",\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_document\": \"\"\n },\n \"pix_key_brl\": {\n \"pix_key\": \"\"\n },\n \"br_code_brl\": {\n \"br_code\": \"\"\n },\n \"fps_gbp\": {\n \"account_number\": \"\",\n \"sort_code\": \"\",\n \"account_holder_name\": \"\"\n },\n \"iban\": \"\",\n \"bic\": \"\"\n },\n \"balance_details\": {\n \"total\": \"\",\n \"available\": \"\",\n \"last_update\": \"\"\n },\n \"is_virtual_account\": false,\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"owner_id\": \"\"\n },\n {\n \"id\": \"\",\n \"bank\": \"\",\n \"currency\": \"BRL\",\n \"country\": \"UY\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"idempotency_key\": \"\",\n \"company_id\": \"\",\n \"account_number\": \"\",\n \"enabled\": true,\n \"account_type\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\",\n \"funding_instructions\": {\n \"type\": \"fiat\",\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"bank_code\": \"\",\n \"br_code\": \"\",\n \"breb_key\": \"\",\n \"ted_brl\": {\n \"bank_code\": \"\",\n \"branch_number\": \"\",\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_document\": \"\"\n },\n \"pix_key_brl\": {\n \"pix_key\": \"\"\n },\n \"br_code_brl\": {\n \"br_code\": \"\"\n },\n \"fps_gbp\": {\n \"account_number\": \"\",\n \"sort_code\": \"\",\n \"account_holder_name\": \"\"\n },\n \"iban\": \"\",\n \"bic\": \"\"\n },\n \"balance_details\": {\n \"total\": \"\",\n \"available\": \"\",\n \"last_update\": \"\"\n },\n \"is_virtual_account\": false,\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"owner_id\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2bea87c-9db2-4edb-9982-54483619a0be", "name": "Bad Request", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Search using the account ID; ignores other parameters", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Search using the account owner ID", "type": "text/plain" }, "key": "owner_id", "value": "" }, { "disabled": false, "description": { "content": "Search across account label, alias, and num_cta. If the value is an integer, also matches the account ID exactly.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb826eff-8315-4e90-852e-75373c48bb06", "name": "Validation Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Search using the account ID; ignores other parameters", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Search using the account owner ID", "type": "text/plain" }, "key": "owner_id", "value": "" }, { "disabled": false, "description": { "content": "Search across account label, alias, and num_cta. If the value is an integer, also matches the account ID exactly.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e140c573-6b9a-4900-8ba5-421993c9d6e0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Search using the account ID; ignores other parameters", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Search using the account owner ID", "type": "text/plain" }, "key": "owner_id", "value": "" }, { "disabled": false, "description": { "content": "Search across account label, alias, and num_cta. If the value is an integer, also matches the account ID exactly.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d38b201c-0606-4d13-8b59-8556482b9fac", "name": "Get Account Details", "request": { "name": "Get Account Details", "description": { "content": "Retrieve details of an account.", "type": "text/plain" }, "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "8f7ebcca-ae0b-4cc6-a42b-aa23851f0bb7", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"bank\": \"\",\n \"currency\": \"SGD\",\n \"country\": \"BR\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"idempotency_key\": \"\",\n \"company_id\": \"\",\n \"account_number\": \"\",\n \"enabled\": true,\n \"account_type\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\",\n \"funding_instructions\": {\n \"type\": \"fiat\",\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"bank_code\": \"\",\n \"br_code\": \"\",\n \"breb_key\": \"\",\n \"ted_brl\": {\n \"bank_code\": \"\",\n \"branch_number\": \"\",\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_document\": \"\"\n },\n \"pix_key_brl\": {\n \"pix_key\": \"\"\n },\n \"br_code_brl\": {\n \"br_code\": \"\"\n },\n \"fps_gbp\": {\n \"account_number\": \"\",\n \"sort_code\": \"\",\n \"account_holder_name\": \"\"\n },\n \"iban\": \"\",\n \"bic\": \"\"\n },\n \"balance_details\": {\n \"total\": \"\",\n \"available\": \"\",\n \"last_update\": \"\"\n },\n \"is_virtual_account\": false,\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"owner_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a67d708-dad9-455e-9f24-c45a4f428e96", "name": "Forbidden", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ec77e2-ed6f-4318-a99a-251582bc3f8f", "name": "Validation Error", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d290a074-356d-4c0b-9fc8-3b509f035798", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7150440a-43ac-4e32-b501-1599e4f7d1eb", "name": "Update Account", "request": { "name": "Update Account", "description": { "content": "Partially update an existing account. \n\nOnly the fields provided in the request body will be modified; all other fields will remain unchanged.", "type": "text/plain" }, "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"PAYINS\"\n ],\n \"webhook_url\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "4d8292f7-8933-40b4-81c6-30a2ca4f0976", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"PAYINS\"\n ],\n \"webhook_url\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"bank\": \"\",\n \"currency\": \"SGD\",\n \"country\": \"BR\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"idempotency_key\": \"\",\n \"company_id\": \"\",\n \"account_number\": \"\",\n \"enabled\": true,\n \"account_type\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\",\n \"funding_instructions\": {\n \"type\": \"fiat\",\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"bank_code\": \"\",\n \"br_code\": \"\",\n \"breb_key\": \"\",\n \"ted_brl\": {\n \"bank_code\": \"\",\n \"branch_number\": \"\",\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_document\": \"\"\n },\n \"pix_key_brl\": {\n \"pix_key\": \"\"\n },\n \"br_code_brl\": {\n \"br_code\": \"\"\n },\n \"fps_gbp\": {\n \"account_number\": \"\",\n \"sort_code\": \"\",\n \"account_holder_name\": \"\"\n },\n \"iban\": \"\",\n \"bic\": \"\"\n },\n \"balance_details\": {\n \"total\": \"\",\n \"available\": \"\",\n \"last_update\": \"\"\n },\n \"is_virtual_account\": false,\n \"webhook_url\": \"\",\n \"status_callback_url\": \"\",\n \"owner_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e07fec2-67e1-48f6-a0cc-36daf3ee551d", "name": "Bad Request", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"PAYINS\"\n ],\n \"webhook_url\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbd5d8a9-12c0-47e3-beeb-bf75d9463a95", "name": "Not Found", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"PAYINS\"\n ],\n \"webhook_url\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f7abb8-c680-4e67-ae6b-e073303704ae", "name": "Validation Error", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"PAYINS\"\n ],\n \"webhook_url\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a02efa7a-d6e9-42b0-84de-25393367aaab", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ ":account_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"products\": [\n \"PAYOUTS\",\n \"PAYINS\"\n ],\n \"webhook_url\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6917fa06-bb92-41ba-94ca-e6d334869f13", "name": "Get Account Limits & Usage", "request": { "name": "Get Account Limits & Usage", "description": { "content": "Returns the current monthly volume used and configured limit for the account.", "type": "text/plain" }, "url": { "path": [ ":account_id", "limits", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "b798d9d4-bf4e-453d-a104-dd1f733f6182", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":account_id", "limits", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"monthly\": {\n \"used\": \"\",\n \"resets_at\": \"\",\n \"limit\": \"\",\n \"remaining\": \"\"\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab503fa5-6460-4ff3-9aa8-0e31c3bc9447", "name": "Forbidden", "originalRequest": { "url": { "path": [ ":account_id", "limits", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d96cef53-8228-41d6-8b4b-aaf97c9fe610", "name": "Not Found", "originalRequest": { "url": { "path": [ ":account_id", "limits", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edc9392b-bed4-417a-8449-e572cb5437a7", "name": "Validation Error", "originalRequest": { "url": { "path": [ ":account_id", "limits", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e42148b1-550d-4f4c-aa4f-5c4b00ee5a39", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ ":account_id", "limits", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "account_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab9e9089-3b80-48a5-b35a-98f2513568d5", "name": "List Account Movements", "request": { "name": "List Account Movements", "description": { "content": "Retrieves a paginated list of debit/credit movements.", "type": "text/plain" }, "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If provided, only return movements for this specific account ID.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include movements from accounts owned by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "3670-76-29T56:58:21" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "9390-67-92T61:89:34+18:33" }, { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of movements to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If provided, only return the movement with this ID.", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, filter movements by this company ID.", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type. (This can only be one of PAYOUT,PAYOUT_REFUND,INTERNAL_TRANSFER,INTERNAL_TRANSFER_REFUND,PAYIN,PAYIN_REFUND,PAYIN_REFUND_BOUNCE,CREDIT,CREDIT_REFUND,CREDIT_REFUND_BOUNCE,DEBIT,FEE,TAX,ORDER_FUNDING,ORDER_DELIVERY,ORDER_RECOVERY,EXCHANGE_OUT,EXCHANGE_IN)", "type": "text/plain" }, "key": "operation_type", "value": "PAYIN_REFUND_BOUNCE" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this voucher ID.", "type": "text/plain" }, "key": "voucher_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of BRL,BRLA,MXN,ARS,COP,CLP,BOB,PYG,SGD,PEN,EUR,GBP,USD,USDT,USDC,UYU,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,BRLA_ETH,BRLA_POL,BRLA_BASE,TGBP_ETH,TGBP_POL,TGBP_BASE)", "type": "text/plain" }, "key": "currency", "value": "EURC_BASE" }, { "disabled": false, "description": { "content": " (This can only be one of BR,AR,CO,CL,BO,PY,SG,PE,MX,UY,US,EU,XX,GB)", "type": "text/plain" }, "key": "country", "value": "CL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "874ca26f-1e9f-41f6-980d-d5cc569d5388", "name": "Successful Response", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If provided, only return movements for this specific account ID.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include movements from accounts owned by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "3670-76-29T56:58:21" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "9390-67-92T61:89:34+18:33" }, { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of movements to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If provided, only return the movement with this ID.", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, filter movements by this company ID.", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type. (This can only be one of PAYOUT,PAYOUT_REFUND,INTERNAL_TRANSFER,INTERNAL_TRANSFER_REFUND,PAYIN,PAYIN_REFUND,PAYIN_REFUND_BOUNCE,CREDIT,CREDIT_REFUND,CREDIT_REFUND_BOUNCE,DEBIT,FEE,TAX,ORDER_FUNDING,ORDER_DELIVERY,ORDER_RECOVERY,EXCHANGE_OUT,EXCHANGE_IN)", "type": "text/plain" }, "key": "operation_type", "value": "PAYIN_REFUND_BOUNCE" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this voucher ID.", "type": "text/plain" }, "key": "voucher_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of BRL,BRLA,MXN,ARS,COP,CLP,BOB,PYG,SGD,PEN,EUR,GBP,USD,USDT,USDC,UYU,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,BRLA_ETH,BRLA_POL,BRLA_BASE,TGBP_ETH,TGBP_POL,TGBP_BASE)", "type": "text/plain" }, "key": "currency", "value": "EURC_BASE" }, { "disabled": false, "description": { "content": " (This can only be one of BR,AR,CO,CL,BO,PY,SG,PE,MX,UY,US,EU,XX,GB)", "type": "text/plain" }, "key": "country", "value": "CL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"company_id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"balance\": \"\",\n \"description\": \"\",\n \"updated_at\": \"\",\n \"third_party\": {\n \"type\": \"FIAT\",\n \"voucher_id\": \"\",\n \"source_reference\": \"\",\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\",\n \"full_name\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\"\n },\n \"operation\": {\n \"type\": \"INTERNAL_TRANSFER_REFUND\",\n \"operation_id\": \"\",\n \"product\": \"PAYOUTS\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"claim_id\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"company_id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"balance\": \"\",\n \"description\": \"\",\n \"updated_at\": \"\",\n \"third_party\": {\n \"type\": \"FIAT\",\n \"voucher_id\": \"\",\n \"source_reference\": \"\",\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\",\n \"full_name\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\"\n },\n \"operation\": {\n \"type\": \"ORDER_FUNDING\",\n \"operation_id\": \"\",\n \"product\": \"INTERNAL_TRANSFER\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"claim_id\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea3cca0a-30a9-4f48-a12d-a4e171d9164c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If provided, only return movements for this specific account ID.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include movements from accounts owned by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "3670-76-29T56:58:21" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "9390-67-92T61:89:34+18:33" }, { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of movements to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If provided, only return the movement with this ID.", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, filter movements by this company ID.", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type. (This can only be one of PAYOUT,PAYOUT_REFUND,INTERNAL_TRANSFER,INTERNAL_TRANSFER_REFUND,PAYIN,PAYIN_REFUND,PAYIN_REFUND_BOUNCE,CREDIT,CREDIT_REFUND,CREDIT_REFUND_BOUNCE,DEBIT,FEE,TAX,ORDER_FUNDING,ORDER_DELIVERY,ORDER_RECOVERY,EXCHANGE_OUT,EXCHANGE_IN)", "type": "text/plain" }, "key": "operation_type", "value": "PAYIN_REFUND_BOUNCE" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this voucher ID.", "type": "text/plain" }, "key": "voucher_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of BRL,BRLA,MXN,ARS,COP,CLP,BOB,PYG,SGD,PEN,EUR,GBP,USD,USDT,USDC,UYU,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,BRLA_ETH,BRLA_POL,BRLA_BASE,TGBP_ETH,TGBP_POL,TGBP_BASE)", "type": "text/plain" }, "key": "currency", "value": "EURC_BASE" }, { "disabled": false, "description": { "content": " (This can only be one of BR,AR,CO,CL,BO,PY,SG,PE,MX,UY,US,EU,XX,GB)", "type": "text/plain" }, "key": "country", "value": "CL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cdc18ab-d51b-4bb9-b588-e94df0221910", "name": "Validation Error", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If provided, only return movements for this specific account ID.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include movements from accounts owned by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "3670-76-29T56:58:21" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "9390-67-92T61:89:34+18:33" }, { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of movements to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If provided, only return the movement with this ID.", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, filter movements by this company ID.", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type. (This can only be one of PAYOUT,PAYOUT_REFUND,INTERNAL_TRANSFER,INTERNAL_TRANSFER_REFUND,PAYIN,PAYIN_REFUND,PAYIN_REFUND_BOUNCE,CREDIT,CREDIT_REFUND,CREDIT_REFUND_BOUNCE,DEBIT,FEE,TAX,ORDER_FUNDING,ORDER_DELIVERY,ORDER_RECOVERY,EXCHANGE_OUT,EXCHANGE_IN)", "type": "text/plain" }, "key": "operation_type", "value": "PAYIN_REFUND_BOUNCE" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this voucher ID.", "type": "text/plain" }, "key": "voucher_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of BRL,BRLA,MXN,ARS,COP,CLP,BOB,PYG,SGD,PEN,EUR,GBP,USD,USDT,USDC,UYU,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,BRLA_ETH,BRLA_POL,BRLA_BASE,TGBP_ETH,TGBP_POL,TGBP_BASE)", "type": "text/plain" }, "key": "currency", "value": "EURC_BASE" }, { "disabled": false, "description": { "content": " (This can only be one of BR,AR,CO,CL,BO,PY,SG,PE,MX,UY,US,EU,XX,GB)", "type": "text/plain" }, "key": "country", "value": "CL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40e588a2-a853-4f45-8295-2a7051bcda7c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If provided, only return movements for this specific account ID.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include movements from accounts owned by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "3670-76-29T56:58:21" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "9390-67-92T61:89:34+18:33" }, { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of movements to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If provided, only return the movement with this ID.", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, filter movements by this company ID.", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type. (This can only be one of PAYOUT,PAYOUT_REFUND,INTERNAL_TRANSFER,INTERNAL_TRANSFER_REFUND,PAYIN,PAYIN_REFUND,PAYIN_REFUND_BOUNCE,CREDIT,CREDIT_REFUND,CREDIT_REFUND_BOUNCE,DEBIT,FEE,TAX,ORDER_FUNDING,ORDER_DELIVERY,ORDER_RECOVERY,EXCHANGE_OUT,EXCHANGE_IN)", "type": "text/plain" }, "key": "operation_type", "value": "PAYIN_REFUND_BOUNCE" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this voucher ID.", "type": "text/plain" }, "key": "voucher_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of BRL,BRLA,MXN,ARS,COP,CLP,BOB,PYG,SGD,PEN,EUR,GBP,USD,USDT,USDC,UYU,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,BRLA_ETH,BRLA_POL,BRLA_BASE,TGBP_ETH,TGBP_POL,TGBP_BASE)", "type": "text/plain" }, "key": "currency", "value": "EURC_BASE" }, { "disabled": false, "description": { "content": " (This can only be one of BR,AR,CO,CL,BO,PY,SG,PE,MX,UY,US,EU,XX,GB)", "type": "text/plain" }, "key": "country", "value": "CL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24bb1647-830d-4c97-a8af-256f1dbb06b9", "name": "[Sandbox] Create Deposit", "request": { "name": "[Sandbox] Create Deposit", "description": { "content": "Create a deposit. \nThis endpoint is only for testing purposes and works only in the sandbox environment.", "type": "text/plain" }, "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account_id\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "37f378cf-444d-4d58-a075-18bf76b2674e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account_id\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"account_id\": \"\",\n \"company_id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"balance\": \"\",\n \"description\": \"\",\n \"updated_at\": \"\",\n \"third_party\": {\n \"type\": \"FIAT\",\n \"voucher_id\": \"\",\n \"source_reference\": \"\",\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\",\n \"full_name\": \"\",\n \"document_number\": \"\",\n \"document_type\": \"\"\n },\n \"operation\": {\n \"type\": \"EXCHANGE_OUT\",\n \"operation_id\": \"\",\n \"product\": \"INTERNAL_TRANSFER\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"claim_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a58c21c-418f-4d86-a523-119b60b0ecf7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account_id\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dedcc5e8-4d78-4eb1-95af-92e864aebdab", "name": "Validation Error", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account_id\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df1b1b69-717a-4b83-bc1f-79084351fc55", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "movements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account_id\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "962d1c68-bb07-4cca-a379-2a947b285742", "name": "Refund Deposit", "request": { "name": "Refund Deposit", "description": { "content": "Create a refund for a deposit. Only deposit movements with `operation_type = CREDIT` are eligible. \n\nA refund may still fail after being initially marked as `SUCCESS`; in such cases, you'll receive a callback with `status = FAILED`. \n\nTo simulate a failed refund in the sandbox, create a deposit with `amount = 101` (see the `Create Deposit` endpoint for details).\n\nTo refund a Payin, use the `Create Refund` endpoint from Payins.", "type": "text/plain" }, "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"movement_id\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "376fcffa-3761-4498-9358-bad39e493fa0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"movement_id\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"FAILED\",\n \"movement_id\": \"\",\n \"updated_at\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"debit_movement_id\": \"\",\n \"bounce_movement_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"voucher_id\": \"\",\n \"failure_reason\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81eb3e9e-b8e3-4ace-9a74-6852ec1de87f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"movement_id\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cbbf3c3-58a2-47fe-9804-af76bcc27a9d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"movement_id\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18f78178-b735-4cb9-b07b-1c655cc4d698", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"movement_id\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5a1a3d6-86c0-4c7d-b85b-d27e19a7afab", "name": "List Deposit Refunds", "request": { "name": "List Deposit Refunds", "description": { "content": "Retrieve a list of deposit refunds.", "type": "text/plain" }, "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_size", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "c45d2893-b513-4232-b715-4801c6e335c3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_size", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"PENDING\",\n \"movement_id\": \"\",\n \"updated_at\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"debit_movement_id\": \"\",\n \"bounce_movement_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"voucher_id\": \"\",\n \"failure_reason\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"SUCCESS\",\n \"movement_id\": \"\",\n \"updated_at\": \"\",\n \"idempotency_key\": \"\",\n \"description\": \"\",\n \"debit_movement_id\": \"\",\n \"bounce_movement_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"voucher_id\": \"\",\n \"failure_reason\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5697ce2-d2aa-43ed-aba3-b3ebaf3df80a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_size", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "735fe948-af6b-4fdb-b20b-0e6a1b50273e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_size", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0467f9e9-c923-488d-9841-69002469779e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "movements", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_size", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "movement_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "FX Quotes", "description": "", "item": [ { "id": "2d5d1c93-33b1-4534-8dab-9db2baba6822", "name": "List Quotes", "request": { "name": "List Quotes", "description": { "content": "Retrieve a list of quote requests.", "type": "text/plain" }, "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of quotes to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include quotes created on or after this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include quotes created on or before this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include quotes initiated by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "9eb0cde6-5c9b-47ce-bc29-d6ba839a2fcc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of quotes to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include quotes created on or after this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include quotes created on or before this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include quotes initiated by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"source_amount\": \"\",\n \"status\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"external_id\": \"\",\n \"target_amount\": \"\",\n \"failure_reason\": \"\",\n \"rate\": \"\",\n \"expire_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"callback_url\": \"\"\n },\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"source_amount\": \"\",\n \"status\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"external_id\": \"\",\n \"target_amount\": \"\",\n \"failure_reason\": \"\",\n \"rate\": \"\",\n \"expire_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"callback_url\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdbac09c-96ef-491a-be3f-8fbd4ede7a99", "name": "Forbidden", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of quotes to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include quotes created on or after this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include quotes created on or before this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include quotes initiated by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b49476c7-e3b4-44a7-99b8-90c2f43a2bce", "name": "Validation Error", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of quotes to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include quotes created on or after this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include quotes created on or before this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include quotes initiated by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19141c4f-ff88-4388-bff0-850ce0662593", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of quotes to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include quotes created on or after this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include quotes created on or before this timestamp. Must be an ISO 8601 datetime in UTC (applied to the `createdAt` field).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include quotes initiated by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef1f5537-5a83-4748-8ab4-57f990c8702e", "name": "Get FX Quote Details for Internal Transfer", "request": { "name": "Get FX Quote Details for Internal Transfer", "description": { "content": "Retrieve the details of a requested quote.", "type": "text/plain" }, "url": { "path": [ "internal-transfer", "quote", ":quote_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "quote_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "960ef26f-7014-4a39-9224-6bc5a90b69fa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", ":quote_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "quote_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"source_amount\": \"\",\n \"status\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"external_id\": \"\",\n \"target_amount\": \"\",\n \"failure_reason\": \"\",\n \"rate\": \"\",\n \"expire_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"callback_url\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84dae2ca-c3b3-4133-9f8b-6cd737603e88", "name": "Forbidden", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", ":quote_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "quote_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18f8243f-8802-4fb1-a877-c0f135ddeaba", "name": "Validation Error", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", ":quote_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "quote_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "043c4a5c-f2a7-44d1-b1b3-4d6746b38ae0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", ":quote_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "quote_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Internal Transfers", "description": "", "item": [ { "id": "e65d0954-94a4-4f04-b433-4cfa2604a62f", "name": "Request FX Quote for Internal Transfer", "request": { "name": "Request FX Quote for Internal Transfer", "description": { "content": "Create a quote for an internal transfer between different currencies. \n\nThe quote will be valid for a limited time. \n\nYou can then use the quote ID to execute the internal transfer.", "type": "text/plain" }, "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"external_id\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"requested_lock_time\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "5a397ed6-9dda-400e-bbd5-bf771fac121a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"external_id\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"requested_lock_time\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"source_amount\": \"\",\n \"status\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"external_id\": \"\",\n \"target_amount\": \"\",\n \"failure_reason\": \"\",\n \"rate\": \"\",\n \"expire_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"callback_url\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39693f95-e18e-4536-835c-5ce22c94eaeb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"external_id\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"requested_lock_time\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f27d0172-736e-4755-aa56-88b4039b72b0", "name": "Validation Error", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"external_id\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"requested_lock_time\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7cf7766-8a0c-4f12-808f-fe4f6f00aa78", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "internal-transfer", "quote", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"external_id\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"requested_lock_time\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df861cee-d583-4a22-a1f0-9763ef629880", "name": "List Internal Transfers", "request": { "name": "List Internal Transfers", "description": { "content": "Retrieves a list of internal transfers.", "type": "text/plain" }, "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of transfers to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include transfers created on or after this timestamp. Must be ISO 8601 (UTC).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include transfers created on or before this timestamp. Must be ISO 8601 (UTC).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also return transfers belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Source account currency", "type": "text/plain" }, "key": "source_currency", "value": "" }, { "disabled": false, "description": { "content": "Target account currency", "type": "text/plain" }, "key": "target_currency", "value": "" }, { "disabled": false, "description": { "content": "Filter by transfer status (PENDING, PROCESSING, SETTLING, COMPLETED, FAILED). (This can only be one of PENDING,PROCESSING,SETTLING,COMPLETED,FAILED)", "type": "text/plain" }, "key": "status", "value": "PROCESSING" }, { "disabled": false, "description": { "content": "Idempotency key.", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Internal tranfer ID. If passed it will ignore the rest of theparameters, except for 'include_child_companies'.", "type": "text/plain" }, "key": "internal_transfer_id", "value": "" }, { "disabled": false, "description": { "content": "Source account ID.", "type": "text/plain" }, "key": "source_account_id", "value": "" }, { "disabled": false, "description": { "content": "Target account ID.", "type": "text/plain" }, "key": "target_account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "7519e7db-52fb-4322-84ad-4632cf28ca6a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of transfers to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include transfers created on or after this timestamp. Must be ISO 8601 (UTC).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include transfers created on or before this timestamp. Must be ISO 8601 (UTC).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also return transfers belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Source account currency", "type": "text/plain" }, "key": "source_currency", "value": "" }, { "disabled": false, "description": { "content": "Target account currency", "type": "text/plain" }, "key": "target_currency", "value": "" }, { "disabled": false, "description": { "content": "Filter by transfer status (PENDING, PROCESSING, SETTLING, COMPLETED, FAILED). (This can only be one of PENDING,PROCESSING,SETTLING,COMPLETED,FAILED)", "type": "text/plain" }, "key": "status", "value": "PROCESSING" }, { "disabled": false, "description": { "content": "Idempotency key.", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Internal tranfer ID. If passed it will ignore the rest of theparameters, except for 'include_child_companies'.", "type": "text/plain" }, "key": "internal_transfer_id", "value": "" }, { "disabled": false, "description": { "content": "Source account ID.", "type": "text/plain" }, "key": "source_account_id", "value": "" }, { "disabled": false, "description": { "content": "Target account ID.", "type": "text/plain" }, "key": "target_account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"status\": \"PENDING\",\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"idempotency_key\": \"\",\n \"quote_id\": \"\",\n \"rate\": \"\",\n \"source_amount\": \"\",\n \"destination_amount\": \"\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"voucher_ids\": [\n \"\",\n \"\"\n ],\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"status\": \"PROCESSING\",\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"idempotency_key\": \"\",\n \"quote_id\": \"\",\n \"rate\": \"\",\n \"source_amount\": \"\",\n \"destination_amount\": \"\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"voucher_ids\": [\n \"\",\n \"\"\n ],\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "740d2ff7-cbf0-4331-aa9f-f3ffac512497", "name": "Validation Error", "originalRequest": { "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Results start from page 1 by default.", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of transfers to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "Only include transfers created on or after this timestamp. Must be ISO 8601 (UTC).", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include transfers created on or before this timestamp. Must be ISO 8601 (UTC).", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also return transfers belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Source account currency", "type": "text/plain" }, "key": "source_currency", "value": "" }, { "disabled": false, "description": { "content": "Target account currency", "type": "text/plain" }, "key": "target_currency", "value": "" }, { "disabled": false, "description": { "content": "Filter by transfer status (PENDING, PROCESSING, SETTLING, COMPLETED, FAILED). (This can only be one of PENDING,PROCESSING,SETTLING,COMPLETED,FAILED)", "type": "text/plain" }, "key": "status", "value": "PROCESSING" }, { "disabled": false, "description": { "content": "Idempotency key.", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Internal tranfer ID. If passed it will ignore the rest of theparameters, except for 'include_child_companies'.", "type": "text/plain" }, "key": "internal_transfer_id", "value": "" }, { "disabled": false, "description": { "content": "Source account ID.", "type": "text/plain" }, "key": "source_account_id", "value": "" }, { "disabled": false, "description": { "content": "Target account ID.", "type": "text/plain" }, "key": "target_account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e19afc8e-47a4-4e19-93a1-e2ac1814ab9c", "name": "Make Internal Transfer", "request": { "name": "Make Internal Transfer", "description": { "content": "Make an internal transfer between accounts of the same family of companies. An internal transfer can have the following statuses:\n\n* PENDING: The transfer has been created.\n* PROCESSING: The transfer has started to be processed and funds have been debited.\n* SETTLING: The transfer is being settled.\n* COMPLETED: The funds have been sent to the destination account (but not necessarily received yet).\n* FAILED: The transfer failed.\n\n### Testing in sandbox\n\nIn the sandbox, transfer the magic amount `302` to get a transfer that is accepted, debits the source\naccount and then fails, refunding it and notifying the `callback_url`, or `303` to get one that fails in\nthis endpoint's response. Any other amount follows the normal (successful) flow.", "type": "text/plain" }, "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"idempotency_key\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"quote_id\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "7dc34856-dc33-4fbd-8295-1930edc6a5d2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"idempotency_key\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"quote_id\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"status\": \"PENDING\",\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"idempotency_key\": \"\",\n \"quote_id\": \"\",\n \"rate\": \"\",\n \"source_amount\": \"\",\n \"destination_amount\": \"\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"voucher_ids\": [\n \"\",\n \"\"\n ],\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef6392e6-5399-4e76-a55b-125ef064c1c2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"idempotency_key\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"quote_id\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f0aeb36-6df3-49c1-88d6-07fdf29eecca", "name": "Validation Error", "originalRequest": { "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"idempotency_key\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"quote_id\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b95b027b-237d-46b8-b885-bd33ad7f749b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "internal-transfer", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"idempotency_key\": \"\",\n \"source_amount\": \"\",\n \"target_amount\": \"\",\n \"quote_id\": \"\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9938d4d-86c1-4caa-9856-d5a2b67f02c3", "name": "Get Internal Transfer Details", "request": { "name": "Get Internal Transfer Details", "description": { "content": "Retrieve details of an internal transfer.", "type": "text/plain" }, "url": { "path": [ "internal-transfer", ":transfer_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transfer_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "0320ea9f-26f7-49b8-b163-6fb7dd9bcae8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "internal-transfer", ":transfer_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "transfer_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"source_account_id\": \"\",\n \"target_account_id\": \"\",\n \"status\": \"PENDING\",\n \"source_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"idempotency_key\": \"\",\n \"quote_id\": \"\",\n \"rate\": \"\",\n \"source_amount\": \"\",\n \"destination_amount\": \"\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"voucher_ids\": [\n \"\",\n \"\"\n ],\n \"target_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ed2fde-7724-4357-a4f2-8c17a77d18e2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "internal-transfer", ":transfer_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "transfer_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "982b9184-401b-40b1-bb88-bb69dfb29eb6", "name": "Validation Error", "originalRequest": { "url": { "path": [ "internal-transfer", ":transfer_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "transfer_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "772ca92f-6675-459e-9511-3803d9ce3b5e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "internal-transfer", ":transfer_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "transfer_id" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Owners", "description": "", "item": [ { "id": "d6aa8ad0-c5ce-4111-b3ee-fa9113073609", "name": "Create Account Owner", "request": { "name": "Create Account Owner", "description": { "content": "Create a new account owner for KYC purposes.", "type": "text/plain" }, "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"ORGANIZATION\",\n \"kyc_mode\": \"EXTERNAL\",\n \"idempotency_key\": \"\",\n \"callback_url\": \"\",\n \"external\": {\n \"sumsub_share_token\": \"\"\n },\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "b6bbf05f-3295-4abb-b690-058e682220f1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"ORGANIZATION\",\n \"kyc_mode\": \"EXTERNAL\",\n \"idempotency_key\": \"\",\n \"callback_url\": \"\",\n \"external\": {\n \"sumsub_share_token\": \"\"\n },\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"INDIVIDUAL\",\n \"kyc_mode\": \"EXTERNAL\",\n \"status\": \"COMPLETED\",\n \"level\": \"ENHANCED\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"hosted\": {\n \"verification_url\": \"\",\n \"verification_url_expires_at\": \"\"\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"SUPERSEDED\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"CURRENT\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n }\n ],\n \"change_log\": [\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n },\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n }\n ],\n \"versions\": [\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 7439.462929630734\n },\n \"organization\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 7466,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": 5416.9695217009385,\n \"key_1\": true,\n \"key_2\": 4947\n }\n }\n ]\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99b84161-9067-4a56-a540-1c67f0779201", "name": "Bad Request", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"ORGANIZATION\",\n \"kyc_mode\": \"EXTERNAL\",\n \"idempotency_key\": \"\",\n \"callback_url\": \"\",\n \"external\": {\n \"sumsub_share_token\": \"\"\n },\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f1b64f7-f2b2-4028-99df-02e8eb1754d6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"ORGANIZATION\",\n \"kyc_mode\": \"EXTERNAL\",\n \"idempotency_key\": \"\",\n \"callback_url\": \"\",\n \"external\": {\n \"sumsub_share_token\": \"\"\n },\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539e1d57-0283-4dcd-a6e6-24ca714c33c9", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"ORGANIZATION\",\n \"kyc_mode\": \"EXTERNAL\",\n \"idempotency_key\": \"\",\n \"callback_url\": \"\",\n \"external\": {\n \"sumsub_share_token\": \"\"\n },\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5908394-fe2e-4bd1-9599-5106947bb8c8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"ORGANIZATION\",\n \"kyc_mode\": \"EXTERNAL\",\n \"idempotency_key\": \"\",\n \"callback_url\": \"\",\n \"external\": {\n \"sumsub_share_token\": \"\"\n },\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e848958-ff21-447b-af7f-6b78764b291c", "name": "List Account Owners", "request": { "name": "List Account Owners", "description": { "content": "Retrieves a paginated list of account owners with optional filters.", "type": "text/plain" }, "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ID", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Tax ID", "type": "text/plain" }, "key": "tax_id", "value": "" }, { "disabled": false, "description": { "content": "Search in both tax_id and additional_tax_id", "type": "text/plain" }, "key": "combined_tax_id", "value": "" }, { "disabled": false, "description": { "content": "Page index (1-based). Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of results per page. Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If true, include account owners from child companies. Default: false", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Filter by idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Filter by account ID. Returns the owner linked to that account.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "89120cd8-d005-4bd7-8e32-a7b640eb4cea", "name": "Successful Response", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ID", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Tax ID", "type": "text/plain" }, "key": "tax_id", "value": "" }, { "disabled": false, "description": { "content": "Search in both tax_id and additional_tax_id", "type": "text/plain" }, "key": "combined_tax_id", "value": "" }, { "disabled": false, "description": { "content": "Page index (1-based). Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of results per page. Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If true, include account owners from child companies. Default: false", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Filter by idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Filter by account ID. Returns the owner linked to that account.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"INDIVIDUAL\",\n \"kyc_mode\": \"EXTERNAL\",\n \"status\": \"PENDING\",\n \"level\": \"STANDARD\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"hosted\": {\n \"verification_url\": \"\",\n \"verification_url_expires_at\": \"\"\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"SUPERSEDED\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"CURRENT\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n }\n ],\n \"change_log\": [\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n },\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n }\n ],\n \"versions\": [\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 1872.8961067488115,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": 8178,\n \"key_1\": true\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": \"string\",\n \"key_1\": 5358,\n \"key_2\": false\n },\n \"organization\": {\n \"key_0\": 4708,\n \"key_1\": 760,\n \"key_2\": 8578.508726270087,\n \"key_3\": 2135.707159322029\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"ORGANIZATION\",\n \"kyc_mode\": \"SELF_DECLARED\",\n \"status\": \"FAILED\",\n \"level\": \"STANDARD\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"hosted\": {\n \"verification_url\": \"\",\n \"verification_url_expires_at\": \"\"\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"CURRENT\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"SUPERSEDED\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n }\n ],\n \"change_log\": [\n {\n \"action\": \"DOCUMENT_ADDED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n },\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n }\n ],\n \"versions\": [\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 853.5300580596083,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": false\n },\n \"organization\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n }\n ]\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e300045d-b044-4c02-a785-c9c8685bb8a2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ID", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Tax ID", "type": "text/plain" }, "key": "tax_id", "value": "" }, { "disabled": false, "description": { "content": "Search in both tax_id and additional_tax_id", "type": "text/plain" }, "key": "combined_tax_id", "value": "" }, { "disabled": false, "description": { "content": "Page index (1-based). Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of results per page. Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If true, include account owners from child companies. Default: false", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Filter by idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Filter by account ID. Returns the owner linked to that account.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec95c319-d2a6-4df4-bbb1-c58b69d11584", "name": "Forbidden", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ID", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Tax ID", "type": "text/plain" }, "key": "tax_id", "value": "" }, { "disabled": false, "description": { "content": "Search in both tax_id and additional_tax_id", "type": "text/plain" }, "key": "combined_tax_id", "value": "" }, { "disabled": false, "description": { "content": "Page index (1-based). Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of results per page. Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If true, include account owners from child companies. Default: false", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Filter by idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Filter by account ID. Returns the owner linked to that account.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6102449e-8f07-4ca8-a9c3-3854341ced1d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ID", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Tax ID", "type": "text/plain" }, "key": "tax_id", "value": "" }, { "disabled": false, "description": { "content": "Search in both tax_id and additional_tax_id", "type": "text/plain" }, "key": "combined_tax_id", "value": "" }, { "disabled": false, "description": { "content": "Page index (1-based). Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of results per page. Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If true, include account owners from child companies. Default: false", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Filter by idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Filter by account ID. Returns the owner linked to that account.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a8d09a-1130-4f60-a79d-075027b394e7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "owners", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ID", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Name", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Tax ID", "type": "text/plain" }, "key": "tax_id", "value": "" }, { "disabled": false, "description": { "content": "Search in both tax_id and additional_tax_id", "type": "text/plain" }, "key": "combined_tax_id", "value": "" }, { "disabled": false, "description": { "content": "Page index (1-based). Default: 1", "type": "text/plain" }, "key": "page_number", "value": "1" }, { "disabled": false, "description": { "content": "Maximum number of results per page. Default: 50", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "disabled": false, "description": { "content": "If true, include account owners from child companies. Default: false", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Filter by idempotency key", "type": "text/plain" }, "key": "idempotency_key", "value": "" }, { "disabled": false, "description": { "content": "Filter by account ID. Returns the owner linked to that account.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15fc7826-dad7-4463-be4e-7ae6d9f021ce", "name": "Get Account Owner", "request": { "name": "Get Account Owner", "description": { "content": "Retrieves a specific account owner by its UUID.", "type": "text/plain" }, "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "6b2a55eb-5d04-42c2-819b-20bc1f492633", "name": "Successful Response", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"INDIVIDUAL\",\n \"kyc_mode\": \"EXTERNAL\",\n \"status\": \"COMPLETED\",\n \"level\": \"ENHANCED\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"hosted\": {\n \"verification_url\": \"\",\n \"verification_url_expires_at\": \"\"\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"SUPERSEDED\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"CURRENT\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n }\n ],\n \"change_log\": [\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n },\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n }\n ],\n \"versions\": [\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 7439.462929630734\n },\n \"organization\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 7466,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": 5416.9695217009385,\n \"key_1\": true,\n \"key_2\": 4947\n }\n }\n ]\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eef91240-b709-4ff6-8729-9ed5b0994f3a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb42a0a-3114-400b-8fee-f6128367f0ef", "name": "Forbidden", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ba96731-dad8-422b-8937-46dffbc3ab57", "name": "Not Found", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ac08ebf-e6b6-4791-b22d-ea597d799d7e", "name": "Validation Error", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8fe37f8-9a9c-4d72-9d3c-2aa96b332682", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1dd62f6-7223-4b7d-af49-53e2b8cd90b3", "name": "Update Account Owner", "request": { "name": "Update Account Owner", "description": { "content": "Update an existing account owner. Every data field can be updated except tax_id. Documents can be added or replaced: a replaced document is kept and marked superseded, never modified or deleted. Every change is recorded: data snapshots in versions, document changes in change_log.", "type": "text/plain" }, "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"individual\": {\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id_country\": \"\",\n \"additional_tax_id\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\",\n \"ultimate_beneficial_owners\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "e1813bc6-593f-444c-b5c9-1e6b3a07a570", "name": "Successful Response", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"individual\": {\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id_country\": \"\",\n \"additional_tax_id\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\",\n \"ultimate_beneficial_owners\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"INDIVIDUAL\",\n \"kyc_mode\": \"EXTERNAL\",\n \"status\": \"COMPLETED\",\n \"level\": \"ENHANCED\",\n \"failure_reason\": \"\",\n \"callback_url\": \"\",\n \"individual\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n \"hosted\": {\n \"verification_url\": \"\",\n \"verification_url_expires_at\": \"\"\n },\n \"documents\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"SUPERSEDED\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"CURRENT\",\n \"created_at\": \"\",\n \"superseded_at\": \"\",\n \"superseded_by_id\": \"\"\n }\n ],\n \"change_log\": [\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n },\n {\n \"action\": \"DOCUMENT_REPLACED\",\n \"document_type\": \"\",\n \"created_at\": \"\",\n \"previous_document_id\": \"\",\n \"new_document_id\": \"\"\n }\n ],\n \"versions\": [\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 7439.462929630734\n },\n \"organization\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 7466,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": 5416.9695217009385,\n \"key_1\": true,\n \"key_2\": 4947\n }\n }\n ]\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e841db67-8301-44eb-ab81-73665bf8f264", "name": "Bad Request", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"individual\": {\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id_country\": \"\",\n \"additional_tax_id\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\",\n \"ultimate_beneficial_owners\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b22f7a9-f849-47be-aa5c-b970f9acf441", "name": "Forbidden", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"individual\": {\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id_country\": \"\",\n \"additional_tax_id\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\",\n \"ultimate_beneficial_owners\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da1ab5b4-1fb9-4dfb-9620-ea6e7aaa1af4", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"individual\": {\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id_country\": \"\",\n \"additional_tax_id\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\",\n \"ultimate_beneficial_owners\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6698afa3-ea34-4735-8614-f923c79a42c3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "owners", ":uuid", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"individual\": {\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id_country\": \"\",\n \"additional_tax_id\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\"\n },\n \"organization\": {\n \"incorporation_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"ownership_structure_document_id\": \"\",\n \"tax_registration_document_id\": \"\",\n \"corporate_org_chart_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"date_of_incorporation\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"expected_monthly_volume_usd\": \"\",\n \"ultimate_beneficial_owners\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"tax_id\": \"\",\n \"tax_id_country\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"line_2\": \"\"\n },\n \"additional_tax_id\": \"\",\n \"identity_document_id\": \"\",\n \"selfie_document_id\": \"\",\n \"proof_of_address_document_id\": \"\",\n \"source_of_funds_document_id\": \"\",\n \"other_documents\": [\n \"\",\n \"\"\n ],\n \"expected_monthly_volume_usd\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "322607ac-b010-4fb3-8ed3-59e2354047c2", "name": "Initiate Document Upload", "request": { "name": "Initiate Document Upload", "description": { "content": "Generate pre-signed URLs for uploading account owner documents.One of 'individual', 'organization', or 'external' is required depending on 'type' and 'kyc_mode'.", "type": "text/plain" }, "url": { "path": [ "owners", "documents", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"CORPORATE_ORG_CHART\",\n \"double_sided\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "983882e7-edf3-46cd-b05f-8017f5cd07c1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "owners", "documents", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"CORPORATE_ORG_CHART\",\n \"double_sided\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"upload_front_url\": \"\",\n \"upload_back_url\": \"\",\n \"expires_at\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf8e5547-3c2e-4006-b4e4-2aeb04101445", "name": "Bad Request", "originalRequest": { "url": { "path": [ "owners", "documents", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"CORPORATE_ORG_CHART\",\n \"double_sided\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97df9f96-0699-49f3-90b9-18f9a584b791", "name": "Forbidden", "originalRequest": { "url": { "path": [ "owners", "documents", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"CORPORATE_ORG_CHART\",\n \"double_sided\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd440eb6-f2d2-4a7b-a471-394a98a8be35", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "owners", "documents", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"CORPORATE_ORG_CHART\",\n \"double_sided\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a04ce3a-e144-4d05-a779-21b413b56339", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "owners", "documents", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ID of a child company for authentication. If not provided, the parent company will be authenticated.", "type": "text/plain" }, "key": "x-company-id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"CORPORATE_ORG_CHART\",\n \"double_sided\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://app2test.infiniaweb.com/infinia_api/v1/accounts" } ], "info": { "_postman_id": "8f6bf378-e67f-4082-8780-ce668b5175c0", "name": "Accounts", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Manage your virtual accounts and movements", "type": "text/plain" } } }