{ "item": [ { "name": "Accounts", "description": "", "item": [ { "id": "f3aba5e5-9a36-4507-9e42-bfd5b59003c1", "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\": \"EURC_ETH\",\n \"country\": \"MX\",\n \"label\": \"\",\n \"products\": [\n \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "a108fd15-f932-41d1-bd06-059dd55522d0", "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\": \"EURC_ETH\",\n \"country\": \"MX\",\n \"label\": \"\",\n \"products\": [\n \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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\": \"EURC_BASE\",\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": "baea01d8-bdac-4a70-9b17-84e1a7d4283d", "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\": \"EURC_ETH\",\n \"country\": \"MX\",\n \"label\": \"\",\n \"products\": [\n \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "720d2945-81d1-4ae1-b145-1225bddf706e", "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\": \"EURC_ETH\",\n \"country\": \"MX\",\n \"label\": \"\",\n \"products\": [\n \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "d34fc3c5-dff3-4398-a83b-3f6bd9c40429", "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\": \"EURC_ETH\",\n \"country\": \"MX\",\n \"label\": \"\",\n \"products\": [\n \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "6d44f3c6-c47a-4e4a-980d-057b29256431", "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": "b0982a8d-3c98-43a3-b049-f1c6a004ce1f", "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\": \"CLP\",\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 \"id\": \"\",\n \"bank\": \"\",\n \"currency\": \"SGD\",\n \"country\": \"PY\",\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": "380dd166-a3ae-45eb-9fb2-130d9b885fae", "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": "91e550b5-559c-4ac8-b947-2a37786b24c5", "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": "1299b1db-fccc-4237-b301-d5e7298e5679", "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": "b254df54-3cb5-44e6-bc45-ae90aa44eede", "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": "e5338662-8a96-4ddd-bd46-adf635b80ca4", "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\": \"EURC_BASE\",\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": "af4590ee-d6af-4477-8f99-1e85ebaf7265", "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": "70477313-6467-4aaf-8baf-05f3e747c82d", "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": "58e5bccb-e88f-44c8-8cba-bddfe5633dd3", "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": "659f0f45-b93c-46f6-9268-87404a976c07", "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 \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "7634e33a-c56b-4810-b314-214878c9f9f6", "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 \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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\": \"EURC_BASE\",\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": "72978760-9f36-4847-8931-dceb3043b8ca", "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 \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "efc5e5dd-9ce6-473e-9236-14314ff514f9", "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 \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "a53bcede-3424-496a-a235-f17f4f0c82fe", "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 \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "f98b3e36-7fdc-4f92-9eae-7bbf472e3996", "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 \"INTERNAL_TRANSFER\",\n \"PAYOUTS\"\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": "b7f4af65-53e6-4361-883c-a3232e43212a", "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": "9561f63d-5f36-4933-bf18-95455cd82e61", "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": "54bc221b-d602-44ce-af9f-f71b8d8db329", "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": "efd1df6d-0429-4768-8392-9fbd0e367a0b", "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": "1eea4cd9-5476-488a-989c-63aa09a5a46a", "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": "30504900-86ec-4811-864f-378fb05bd7ce", "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": "cba2a588-091f-4ab7-97e0-261d52490985", "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": "4306-46-25T26:49:91" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "0906-45-37T61:14:10" }, { "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)", "type": "text/plain" }, "key": "operation_type", "value": "PAYOUT" }, { "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": "USDT_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": "GB" }, { "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": "6464865b-b088-4802-b88c-e04f19ef0035", "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": "4306-46-25T26:49:91" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "0906-45-37T61:14:10" }, { "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)", "type": "text/plain" }, "key": "operation_type", "value": "PAYOUT" }, { "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": "USDT_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": "GB" }, { "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\": \"FEE\",\n \"operation_id\": \"\",\n \"product\": \"PAYINS\"\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\": \"CREDIT\",\n \"operation_id\": \"\",\n \"product\": \"ACCOUNTS\"\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": "dfd7596e-799f-425f-954c-13b1538a2a52", "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": "4306-46-25T26:49:91" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "0906-45-37T61:14:10" }, { "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)", "type": "text/plain" }, "key": "operation_type", "value": "PAYOUT" }, { "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": "USDT_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": "GB" }, { "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": "32d1de2b-87f0-43e9-a494-ec8a44bc3d10", "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": "4306-46-25T26:49:91" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "0906-45-37T61:14:10" }, { "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)", "type": "text/plain" }, "key": "operation_type", "value": "PAYOUT" }, { "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": "USDT_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": "GB" }, { "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": "3c858bfb-1807-4bb7-b71c-31f1e9a86fb9", "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": "4306-46-25T26:49:91" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "0906-45-37T61:14:10" }, { "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)", "type": "text/plain" }, "key": "operation_type", "value": "PAYOUT" }, { "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": "USDT_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": "GB" }, { "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": "caf6986f-168d-4c76-8503-bcfc9731dc59", "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": "3c5cabd6-88de-479f-93f5-1eb5fd1df050", "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\": \"PAYOUT\",\n \"operation_id\": \"\",\n \"product\": \"ACCOUNTS\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"claim_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d17425ce-469d-42ee-9d73-5142b4ad355b", "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": "e3a0649a-2674-48f6-9107-f998330bda86", "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": "32d9adcb-7a48-4a56-9252-ef82956bc0b1", "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": "d5eb43e1-d758-4418-8096-3647448a35f8", "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": "1a262f74-94b7-4524-a210-73c3f76d610c", "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\": \"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 \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b6cc63b-3b53-4097-a045-f5d15dd7751c", "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": "8cb9c30c-0c59-418b-a80d-038aa9dd549a", "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": "f4b74c0a-e216-4fc4-87d7-1e2c0f16fe86", "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": "ad768ff0-fde1-4333-abcb-50a6437a670d", "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": "cd2c54b4-3610-4891-b994-0e296dcde26d", "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\": \"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 \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc06d92f-eaa9-47c8-85f3-1f15c782a915", "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": "f9687b84-29e3-4ae0-9552-f14b250e91e1", "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": "29063ee8-7ce1-4fa3-9cf8-11376ec3b3f9", "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": "d4593daf-8d33-489c-852c-358087a4f818", "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": "6c9eb8bf-a577-4153-9ff3-0dd3ec783412", "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": "7e103161-51cc-4628-95f8-909e15626cd9", "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": "de00b188-de10-4f1f-921b-43341cd7fb1b", "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": "ca3018d8-c8d7-4a73-8a38-35fac39ac689", "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": "92ae418e-6adf-420f-9c95-43afabc54bd6", "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": "24640c36-3916-496a-aa13-34745dd68c4b", "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": "c0878cd7-9ab2-4738-aa67-fa9c445bf430", "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": "97f6ebd7-4dbb-4a0b-9fbd-0e5d786721be", "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": "e9963070-6a93-4d6d-a53b-a97865bcebba", "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": "b469c506-8909-4421-b97e-41cae8395d4b", "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": "bf50fca9-ea7b-46ab-b765-b2183bd4fe8c", "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": "02f835f9-7652-44c6-b30c-e59b6a1f57e7", "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": "5d00a51d-48ce-4517-9829-65d294069afb", "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": "5fcec6e3-0def-4a84-8d9e-9a3755c05954", "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": "e5ff9ff2-5c41-419b-a6fa-69d5a1f2d38a", "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": "FAILED" }, { "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": "", "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": "151e93e3-744a-4cc0-a0c6-2d4ec5824e7c", "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": "FAILED" }, { "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": "", "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\": \"SETTLING\",\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": "45d68a16-7457-4d20-84e5-1a0b7fe36427", "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": "FAILED" }, { "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": "", "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": "a62ef0d3-86e7-45f8-a7da-fba70f13440f", "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": "f0a25e93-99ed-434e-ac45-1d8b33c1e0dd", "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\": \"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 \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd987b3a-f8fc-4f8c-8f2c-e6c09c3080b1", "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": "e08a0bfa-48d7-47a1-9bbc-5bbbf1674694", "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": "5c84a649-2919-45dd-bf4e-bf2f7b6d1610", "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": "be96925a-e0f3-45bc-ac29-2967ca30d00a", "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": "10283166-ee95-4aa1-99e5-74728c489d66", "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\": \"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 \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebbda219-e445-4d31-8805-2bfd8e529149", "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": "2c59f6b9-856d-4541-b43e-66ae81093ab4", "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": "bf640d11-c5c5-4a80-9b24-6793d59ed867", "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": "6d4f43ad-356a-4771-8557-e27905deaa3a", "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\": \"INDIVIDUAL\",\n \"kyc_mode\": \"SELF_DECLARED\",\n \"idempotency_key\": \"\",\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": "819816b2-4ceb-4df6-baae-417d8ed19c45", "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\": \"INDIVIDUAL\",\n \"kyc_mode\": \"SELF_DECLARED\",\n \"idempotency_key\": \"\",\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\": \"SELF_DECLARED\",\n \"status\": \"COMPLETED\",\n \"level\": \"ENHANCED\",\n \"failure_reason\": \"\",\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\": \"CURRENT\",\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\": false,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 1772.5422218996623,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": false,\n \"key_1\": 1867.9180670827034\n }\n }\n ]\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f18ab1b4-6820-4991-8501-3a0591a4458f", "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\": \"INDIVIDUAL\",\n \"kyc_mode\": \"SELF_DECLARED\",\n \"idempotency_key\": \"\",\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": "bc5c3f4d-87c4-467e-a755-7ad66ced5847", "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\": \"INDIVIDUAL\",\n \"kyc_mode\": \"SELF_DECLARED\",\n \"idempotency_key\": \"\",\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": "8319259d-4f19-43c5-8e73-74b963010180", "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\": \"INDIVIDUAL\",\n \"kyc_mode\": \"SELF_DECLARED\",\n \"idempotency_key\": \"\",\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": "72fced7d-df34-4d85-8874-24783b53c0d0", "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\": \"INDIVIDUAL\",\n \"kyc_mode\": \"SELF_DECLARED\",\n \"idempotency_key\": \"\",\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": "9be3260b-f961-4084-8fea-f00bb0ba175e", "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": "6e9d5291-3577-4aca-8b49-bd520e84e384", "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\": \"ORGANIZATION\",\n \"kyc_mode\": \"HOSTED\",\n \"status\": \"COMPLETED\",\n \"level\": \"BASIC\",\n \"failure_reason\": \"\",\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\": 2286.824625541215\n },\n \"organization\": {\n \"key_0\": 454.7177245159073,\n \"key_1\": 3578.7453286225455\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": true,\n \"key_1\": 1275\n },\n \"organization\": {\n \"key_0\": 3417.761920123974,\n \"key_1\": 8265.811044238137\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"INDIVIDUAL\",\n \"kyc_mode\": \"EXTERNAL\",\n \"status\": \"PENDING\",\n \"level\": \"BASIC\",\n \"failure_reason\": \"\",\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\": \"CURRENT\",\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\": \"string\"\n },\n \"organization\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"organization\": {\n \"key_0\": 4633,\n \"key_1\": 7342.56889911024,\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": "13a321b2-54fa-4c2b-838e-b3c37c9877ba", "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": "74c981d9-7413-4273-aa81-ee0a22c5c210", "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": "53121c74-cfcf-4e8d-b40e-2a635d688904", "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": "ad5aaa2a-5f0f-4fa2-8d3f-545e56b4cae8", "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": "6a0c0779-dc84-4c53-9ea3-c559aea41953", "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": "ad11f752-8be6-45b1-935d-662ccec0dfa7", "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\": \"SELF_DECLARED\",\n \"status\": \"COMPLETED\",\n \"level\": \"ENHANCED\",\n \"failure_reason\": \"\",\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\": \"CURRENT\",\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\": false,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 1772.5422218996623,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": false,\n \"key_1\": 1867.9180670827034\n }\n }\n ]\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b699c7c-5a37-459a-9411-50ad7f62c55c", "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": "4bcacc66-e5e4-4960-83a1-32562c6ab9fd", "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": "3b5c3457-b5db-427f-a35c-8a6a8fdf953e", "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": "52404d58-8fbc-4c03-9b8d-1874ac9fd6bd", "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": "8658b78b-62d0-4f44-91f7-2c7f229c0057", "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": "53624832-6e66-4412-b055-a9b508fb2673", "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": "51db598f-def9-4498-b569-4d36324fb334", "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\": \"SELF_DECLARED\",\n \"status\": \"COMPLETED\",\n \"level\": \"ENHANCED\",\n \"failure_reason\": \"\",\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\": \"CURRENT\",\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\": false,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n {\n \"version\": \"\",\n \"created_at\": \"\",\n \"individual\": {\n \"key_0\": 1772.5422218996623,\n \"key_1\": \"string\"\n },\n \"organization\": {\n \"key_0\": false,\n \"key_1\": 1867.9180670827034\n }\n }\n ]\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdf4f6f8-4bb2-43b2-ae9c-a598a573face", "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": "64bd8491-7bc4-4984-8249-8412808dd65c", "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": "84eae170-2c1a-4ceb-91bc-235cfa5247de", "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": "38ef7091-cdea-4d9c-9738-b5ec1ec9fe15", "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": "7c7e5f32-f9fc-4db1-8d63-4e64d162ebcc", "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\": \"OWNERSHIP_STRUCTURE\",\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": "42f4a52c-3de4-4896-b02d-cf642cfff0ca", "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\": \"OWNERSHIP_STRUCTURE\",\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": "d43fc8bc-12f2-4c21-bf82-b3226635ae92", "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\": \"OWNERSHIP_STRUCTURE\",\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": "ef453b9a-1ae6-4a50-91bf-f11c20813b46", "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\": \"OWNERSHIP_STRUCTURE\",\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": "c0282ac3-5e83-4e89-9072-eece8d33c590", "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\": \"OWNERSHIP_STRUCTURE\",\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": "be7536d5-32e2-44b6-80bb-e04a840d608c", "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\": \"OWNERSHIP_STRUCTURE\",\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": "516fa1e5-981b-410a-8922-d88c90ab8561", "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" } } }