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

If you are interested in any other country kindly reach out to us as we're continuosly expanding our coverage.", "type": "text/plain" }, "url": { "path": [ "v1", "bank-account-validation", "" ], "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 \"country\": \"AR\",\n \"account\": {\n \"dataType\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"callbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "157c3844-e486-49e1-8e59-ae9d52a8ffc7", "name": "The validation request was created successfully.", "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 \"country\": \"AR\",\n \"account\": {\n \"dataType\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"callbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"country\": \"IN\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"inputData\": {\n \"key_0\": \"string\",\n \"key_1\": 7783.305890322658,\n \"key_2\": 4920.545497523974\n },\n \"status\": \"ERROR\",\n \"statusDescription\": \"\",\n \"countryData\": {\n \"account\": {\n \"number\": \"\",\n \"currency\": \"ARS\",\n \"type\": \"CC\"\n },\n \"owners\": [\n {\n \"documentType\": \"DNI\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"LEGAL\"\n },\n {\n \"documentType\": \"CUIT\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"LEGAL\"\n }\n ]\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abacb793-69d5-49a1-8ec9-ab7cec34ce2c", "name": "Unauthorized. The request is missing the required authentication credentials.", "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 \"country\": \"AR\",\n \"account\": {\n \"dataType\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"callbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "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": "fd3d3698-1542-42b0-a11c-47bcf071316f", "name": "Forbidden. The endpoint is not allowed to be accessed in this environment.", "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 \"country\": \"AR\",\n \"account\": {\n \"dataType\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"callbackUrl\": \"\"\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": "c648818a-6d70-44cc-b4f9-257a7329f80d", "name": "A validation request could not be created due to invalid data.", "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 \"country\": \"AR\",\n \"account\": {\n \"dataType\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"callbackUrl\": \"\"\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": "ae10f94b-f3c9-4041-a448-cacffdeee720", "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 \"country\": \"AR\",\n \"account\": {\n \"dataType\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"callbackUrl\": \"\"\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": "3912a054-0c7b-4374-9c01-9f998f5ef595", "name": "List Bank Account Validations", "request": { "name": "List Bank Account Validations", "description": { "content": "Retrieve a paginated list of bank account validation requests.", "type": "text/plain" }, "url": { "path": [ "v1", "bank-account-validation", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,IN_PROGRESS,TEMPORARY_FAILURE,ERROR)", "type": "text/plain" }, "key": "status", "value": "IN_PROGRESS" }, { "disabled": false, "description": { "content": "Country code in ISO 3166-1 alpha-2 format (This can only be one of UY,BR,CO,MX,US,GB,ES,AR,IN,PK,CN,BD,VN,NG,ID,KR,NP,INTL)", "type": "text/plain" }, "key": "country", "value": "VN" }, { "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": "0e5587dc-7cfd-4093-b475-1b1ea522a787", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,IN_PROGRESS,TEMPORARY_FAILURE,ERROR)", "type": "text/plain" }, "key": "status", "value": "IN_PROGRESS" }, { "disabled": false, "description": { "content": "Country code in ISO 3166-1 alpha-2 format (This can only be one of UY,BR,CO,MX,US,GB,ES,AR,IN,PK,CN,BD,VN,NG,ID,KR,NP,INTL)", "type": "text/plain" }, "key": "country", "value": "VN" }, { "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 \"country\": \"BR\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"inputData\": {\n \"key_0\": 5751,\n \"key_1\": false,\n \"key_2\": 7687.790345474233\n },\n \"status\": \"ERROR\",\n \"statusDescription\": \"\",\n \"countryData\": {\n \"account\": {\n \"number\": \"\",\n \"currency\": \"USD\",\n \"type\": \"WALLET\"\n },\n \"owners\": [\n {\n \"documentType\": \"DNI\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"NATURAL\"\n },\n {\n \"documentType\": \"DNI\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"LEGAL\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"country\": \"CO\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"inputData\": {\n \"key_0\": true\n },\n \"status\": \"ERROR\",\n \"statusDescription\": \"\",\n \"countryData\": {\n \"account\": {\n \"number\": \"\",\n \"currency\": \"USD\",\n \"type\": \"CA\"\n },\n \"owners\": [\n {\n \"documentType\": \"CUIT\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"LEGAL\"\n },\n {\n \"documentType\": \"CUIT\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"LEGAL\"\n }\n ]\n }\n }\n ],\n \"pagination\": {\n \"total\": 0,\n \"page\": 1,\n \"perPage\": 50\n },\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "723be90c-8455-480f-9380-edeaa016bc99", "name": "Bad Request", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,IN_PROGRESS,TEMPORARY_FAILURE,ERROR)", "type": "text/plain" }, "key": "status", "value": "IN_PROGRESS" }, { "disabled": false, "description": { "content": "Country code in ISO 3166-1 alpha-2 format (This can only be one of UY,BR,CO,MX,US,GB,ES,AR,IN,PK,CN,BD,VN,NG,ID,KR,NP,INTL)", "type": "text/plain" }, "key": "country", "value": "VN" }, { "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": "0ff73f32-2d67-4435-a361-3aa14ef69b6a", "name": "Validation Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,IN_PROGRESS,TEMPORARY_FAILURE,ERROR)", "type": "text/plain" }, "key": "status", "value": "IN_PROGRESS" }, { "disabled": false, "description": { "content": "Country code in ISO 3166-1 alpha-2 format (This can only be one of UY,BR,CO,MX,US,GB,ES,AR,IN,PK,CN,BD,VN,NG,ID,KR,NP,INTL)", "type": "text/plain" }, "key": "country", "value": "VN" }, { "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": "005272c9-e3b0-4ade-87ea-59deaa49e9e0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,IN_PROGRESS,TEMPORARY_FAILURE,ERROR)", "type": "text/plain" }, "key": "status", "value": "IN_PROGRESS" }, { "disabled": false, "description": { "content": "Country code in ISO 3166-1 alpha-2 format (This can only be one of UY,BR,CO,MX,US,GB,ES,AR,IN,PK,CN,BD,VN,NG,ID,KR,NP,INTL)", "type": "text/plain" }, "key": "country", "value": "VN" }, { "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": "4e6702d7-15e3-4abc-92a3-9fda4ab7abe8", "name": "Get Bank Account Validation Details", "request": { "name": "Get Bank Account Validation Details", "description": { "content": "Retrieve the validation information using the validation request ID previously obtained from the Create Bank Account Validation endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "bank-account-validation", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "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": "5e77545d-a7c7-4dc5-9724-d83487ca6aca", "name": "The validation request was found and the response is returned.", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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 \"country\": \"IN\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"inputData\": {\n \"key_0\": \"string\",\n \"key_1\": 7783.305890322658,\n \"key_2\": 4920.545497523974\n },\n \"status\": \"ERROR\",\n \"statusDescription\": \"\",\n \"countryData\": {\n \"account\": {\n \"number\": \"\",\n \"currency\": \"ARS\",\n \"type\": \"CC\"\n },\n \"owners\": [\n {\n \"documentType\": \"DNI\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"LEGAL\"\n },\n {\n \"documentType\": \"CUIT\",\n \"documentNumber\": \"\",\n \"name\": \"\",\n \"type\": \"LEGAL\"\n }\n ]\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8663731-30e7-4e1a-8b60-94375195f929", "name": "Unauthorized. The request is missing the required authentication credentials.", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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": "Unauthorized", "code": 401, "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": "3b2bb495-5426-4e0f-92b8-d41c0a97cbf2", "name": "Forbidden. The endpoint is not allowed to be accessed in this environment.", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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": "30934b56-eedd-4e10-bbf1-695a1d28b056", "name": "Validation request not found.", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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": "ecd9fb6c-d4f3-4d1b-88a7-fb9c616f0197", "name": "The validation request ID is invalid.", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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 \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66088a38-c0da-41eb-b0db-40f3eaa51932", "name": "Internal server error.", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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 } } ] } ], "description": { "content": "Easily verify bank accounts globally with our single API solution.", "type": "text/plain" }, "event": [] }, { "name": "Cases", "item": [ { "name": "Cases", "description": "", "item": [ { "id": "769c9e38-d1aa-46ae-832b-601adae6aaea", "name": "List Cases", "request": { "name": "List Cases", "description": { "content": "Returns a paginated list of your cases, newest first. `action_required_by` tells you who has to act next; use `reference_url` to open the support ticket and answer.", "type": "text/plain" }, "url": { "path": [ "v1", "cases", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by case status. (This can only be one of AWAITING_CUSTOMER,AWAITING_INFINIA,RESOLVED,CANCELLED)", "type": "text/plain" }, "key": "status", "value": "AWAITING_INFINIA" }, { "disabled": false, "description": { "content": "Filter by who has to act next: CUSTOMER (you), INFINIA, or NONE (closed cases). (This can only be one of CUSTOMER,INFINIA,NONE)", "type": "text/plain" }, "key": "action_required_by", "value": "NONE" }, { "disabled": false, "description": { "content": "Filter by category. (This can only be one of RFI,FRAUD,MISTAKE)", "type": "text/plain" }, "key": "category", "value": "MISTAKE" }, { "disabled": false, "description": { "content": "Support ticket reference (exact match).", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or after this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or before this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_to", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or after this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or before this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "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 cases to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "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": "b46cbe53-47d9-4aaa-adb9-b745effb464b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by case status. (This can only be one of AWAITING_CUSTOMER,AWAITING_INFINIA,RESOLVED,CANCELLED)", "type": "text/plain" }, "key": "status", "value": "AWAITING_INFINIA" }, { "disabled": false, "description": { "content": "Filter by who has to act next: CUSTOMER (you), INFINIA, or NONE (closed cases). (This can only be one of CUSTOMER,INFINIA,NONE)", "type": "text/plain" }, "key": "action_required_by", "value": "NONE" }, { "disabled": false, "description": { "content": "Filter by category. (This can only be one of RFI,FRAUD,MISTAKE)", "type": "text/plain" }, "key": "category", "value": "MISTAKE" }, { "disabled": false, "description": { "content": "Support ticket reference (exact match).", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or after this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or before this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_to", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or after this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or before this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "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 cases to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "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 \"title\": \"\",\n \"description\": \"\",\n \"category\": \"FRAUD\",\n \"status\": \"AWAITING_INFINIA\",\n \"action_required_by\": \"NONE\",\n \"is_overdue\": \"\",\n \"reference\": \"\",\n \"reference_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"due_at\": \"\",\n \"resources\": [\n {\n \"type\": \"PAYIN\",\n \"id\": \"\"\n },\n {\n \"type\": \"ACCOUNT_OWNER\",\n \"id\": \"\"\n }\n ],\n \"closed_at\": \"\"\n },\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"category\": \"MISTAKE\",\n \"status\": \"AWAITING_CUSTOMER\",\n \"action_required_by\": \"NONE\",\n \"is_overdue\": \"\",\n \"reference\": \"\",\n \"reference_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"due_at\": \"\",\n \"resources\": [\n {\n \"type\": \"PAYIN\",\n \"id\": \"\"\n },\n {\n \"type\": \"INTERNAL_TRANSFER\",\n \"id\": \"\"\n }\n ],\n \"closed_at\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6615d00c-9f69-404e-9e19-26fd84d16dc2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by case status. (This can only be one of AWAITING_CUSTOMER,AWAITING_INFINIA,RESOLVED,CANCELLED)", "type": "text/plain" }, "key": "status", "value": "AWAITING_INFINIA" }, { "disabled": false, "description": { "content": "Filter by who has to act next: CUSTOMER (you), INFINIA, or NONE (closed cases). (This can only be one of CUSTOMER,INFINIA,NONE)", "type": "text/plain" }, "key": "action_required_by", "value": "NONE" }, { "disabled": false, "description": { "content": "Filter by category. (This can only be one of RFI,FRAUD,MISTAKE)", "type": "text/plain" }, "key": "category", "value": "MISTAKE" }, { "disabled": false, "description": { "content": "Support ticket reference (exact match).", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or after this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or before this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_to", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or after this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or before this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "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 cases to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "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": "373a3b09-c349-41cd-9e89-d2486ad9fd6c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by case status. (This can only be one of AWAITING_CUSTOMER,AWAITING_INFINIA,RESOLVED,CANCELLED)", "type": "text/plain" }, "key": "status", "value": "AWAITING_INFINIA" }, { "disabled": false, "description": { "content": "Filter by who has to act next: CUSTOMER (you), INFINIA, or NONE (closed cases). (This can only be one of CUSTOMER,INFINIA,NONE)", "type": "text/plain" }, "key": "action_required_by", "value": "NONE" }, { "disabled": false, "description": { "content": "Filter by category. (This can only be one of RFI,FRAUD,MISTAKE)", "type": "text/plain" }, "key": "category", "value": "MISTAKE" }, { "disabled": false, "description": { "content": "Support ticket reference (exact match).", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or after this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or before this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_to", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or after this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or before this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "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 cases to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "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": "287ca6e1-c678-42f0-8a37-978fcd9d9547", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by case status. (This can only be one of AWAITING_CUSTOMER,AWAITING_INFINIA,RESOLVED,CANCELLED)", "type": "text/plain" }, "key": "status", "value": "AWAITING_INFINIA" }, { "disabled": false, "description": { "content": "Filter by who has to act next: CUSTOMER (you), INFINIA, or NONE (closed cases). (This can only be one of CUSTOMER,INFINIA,NONE)", "type": "text/plain" }, "key": "action_required_by", "value": "NONE" }, { "disabled": false, "description": { "content": "Filter by category. (This can only be one of RFI,FRAUD,MISTAKE)", "type": "text/plain" }, "key": "category", "value": "MISTAKE" }, { "disabled": false, "description": { "content": "Support ticket reference (exact match).", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or after this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases due on or before this timestamp. ISO 8601 (UTC), applied to `due_at`.", "type": "text/plain" }, "key": "due_to", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or after this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_from", "value": "" }, { "disabled": false, "description": { "content": "Only include cases created on or before this timestamp. ISO 8601 (UTC), applied to `created_at`.", "type": "text/plain" }, "key": "date_to", "value": "" }, { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "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 cases to return per page. Defaults to 50.", "type": "text/plain" }, "key": "page_size", "value": "50" }, { "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": "f178bdb8-706b-40e3-b4bc-5a29dd459022", "name": "Get Case Details", "request": { "name": "Get Case Details", "description": { "content": "Retrieve details of a case.", "type": "text/plain" }, "url": { "path": [ "v1", "cases", ":case_id", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" } ], "variable": [ { "type": "any", "value": "", "key": "case_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": "ebc216a9-db99-4739-b51f-11fadec8160d", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":case_id", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "case_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 \"title\": \"\",\n \"description\": \"\",\n \"category\": \"RFI\",\n \"status\": \"CANCELLED\",\n \"action_required_by\": \"CUSTOMER\",\n \"is_overdue\": \"\",\n \"reference\": \"\",\n \"reference_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"due_at\": \"\",\n \"resources\": [\n {\n \"type\": \"ACCOUNT\",\n \"id\": \"\"\n },\n {\n \"type\": \"MOVEMENT\",\n \"id\": \"\"\n }\n ],\n \"closed_at\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f98ddaf-745a-4c57-b2d1-fe357464bf54", "name": "Bad Request", "originalRequest": { "url": { "path": [ ":case_id", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "case_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": "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": "5c2cd534-13a3-4067-8093-665710d91ed6", "name": "Not Found", "originalRequest": { "url": { "path": [ ":case_id", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "case_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": "5fc9f207-3ac0-4fd3-b366-4cf3ef279e68", "name": "Validation Error", "originalRequest": { "url": { "path": [ ":case_id", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "case_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": "2114910b-cf84-47fe-be81-3999f3ffbf77", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ ":case_id", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set to true, also include cases belonging to any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "case_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 } } ] } ], "description": { "content": "Track the cases Infinia opens for your company (requests for information and compliance reviews raised by our banking partners). Each case links to the support ticket where it is discussed and answered.", "type": "text/plain" }, "event": [] }, { "name": "Identity Validation", "item": [ { "name": "Identity Validation", "description": "", "item": [ { "id": "474cbd63-a29f-47f4-871b-2a53af76fff1", "name": "Create Identity Validation", "request": { "name": "Create Identity Validation", "description": { "content": "Create an identity validation request to verify the identity of a user. The response carries the full validation; when the result is not available yet, the status is IN_PROGRESS and the country data is empty until the validation finishes.", "type": "text/plain" }, "url": { "path": [ "v1", "identity-validation", "" ], "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 \"country\": {\n \"code\": \"AR\",\n \"validation\": {\n \"type\": \"AR_DNI\",\n \"dni\": \"\"\n }\n },\n \"callbackUrl\": \"\",\n \"freshnessLimit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "5f53c3fd-685c-41c0-b2c6-922d79f553a5", "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 \"country\": {\n \"code\": \"AR\",\n \"validation\": {\n \"type\": \"AR_DNI\",\n \"dni\": \"\"\n }\n },\n \"callbackUrl\": \"\",\n \"freshnessLimit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"validatedAt\": \"\",\n \"statusDescription\": \"\",\n \"callbackUrl\": \"\",\n \"freshnessLimit\": 2592000,\n \"country\": {\n \"code\": \"AR\",\n \"validation\": {\n \"type\": \"AR_DNI\",\n \"dni\": \"\",\n \"fullName\": \"\",\n \"deceased\": \"\",\n \"dateOfBirth\": \"\",\n \"activityDescription\": \"\",\n \"activityCode\": \"\"\n }\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4766c44c-b8c8-4203-a47a-4546c32d73ce", "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 \"country\": {\n \"code\": \"AR\",\n \"validation\": {\n \"type\": \"AR_DNI\",\n \"dni\": \"\"\n }\n },\n \"callbackUrl\": \"\",\n \"freshnessLimit\": \"\"\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1869bb29-0945-43ac-aba6-1901a903e48a", "name": "List Identity Validation Requests", "request": { "name": "List Identity Validation Requests", "description": { "content": "Retrieve a paginated list of identity validation requests.", "type": "text/plain" }, "url": { "path": [ "v1", "identity-validation", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,FAILED,IN_PROGRESS,TEMPORARY_FAILURE)", "type": "text/plain" }, "key": "status", "value": "TEMPORARY_FAILURE" }, { "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": "192029d0-2bef-46f7-9e90-582ef440c3d4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,FAILED,IN_PROGRESS,TEMPORARY_FAILURE)", "type": "text/plain" }, "key": "status", "value": "TEMPORARY_FAILURE" }, { "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 \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"TEMPORARY_FAILURE\",\n \"validatedAt\": \"\",\n \"statusDescription\": \"\",\n \"callbackUrl\": \"\",\n \"freshnessLimit\": 2592000,\n \"country\": {\n \"code\": \"AR\",\n \"validation\": {\n \"type\": \"AR_DNI\",\n \"dni\": \"\",\n \"fullName\": \"\",\n \"deceased\": \"\",\n \"dateOfBirth\": \"\",\n \"activityDescription\": \"\",\n \"activityCode\": \"\"\n }\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"FAILED\",\n \"validatedAt\": \"\",\n \"statusDescription\": \"\",\n \"callbackUrl\": \"\",\n \"freshnessLimit\": 2592000,\n \"country\": {\n \"code\": \"AR\",\n \"validation\": {\n \"type\": \"AR_DNI\",\n \"dni\": \"\",\n \"fullName\": \"\",\n \"deceased\": \"\",\n \"dateOfBirth\": \"\",\n \"activityDescription\": \"\",\n \"activityCode\": \"\"\n }\n }\n }\n ],\n \"pagination\": {\n \"total\": 0,\n \"page\": 1,\n \"perPage\": 50\n },\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386806df-c16e-47d6-b5fe-c47732baff10", "name": "Validation Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "Page size", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "Start date", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "End date", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": "Status (This can only be one of SUCCESSFUL,FAILED,IN_PROGRESS,TEMPORARY_FAILURE)", "type": "text/plain" }, "key": "status", "value": "TEMPORARY_FAILURE" }, { "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": "9924a00d-5511-4883-9abb-2eecdf8cfbd3", "name": "Get Identity Validation Details", "request": { "name": "Get Identity Validation Details", "description": { "content": "Retrieve an identity validation information using the validation request ID previously obtained from the Create Identity Validation endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "identity-validation", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "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": "1237a74d-ac10-4b9e-9272-ec98d4e0fb3b", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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 \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"validatedAt\": \"\",\n \"statusDescription\": \"\",\n \"callbackUrl\": \"\",\n \"freshnessLimit\": 2592000,\n \"country\": {\n \"code\": \"AR\",\n \"validation\": {\n \"type\": \"AR_DNI\",\n \"dni\": \"\",\n \"fullName\": \"\",\n \"deceased\": \"\",\n \"dateOfBirth\": \"\",\n \"activityDescription\": \"\",\n \"activityCode\": \"\"\n }\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc2992ca-8b4e-4c70-a829-095b8ef8e8ce", "name": "Validation Error", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "description": { "content": "An Identity Validation API provides a secure way to verify users' identities by cross-checking provided personal information against trusted data sources. It allows businesses to validate key details such as name, address, date of birth, and government-issued identification (e.g., SSN, passport). This API helps prevent fraud, comply with KYC (Know Your Customer) regulations, and streamline onboarding processes by ensuring that only verified users gain access to services. By integrating identity validation, organizations can improve security, reduce risk, and enhance user trust.", "type": "text/plain" }, "event": [] }, { "name": "Onboarding", "item": [ { "name": "Onboarding", "description": "", "item": [ { "id": "26ca5177-374d-4d99-8464-a5bb7515189f", "name": "Create Subcompany", "request": { "name": "Create Subcompany", "description": { "content": "Create a subcompany.", "type": "text/plain" }, "url": { "path": [ "v1", "onboarding", "company", "" ], "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 \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"PP\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"idempotency_key\": \"\",\n \"acc_default_webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "82c64c81-9e0a-47d2-a652-15e4128ebdb9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "company", "" ], "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 \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"PP\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"idempotency_key\": \"\",\n \"acc_default_webhook_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 \"idempotency_key\": \"\",\n \"created_at\": \"\",\n \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"acc_default_webhook_url\": \"\",\n \"parent_company_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c762f4b4-3c97-49ae-a2a4-2e5ff04e0a23", "name": "Bad Request", "originalRequest": { "url": { "path": [ "company", "" ], "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 \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"PP\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"idempotency_key\": \"\",\n \"acc_default_webhook_url\": \"\"\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": "dd4cce43-5445-44f3-9d2b-064667963cd2", "name": "Validation Error", "originalRequest": { "url": { "path": [ "company", "" ], "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 \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"PP\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"idempotency_key\": \"\",\n \"acc_default_webhook_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": "05eea456-dcac-48ed-9f1e-041ef6dff044", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "company", "" ], "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 \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"PP\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"idempotency_key\": \"\",\n \"acc_default_webhook_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": "9691ff4e-f82f-40a9-a493-4e37db75dd4e", "name": "List Companies", "request": { "name": "List Companies", "description": { "content": "Retrieve a list of companies and child companies.", "type": "text/plain" }, "url": { "path": [ "v1", "onboarding", "company", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "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": "575b95d8-ecc2-47dd-90f8-476ef7e01609", "name": "Successful Response", "originalRequest": { "url": { "path": [ "company", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "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 \"idempotency_key\": \"\",\n \"created_at\": \"\",\n \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"acc_default_webhook_url\": \"\",\n \"parent_company_id\": \"\"\n },\n {\n \"id\": \"\",\n \"idempotency_key\": \"\",\n \"created_at\": \"\",\n \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"acc_default_webhook_url\": \"\",\n \"parent_company_id\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0254f8e-d6b3-4da9-9e3d-579a79d15c84", "name": "Bad Request", "originalRequest": { "url": { "path": [ "company", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "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": "c21de02e-c62e-494a-b8a6-ccd4b130f76d", "name": "Validation Error", "originalRequest": { "url": { "path": [ "company", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "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": "74e94855-266c-4bfc-81b4-799e4a05fcdb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "company", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Idempotency key", "type": "text/plain" }, "key": "idempotency_key", "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": "534d4c6e-9e93-481f-954a-2692ffa109d7", "name": "Get Company Details", "request": { "name": "Get Company Details", "description": { "content": "Retrieve the details of a company.", "type": "text/plain" }, "url": { "path": [ "v1", "onboarding", "company", ":company_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "company_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": "12d4162d-1f96-4f28-a9d0-f1236530d7e8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "company", ":company_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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 \"idempotency_key\": \"\",\n \"created_at\": \"\",\n \"business_name\": \"\",\n \"friendly_name\": \"\",\n \"country_of_registration\": \"\",\n \"registration_number\": \"\",\n \"entity_type\": \"\",\n \"acc_default_webhook_url\": \"\",\n \"parent_company_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d4afb56-509c-4ea6-baa0-2b3977e7d8ce", "name": "Forbidden", "originalRequest": { "url": { "path": [ "company", ":company_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "2a22540e-21a2-4f70-b6de-dcc15a1fc599", "name": "Validation Error", "originalRequest": { "url": { "path": [ "company", ":company_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "857095f7-4bf3-4b61-b426-8e16634d6cc5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "company", ":company_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "10602397-4231-4de9-a302-ade1260c37ba", "name": "Enable Product and Geography", "request": { "name": "Enable Product and Geography", "description": { "content": "Request enablement of a product and geography for a company. \n\nThis action is required for all companies created via the Create Subcompany endpoint. \n\nProducts and geographies for primary companies are enabled by Infinia staff.\n\nIn Sandbox, requests are approved automatically, and primary companies have all products and geographies enabled by default.", "type": "text/plain" }, "url": { "path": [ "v1", "onboarding", "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "company_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": "POST", "body": { "mode": "raw", "raw": "{\n \"product\": \"ONBOARDING\",\n \"geography\": \"XX\",\n \"callback_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "4b813521-3567-4a7c-8230-c7c51328d027", "name": "Successful Response", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "POST", "body": { "mode": "raw", "raw": "{\n \"product\": \"ONBOARDING\",\n \"geography\": \"XX\",\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 \"company_id\": \"\",\n \"requested_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"KYB_REQUIRED\",\n \"product\": \"IDENTITY_VALIDATION\",\n \"geography\": \"XX\",\n \"callback_url\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db4e9635-bd22-4933-8e1c-f7dfe38421eb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "POST", "body": { "mode": "raw", "raw": "{\n \"product\": \"ONBOARDING\",\n \"geography\": \"XX\",\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": "a0065848-54c2-4757-a177-01e992c667fb", "name": "Validation Error", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "POST", "body": { "mode": "raw", "raw": "{\n \"product\": \"ONBOARDING\",\n \"geography\": \"XX\",\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": "9696957e-8ef4-4a2a-8d96-33f391f0c1de", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "POST", "body": { "mode": "raw", "raw": "{\n \"product\": \"ONBOARDING\",\n \"geography\": \"XX\",\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": "77296a85-c816-44f6-a23b-2ddd1acd9e1a", "name": "Get Company Products", "request": { "name": "Get Company Products", "description": { "content": "Retrieve enabled products for a company. \n\nIn Sandbox, primary companies have all products and geographies enabled by default, so the full catalog is returned as APPROVED.", "type": "text/plain" }, "url": { "path": [ "v1", "onboarding", "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "company_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": "f70f7e55-f3f2-4ca7-9fd3-225c57b0baef", "name": "Successful Response", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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 {\n \"company_id\": \"\",\n \"requested_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"PENDING\",\n \"product\": \"INTERNAL_TRANSFER\",\n \"geography\": \"CL\",\n \"callback_url\": \"\"\n },\n {\n \"company_id\": \"\",\n \"requested_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"KYB_REQUIRED\",\n \"product\": \"CREDIT_REFUND\",\n \"geography\": \"BR\",\n \"callback_url\": \"\"\n }\n ],\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58e2376d-03ea-48e1-8978-d4e2bfab3b24", "name": "Forbidden", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "ac862b3f-b47f-4ca1-9e12-348992f4f788", "name": "Validation Error", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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": "af8c36e3-f962-4497-ace6-6237314a08ce", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "company", ":company_id", "product", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "company_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 } } ] } ], "description": { "content": "Create customers and enable products", "type": "text/plain" }, "event": [] }, { "name": "Payins", "item": [ { "name": "Payins", "description": "", "item": [ { "id": "25dcb8fe-efe0-4ee2-a24f-d0cf2305a42b", "name": "List Payment Refunds", "request": { "name": "List Payment Refunds", "description": { "content": "Retrieve a list of payin refunds.", "type": "text/plain" }, "url": { "path": [ "v1", "payments", "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "payment_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "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": "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": "d710b817-aff2-4e3c-9a87-4fcc3f3859de", "name": "Successful Response", "originalRequest": { "url": { "path": [ "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "payment_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "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": "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\": \"FAILED\",\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 \"payment_id\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"PENDING\",\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 \"payment_id\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aea9853-0b19-45b1-8b02-9a0822ea7ccb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "payment_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "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": "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": "2a241096-c40c-4be1-81de-149f7f71648c", "name": "Validation Error", "originalRequest": { "url": { "path": [ "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "payment_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "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": "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": "119ad6fd-8338-4ef2-960e-ce7c64235936", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "refund", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "payment_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "refund_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "idempotency_key", "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": "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": "ad3a1dc4-e151-4a43-a170-4f7f7c11473e", "name": "Refund Payment", "request": { "name": "Refund Payment", "description": { "content": "Create a refund for a payin. Only completed payins are eligible for refunds. \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 payin with `amount = 101` and wait for it to complete — it does so asynchronously a few seconds after creation (see the `Create Payment` endpoint for details).\n\nTo refund a deposit, use the `Create Refund` endpoint from Accounts.", "type": "text/plain" }, "url": { "path": [ "v1", "payments", "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 \"payment_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": "54f4de20-16ed-4309-94e4-821849090f7c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "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 \"payment_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 \"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 \"payment_id\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d236771c-5fb4-487e-8966-1d05a401f9ec", "name": "Forbidden", "originalRequest": { "url": { "path": [ "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 \"payment_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": "5ba11f37-b7e6-4ecf-a3d5-9a4591152dff", "name": "Validation Error", "originalRequest": { "url": { "path": [ "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 \"payment_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": "ab0e5384-d5c1-462c-8c84-6ab607c60d95", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "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 \"payment_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": "759626f1-5110-447c-8d6c-e0a76dc98f84", "name": "Create Payment", "request": { "name": "Create Payment", "description": { "content": "Create a one-time payment instruction with a fixed amount and expiration. \n\nTo test different scenarios for each market and payment rail, please refer to the Examples tab on the right side of the screen. \n\nEach market has a dedicated example. Use the following amounts to simulate specific statuses: \n\n100 → COMPLETED in the create response. \n\n101 → AWAITING in the create response, then COMPLETED a few seconds later, with a webhook sent to your `callbackUrl` — use it to test the asynchronous happy path. \n\n102 → ERROR. \n\nAny other amount → AWAITING until you complete it through the payment's `startUrl`.", "type": "text/plain" }, "url": { "path": [ "v1", "payments", "" ], "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 \"amount\": \"\",\n \"expiryDate\": \"\",\n \"accountId\": \"\",\n \"market\": \"AR\",\n \"type\": \"OFFLINE\",\n \"currency\": \"USD\",\n \"clientTaxId\": \"\",\n \"callbackUrl\": \"\",\n \"reference\": \"\",\n \"redirectUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "4d3f77c6-271d-4161-bbf9-559f0d8af86a", "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 \"amount\": \"\",\n \"expiryDate\": \"\",\n \"accountId\": \"\",\n \"market\": \"AR\",\n \"type\": \"OFFLINE\",\n \"currency\": \"USD\",\n \"clientTaxId\": \"\",\n \"callbackUrl\": \"\",\n \"reference\": \"\",\n \"redirectUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"market\": \"BR\",\n \"type\": \"OFFLINE_SERVICE_PAYMENT\",\n \"amount\": \"\",\n \"currency\": \"ARS\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"attempts\": [\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"EXPIRED\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n },\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"ERROR\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n }\n ],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"COMPLETED\",\n \"retryable\": false,\n \"expiryDate\": \"\",\n \"callbackUrl\": \"\",\n \"redirectUrl\": \"\",\n \"startUrl\": \"\",\n \"reference\": \"\",\n \"account\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"number\": \"\",\n \"id\": \"\"\n },\n \"accountId\": \"\",\n \"providerExternalId\": \"\",\n \"initData\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n },\n \"voucherId\": \"\"\n },\n {\n \"id\": \"\",\n \"market\": \"CO\",\n \"type\": \"ONLINE\",\n \"amount\": \"\",\n \"currency\": \"COP\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"attempts\": [\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"ERROR\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n },\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"AWAITING\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n }\n ],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"ERROR\",\n \"retryable\": false,\n \"expiryDate\": \"\",\n \"callbackUrl\": \"\",\n \"redirectUrl\": \"\",\n \"startUrl\": \"\",\n \"reference\": \"\",\n \"account\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"number\": \"\",\n \"id\": \"\"\n },\n \"accountId\": \"\",\n \"providerExternalId\": \"\",\n \"initData\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n },\n \"voucherId\": \"\"\n }\n ],\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aacb4014-641c-4203-9bd7-88213518004f", "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 \"amount\": \"\",\n \"expiryDate\": \"\",\n \"accountId\": \"\",\n \"market\": \"AR\",\n \"type\": \"OFFLINE\",\n \"currency\": \"USD\",\n \"clientTaxId\": \"\",\n \"callbackUrl\": \"\",\n \"reference\": \"\",\n \"redirectUrl\": \"\"\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": "2aed58e8-c11e-46c7-9b87-bada8c06fc67", "name": "Forbidden", "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 \"amount\": \"\",\n \"expiryDate\": \"\",\n \"accountId\": \"\",\n \"market\": \"AR\",\n \"type\": \"OFFLINE\",\n \"currency\": \"USD\",\n \"clientTaxId\": \"\",\n \"callbackUrl\": \"\",\n \"reference\": \"\",\n \"redirectUrl\": \"\"\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": "34138217-9d37-4ece-b3f6-54a5baca8f37", "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 \"amount\": \"\",\n \"expiryDate\": \"\",\n \"accountId\": \"\",\n \"market\": \"AR\",\n \"type\": \"OFFLINE\",\n \"currency\": \"USD\",\n \"clientTaxId\": \"\",\n \"callbackUrl\": \"\",\n \"reference\": \"\",\n \"redirectUrl\": \"\"\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": "24823b7f-7d7c-47fa-af1d-0f5b0fc4e717", "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 \"amount\": \"\",\n \"expiryDate\": \"\",\n \"accountId\": \"\",\n \"market\": \"AR\",\n \"type\": \"OFFLINE\",\n \"currency\": \"USD\",\n \"clientTaxId\": \"\",\n \"callbackUrl\": \"\",\n \"reference\": \"\",\n \"redirectUrl\": \"\"\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": "ed166413-5c7d-44f1-8d94-56cf7edb09ef", "name": "List Payments", "request": { "name": "List Payments", "description": { "content": "Retrieve a paginated list of payins.", "type": "text/plain" }, "url": { "path": [ "v1", "payments", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of AWAITING,EXPIRED,COMPLETED,ERROR,PARTIALLY_REFUNDED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ERROR" }, { "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": "market", "value": "AR" }, { "disabled": false, "description": { "content": " (This can only be one of ONLINE,OFFLINE,PULL,PIX,PIX_ITP,PLEXO)", "type": "text/plain" }, "key": "type", "value": "PIX" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "includeChildCompanies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "paymentId", "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": "88e4e639-6541-4aad-a591-645dbfea264b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of AWAITING,EXPIRED,COMPLETED,ERROR,PARTIALLY_REFUNDED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ERROR" }, { "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": "market", "value": "AR" }, { "disabled": false, "description": { "content": " (This can only be one of ONLINE,OFFLINE,PULL,PIX,PIX_ITP,PLEXO)", "type": "text/plain" }, "key": "type", "value": "PIX" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "includeChildCompanies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "paymentId", "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 \"market\": \"CL\",\n \"type\": \"PIX_ITP\",\n \"amount\": \"\",\n \"currency\": \"CLP\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"attempts\": [\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"PARTIALLY_REFUNDED\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n },\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"REFUNDED\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n }\n ],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"PARTIALLY_REFUNDED\",\n \"retryable\": false,\n \"expiryDate\": \"\",\n \"callbackUrl\": \"\",\n \"redirectUrl\": \"\",\n \"startUrl\": \"\",\n \"reference\": \"\",\n \"account\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"number\": \"\",\n \"id\": \"\"\n },\n \"accountId\": \"\",\n \"providerExternalId\": \"\",\n \"initData\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n },\n \"voucherId\": \"\"\n },\n {\n \"id\": \"\",\n \"market\": \"MX\",\n \"type\": \"OFFLINE\",\n \"amount\": \"\",\n \"currency\": \"MXN\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"attempts\": [\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"ERROR\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n },\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"ERROR\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n }\n ],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"EXPIRED\",\n \"retryable\": false,\n \"expiryDate\": \"\",\n \"callbackUrl\": \"\",\n \"redirectUrl\": \"\",\n \"startUrl\": \"\",\n \"reference\": \"\",\n \"account\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"number\": \"\",\n \"id\": \"\"\n },\n \"accountId\": \"\",\n \"providerExternalId\": \"\",\n \"initData\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n },\n \"voucherId\": \"\"\n }\n ],\n \"page_number\": \"\",\n \"page_size\": \"\",\n \"total_pages\": \"\",\n \"total_payments\": \"\",\n \"next_cursor\": \"\",\n \"has_more\": false,\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95c69399-b150-4cf0-b92f-64d8262d561f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of AWAITING,EXPIRED,COMPLETED,ERROR,PARTIALLY_REFUNDED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ERROR" }, { "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": "market", "value": "AR" }, { "disabled": false, "description": { "content": " (This can only be one of ONLINE,OFFLINE,PULL,PIX,PIX_ITP,PLEXO)", "type": "text/plain" }, "key": "type", "value": "PIX" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "includeChildCompanies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "paymentId", "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": "5065ae31-cbf1-4605-a3a1-675605d6ce85", "name": "Validation Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of AWAITING,EXPIRED,COMPLETED,ERROR,PARTIALLY_REFUNDED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ERROR" }, { "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": "market", "value": "AR" }, { "disabled": false, "description": { "content": " (This can only be one of ONLINE,OFFLINE,PULL,PIX,PIX_ITP,PLEXO)", "type": "text/plain" }, "key": "type", "value": "PIX" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "includeChildCompanies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "paymentId", "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": "d39cb9b0-b973-4c8b-81ec-a1a69024db62", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageNumber", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "pageSize", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of AWAITING,EXPIRED,COMPLETED,ERROR,PARTIALLY_REFUNDED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ERROR" }, { "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": "market", "value": "AR" }, { "disabled": false, "description": { "content": " (This can only be one of ONLINE,OFFLINE,PULL,PIX,PIX_ITP,PLEXO)", "type": "text/plain" }, "key": "type", "value": "PIX" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "includeChildCompanies", "value": "false" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "paymentId", "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": "525123cb-d330-4458-9a1a-84800a60af43", "name": "Get Payment Details", "request": { "name": "Get Payment Details", "description": { "content": "Retrieve details of a payin.", "type": "text/plain" }, "url": { "path": [ "v1", "payments", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "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": "20a94efb-e844-4790-975f-92cfb056beab", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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 {\n \"id\": \"\",\n \"market\": \"US\",\n \"type\": \"SPEI\",\n \"amount\": \"\",\n \"currency\": \"PEN\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"attempts\": [\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"ERROR\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n },\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"ERROR\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n }\n ],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"ERROR\",\n \"retryable\": false,\n \"expiryDate\": \"\",\n \"callbackUrl\": \"\",\n \"redirectUrl\": \"\",\n \"startUrl\": \"\",\n \"reference\": \"\",\n \"account\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"number\": \"\",\n \"id\": \"\"\n },\n \"accountId\": \"\",\n \"providerExternalId\": \"\",\n \"initData\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n },\n \"voucherId\": \"\"\n },\n {\n \"id\": \"\",\n \"market\": \"US\",\n \"type\": \"PULL\",\n \"amount\": \"\",\n \"currency\": \"ARS\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"attempts\": [\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"REFUNDED\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n },\n {\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"status\": \"ERROR\",\n \"providerExternalId\": \"\",\n \"providerExternalId2\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n }\n }\n ],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"ERROR\",\n \"retryable\": false,\n \"expiryDate\": \"\",\n \"callbackUrl\": \"\",\n \"redirectUrl\": \"\",\n \"startUrl\": \"\",\n \"reference\": \"\",\n \"account\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"number\": \"\",\n \"id\": \"\"\n },\n \"accountId\": \"\",\n \"providerExternalId\": \"\",\n \"initData\": \"\",\n \"payerData\": {\n \"name\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"accountNumber\": \"\"\n },\n \"voucherId\": \"\"\n }\n ],\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e5625aa-cfd9-468c-ad77-770c9101c719", "name": "Bad Request", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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": "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": "b3dd4b7e-ddd0-4e6d-af2d-d64ed28c3006", "name": "Validation Error", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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": "6ede2192-75b4-4519-bdae-7ddeb1d0fa23", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "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 } } ] } ], "description": { "content": "Initiate payments using a variety of payment methods in multiple markets.", "type": "text/plain" }, "event": [] }, { "name": "Payouts", "item": [ { "name": "Payouts", "description": "", "item": [ { "id": "b8e609e8-ea5a-46c0-ba11-8e9c4fe72710", "name": "Create Payout", "request": { "name": "Create Payout", "description": { "content": "Create a new payout. \n\nTo test different scenarios for each market, please refer to the Examples tab on the right side of the screen. \n\nEach market has a dedicated example. Use the following amounts to simulate specific statuses: \n\n201 → IN_PROGRESS then COMPLETED, 202 → IN_PROGRESS then FAILED, 203 → immediate ERROR, any other amount → completes immediately.", "type": "text/plain" }, "url": { "path": [ "v2", "payouts", "" ], "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "8031d608-419b-4429-90a3-39dee63a7a5d", "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"country\": \"CHILE\",\n \"currency\": \"USDT\",\n \"createdAt\": \"\",\n \"amount\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"transactionId\": \"\",\n \"originId\": \"\",\n \"voucherId\": \"\",\n \"bank\": \"INFINIA\",\n \"updatedAt\": \"\",\n \"msgStatus\": \"\",\n \"sourceAccount\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"accountNumber\": \"\",\n \"id\": \"\",\n \"label\": \"\"\n },\n \"destination\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"creditorAccount\": {\n \"number\": \"\",\n \"branch\": \"\",\n \"type\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"ownerName\": \"\",\n \"ownerDocument\": \"\",\n \"ownerDocumentType\": \"\"\n },\n \"extraInfo\": {\n \"key_0\": false\n },\n \"callbackUrl\": \"\",\n \"createdAtIso\": \"\",\n \"updatedAtIso\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09d4bb4a-8920-4f9e-af67-e8269bb08484", "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\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": "b58d61f5-fb13-4786-a51e-f2059cc99363", "name": "Forbidden", "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\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": "7aa7d341-f133-4f6f-a3a0-65b23d4105de", "name": "Payout blocked by a risk/compliance rule. The `error_code` field identifies the outcome.", "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "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": "7526eb3d-c466-469c-86ef-7c64cf946ff4", "name": "The source account does not have enough available balance to cover the payout. A payout record is still created with status `ERROR`, and its data is returned in the `data` field.", "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\",\n \"data\": {\n \"id\": \"\",\n \"country\": \"MEXICO\",\n \"currency\": \"BRLA_ETH\",\n \"createdAt\": \"\",\n \"amount\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"transactionId\": \"\",\n \"originId\": \"\",\n \"voucherId\": \"\",\n \"bank\": \"INFINIA\",\n \"updatedAt\": \"\",\n \"msgStatus\": \"\",\n \"sourceAccount\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"accountNumber\": \"\",\n \"id\": \"\",\n \"label\": \"\"\n },\n \"destination\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"creditorAccount\": {\n \"number\": \"\",\n \"branch\": \"\",\n \"type\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"ownerName\": \"\",\n \"ownerDocument\": \"\",\n \"ownerDocumentType\": \"\"\n },\n \"extraInfo\": {\n \"key_0\": 682\n },\n \"callbackUrl\": \"\",\n \"createdAtIso\": \"\",\n \"updatedAtIso\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35bc4657-6eba-4848-8ae3-210fae5326e0", "name": "Unprocessable Entity", "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\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": "fac06618-8eee-41b5-bd1e-f554cdbf8f8b", "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 \"originId\": \"\",\n \"amount\": \"\",\n \"destinationAccount\": {\n \"country\": \"ARGENTINA\",\n \"currency\": \"USD\",\n \"destinationType\": {\n \"type\": \"ALIAS\",\n \"alias\": \"\"\n },\n \"adultCheck\": \"\"\n },\n \"sourceAccountId\": \"\",\n \"callbackUrl\": \"\"\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": "473b9f3b-54e2-4d6b-8650-5b451b4c6971", "name": "List Payouts", "request": { "name": "List Payouts", "description": { "content": "Retrieve a paginated list of payouts.", "type": "text/plain" }, "url": { "path": [ "v2", "payouts", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ARGENTINA,BRAZIL,MEXICO,PARAGUAY,PERU,COLOMBIA,CHILE,EUROPE,GLOBAL,BOLIVIA,UNITED_KINGDOM)", "type": "text/plain" }, "key": "country", "value": "BRAZIL" }, { "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": "Payout ID", "type": "text/plain" }, "key": "payout_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include payouts by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_from", "value": "9488-19-23 96:38:05" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_to", "value": "7444-81-51 10:33:75" }, { "disabled": false, "description": { "content": " (This can only be one of COMPLETED,IN_PROGRESS,FAILED,REFUNDED,PARTIALLY_REFUNDED,ERROR)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": " (This can only be one of ARS,USD,BRL,MXN,PYG,CLP,PEN,EUR,GBP,USDT,USDC,BOB,EURC,COP,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,GBP,BRLA,BRLA_POL,BRLA_BASE,BRLA_ETH,TGBP,TGBP_POL,TGBP_BASE,TGBP_ETH)", "type": "text/plain" }, "key": "currency", "value": "EURC_ETH" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_max", "value": "" }, { "disabled": false, "description": { "content": "Origin ID to filter payouts.", "type": "text/plain" }, "key": "origin_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": "7d5cd1a8-0ab7-4f6c-ac4e-e1d2cae3ec8f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ARGENTINA,BRAZIL,MEXICO,PARAGUAY,PERU,COLOMBIA,CHILE,EUROPE,GLOBAL,BOLIVIA,UNITED_KINGDOM)", "type": "text/plain" }, "key": "country", "value": "BRAZIL" }, { "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": "Payout ID", "type": "text/plain" }, "key": "payout_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include payouts by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_from", "value": "9488-19-23 96:38:05" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_to", "value": "7444-81-51 10:33:75" }, { "disabled": false, "description": { "content": " (This can only be one of COMPLETED,IN_PROGRESS,FAILED,REFUNDED,PARTIALLY_REFUNDED,ERROR)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": " (This can only be one of ARS,USD,BRL,MXN,PYG,CLP,PEN,EUR,GBP,USDT,USDC,BOB,EURC,COP,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,GBP,BRLA,BRLA_POL,BRLA_BASE,BRLA_ETH,TGBP,TGBP_POL,TGBP_BASE,TGBP_ETH)", "type": "text/plain" }, "key": "currency", "value": "EURC_ETH" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_max", "value": "" }, { "disabled": false, "description": { "content": "Origin ID to filter payouts.", "type": "text/plain" }, "key": "origin_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 \"country\": \"CHILE\",\n \"currency\": \"USDT_TEMPO\",\n \"createdAt\": \"\",\n \"amount\": \"\",\n \"status\": \"REFUNDED\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"transactionId\": \"\",\n \"originId\": \"\",\n \"voucherId\": \"\",\n \"bank\": \"INFINIA\",\n \"updatedAt\": \"\",\n \"msgStatus\": \"\",\n \"sourceAccount\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"accountNumber\": \"\",\n \"id\": \"\",\n \"label\": \"\"\n },\n \"destination\": {\n \"key_0\": 67,\n \"key_1\": 6583\n },\n \"creditorAccount\": {\n \"number\": \"\",\n \"branch\": \"\",\n \"type\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"ownerName\": \"\",\n \"ownerDocument\": \"\",\n \"ownerDocumentType\": \"\"\n },\n \"extraInfo\": {\n \"key_0\": 4357.625148052404,\n \"key_1\": true\n },\n \"callbackUrl\": \"\",\n \"createdAtIso\": \"\",\n \"updatedAtIso\": \"\"\n },\n {\n \"id\": \"\",\n \"country\": \"MEXICO\",\n \"currency\": \"BOB\",\n \"createdAt\": \"\",\n \"amount\": \"\",\n \"status\": \"PARTIALLY_REFUNDED\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"transactionId\": \"\",\n \"originId\": \"\",\n \"voucherId\": \"\",\n \"bank\": \"INFINIA\",\n \"updatedAt\": \"\",\n \"msgStatus\": \"\",\n \"sourceAccount\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"accountNumber\": \"\",\n \"id\": \"\",\n \"label\": \"\"\n },\n \"destination\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": true\n },\n \"creditorAccount\": {\n \"number\": \"\",\n \"branch\": \"\",\n \"type\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"ownerName\": \"\",\n \"ownerDocument\": \"\",\n \"ownerDocumentType\": \"\"\n },\n \"extraInfo\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"callbackUrl\": \"\",\n \"createdAtIso\": \"\",\n \"updatedAtIso\": \"\"\n }\n ],\n \"status\": \"success\",\n \"nextCursor\": \"\",\n \"hasMore\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b858a1f9-933f-48d0-8246-fcb907184d6c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ARGENTINA,BRAZIL,MEXICO,PARAGUAY,PERU,COLOMBIA,CHILE,EUROPE,GLOBAL,BOLIVIA,UNITED_KINGDOM)", "type": "text/plain" }, "key": "country", "value": "BRAZIL" }, { "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": "Payout ID", "type": "text/plain" }, "key": "payout_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include payouts by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_from", "value": "9488-19-23 96:38:05" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_to", "value": "7444-81-51 10:33:75" }, { "disabled": false, "description": { "content": " (This can only be one of COMPLETED,IN_PROGRESS,FAILED,REFUNDED,PARTIALLY_REFUNDED,ERROR)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": " (This can only be one of ARS,USD,BRL,MXN,PYG,CLP,PEN,EUR,GBP,USDT,USDC,BOB,EURC,COP,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,GBP,BRLA,BRLA_POL,BRLA_BASE,BRLA_ETH,TGBP,TGBP_POL,TGBP_BASE,TGBP_ETH)", "type": "text/plain" }, "key": "currency", "value": "EURC_ETH" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_max", "value": "" }, { "disabled": false, "description": { "content": "Origin ID to filter payouts.", "type": "text/plain" }, "key": "origin_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": "a08401fa-459a-4e14-90c9-8e2ad0df242a", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ARGENTINA,BRAZIL,MEXICO,PARAGUAY,PERU,COLOMBIA,CHILE,EUROPE,GLOBAL,BOLIVIA,UNITED_KINGDOM)", "type": "text/plain" }, "key": "country", "value": "BRAZIL" }, { "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": "Payout ID", "type": "text/plain" }, "key": "payout_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include payouts by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_from", "value": "9488-19-23 96:38:05" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_to", "value": "7444-81-51 10:33:75" }, { "disabled": false, "description": { "content": " (This can only be one of COMPLETED,IN_PROGRESS,FAILED,REFUNDED,PARTIALLY_REFUNDED,ERROR)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": " (This can only be one of ARS,USD,BRL,MXN,PYG,CLP,PEN,EUR,GBP,USDT,USDC,BOB,EURC,COP,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,GBP,BRLA,BRLA_POL,BRLA_BASE,BRLA_ETH,TGBP,TGBP_POL,TGBP_BASE,TGBP_ETH)", "type": "text/plain" }, "key": "currency", "value": "EURC_ETH" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_max", "value": "" }, { "disabled": false, "description": { "content": "Origin ID to filter payouts.", "type": "text/plain" }, "key": "origin_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 \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "099d2ed9-a828-4f28-b960-8ee27ab57d82", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ARGENTINA,BRAZIL,MEXICO,PARAGUAY,PERU,COLOMBIA,CHILE,EUROPE,GLOBAL,BOLIVIA,UNITED_KINGDOM)", "type": "text/plain" }, "key": "country", "value": "BRAZIL" }, { "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": "Payout ID", "type": "text/plain" }, "key": "payout_id", "value": "" }, { "disabled": false, "description": { "content": "If set to true, include payouts by any child companies of the authenticated company. Default: false.", "type": "text/plain" }, "key": "include_child_companies", "value": "false" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_from", "value": "9488-19-23 96:38:05" }, { "disabled": false, "description": { "content": "Format: YYYY-MM-DD HH:MM:SS. The filter is applied to the startDate field, and dates are considered in UTC.", "type": "text/plain" }, "key": "date_to", "value": "7444-81-51 10:33:75" }, { "disabled": false, "description": { "content": " (This can only be one of COMPLETED,IN_PROGRESS,FAILED,REFUNDED,PARTIALLY_REFUNDED,ERROR)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": " (This can only be one of ARS,USD,BRL,MXN,PYG,CLP,PEN,EUR,GBP,USDT,USDC,BOB,EURC,COP,USDC_POL,USDT_POL,EURC_BASE,USDC_BASE,USDT_BASE,USDC_ETH,USDT_ETH,EURC_ETH,USDC_TEMPO,USDT_TEMPO,EURC_TEMPO,GBP,BRLA,BRLA_POL,BRLA_BASE,BRLA_ETH,TGBP,TGBP_POL,TGBP_BASE,TGBP_ETH)", "type": "text/plain" }, "key": "currency", "value": "EURC_ETH" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "amount_max", "value": "" }, { "disabled": false, "description": { "content": "Origin ID to filter payouts.", "type": "text/plain" }, "key": "origin_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": "e644e74b-8698-4c9c-9d8e-65b2aa32b110", "name": "Get Payout Details", "request": { "name": "Get Payout Details", "description": { "content": "Retrieve details of a payout.", "type": "text/plain" }, "url": { "path": [ "v2", "payouts", ":payout_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payout_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": "398b5d0b-e35a-4f78-801a-065100e28e84", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":payout_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payout_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 \"country\": \"MEXICO\",\n \"currency\": \"BRL\",\n \"createdAt\": \"\",\n \"amount\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"transactionId\": \"\",\n \"originId\": \"\",\n \"voucherId\": \"\",\n \"bank\": \"INFINIA\",\n \"updatedAt\": \"\",\n \"msgStatus\": \"\",\n \"sourceAccount\": {\n \"country\": \"\",\n \"bank\": \"\",\n \"currency\": \"\",\n \"accountNumber\": \"\",\n \"id\": \"\",\n \"label\": \"\"\n },\n \"destination\": {\n \"key_0\": true,\n \"key_1\": 8807\n },\n \"creditorAccount\": {\n \"number\": \"\",\n \"branch\": \"\",\n \"type\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"ownerName\": \"\",\n \"ownerDocument\": \"\",\n \"ownerDocumentType\": \"\"\n },\n \"extraInfo\": {\n \"key_0\": 2886,\n \"key_1\": true\n },\n \"callbackUrl\": \"\",\n \"createdAtIso\": \"\",\n \"updatedAtIso\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "444d7915-7ffd-4594-9cf1-14d47df1e15f", "name": "Bad Request", "originalRequest": { "url": { "path": [ ":payout_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payout_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": "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": "31b3f77e-1cff-4d32-aafc-1512e319042c", "name": "Forbidden", "originalRequest": { "url": { "path": [ ":payout_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payout_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": "7c83b834-3c43-43b0-996d-eb8e2c4e1513", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ ":payout_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payout_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 \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f234ffaa-c209-46cb-98fa-b5cb36c25291", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ ":payout_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payout_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 } } ] } ], "description": { "content": "Payouts", "type": "text/plain" }, "event": [] }, { "name": "Troubleshooting", "item": [ { "name": "Troubleshooting", "description": "", "item": [ { "id": "37da6152-d4f0-45be-b59e-2b650a6c1f44", "name": "Trace a deposit by rail reference", "request": { "name": "Trace a deposit by rail reference", "description": { "content": "Traces an incoming deposit to one of your virtual accounts by the reference on the payer's receipt, and tells you what happened to it: credited, still pending, rejected, expired, or settled on the payment rail but never credited.\n\nThe reference is the rail's own identifier for the transfer:\n\n- **BRL** — the Pix end-to-end ID, a 32-character code starting with `E`.\n- **ARS** — the Coelsa transfer ID.\n\nPix end-to-end IDs are often transcribed by hand, where the letter `O` and the digit `0` are easily confused, so for **BRL** those variations are tried as well. When the match came from a corrected reference, `typo_corrected` is `true` and `matched_reference` holds the reference that actually matched. Coelsa IDs are matched exactly, so for **ARS** `typo_corrected` is always `false`.\n\nThe lookup is read-only and scoped to the authenticated company and its sub-companies.", "type": "text/plain" }, "url": { "path": [ "v1", "troubleshooting", "deposits", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Rail of the deposit, which decides how `reference` is read.\n\n- `BRL` — Pix; the reference is the end-to-end ID.\n- `ARS` — Transferencias 3.0; the reference is the Coelsa transfer ID. (This can only be one of BRL,ARS)", "type": "text/plain" }, "key": "currency", "value": "ARS" }, { "disabled": false, "description": { "content": "(Required) The rail reference of the transfer, as shown on the payer's receipt.", "type": "text/plain" }, "key": "reference", "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": "8221df08-50dd-4010-be8c-2f57b767b13c", "name": "The lookup resolved; branch on `data.result`.", "originalRequest": { "url": { "path": [ "deposits", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Rail of the deposit, which decides how `reference` is read.\n\n- `BRL` — Pix; the reference is the end-to-end ID.\n- `ARS` — Transferencias 3.0; the reference is the Coelsa transfer ID. (This can only be one of BRL,ARS)", "type": "text/plain" }, "key": "currency", "value": "ARS" }, { "disabled": false, "description": { "content": "(Required) The rail reference of the transfer, as shown on the payer's receipt.", "type": "text/plain" }, "key": "reference", "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 \"currency\": \"ARS\",\n \"reference\": \"\",\n \"matched_reference\": \"\",\n \"typo_corrected\": \"\",\n \"result\": \"PENDING\",\n \"reason\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"sender\": {\n \"full_name\": \"\",\n \"document_number\": \"\",\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\"\n },\n \"rail_date\": \"\",\n \"expires_at\": \"\",\n \"movement\": {\n \"id\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"created_at\": \"\"\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d41ae521-2c85-4c3b-ba57-6e7990ff56b1", "name": "The reference is not valid for the rail, or the currency is not enabled for the company.", "originalRequest": { "url": { "path": [ "deposits", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Rail of the deposit, which decides how `reference` is read.\n\n- `BRL` — Pix; the reference is the end-to-end ID.\n- `ARS` — Transferencias 3.0; the reference is the Coelsa transfer ID. (This can only be one of BRL,ARS)", "type": "text/plain" }, "key": "currency", "value": "ARS" }, { "disabled": false, "description": { "content": "(Required) The rail reference of the transfer, as shown on the payer's receipt.", "type": "text/plain" }, "key": "reference", "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": "b4cad00f-76fd-46a6-a7fe-f2eeac3fe080", "name": "Invalid credentials.", "originalRequest": { "url": { "path": [ "deposits", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Rail of the deposit, which decides how `reference` is read.\n\n- `BRL` — Pix; the reference is the end-to-end ID.\n- `ARS` — Transferencias 3.0; the reference is the Coelsa transfer ID. (This can only be one of BRL,ARS)", "type": "text/plain" }, "key": "currency", "value": "ARS" }, { "disabled": false, "description": { "content": "(Required) The rail reference of the transfer, as shown on the payer's receipt.", "type": "text/plain" }, "key": "reference", "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": "Unauthorized", "code": 401, "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": "a980d58b-fcd8-41d2-a250-3cd400025d71", "name": "No record of the reference, on our side or on the rail.", "originalRequest": { "url": { "path": [ "deposits", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Rail of the deposit, which decides how `reference` is read.\n\n- `BRL` — Pix; the reference is the end-to-end ID.\n- `ARS` — Transferencias 3.0; the reference is the Coelsa transfer ID. (This can only be one of BRL,ARS)", "type": "text/plain" }, "key": "currency", "value": "ARS" }, { "disabled": false, "description": { "content": "(Required) The rail reference of the transfer, as shown on the payer's receipt.", "type": "text/plain" }, "key": "reference", "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": "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": "5cf6dbeb-af22-468e-a6cd-2546f251debe", "name": "Validation Error", "originalRequest": { "url": { "path": [ "deposits", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Rail of the deposit, which decides how `reference` is read.\n\n- `BRL` — Pix; the reference is the end-to-end ID.\n- `ARS` — Transferencias 3.0; the reference is the Coelsa transfer ID. (This can only be one of BRL,ARS)", "type": "text/plain" }, "key": "currency", "value": "ARS" }, { "disabled": false, "description": { "content": "(Required) The rail reference of the transfer, as shown on the payer's receipt.", "type": "text/plain" }, "key": "reference", "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 } } ] } ], "description": { "content": "Read-only lookups that trace transfers by their payment-rail reference.", "type": "text/plain" }, "event": [] }, { "name": "Webhooks", "item": [ { "name": "Webhooks", "description": "", "item": [ { "id": "c826900c-085c-4dfb-9f25-9d44bd1933ae", "name": "List Webhooks", "request": { "name": "List Webhooks", "description": { "content": "Retrieve a paginated list of webhooks.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "5195-94-71T45:64:31Z" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "5685-91-55T53:56:83" }, { "disabled": false, "description": { "content": "Filter by webhook status.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type.", "type": "text/plain" }, "key": "operation_type", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "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": "", "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": "a7c7df12-f19d-432e-a503-5600cb6a2695", "name": "Successful Response", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "5195-94-71T45:64:31Z" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "5685-91-55T53:56:83" }, { "disabled": false, "description": { "content": "Filter by webhook status.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type.", "type": "text/plain" }, "key": "operation_type", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "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": "", "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 \"id\": \"\",\n \"status\": \"PENDING\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"operation_type\": \"\",\n \"url\": \"\",\n \"last_response_status\": \"\",\n \"last_response_body\": {\n \"key_0\": \"string\"\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24727ad7-1101-4525-8640-636f9e3c1240", "name": "Bad Request", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "5195-94-71T45:64:31Z" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "5685-91-55T53:56:83" }, { "disabled": false, "description": { "content": "Filter by webhook status.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type.", "type": "text/plain" }, "key": "operation_type", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "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": "", "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": "2f432281-66eb-4ee8-9de8-57739559ce3d", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or after this time.", "type": "text/plain" }, "key": "date_from", "value": "5195-94-71T45:64:31Z" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp (UTC). Only include movements on or before this time.", "type": "text/plain" }, "key": "date_to", "value": "5685-91-55T53:56:83" }, { "disabled": false, "description": { "content": "Filter by webhook status.", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation type.", "type": "text/plain" }, "key": "operation_type", "value": "" }, { "disabled": false, "description": { "content": "If provided, only return movements with this operation ID.", "type": "text/plain" }, "key": "operation_id", "value": "" }, { "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": "", "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 \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e588dccf-d079-47bb-963a-ac9cafddc359", "name": "Update Webhook", "request": { "name": "Update Webhook", "description": { "content": "Updates an existing webhook's configuration or status. If the webhook is currently in an ERROR state, you can trigger a resend by updating its status to PENDING.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhook_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "webhook_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 \"status\": \"PENDING\",\n \"url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "7db27562-b8a5-4460-9256-7d12c3868be4", "name": "Successful Response", "originalRequest": { "url": { "path": [ ":webhook_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_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 \"status\": \"PENDING\",\n \"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 \"status\": \"PENDING\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"operation_type\": \"\",\n \"url\": \"\",\n \"last_response_status\": \"\",\n \"last_response_body\": {\n \"key_0\": \"string\"\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b951c2-a3e7-47b4-9a79-8f98da4d5c9a", "name": "Bad Request", "originalRequest": { "url": { "path": [ ":webhook_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_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 \"status\": \"PENDING\",\n \"url\": \"\"\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": "2884901d-f4e3-4058-9af0-7fc1baf3a5c6", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ ":webhook_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_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 \"status\": \"PENDING\",\n \"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 \"message\": \"\",\n \"status\": \"error\",\n \"error_code\": \"\",\n \"trace_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "description": { "content": "Manage your webhooks", "type": "text/plain" }, "event": [] } ], "variable": [ { "key": "baseUrl", "value": "https://app2test.infiniaweb.com/infinia_api", "type": "string" } ] }