{ "item": [ { "id": "a2a380c5-ae86-4af3-b656-4079cc1a5e25", "name": "Authentication Token", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a0c5372c-5749-4c80-9fa8-000d960eb015", "name": "Token", "request": { "name": "Token", "description": { "content": "Azure Entra application authentication token.", "type": "text/plain" }, "url": { "path": [ "auth", "v1", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"clientSecret\": \"\",\n \"clientId\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31086080-4982-46a1-ade0-c70859ca9586", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "auth", "v1", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSecret\": \"\",\n \"clientId\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tokenType\": \"string\",\n \"expiresIn\": 8498.747067716527,\n \"token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "424038d7-96f2-423b-a593-71b85f39f364", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "auth", "v1", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSecret\": \"\",\n \"clientId\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76cb6402-20a4-4a9b-9d22-7c6478f9127c", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "auth", "v1", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSecret\": \"\",\n \"clientId\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "878eb322-9394-4dbf-8173-bf77a3cb5e7e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "auth", "v1", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSecret\": \"\",\n \"clientId\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37cf298b-5e4d-4d81-80ee-b5ab9422401b", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "auth", "v1", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientSecret\": \"\",\n \"clientId\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bb8c1cad-395a-42d5-b104-f2e96adfa8e1", "name": "Postback", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b2a40e63-632b-4460-a496-af74b43e84d9", "name": "Your postback notification for an order.", "request": { "name": "Your postback notification for an order.", "description": { "content": "\nEvery time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.\n\n**We expect that your system returns to ours: status code 200.** \nIf not, we'll retry 6 more times.\n", "type": "text/plain" }, "url": { "path": [ "order", "example-postback-to-order", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"status\": \"\",\n \"paidAt\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"message\": \"\",\n \"customerMessage\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"name\": \"\",\n \"ispb\": \"\",\n \"code\": \"\",\n \"account\": \"\",\n \"branch\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"payer\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a98813b3-753b-41a1-bc03-f95b55b4b939", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "example-postback-to-order", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"status\": \"\",\n \"paidAt\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"message\": \"\",\n \"customerMessage\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"name\": \"\",\n \"ispb\": \"\",\n \"code\": \"\",\n \"account\": \"\",\n \"branch\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"payer\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"returnCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9617d203-7894-4f93-ade5-b6c73a1e868e", "name": "Your postback notification for a checkout order.", "request": { "name": "Your postback notification for a checkout order.", "description": { "content": "\nEvery time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.\n\n**We expect that your system returns to ours: status code 200.** \nIf not, we'll retry 6 more times.\n", "type": "text/plain" }, "url": { "path": [ "order", "example-postback-to-checkout", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"status\": \"\",\n \"paidAt\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"orderId\": \"\",\n \"message\": \"\",\n \"customerMessage\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"name\": \"\",\n \"ispb\": \"\",\n \"code\": \"\",\n \"account\": \"\",\n \"branch\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"payer\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2c72b1c-93f0-4b5a-ac6a-59e2f180fe95", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "example-postback-to-checkout", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"status\": \"\",\n \"paidAt\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"orderId\": \"\",\n \"message\": \"\",\n \"customerMessage\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"name\": \"\",\n \"ispb\": \"\",\n \"code\": \"\",\n \"account\": \"\",\n \"branch\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"payer\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"returnCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "174fe7d0-9715-4ecb-b74a-44b43a7ebf30", "name": "Banking - Postback", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7dc8b9d9-d7cc-4ab0-b0fb-4b0a6173660f", "name": "Your postback notification for a banking payin.", "request": { "name": "Your postback notification for a banking payin.", "description": { "content": "\nEvery time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.\n\n**We expect that your system returns to ours: status code 200.** \nIf not, we'll retry 6 more times.\n", "type": "text/plain" }, "url": { "path": [ "order", "example-postback-to-banking-order-payin", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"event\": \"\",\n \"status\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"paidAt\": \"\",\n \"endToEndId\": \"\",\n \"customerMessage\": \"\",\n \"description\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f6cca582-6878-4500-81f2-8ac0cf016c70", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "example-postback-to-banking-order-payin", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"event\": \"\",\n \"status\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"paidAt\": \"\",\n \"endToEndId\": \"\",\n \"customerMessage\": \"\",\n \"description\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"returnCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84b3077c-0d57-4151-a51c-9cb0097b7e10", "name": "Your postback notification for a banking payout.", "request": { "name": "Your postback notification for a banking payout.", "description": { "content": "\nEvery time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.\n\n**We expect that your system returns to ours: status code 200.** \nIf not, we'll retry 6 more times.\n", "type": "text/plain" }, "url": { "path": [ "order", "example-postback-to-banking-order-payout", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"event\": \"\",\n \"status\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"receiver\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"paidAt\": \"\",\n \"endToEndId\": \"\",\n \"description\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bf013701-9478-445d-abfb-1c6554646519", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "example-postback-to-banking-order-payout", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"code\": \"\",\n \"event\": \"\",\n \"status\": \"\",\n \"updatedAt\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"receiver\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n },\n \"paidAt\": \"\",\n \"endToEndId\": \"\",\n \"description\": \"\",\n \"ownerBank\": {\n \"name\": \"\",\n \"document\": \"\",\n \"bank\": {\n \"ispb\": \"\",\n \"name\": \"\",\n \"branch\": \"\",\n \"account\": \"\",\n \"accountType\": \"\",\n \"code\": \"\",\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"returnCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e1e319a-971a-4e8a-8564-3a48e48af221", "name": "Your postback notification for approved banking account requests.", "request": { "name": "Your postback notification for approved banking account requests.", "description": { "content": "\nEvery time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.\n\n**We expect that your system returns to ours: status code 200.** \nIf not, we'll retry 6 more times.\n", "type": "text/plain" }, "url": { "path": [ "order", "example-postback-to-banking-account-created", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"event\": \"\",\n \"occurredAt\": \"\",\n \"requestId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"bankData\": {\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"createdAt\": \"\",\n \"ispb\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3b07898f-e58f-46d3-895c-5c68672d5e59", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "example-postback-to-banking-account-created", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"event\": \"\",\n \"occurredAt\": \"\",\n \"requestId\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"bankData\": {\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"createdAt\": \"\",\n \"ispb\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"returnCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63e351f0-5bbf-4a52-91e3-12908d1f97fd", "name": "Your postback notification for rejected banking account requests.", "request": { "name": "Your postback notification for rejected banking account requests.", "description": { "content": "\nEvery time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.\n\n**We expect that your system returns to ours: status code 200.** \nIf not, we'll retry 6 more times.\n", "type": "text/plain" }, "url": { "path": [ "order", "example-postback-to-banking-account-rejected", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"occurredAt\": \"\",\n \"requestId\": \"\",\n \"status\": \"\",\n \"reason\": {\n \"code\": \"\",\n \"description\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cd9bd629-bf0f-4686-ac28-6ade4549f020", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "example-postback-to-banking-account-rejected", "[your_notification_url]" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"occurredAt\": \"\",\n \"requestId\": \"\",\n \"status\": \"\",\n \"reason\": {\n \"code\": \"\",\n \"description\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"returnCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "159dff55-f226-4f89-80fd-0b114674d8e7", "name": "Order", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a366f4a4-309c-4df7-a260-f5cbe2f60d89", "name": "Get a list of your orders", "request": { "name": "Get a list of your orders", "description": { "content": "Get a list of your orders based the data entered as a filter.\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "Unique identifier of the order." }, { "disabled": false, "key": "idempotencyKey", "value": "", "description": "IdempotencyKey to filter." }, { "disabled": false, "key": "code", "value": "", "description": "Order code." }, { "disabled": false, "key": "customerEmail", "value": "", "description": "Customer email." }, { "disabled": false, "key": "customerName", "value": "", "description": "Customer name" }, { "disabled": false, "key": "customerDocumentNumber", "value": "", "description": "Customer document number" }, { "disabled": false, "key": "status", "value": "", "description": "Order status." }, { "disabled": false, "key": "paymentMethod", "value": "", "description": "Payment method." }, { "disabled": false, "key": "startDate", "value": "", "description": "(Required) The search start date, in the following format YYYY-MM-DD. It is required if no id, code, or idempotency key is provided." }, { "disabled": false, "key": "endDate", "value": "", "description": "(Required) The search end date, in the following format YYYY-MM-DD. It is required if no id, code, or idempotency key is provided" }, { "disabled": false, "key": "sortBy", "value": "", "description": "(Required) Field to be used as sort." }, { "disabled": false, "key": "direction", "value": "", "description": "(Required) Direction of the sort." }, { "disabled": false, "key": "page", "value": "", "description": "(Required) The page to return." }, { "disabled": false, "key": "perPage", "value": "", "description": "(Required) The record count per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b57b35d1-57da-4683-83d6-6da9636dfcba", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "code", "value": "" }, { "key": "customerEmail", "value": "" }, { "key": "customerName", "value": "" }, { "key": "customerDocumentNumber", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentMethod", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "sortBy", "value": "" }, { "key": "direction", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"orders\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"code\": \"string\",\n \"customer\": {\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"document\": {\n \"type\": \"CURP\",\n \"number\": \"string\"\n }\n },\n \"amount\": {\n \"currency\": \"BUSD\",\n \"value\": \"string\"\n },\n \"baseAmount\": {\n \"currency\": \"USD\",\n \"value\": \"string\"\n },\n \"createdAt\": \"string\",\n \"paymentMethod\": \"DEPOSIT\",\n \"payment\": {\n \"id\": \"string\",\n \"qrcodeLink\": \"string\",\n \"qrcodeData\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"deeplink\": \"string\",\n \"universalUrl\": \"string\",\n \"returnUrl\": \"string\",\n \"barcode\": \"string\",\n \"expireDateTime\": \"string\",\n \"digitableLine\": \"string\",\n \"token\": \"string\"\n },\n \"feeAdd\": \"string\",\n \"feeFix\": \"string\",\n \"feeVar\": \"string\",\n \"amountClient\": \"string\",\n \"financialPartner\": \"string\",\n \"canceledAt\": \"string\",\n \"errorMessage\": \"string\",\n \"status\": \"REFUNDED\",\n \"paidAt\": \"string\",\n \"refundedAt\": \"string\",\n \"expiredAt\": \"string\",\n \"compensatedAt\": \"string\",\n \"settledAt\": \"string\",\n \"ownerBank\": {\n \"name\": \"string\",\n \"document\": \"string\",\n \"bank\": {\n \"name\": \"string\",\n \"ispb\": \"string\",\n \"code\": \"string\",\n \"account\": \"string\",\n \"branch\": \"string\",\n \"pix\": {\n \"type\": \"RANDOM\",\n \"key\": \"string\"\n }\n }\n },\n \"payer\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"CNPJ\",\n \"number\": \"string\"\n },\n \"bank\": {\n \"ispb\": \"string\",\n \"name\": \"string\",\n \"branch\": \"string\",\n \"account\": \"string\",\n \"accountType\": \"WAGE_ACCOUNT\",\n \"code\": \"string\",\n \"pix\": {\n \"type\": \"EMAIL\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 7133.081980902076,\n \"paidCount\": 6216.7682866900395,\n \"failedCount\": 4095.6553323413145,\n \"pendingCount\": 2327.009621879188,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 5686.1852054175115,\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 692.6429486380026,\n \"amount\": \"string\",\n \"status\": \"ANALYSIS\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"code\": \"string\",\n \"customer\": {\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"document\": {\n \"type\": \"RFC\",\n \"number\": \"string\"\n }\n },\n \"amount\": {\n \"currency\": \"USDT\",\n \"value\": \"string\"\n },\n \"baseAmount\": {\n \"currency\": \"USD\",\n \"value\": \"string\"\n },\n \"createdAt\": \"string\",\n \"paymentMethod\": \"PIX\",\n \"payment\": {\n \"id\": \"string\",\n \"qrcodeLink\": \"string\",\n \"qrcodeData\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"deeplink\": \"string\",\n \"universalUrl\": \"string\",\n \"returnUrl\": \"string\",\n \"barcode\": \"string\",\n \"expireDateTime\": \"string\",\n \"digitableLine\": \"string\",\n \"token\": \"string\"\n },\n \"feeAdd\": \"string\",\n \"feeFix\": \"string\",\n \"feeVar\": \"string\",\n \"amountClient\": \"string\",\n \"financialPartner\": \"string\",\n \"canceledAt\": \"string\",\n \"errorMessage\": \"string\",\n \"status\": \"INITIAL\",\n \"paidAt\": \"string\",\n \"refundedAt\": \"string\",\n \"expiredAt\": \"string\",\n \"compensatedAt\": \"string\",\n \"settledAt\": \"string\",\n \"ownerBank\": {\n \"name\": \"string\",\n \"document\": \"string\",\n \"bank\": {\n \"name\": \"string\",\n \"ispb\": \"string\",\n \"code\": \"string\",\n \"account\": \"string\",\n \"branch\": \"string\",\n \"pix\": {\n \"type\": \"EMAIL\",\n \"key\": \"string\"\n }\n }\n },\n \"payer\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"CPF\",\n \"number\": \"string\"\n },\n \"bank\": {\n \"ispb\": \"string\",\n \"name\": \"string\",\n \"branch\": \"string\",\n \"account\": \"string\",\n \"accountType\": \"WAGE_ACCOUNT\",\n \"code\": \"string\",\n \"pix\": {\n \"type\": \"PHONE\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 4106.546198825156,\n \"paidCount\": 9099.753081223404,\n \"failedCount\": 1583.317862283149,\n \"pendingCount\": 9951.264524295675,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 7882.4687659893525,\n \"amount\": \"string\",\n \"status\": \"ANALYSIS\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 6855.463358925067,\n \"amount\": \"string\",\n \"status\": \"ERROR\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n }\n ],\n \"currentPage\": 2637.556405021373,\n \"perPage\": 378.4878731295871\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6d64979-4132-4efa-a1a3-7fecd9afe963", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "code", "value": "" }, { "key": "customerEmail", "value": "" }, { "key": "customerName", "value": "" }, { "key": "customerDocumentNumber", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentMethod", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "sortBy", "value": "" }, { "key": "direction", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c68decd3-f8d8-42c0-aaa7-4427d6f53157", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "code", "value": "" }, { "key": "customerEmail", "value": "" }, { "key": "customerName", "value": "" }, { "key": "customerDocumentNumber", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentMethod", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "sortBy", "value": "" }, { "key": "direction", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c11801-00a4-472c-a1d9-a343d8ffe318", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "code", "value": "" }, { "key": "customerEmail", "value": "" }, { "key": "customerName", "value": "" }, { "key": "customerDocumentNumber", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentMethod", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "sortBy", "value": "" }, { "key": "direction", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89659911-f280-4bc7-aebc-d4b891879222", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "order" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "code", "value": "" }, { "key": "customerEmail", "value": "" }, { "key": "customerName", "value": "" }, { "key": "customerDocumentNumber", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentMethod", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "sortBy", "value": "" }, { "key": "direction", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43854bbe-cd95-4585-a9d6-bfa8357a1361", "name": "Check transaction status", "request": { "name": "Check transaction status", "description": { "content": "You can check the transaction status at any time.\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "order", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3214140d-d606-4fe7-8a45-21a30d361be7", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "order", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"code\": \"string\",\n \"customer\": {\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"document\": {\n \"type\": \"RFC\",\n \"number\": \"string\"\n }\n },\n \"amount\": {\n \"currency\": \"BRL\",\n \"value\": \"string\"\n },\n \"baseAmount\": {\n \"currency\": \"USDT\",\n \"value\": \"string\"\n },\n \"createdAt\": \"string\",\n \"paymentMethod\": \"BOLETO\",\n \"payment\": {\n \"id\": \"string\",\n \"qrcodeLink\": \"string\",\n \"qrcodeData\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"deeplink\": \"string\",\n \"universalUrl\": \"string\",\n \"returnUrl\": \"string\",\n \"barcode\": \"string\",\n \"expireDateTime\": \"string\",\n \"digitableLine\": \"string\",\n \"token\": \"string\"\n },\n \"feeAdd\": \"string\",\n \"feeFix\": \"string\",\n \"feeVar\": \"string\",\n \"amountClient\": \"string\",\n \"financialPartner\": \"string\",\n \"canceledAt\": \"string\",\n \"errorMessage\": \"string\",\n \"status\": \"PENDING\",\n \"paidAt\": \"string\",\n \"refundedAt\": \"string\",\n \"expiredAt\": \"string\",\n \"compensatedAt\": \"string\",\n \"settledAt\": \"string\",\n \"ownerBank\": {\n \"name\": \"string\",\n \"document\": \"string\",\n \"bank\": {\n \"name\": \"string\",\n \"ispb\": \"string\",\n \"code\": \"string\",\n \"account\": \"string\",\n \"branch\": \"string\",\n \"pix\": {\n \"type\": \"RANDOM\",\n \"key\": \"string\"\n }\n }\n },\n \"payer\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"RUC\",\n \"number\": \"string\"\n },\n \"bank\": {\n \"ispb\": \"string\",\n \"name\": \"string\",\n \"branch\": \"string\",\n \"account\": \"string\",\n \"accountType\": \"SAVINGS_ACCOUNT\",\n \"code\": \"string\",\n \"pix\": {\n \"type\": \"EMAIL\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 928.8154671786231,\n \"paidCount\": 5841.731069400451,\n \"failedCount\": 4116.804031295766,\n \"pendingCount\": 3598.6390305159644,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 2518.206619178851,\n \"amount\": \"string\",\n \"status\": \"ERROR\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 7264.359688988291,\n \"amount\": \"string\",\n \"status\": \"ERROR\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba00a1b-25f5-4482-8d52-61d4e09b9359", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "order", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18fafa7d-8165-43c8-b6aa-3f4fb4a671ea", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "order", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46850b90-7ca3-4226-98c1-88d84a27637e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "order", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0acf9ca2-93a8-4174-a389-e88ad49f594e", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "order", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f135b3dc-ceb3-4154-a8e7-a5bfa2448ed4", "name": "Create Transparent Order - V1", "request": { "name": "Create Transparent Order - V1", "description": { "content": "The transaction is called transparent as it has no interface and/or screen that your customer should interact with.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"ip\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"returnUrl\": \"\",\n \"financialPartner\": \"\",\n \"expiration\": \"\",\n \"specialPaymentDetails\": {\n \"card3DSToken\": \"\",\n \"cardToken\": \"\",\n \"creditCard\": {\n \"holderName\": \"\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expirationDate\": \"\",\n \"brand\": \"\",\n \"installments\": \"\",\n \"holderDocument\": \"\",\n \"skipThreeDSecure\": true\n },\n \"installmentsNumber\": \"\",\n \"browser\": {\n \"httpAcceptBrowserValue\": \"\",\n \"httpAcceptContent\": \"\",\n \"httpBrowserLanguage\": \"\",\n \"httpBrowserJavaEnabled\": \"\",\n \"httpBrowserJavaScriptEnabled\": \"\",\n \"httpBrowserColorDepth\": \"\",\n \"httpBrowserScreenHeight\": \"\",\n \"httpBrowserScreenWidth\": \"\",\n \"httpBrowserTimeDifference\": \"\",\n \"userAgentBrowserValue\": \"\"\n }\n },\n \"bankSlug\": \"\"\n },\n \"merchant\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "74d790da-aff1-4941-9e40-34262ed47001", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"ip\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"returnUrl\": \"\",\n \"financialPartner\": \"\",\n \"expiration\": \"\",\n \"specialPaymentDetails\": {\n \"card3DSToken\": \"\",\n \"cardToken\": \"\",\n \"creditCard\": {\n \"holderName\": \"\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expirationDate\": \"\",\n \"brand\": \"\",\n \"installments\": \"\",\n \"holderDocument\": \"\",\n \"skipThreeDSecure\": true\n },\n \"installmentsNumber\": \"\",\n \"browser\": {\n \"httpAcceptBrowserValue\": \"\",\n \"httpAcceptContent\": \"\",\n \"httpBrowserLanguage\": \"\",\n \"httpBrowserJavaEnabled\": \"\",\n \"httpBrowserJavaScriptEnabled\": \"\",\n \"httpBrowserColorDepth\": \"\",\n \"httpBrowserScreenHeight\": \"\",\n \"httpBrowserScreenWidth\": \"\",\n \"httpBrowserTimeDifference\": \"\",\n \"userAgentBrowserValue\": \"\"\n }\n },\n \"bankSlug\": \"\"\n },\n \"merchant\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"string\",\n \"status\": \"string\",\n \"universalLink\": \"string\",\n \"amountToPay\": \"string\",\n \"description\": \"string\",\n \"bankAccount\": {\n \"clabe\": \"string\",\n \"beneficiary\": \"string\",\n \"bankCode\": \"string\"\n },\n \"qrcodeLink\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"qrcodeData\": \"string\",\n \"expireDateTime\": \"string\",\n \"deepLink\": \"string\",\n \"challengeUrl\": \"string\",\n \"challengeAccessToken\": \"string\",\n \"challengeSetupUrl\": \"string\",\n \"challengeSetupAccessToken\": \"string\",\n \"challengeStatus\": \"string\",\n \"checkoutLink\": \"string\",\n \"token\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"errorMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e370d60b-40b6-4bb0-94e1-f8047ef6eb80", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"ip\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"returnUrl\": \"\",\n \"financialPartner\": \"\",\n \"expiration\": \"\",\n \"specialPaymentDetails\": {\n \"card3DSToken\": \"\",\n \"cardToken\": \"\",\n \"creditCard\": {\n \"holderName\": \"\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expirationDate\": \"\",\n \"brand\": \"\",\n \"installments\": \"\",\n \"holderDocument\": \"\",\n \"skipThreeDSecure\": true\n },\n \"installmentsNumber\": \"\",\n \"browser\": {\n \"httpAcceptBrowserValue\": \"\",\n \"httpAcceptContent\": \"\",\n \"httpBrowserLanguage\": \"\",\n \"httpBrowserJavaEnabled\": \"\",\n \"httpBrowserJavaScriptEnabled\": \"\",\n \"httpBrowserColorDepth\": \"\",\n \"httpBrowserScreenHeight\": \"\",\n \"httpBrowserScreenWidth\": \"\",\n \"httpBrowserTimeDifference\": \"\",\n \"userAgentBrowserValue\": \"\"\n }\n },\n \"bankSlug\": \"\"\n },\n \"merchant\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92c6b23f-c90c-44b7-aa10-12dc4bfdb56b", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"ip\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"returnUrl\": \"\",\n \"financialPartner\": \"\",\n \"expiration\": \"\",\n \"specialPaymentDetails\": {\n \"card3DSToken\": \"\",\n \"cardToken\": \"\",\n \"creditCard\": {\n \"holderName\": \"\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expirationDate\": \"\",\n \"brand\": \"\",\n \"installments\": \"\",\n \"holderDocument\": \"\",\n \"skipThreeDSecure\": true\n },\n \"installmentsNumber\": \"\",\n \"browser\": {\n \"httpAcceptBrowserValue\": \"\",\n \"httpAcceptContent\": \"\",\n \"httpBrowserLanguage\": \"\",\n \"httpBrowserJavaEnabled\": \"\",\n \"httpBrowserJavaScriptEnabled\": \"\",\n \"httpBrowserColorDepth\": \"\",\n \"httpBrowserScreenHeight\": \"\",\n \"httpBrowserScreenWidth\": \"\",\n \"httpBrowserTimeDifference\": \"\",\n \"userAgentBrowserValue\": \"\"\n }\n },\n \"bankSlug\": \"\"\n },\n \"merchant\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9d5c69c-459c-4059-85d8-a8962e73d860", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"ip\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"returnUrl\": \"\",\n \"financialPartner\": \"\",\n \"expiration\": \"\",\n \"specialPaymentDetails\": {\n \"card3DSToken\": \"\",\n \"cardToken\": \"\",\n \"creditCard\": {\n \"holderName\": \"\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expirationDate\": \"\",\n \"brand\": \"\",\n \"installments\": \"\",\n \"holderDocument\": \"\",\n \"skipThreeDSecure\": true\n },\n \"installmentsNumber\": \"\",\n \"browser\": {\n \"httpAcceptBrowserValue\": \"\",\n \"httpAcceptContent\": \"\",\n \"httpBrowserLanguage\": \"\",\n \"httpBrowserJavaEnabled\": \"\",\n \"httpBrowserJavaScriptEnabled\": \"\",\n \"httpBrowserColorDepth\": \"\",\n \"httpBrowserScreenHeight\": \"\",\n \"httpBrowserScreenWidth\": \"\",\n \"httpBrowserTimeDifference\": \"\",\n \"userAgentBrowserValue\": \"\"\n }\n },\n \"bankSlug\": \"\"\n },\n \"merchant\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "896a091b-2704-4f40-ad59-63410cf6e22e", "name": "Refund an order - V1", "request": { "name": "Refund an order - V1", "description": { "content": "Refund an order\n by the way only order with payment methods BINANCE_PAY, PIX and SPEI are allowed to refund.\n For other payment methods, we are implementing them.\n\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\"\n ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31506a57-8fbb-4457-8225-d361b72726f3", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"orderId\": \"string\",\n \"amount\": \"string\",\n \"reason\": \"string\",\n \"requestedBy\": {\n \"name\": \"string\",\n \"email\": \"string\"\n },\n \"status\": \"string\",\n \"createdAt\": \"string\",\n \"endToEndId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b20257fe-b872-4e22-841f-2c1979a5bb6b", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43b2cee3-48ca-45d6-9044-e95c5d9fbca7", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b07b00b-9c45-4a51-9322-d92c0df381db", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d833654-e28d-4c8f-a33f-260f8f419640", "name": "Get refund by id", "request": { "name": "Get refund by id", "description": { "content": "Returns a refund information", "type": "text/plain" }, "url": { "path": [ "order", "v1", "refund", ":refundId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "refundId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ac7a222b-b57b-4dd7-a447-3bf541d11cc8", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "refund", ":refundId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "refundId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"orderId\": \"string\",\n \"amount\": \"string\",\n \"reason\": \"string\",\n \"requestedBy\": {\n \"name\": \"string\",\n \"email\": \"string\"\n },\n \"status\": \"string\",\n \"createdAt\": \"string\",\n \"endToEndId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "352e4cc9-b5e7-42fe-af76-6dbb96a02462", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "refund", ":refundId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "refundId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b822ca-cc81-4ce9-86ac-58911b38e203", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "refund", ":refundId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "refundId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5dc373b-085f-4bc9-bf4f-246284a5a119", "name": "Get refunds by filter", "request": { "name": "Get refunds by filter", "description": { "content": "Returns the information of all refunds according to the filter\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\"", "type": "text/plain" }, "url": { "path": [ "order", "v1", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "The id of the refund" }, { "disabled": false, "key": "idempotencyKey", "value": "", "description": "The idempotency key of the refund" }, { "disabled": false, "key": "status", "value": "", "description": "The status of the refund" }, { "disabled": false, "key": "orderId", "value": "", "description": "The id of the order" }, { "disabled": false, "key": "startDate", "value": "", "description": "(Required) The search start date, in the following format YYYY-MM-DD. It is required if no id, order id, or idempotency key is provided." }, { "disabled": false, "key": "endDate", "value": "", "description": "(Required) The search end date, in the following format YYYY-MM-DD. It is required if no id, order id, or idempotency key is provided" }, { "disabled": false, "key": "page", "value": "", "description": "(Required) The page to return." }, { "disabled": false, "key": "perPage", "value": "", "description": "(Required) The record count per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7b729c27-5475-4480-a630-a833abf6f5e0", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "status", "value": "" }, { "key": "orderId", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"orderId\": \"string\",\n \"amount\": {\n \"currency\": \"USDT\",\n \"value\": \"string\"\n },\n \"status\": \"REJECTED\",\n \"type\": \"FULL\",\n \"operationType\": \"PAYOUT\",\n \"reason\": \"string\",\n \"endToEndId\": \"string\",\n \"errorMessages\": [\n \"string\",\n \"string\"\n ],\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n },\n {\n \"id\": \"string\",\n \"orderId\": \"string\",\n \"amount\": {\n \"currency\": \"USDT\",\n \"value\": \"string\"\n },\n \"status\": \"SUCCESS\",\n \"type\": \"FULL\",\n \"operationType\": \"PAYOUT\",\n \"reason\": \"string\",\n \"endToEndId\": \"string\",\n \"errorMessages\": [\n \"string\",\n \"string\"\n ],\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca76b1a3-0530-46b0-b29f-04618d46a051", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "status", "value": "" }, { "key": "orderId", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce9b8688-2131-4c73-9b4e-0c46bc95b28f", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" }, { "key": "idempotencyKey", "value": "" }, { "key": "status", "value": "" }, { "key": "orderId", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "page", "value": "" }, { "key": "perPage", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b57c1c74-6bb8-4863-9f8c-36fc7c5e3ddf", "name": "Create Transparent Order - V2", "request": { "name": "Create Transparent Order - V2", "description": { "content": "The transaction is called transparent as it has no interface and/or screen that your customer should interact with.\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" \n ", "type": "text/plain" }, "url": { "path": [ "order", "v2", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"ip\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"returnUrl\": \"\",\n \"financialPartner\": \"\",\n \"expiration\": \"\",\n \"specialPaymentDetails\": {\n \"card3DSToken\": \"\",\n \"cardToken\": \"\",\n \"creditCard\": {\n \"holderName\": \"\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expirationDate\": \"\",\n \"brand\": \"\",\n \"installments\": \"\",\n \"holderDocument\": \"\",\n \"skipThreeDSecure\": true\n },\n \"installmentsNumber\": \"\",\n \"browser\": {\n \"httpAcceptBrowserValue\": \"\",\n \"httpAcceptContent\": \"\",\n \"httpBrowserLanguage\": \"\",\n \"httpBrowserJavaEnabled\": \"\",\n \"httpBrowserJavaScriptEnabled\": \"\",\n \"httpBrowserColorDepth\": \"\",\n \"httpBrowserScreenHeight\": \"\",\n \"httpBrowserScreenWidth\": \"\",\n \"httpBrowserTimeDifference\": \"\",\n \"userAgentBrowserValue\": \"\"\n }\n },\n \"bankSlug\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "99e9c197-60ae-4619-97ff-cfd346e2e2ff", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v2", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"string\",\n \"status\": \"string\",\n \"universalLink\": \"string\",\n \"amountToPay\": \"string\",\n \"description\": \"string\",\n \"bankAccount\": {\n \"clabe\": \"string\",\n \"beneficiary\": \"string\",\n \"bankCode\": \"string\"\n },\n \"qrcodeLink\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"qrcodeData\": \"string\",\n \"expireDateTime\": \"string\",\n \"deepLink\": \"string\",\n \"challengeUrl\": \"string\",\n \"challengeAccessToken\": \"string\",\n \"challengeSetupUrl\": \"string\",\n \"challengeSetupAccessToken\": \"string\",\n \"challengeStatus\": \"string\",\n \"checkoutLink\": \"string\",\n \"token\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"errorMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "888c2759-a193-4a4f-a300-06306f56bb99", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v2", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cae027a-7b61-4d80-844a-c3eccc1ac3f5", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v2", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1a60869-45d9-43cb-bfb1-ecba93a84f07", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v2", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d99be312-e5c0-47be-af97-540eb17e3d4f", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v2", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8d74a41-35da-4af8-874b-c47ad994440b", "name": "Refund an order - V2", "request": { "name": "Refund an order - V2", "description": { "content": "Refund an order\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\"\n ", "type": "text/plain" }, "url": { "path": [ "order", "v2", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n },\n \"amount\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5a56969d-9160-4acc-9f25-5a563b566ac4", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v2", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n },\n \"amount\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"orderId\": \"string\",\n \"amount\": \"string\",\n \"reason\": \"string\",\n \"requestedBy\": {\n \"name\": \"string\",\n \"email\": \"string\"\n },\n \"status\": \"string\",\n \"createdAt\": \"string\",\n \"endToEndId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e1233b0-72e6-4f2c-8c47-5ce9953bddd7", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v2", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n },\n \"amount\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a75d1fde-71b1-4585-ad2b-b5a313ff0e75", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v2", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n },\n \"amount\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b00146f9-4c2a-47c2-84cc-c3bfcfd4ec39", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v2", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"reason\": \"\",\n \"requestedBy\": {\n \"name\": \"\",\n \"email\": \"\"\n },\n \"amount\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77f7b988-2b20-48e5-ab02-5adff2a99b4f", "name": "Create Transparent Order - V3", "request": { "name": "Create Transparent Order - V3", "description": { "content": "The transaction is called transparent as it has no interface and/or screen that your customer should interact with.\n This version all order will be validated by AML process, to prevent frauds.\n\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\"\n ", "type": "text/plain" }, "url": { "path": [ "order", "v3", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"ip\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"returnUrl\": \"\",\n \"financialPartner\": \"\",\n \"expiration\": \"\",\n \"specialPaymentDetails\": {\n \"card3DSToken\": \"\",\n \"cardToken\": \"\",\n \"creditCard\": {\n \"holderName\": \"\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expirationDate\": \"\",\n \"brand\": \"\",\n \"installments\": \"\",\n \"holderDocument\": \"\",\n \"skipThreeDSecure\": true\n },\n \"installmentsNumber\": \"\",\n \"browser\": {\n \"httpAcceptBrowserValue\": \"\",\n \"httpAcceptContent\": \"\",\n \"httpBrowserLanguage\": \"\",\n \"httpBrowserJavaEnabled\": \"\",\n \"httpBrowserJavaScriptEnabled\": \"\",\n \"httpBrowserColorDepth\": \"\",\n \"httpBrowserScreenHeight\": \"\",\n \"httpBrowserScreenWidth\": \"\",\n \"httpBrowserTimeDifference\": \"\",\n \"userAgentBrowserValue\": \"\"\n }\n },\n \"bankSlug\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "270436c6-1849-4af0-b324-7e0f7de70979", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v3", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"string\",\n \"status\": \"string\",\n \"universalLink\": \"string\",\n \"amountToPay\": \"string\",\n \"description\": \"string\",\n \"bankAccount\": {\n \"clabe\": \"string\",\n \"beneficiary\": \"string\",\n \"bankCode\": \"string\"\n },\n \"qrcodeLink\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"qrcodeData\": \"string\",\n \"expireDateTime\": \"string\",\n \"deepLink\": \"string\",\n \"challengeUrl\": \"string\",\n \"challengeAccessToken\": \"string\",\n \"challengeSetupUrl\": \"string\",\n \"challengeSetupAccessToken\": \"string\",\n \"challengeStatus\": \"string\",\n \"checkoutLink\": \"string\",\n \"token\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"errorMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1bfb3c2-494c-49ca-b1e4-e37dda04ced2", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v3", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a11d7b27-9fb8-4734-8e64-a63e200b544d", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v3", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38d6aa59-1872-4a11-b1ec-03d09db217ba", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v3", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ef06779-ecbb-499c-a9b1-0d271fb781c5", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v3", "transparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42839514-7300-4205-b0cc-2f9ce3ba3660", "name": "Force update a order status and receive postback webhook.", "request": { "name": "Force update a order status and receive postback webhook.", "description": {}, "url": { "path": [ "order-tools", "v1", "order", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5627939c-c9d6-433f-8d32-cf55bd69c53a", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order-tools", "v1", "order", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c08bb65-7ca9-4767-81bd-1da40a00b90e", "originalRequest": { "url": { "path": [ "order-tools", "v1", "order", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d8e2f36-2a2e-4f62-ba6f-727b4512bde0", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order-tools", "v1", "order", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "318e7072-0dec-4b05-9a2e-377e5d4514f9", "name": "Payout", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b3497c93-4367-4d67-bb92-4ee2f3777d26", "name": "Brazil payout - V1", "request": { "name": "Brazil payout - V1", "description": { "content": "\n\t Request a payout for Brazil country\n\t \n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" \n\t ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a98c1fce-f17a-4c6e-8af5-9a42c6aa04fa", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 5945.00124546912,\n \"paidCount\": 5423.381587391967,\n \"failedCount\": 1250.7099817632538,\n \"pendingCount\": 811.1182338328282,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 8644.571646002822,\n \"amount\": \"string\",\n \"status\": \"PENDING\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 849.9339563255503,\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb19a5b7-76c9-40cf-9b3c-ad427b8c6ed2", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fd8fe56-e0d2-4b05-aff5-df5116a555f0", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29cf7cd7-ee27-4a64-8d4f-33e80bf34e6b", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12bd521c-3968-40df-939a-e3c1f5eb9cfc", "name": "Get Brazil payout data by id", "request": { "name": "Get Brazil payout data by id", "description": { "content": " \n\t \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" \n\t ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "payout", "brazil", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "01548141-e87e-4ee6-8179-d7564f1be089", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"description\": \"string\",\n \"amount\": \"string\",\n \"status\": \"PARTIALLY_PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"crypto\": {\n \"address\": \"string\",\n \"memo\": \"string\"\n },\n \"paymentMethod\": \"TED\",\n \"bank\": {\n \"pix\": {\n \"type\": \"CNPJ\",\n \"key\": \"string\"\n },\n \"account\": {\n \"ispb\": \"string\",\n \"bankNumber\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\"\n }\n },\n \"customer\": {\n \"fullName\": \"string\",\n \"document\": {\n \"type\": \"CNPJ\",\n \"number\": \"string\"\n },\n \"email\": \"string\",\n \"phone\": \"string\",\n \"birth\": \"string\"\n },\n \"endToEndId\": \"string\",\n \"receiver\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"CNPJ\",\n \"number\": \"string\"\n },\n \"bank\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"ispb\": \"string\",\n \"pix\": {\n \"type\": \"CPF\",\n \"key\": \"string\"\n },\n \"account\": {\n \"type\": \"PHONE\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 6355.80190268122,\n \"paidCount\": 3076.0209245188676,\n \"failedCount\": 1535.2999406698432,\n \"pendingCount\": 8662.093912250428,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 2813.585936502239,\n \"amount\": \"string\",\n \"status\": \"CANCELED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 6085.270692145997,\n \"amount\": \"string\",\n \"status\": \"EXPIRED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n },\n \"owner\": {\n \"name\": \"string\",\n \"document\": \"string\",\n \"bank\": {\n \"name\": \"string\",\n \"ispb\": \"string\",\n \"code\": \"string\",\n \"account\": \"string\",\n \"branch\": \"string\",\n \"pix\": {\n \"type\": \"CPF\",\n \"key\": \"string\"\n }\n }\n },\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f407345c-dcbf-45c7-97b8-f894274c9aa7", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd6b2e96-f728-42f8-b13c-93bcccf5b1f0", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c4de53b-2579-43ec-b4f7-e028e6ff8341", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "188cd1e0-bb42-4881-b37d-32baccf63e32", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df38e5b3-7112-4ac6-b0e6-090b92ae45ae", "name": "Get Brazil payout data by idepotency key", "request": { "name": "Get Brazil payout data by idepotency key", "description": { "content": " \n\t \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" \n\t ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "payout", "brazil", "idempotency", ":idempotencyKey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idempotencyKey", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "649a86a3-faed-476c-8af0-43f809e03942", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", "idempotency", ":idempotencyKey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idempotencyKey", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"description\": \"string\",\n \"amount\": \"string\",\n \"status\": \"PARTIALLY_PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"crypto\": {\n \"address\": \"string\",\n \"memo\": \"string\"\n },\n \"paymentMethod\": \"TED\",\n \"bank\": {\n \"pix\": {\n \"type\": \"CNPJ\",\n \"key\": \"string\"\n },\n \"account\": {\n \"ispb\": \"string\",\n \"bankNumber\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\"\n }\n },\n \"customer\": {\n \"fullName\": \"string\",\n \"document\": {\n \"type\": \"CNPJ\",\n \"number\": \"string\"\n },\n \"email\": \"string\",\n \"phone\": \"string\",\n \"birth\": \"string\"\n },\n \"endToEndId\": \"string\",\n \"receiver\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"CNPJ\",\n \"number\": \"string\"\n },\n \"bank\": {\n \"name\": \"string\",\n \"code\": \"string\",\n \"ispb\": \"string\",\n \"pix\": {\n \"type\": \"CPF\",\n \"key\": \"string\"\n },\n \"account\": {\n \"type\": \"PHONE\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 6355.80190268122,\n \"paidCount\": 3076.0209245188676,\n \"failedCount\": 1535.2999406698432,\n \"pendingCount\": 8662.093912250428,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 2813.585936502239,\n \"amount\": \"string\",\n \"status\": \"CANCELED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 6085.270692145997,\n \"amount\": \"string\",\n \"status\": \"EXPIRED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n },\n \"owner\": {\n \"name\": \"string\",\n \"document\": \"string\",\n \"bank\": {\n \"name\": \"string\",\n \"ispb\": \"string\",\n \"code\": \"string\",\n \"account\": \"string\",\n \"branch\": \"string\",\n \"pix\": {\n \"type\": \"CPF\",\n \"key\": \"string\"\n }\n }\n },\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d7bc4fc-f6b2-4bbc-aa58-3eed5cf35300", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", "idempotency", ":idempotencyKey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idempotencyKey", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5afa2729-d766-44f6-a23c-e9c5fb0a19b7", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", "idempotency", ":idempotencyKey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idempotencyKey", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ac0f140-1b73-48de-aedb-4f0e5722a3cc", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", "idempotency", ":idempotencyKey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idempotencyKey", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "976ffc6b-7c29-4262-a93e-e4a65b7478b8", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "brazil", "idempotency", ":idempotencyKey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "idempotencyKey", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52cbc929-f76a-47ff-b035-20b421762ce8", "name": "Mexico payout - V1", "request": { "name": "Mexico payout - V1", "description": { "content": "\n\t Request a payout for Mexico country\n\t \n\t \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" \n\t ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "payout", "mexico" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"account\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "87f4ba63-ef47-42c4-b316-bba962885c9a", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"account\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 5945.00124546912,\n \"paidCount\": 5423.381587391967,\n \"failedCount\": 1250.7099817632538,\n \"pendingCount\": 811.1182338328282,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 8644.571646002822,\n \"amount\": \"string\",\n \"status\": \"PENDING\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 849.9339563255503,\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e8212f-5f3f-4aaa-ac48-6cb54119c5a0", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"account\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33d8357f-955c-42d6-8f12-78ab79b8d8d4", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"account\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "568ca95b-9030-46e5-8d04-2076d421a20f", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"account\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8865ed91-8953-4715-8d06-fa3aa1bdf760", "name": "Get Mexico payout data by id", "request": { "name": "Get Mexico payout data by id", "description": { "content": " \n\t \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" \n\t ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "payout", "mexico", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d98c87f2-1770-4dfc-907d-00d1ef0c574e", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"description\": \"string\",\n \"amount\": \"string\",\n \"status\": \"PENDING\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"crypto\": {\n \"address\": \"string\",\n \"memo\": \"string\"\n },\n \"financialPartner\": \"GAMECASH\",\n \"paymentMethod\": \"TETHER\",\n \"customer\": {\n \"fullName\": \"string\",\n \"document\": {\n \"type\": \"CURP\",\n \"number\": \"string\"\n },\n \"email\": \"string\",\n \"phone\": \"string\",\n \"birth\": \"string\"\n },\n \"bank\": {\n \"account\": {\n \"accountNumber\": \"string\",\n \"bankCode\": \"string\"\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 3332.0650057031507,\n \"paidCount\": 9769.630309064089,\n \"failedCount\": 8516.219205080779,\n \"pendingCount\": 2182.6008152919394,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 1045.24771329523,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 9220.026883232265,\n \"amount\": \"string\",\n \"status\": \"CANCELED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25f3ca90-0aa5-4a72-88ae-ad4df9211e2d", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "837e4ebd-c777-4bf0-b656-f4edf7f9b500", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc97070-8bf4-4164-b80f-ecf685dc704b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "767cc4e9-2a28-4519-9362-ddb958db104f", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "payout", "mexico", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc84e6ed-88c2-444b-8105-93d1d2235217", "name": "Brazil payout - V2", "request": { "name": "Brazil payout - V2", "description": { "content": "\n\t Request a payout for Brazil country\n\t \n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" \n\t ", "type": "text/plain" }, "url": { "path": [ "order", "v2", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0c9679ee-d64c-4832-b64b-126b00ef51c5", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v2", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 5945.00124546912,\n \"paidCount\": 5423.381587391967,\n \"failedCount\": 1250.7099817632538,\n \"pendingCount\": 811.1182338328282,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 8644.571646002822,\n \"amount\": \"string\",\n \"status\": \"PENDING\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 849.9339563255503,\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3de1f9d-0d07-4002-80e2-bf21304a7462", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v2", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acb48a93-4e25-47c0-9d81-c1c9b3dcdcf9", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v2", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd8ee7c8-9154-43c4-9e6f-a5fbde14adca", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v2", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1c2e8a8-9cdd-4936-b224-666ffd89ec60", "name": "Brazil payout - V3", "request": { "name": "Brazil payout - V3", "description": { "content": "\n\t Request a payout for Brazil country\n\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\"\n\t ", "type": "text/plain" }, "url": { "path": [ "order", "v3", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"qrcodeData\": \"\",\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4bd6940f-f9b9-4ca1-9ffb-424e658610b4", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v3", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"qrcodeData\": \"\",\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 5945.00124546912,\n \"paidCount\": 5423.381587391967,\n \"failedCount\": 1250.7099817632538,\n \"pendingCount\": 811.1182338328282,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 8644.571646002822,\n \"amount\": \"string\",\n \"status\": \"PENDING\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 849.9339563255503,\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cebb7054-429e-49ca-be1a-054cbfbd2a27", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v3", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"qrcodeData\": \"\",\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e8a9340-ab1d-4efc-918f-e552add5ecbe", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v3", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"qrcodeData\": \"\",\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5013e05d-0505-431d-b631-023d132f2cd4", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v3", "payout", "brazil" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"customer\": {\n \"fullName\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"birth\": \"\"\n },\n \"bank\": {\n \"pix\": {\n \"qrcodeData\": \"\",\n \"type\": \"\",\n \"key\": \"\"\n },\n \"account\": {\n \"bankNumber\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\"\n }\n },\n \"description\": \"\",\n \"webhookUrl\": \"\",\n \"code\": \"\",\n \"paymentMethod\": \"\",\n \"crypto\": {\n \"address\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "21d059a8-bca0-43af-b237-864f51de2c18", "name": "Client Token 3DS", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6aeabab8-2eef-43bb-98bc-8591cbbf4967", "name": "Get 3DS client token", "request": { "name": "Get 3DS client token", "description": { "content": "Get 3DS client token by provider", "type": "text/plain" }, "url": { "path": [ "order", "v1", "client-token-3ds", ":provider" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "provider", "description": "(Required) The provider name, that you want to get the client token." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2cd305a2-bc67-4032-b544-4c3db7318b82", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", ":provider" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "provider", "description": "(Required) The provider name, that you want to get the client token." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientToken\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42dcac62-3642-47e7-994e-e426afae8e6f", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", ":provider" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "provider", "description": "(Required) The provider name, that you want to get the client token." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65190f6c-ce38-403a-aeff-89eaa66c24c6", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", ":provider" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "provider", "description": "(Required) The provider name, that you want to get the client token." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "809c62a5-6a80-496a-b676-e466638490ec", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", ":provider" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "provider", "description": "(Required) The provider name, that you want to get the client token." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2269eb1c-1f47-4a09-ac1c-1320edb4789a", "name": "Generate card token", "request": { "name": "Generate card token", "description": { "content": "Generate card token by Provider \n\t\nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\"\n ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "client-token-3ds", "card-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"card\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"cardNumber\": \"\",\n \"cardExpirationMonth\": \"\",\n \"cardExpirationYear\": \"\",\n \"cvv\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4133f0af-db43-42a9-97df-92279c5b648d", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", "card-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"card\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"cardNumber\": \"\",\n \"cardExpirationMonth\": \"\",\n \"cardExpirationYear\": \"\",\n \"cvv\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59cdf6f3-df91-46d9-9e97-9440a1942d4c", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", "card-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"card\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"cardNumber\": \"\",\n \"cardExpirationMonth\": \"\",\n \"cardExpirationYear\": \"\",\n \"cvv\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48991c35-597f-4bdb-816b-bdf9b5944200", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", "card-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"card\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"cardNumber\": \"\",\n \"cardExpirationMonth\": \"\",\n \"cardExpirationYear\": \"\",\n \"cvv\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca04990e-d5ef-45ae-8061-a31d3d6ab0e5", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "client-token-3ds", "card-token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"card\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"cardNumber\": \"\",\n \"cardExpirationMonth\": \"\",\n \"cardExpirationYear\": \"\",\n \"cvv\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "59c00e1e-4033-4fa3-aaab-fd8821de3be1", "name": "Checkout", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a158cc25-9a65-4813-a64f-f915e98c0233", "name": "Create Checkout - V1", "request": { "name": "Create Checkout - V1", "description": { "content": "Create a Checkout link for payment\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"paymentMethod\": \"\",\n \"use3ds\": \"\",\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"redirectUrl\": \"\",\n \"expiresAt\": \"\"\n },\n \"country\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e28ce43-8956-4425-ad7c-e3122bc3c0f6", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"string\",\n \"status\": \"string\",\n \"universalLink\": \"string\",\n \"amountToPay\": \"string\",\n \"description\": \"string\",\n \"bankAccount\": {\n \"clabe\": \"string\",\n \"beneficiary\": \"string\",\n \"bankCode\": \"string\"\n },\n \"qrcodeLink\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"qrcodeData\": \"string\",\n \"expireDateTime\": \"string\",\n \"deepLink\": \"string\",\n \"challengeUrl\": \"string\",\n \"challengeAccessToken\": \"string\",\n \"challengeSetupUrl\": \"string\",\n \"challengeSetupAccessToken\": \"string\",\n \"challengeStatus\": \"string\",\n \"checkoutLink\": \"string\",\n \"token\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"errorMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e62c4bbf-c622-468f-ae5a-a448d876858a", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f0df715-0c28-4b52-8765-5fe782435e48", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec580cd3-6040-409c-8308-7892c688ae0b", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a4ffc25-ea6b-417f-8468-5b0f9575ccc1", "name": "Get Checkout by id", "request": { "name": "Get Checkout by id", "description": { "content": "Get checkout data by id\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "checkout", ":checkoutId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "checkoutId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fd7318ff-d33f-4324-82d9-0e668b5b1e5b", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "checkout", ":checkoutId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "checkoutId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"customer\": {\n \"fullName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"document\": {\n \"type\": \"OTHERS\",\n \"number\": \"string\"\n },\n \"email\": \"string\",\n \"phone\": \"string\",\n \"country\": \"GLP\",\n \"birth\": \"string\",\n \"address\": {\n \"state\": \"string\",\n \"city\": \"string\",\n \"street\": \"string\",\n \"neighborhood\": \"string\",\n \"number\": \"string\",\n \"complement\": \"string\",\n \"postalCode\": \"string\"\n }\n },\n \"status\": \"string\",\n \"description\": \"string\",\n \"code\": \"string\",\n \"paymentMethod\": \"string\",\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": \"string\"\n },\n \"country\": \"string\",\n \"redirectUrl\": \"string\",\n \"webhookUrl\": \"string\",\n \"universalLink\": \"string\",\n \"errorMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b4f624-13e6-46cd-9c3f-9b10d6cb883c", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "checkout", ":checkoutId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "checkoutId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6880bf85-926a-4a93-82d7-33a7888f6287", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "checkout", ":checkoutId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "checkoutId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89d0b32f-b21f-42c2-b903-48ebc5af493a", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "checkout", ":checkoutId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "checkoutId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f8ed580-1c17-4dd5-a5d2-287fcdc1aad6", "name": "Create Checkout - V2", "request": { "name": "Create Checkout - V2", "description": { "content": "Create a Checkout link for payment\n \n This version all checkout orders will be validated by AML process, to prevent frauds.\n\n \nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\" ", "type": "text/plain" }, "url": { "path": [ "order", "v2", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"fullName\": \"\",\n \"type\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"email\": \"\",\n \"phone\": \"\",\n \"country\": \"\",\n \"birth\": \"\",\n \"address\": {\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"postalCode\": \"\"\n }\n },\n \"order\": {\n \"code\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"paymentMethod\": \"\",\n \"use3ds\": \"\",\n \"additionalInfo\": \"\",\n \"webhookUrl\": \"\",\n \"redirectUrl\": \"\",\n \"expiresAt\": \"\"\n },\n \"country\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0b533ef-7734-4f2f-824b-2acd04b09d87", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v2", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"string\",\n \"status\": \"string\",\n \"universalLink\": \"string\",\n \"amountToPay\": \"string\",\n \"description\": \"string\",\n \"bankAccount\": {\n \"clabe\": \"string\",\n \"beneficiary\": \"string\",\n \"bankCode\": \"string\"\n },\n \"qrcodeLink\": \"string\",\n \"qrcodeBase64\": \"string\",\n \"qrcodeData\": \"string\",\n \"expireDateTime\": \"string\",\n \"deepLink\": \"string\",\n \"challengeUrl\": \"string\",\n \"challengeAccessToken\": \"string\",\n \"challengeSetupUrl\": \"string\",\n \"challengeSetupAccessToken\": \"string\",\n \"challengeStatus\": \"string\",\n \"checkoutLink\": \"string\",\n \"token\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"errorMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cab728fb-1309-4d57-8cb6-65b86340f13f", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v2", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9ea9bf6-1374-46fe-a090-0224ab8cd915", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v2", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0367793-f414-40db-9362-cc5b0ac9e7e9", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v2", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b17c8067-ef12-4893-9d7a-2955c5adbf7a", "name": "Force update a checkout status and receive postback webhook.", "request": { "name": "Force update a checkout status and receive postback webhook.", "description": {}, "url": { "path": [ "order-tools", "v1", "checkout", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9ef13dec-04a0-4249-a61d-5026877028b2", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order-tools", "v1", "checkout", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40103890-bbf7-4660-a6af-1a7d4cc60aab", "originalRequest": { "url": { "path": [ "order-tools", "v1", "checkout", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d009104a-20c7-4d40-905c-62217db03e67", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order-tools", "v1", "checkout", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "59dca94c-5294-4b11-8283-011f11f8a9ad", "name": "Banks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c07aa7dd-9987-411e-a6a9-77919df51845", "name": "Get available banks for DEPOSIT payment method", "request": { "name": "Get available banks for DEPOSIT payment method", "description": { "content": "Returns a list of available banks that support DEPOSIT payment method.\n \n**Usage:**\n1. Call this endpoint to get available banks and their slugs\n2. Use the 'slug' field from the response as the optional 'bankSlug' parameter when creating DEPOSIT orders\n3. If 'bankSlug' is not provided in order creation, system will use automatic bank selection\n \n\nNOTE: Please, to authenticate use the scope: \"api://app-order-hml\"\n ", "type": "text/plain" }, "url": { "path": [ "order", "v1", "orders", "deposit", "banks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4009ec8b-0f4d-4648-bb63-1ad17b9d9078", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "orders", "deposit", "banks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"banks\": [\n [],\n []\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4eb18f3-13b0-4813-9f1e-f66b8a5da208", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "orders", "deposit", "banks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8313215-1d83-42e6-bc9d-fe2b4a4170f2", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "orders", "deposit", "banks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc9600ac-1961-429a-99e0-664c40d0d7d7", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "orders", "deposit", "banks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8e064c4f-d8d1-45af-839e-97785a511018", "name": "Banking - Accounts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c166343c-eff8-42a4-943e-79592780ec0f", "name": "Create account request", "request": { "name": "Create account request", "description": { "content": "Create a banking account request with holder information and representatives.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"holderType\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"complement\": \"\"\n },\n \"representatives\": [\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n },\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n }\n ],\n \"onboardingDocuments\": {\n \"tradingName\": \"\",\n \"businessName\": \"\",\n \"contactNumber\": \"\",\n \"site\": \"\",\n \"socialContract\": \"\",\n \"cnpjCard\": \"\",\n \"proofAddress\": \"\",\n \"proofBankAddress\": \"\",\n \"partnerProofAddress\": \"\",\n \"documentRepresentative\": \"\",\n \"selfieRepresentative\": \"\",\n \"ir\": \"\",\n \"kyc\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e59b818-d011-424f-bab6-9b7cb6bf0967", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"holderType\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"complement\": \"\"\n },\n \"representatives\": [\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n },\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n }\n ],\n \"onboardingDocuments\": {\n \"tradingName\": \"\",\n \"businessName\": \"\",\n \"contactNumber\": \"\",\n \"site\": \"\",\n \"socialContract\": \"\",\n \"cnpjCard\": \"\",\n \"proofAddress\": \"\",\n \"proofBankAddress\": \"\",\n \"partnerProofAddress\": \"\",\n \"documentRepresentative\": \"\",\n \"selfieRepresentative\": \"\",\n \"ir\": \"\",\n \"kyc\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountRequestId\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b96adf-99a0-45f9-b187-536037303be0", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"holderType\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"complement\": \"\"\n },\n \"representatives\": [\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n },\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n }\n ],\n \"onboardingDocuments\": {\n \"tradingName\": \"\",\n \"businessName\": \"\",\n \"contactNumber\": \"\",\n \"site\": \"\",\n \"socialContract\": \"\",\n \"cnpjCard\": \"\",\n \"proofAddress\": \"\",\n \"proofBankAddress\": \"\",\n \"partnerProofAddress\": \"\",\n \"documentRepresentative\": \"\",\n \"selfieRepresentative\": \"\",\n \"ir\": \"\",\n \"kyc\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f17389c1-734d-49a0-b651-071aed16879b", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"holderType\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"complement\": \"\"\n },\n \"representatives\": [\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n },\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n }\n ],\n \"onboardingDocuments\": {\n \"tradingName\": \"\",\n \"businessName\": \"\",\n \"contactNumber\": \"\",\n \"site\": \"\",\n \"socialContract\": \"\",\n \"cnpjCard\": \"\",\n \"proofAddress\": \"\",\n \"proofBankAddress\": \"\",\n \"partnerProofAddress\": \"\",\n \"documentRepresentative\": \"\",\n \"selfieRepresentative\": \"\",\n \"ir\": \"\",\n \"kyc\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b1bea7-bca0-4d3f-bb54-9425b029a6b4", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"holderType\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"complement\": \"\"\n },\n \"representatives\": [\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n },\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n }\n ],\n \"onboardingDocuments\": {\n \"tradingName\": \"\",\n \"businessName\": \"\",\n \"contactNumber\": \"\",\n \"site\": \"\",\n \"socialContract\": \"\",\n \"cnpjCard\": \"\",\n \"proofAddress\": \"\",\n \"proofBankAddress\": \"\",\n \"partnerProofAddress\": \"\",\n \"documentRepresentative\": \"\",\n \"selfieRepresentative\": \"\",\n \"ir\": \"\",\n \"kyc\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b5f52e3-a001-4ef1-879e-50a2c8971548", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"holderType\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n },\n \"address\": {\n \"street\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"complement\": \"\"\n },\n \"representatives\": [\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n },\n {\n \"country\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birthdate\": \"\",\n \"documentNumber\": \"\"\n }\n ],\n \"onboardingDocuments\": {\n \"tradingName\": \"\",\n \"businessName\": \"\",\n \"contactNumber\": \"\",\n \"site\": \"\",\n \"socialContract\": \"\",\n \"cnpjCard\": \"\",\n \"proofAddress\": \"\",\n \"proofBankAddress\": \"\",\n \"partnerProofAddress\": \"\",\n \"documentRepresentative\": \"\",\n \"selfieRepresentative\": \"\",\n \"ir\": \"\",\n \"kyc\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb3c4c46-9f2a-4987-a32f-f4221e521fac", "name": "Upload onboarding document", "request": { "name": "Upload onboarding document", "description": { "content": "Upload an onboarding document file (pdf, png, jpg, jpeg, up to 10MB) for an existing account request. The document is attached to the request under the declared documentType.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "accounts", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Document file (pdf, png, jpg, jpeg). Maximum size of 10MB." }, { "key": "documentType", "value": "", "type": "text", "description": "(Required) Which onboarding document of the account request this file is. (This can only be one of socialContract,cnpjCard,proofAddress,proofBankAddress,partnerProofAddress,documentRepresentative,selfieRepresentative,ir,kyc,pepDeclaration,incomeStatement)" }, { "key": "accountRequestId", "value": "", "type": "text", "description": "(Required) Id of the account request this document belongs to, returned by the create account request endpoint. The request must exist, belong to the authenticated company and still be pending. Any previous document in the same field is kept in its history." } ] } }, "response": [ { "id": "8603574e-5de7-46cf-bb2a-304023de611c", "name": "Resource successfully created", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Document file (pdf, png, jpg, jpeg). Maximum size of 10MB.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) Which onboarding document of the account request this file is. (This can only be one of socialContract,cnpjCard,proofAddress,proofBankAddress,partnerProofAddress,documentRepresentative,selfieRepresentative,ir,kyc,pepDeclaration,incomeStatement)", "type": "text/plain" }, "key": "documentType", "value": "", "type": "text" }, { "description": { "content": "(Required) Id of the account request this document belongs to, returned by the create account request endpoint. The request must exist, belong to the authenticated company and still be pending. Any previous document in the same field is kept in its history.", "type": "text/plain" }, "key": "accountRequestId", "value": "", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"documentId\": \"67ed37c5-2cac-d5b1-dd7a-139b0877486d\",\n \"url\": \"string\",\n \"documentType\": \"proofAddress\",\n \"attached\": false,\n \"accountRequestId\": \"9eb623e4-681f-0260-13ea-b7b9b96c6e4c\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7d01b83-9c9e-49b2-a7e5-b1a0d18c78e8", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Document file (pdf, png, jpg, jpeg). Maximum size of 10MB.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) Which onboarding document of the account request this file is. (This can only be one of socialContract,cnpjCard,proofAddress,proofBankAddress,partnerProofAddress,documentRepresentative,selfieRepresentative,ir,kyc,pepDeclaration,incomeStatement)", "type": "text/plain" }, "key": "documentType", "value": "", "type": "text" }, { "description": { "content": "(Required) Id of the account request this document belongs to, returned by the create account request endpoint. The request must exist, belong to the authenticated company and still be pending. Any previous document in the same field is kept in its history.", "type": "text/plain" }, "key": "accountRequestId", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31744495-af6a-47b9-999f-96ade0feab30", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Document file (pdf, png, jpg, jpeg). Maximum size of 10MB.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) Which onboarding document of the account request this file is. (This can only be one of socialContract,cnpjCard,proofAddress,proofBankAddress,partnerProofAddress,documentRepresentative,selfieRepresentative,ir,kyc,pepDeclaration,incomeStatement)", "type": "text/plain" }, "key": "documentType", "value": "", "type": "text" }, { "description": { "content": "(Required) Id of the account request this document belongs to, returned by the create account request endpoint. The request must exist, belong to the authenticated company and still be pending. Any previous document in the same field is kept in its history.", "type": "text/plain" }, "key": "accountRequestId", "value": "", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a850ef0a-3017-499d-9cdd-590ce95ceb2b", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Document file (pdf, png, jpg, jpeg). Maximum size of 10MB.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) Which onboarding document of the account request this file is. (This can only be one of socialContract,cnpjCard,proofAddress,proofBankAddress,partnerProofAddress,documentRepresentative,selfieRepresentative,ir,kyc,pepDeclaration,incomeStatement)", "type": "text/plain" }, "key": "documentType", "value": "", "type": "text" }, { "description": { "content": "(Required) Id of the account request this document belongs to, returned by the create account request endpoint. The request must exist, belong to the authenticated company and still be pending. Any previous document in the same field is kept in its history.", "type": "text/plain" }, "key": "accountRequestId", "value": "", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3911498d-2c06-48c3-b65a-ce91ccdd98ed", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Document file (pdf, png, jpg, jpeg). Maximum size of 10MB.", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "(Required) Which onboarding document of the account request this file is. (This can only be one of socialContract,cnpjCard,proofAddress,proofBankAddress,partnerProofAddress,documentRepresentative,selfieRepresentative,ir,kyc,pepDeclaration,incomeStatement)", "type": "text/plain" }, "key": "documentType", "value": "", "type": "text" }, { "description": { "content": "(Required) Id of the account request this document belongs to, returned by the create account request endpoint. The request must exist, belong to the authenticated company and still be pending. Any previous document in the same field is kept in its history.", "type": "text/plain" }, "key": "accountRequestId", "value": "", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9782b1a3-ecfd-46f6-a894-13ebdb2a20ca", "name": "Get account details", "request": { "name": "Get account details", "description": { "content": "Retrieve account details by accountId.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2f47349c-9684-45b1-9723-c332cbc5ac60", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"country\": \"EST\",\n \"holderType\": \"INDIVIDUAL\",\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"birthdate\": \"string\",\n \"document\": {\n \"type\": \"NUMERO_DE_IDENTIFICACION_TRIBUTARIA\",\n \"number\": \"string\"\n },\n \"address\": {\n \"street\": \"string\",\n \"neighborhood\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zipCode\": \"string\",\n \"complement\": \"string\"\n },\n \"representatives\": [\n {\n \"country\": \"MNP\",\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"documentNumber\": \"string\",\n \"birthdate\": \"string\"\n },\n {\n \"country\": \"CUB\",\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"documentNumber\": \"string\",\n \"birthdate\": \"string\"\n }\n ],\n \"bankAccountData\": {\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\",\n \"ispb\": \"string\",\n \"createdAt\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9dc8930-de77-487d-9a4b-076ada85282b", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6efe8361-e52c-4a5c-ae4d-c3078ffaf68e", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c80ff72c-a4a7-4f8a-8eb2-5701129ccc0c", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c452c59c-b3e7-4df1-b749-b24b9163e2ed", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c6837e4-1f10-40ba-a3db-eda5d6810a67", "name": "Account statements", "request": { "name": "Account statements", "description": { "content": "Retrieve the account statement for the informed period.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startDate", "value": "", "description": "Start date of the statement period in ISO 8601 format" }, { "disabled": false, "key": "endDate", "value": "", "description": "End date of the statement period in ISO 8601 format" }, { "disabled": false, "key": "currency", "value": "", "description": "(Required) Currency used for the statement (ISO 4217)" }, { "disabled": false, "key": "limit", "value": "500", "description": "Maximum number of records returned" }, { "disabled": false, "key": "sort", "value": "desc", "description": "Sorting direction for the records" }, { "disabled": false, "key": "operation", "value": "", "description": "Filters records by transaction direction (in or out)" }, { "disabled": false, "key": "endToEndId", "value": "", "description": "Filters records by end-to-end id. Matches the order end-to-end id and the refund end-to-end id" }, { "disabled": false, "key": "cursor", "value": "", "description": "Cursor to continue pagination (use the value returned in nextCursor)" }, { "disabled": false, "key": "mergeBatch", "value": "false", "description": "When true, merges all transactions belonging to the same batch into a single entry, summing their amounts" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8bda2055-cbab-411a-afd9-bcd65d168360", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "currency", "value": "" }, { "key": "limit", "value": "500" }, { "key": "sort", "value": "desc" }, { "key": "operation", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "cursor", "value": "" }, { "key": "mergeBatch", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"params\": {\n \"currency\": \"string\",\n \"limit\": 9544.381475681475,\n \"sort\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"operation\": \"in\",\n \"endToEndId\": \"string\"\n },\n \"nextCursor\": \"string\",\n \"hasNext\": false,\n \"data\": [\n {\n \"orderId\": \"string\",\n \"externalCode\": \"string\",\n \"transactionId\": \"string\",\n \"transactionDate\": \"string\",\n \"endToEndId\": \"string\",\n \"refundEndToEndId\": \"string\",\n \"operationType\": \"PAYIN_REFUND_REVERSE\",\n \"amount\": \"string\",\n \"balance\": \"string\",\n \"counterparty\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"ispb\": \"string\",\n \"bankName\": \"string\",\n \"branch\": \"string\",\n \"account\": \"string\",\n \"accountType\": \"string\"\n },\n \"paymentMethod\": \"TETHER\",\n \"description\": \"string\",\n \"refundId\": \"string\",\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 8345.5761147695,\n \"paidCount\": 4968.342510101189,\n \"failedCount\": 1137.0676194577877,\n \"pendingCount\": 9583.885123506714,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 9111.396154148157,\n \"amount\": \"string\",\n \"status\": \"INITIAL\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 3574.0714210465517,\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n },\n {\n \"orderId\": \"string\",\n \"externalCode\": \"string\",\n \"transactionId\": \"string\",\n \"transactionDate\": \"string\",\n \"endToEndId\": \"string\",\n \"refundEndToEndId\": \"string\",\n \"operationType\": \"PAYOUT_FEE\",\n \"amount\": \"string\",\n \"balance\": \"string\",\n \"counterparty\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"ispb\": \"string\",\n \"bankName\": \"string\",\n \"branch\": \"string\",\n \"account\": \"string\",\n \"accountType\": \"string\"\n },\n \"paymentMethod\": \"TED\",\n \"description\": \"string\",\n \"refundId\": \"string\",\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 7813.086772587941,\n \"paidCount\": 466.41451404402903,\n \"failedCount\": 741.5485455306681,\n \"pendingCount\": 7420.735813474071,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 943.2395108643487,\n \"amount\": \"string\",\n \"status\": \"ANALYSIS\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 5672.016487896907,\n \"amount\": \"string\",\n \"status\": \"ERROR\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd331d2c-2a48-4322-bfe4-aba6ce9a7e01", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "currency", "value": "" }, { "key": "limit", "value": "500" }, { "key": "sort", "value": "desc" }, { "key": "operation", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "cursor", "value": "" }, { "key": "mergeBatch", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8576ff5a-fecb-4337-8b18-001a441e379a", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "currency", "value": "" }, { "key": "limit", "value": "500" }, { "key": "sort", "value": "desc" }, { "key": "operation", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "cursor", "value": "" }, { "key": "mergeBatch", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e69b67e-91a2-4a58-b034-9d0a6d323e3d", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "currency", "value": "" }, { "key": "limit", "value": "500" }, { "key": "sort", "value": "desc" }, { "key": "operation", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "cursor", "value": "" }, { "key": "mergeBatch", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed45362d-09a9-4fb9-ac32-f3155c54853f", "name": "Create PIX key", "request": { "name": "Create PIX key", "description": { "content": "Create a PIX key for the given account.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c7bf9285-3f82-4f39-8cc1-af8b7efc5c49", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"type\": \"CNPJ\",\n \"key\": \"string\",\n \"createdAt\": \"string\",\n \"possedAt\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ea31890-cdfe-4877-ad6e-4574df059138", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aee55df-2820-49f5-9896-70637b1feb30", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "952444c9-25cd-4ec4-8852-c38ad73e5067", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50c76877-3c05-4cc1-b88e-2d0518906f35", "name": "List PIX keys", "request": { "name": "List PIX keys", "description": { "content": "Retrieve all PIX keys for the given account.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "397f7304-590a-48f8-bd98-3b7cddd1b564", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"EMAIL\",\n \"key\": \"string\",\n \"createdAt\": \"string\",\n \"possedAt\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"PHONE\",\n \"key\": \"string\",\n \"createdAt\": \"string\",\n \"possedAt\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32c6445f-e98c-4687-99cc-6ddb4724469c", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1e35b42-192a-41c5-b9fb-c9c41e88eabe", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1777575c-ef86-4be0-aa11-c55f16c0a1b9", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c61dd0d-7c76-4312-b988-7e2fada27543", "name": "Delete PIX key", "request": { "name": "Delete PIX key", "description": { "content": "Delete a PIX key linked to the given account.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" }, { "disabled": false, "type": "any", "value": "", "key": "keyId", "description": "(Required) Identifier of the PIX key" } ] }, "header": [ { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3e55d94c-2f9d-4c2c-9c73-d518bf59b394", "name": "PIX key deleted successfully", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" }, { "disabled": false, "type": "any", "value": "", "key": "keyId", "description": "(Required) Identifier of the PIX key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97515fb4-3532-494f-a962-3ba25961a8c2", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" }, { "disabled": false, "type": "any", "value": "", "key": "keyId", "description": "(Required) Identifier of the PIX key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2def991e-bdf7-4592-9219-1c0f5231ed5d", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" }, { "disabled": false, "type": "any", "value": "", "key": "keyId", "description": "(Required) Identifier of the PIX key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa8d40b2-486a-43e7-90be-6d62f9d26311", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "accounts", ":accountId", "keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "accountId", "description": "(Required) Identifier of the account" }, { "disabled": false, "type": "any", "value": "", "key": "keyId", "description": "(Required) Identifier of the PIX key" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n },\n {\n \"field\": \"string\",\n \"issue\": \"string\",\n \"description\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8f81ec70-1f3b-4ca1-884c-c71c6a46b741", "name": "Banking - Payments", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "cd1bc864-9ba6-4516-8e99-54f59cc3919a", "name": "Create banking payout", "request": { "name": "Create banking payout", "description": { "content": "Create a PIX payout using accountId as payer and different initiation types (MANUAL/KEY/STATIC_QRCODE/DYNAMIC_QRCODE).", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "order-payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"iniciationType\": \"\",\n \"receiver\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"paymentData\": {\n \"pixKey\": \"\",\n \"qrcodeData\": \"\",\n \"bankAccount\": {\n \"ispb\": \"\",\n \"accountType\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cfb87881-3d36-43f4-b030-4fc560965535", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"iniciationType\": \"\",\n \"receiver\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"paymentData\": {\n \"pixKey\": \"\",\n \"qrcodeData\": \"\",\n \"bankAccount\": {\n \"ispb\": \"\",\n \"accountType\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"externalId\": \"string\",\n \"status\": \"string\",\n \"amount\": \"string\",\n \"currency\": \"USD\",\n \"description\": \"string\",\n \"endToEndId\": \"string\",\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 8050.091871017682,\n \"paidCount\": 4835.002280235754,\n \"failedCount\": 6798.680305844451,\n \"pendingCount\": 1355.361954250265,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 3559.873130866953,\n \"amount\": \"string\",\n \"status\": \"CANCELED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 9338.464088391867,\n \"amount\": \"string\",\n \"status\": \"REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "967bb01b-a8b8-4a19-95c6-d2b1fa3eeabe", "name": "Bad request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"iniciationType\": \"\",\n \"receiver\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"paymentData\": {\n \"pixKey\": \"\",\n \"qrcodeData\": \"\",\n \"bankAccount\": {\n \"ispb\": \"\",\n \"accountType\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49e996bd-0238-482e-8455-bfc8764a0194", "name": "Forbidden", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"iniciationType\": \"\",\n \"receiver\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"paymentData\": {\n \"pixKey\": \"\",\n \"qrcodeData\": \"\",\n \"bankAccount\": {\n \"ispb\": \"\",\n \"accountType\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7b936d9-3249-4d4a-9d44-0e5e991923ea", "name": "Internal error", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"iniciationType\": \"\",\n \"receiver\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"paymentData\": {\n \"pixKey\": \"\",\n \"qrcodeData\": \"\",\n \"bankAccount\": {\n \"ispb\": \"\",\n \"accountType\": \"\",\n \"branchNumber\": \"\",\n \"accountNumber\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4519a047-7426-443b-8a51-096a0537822b", "name": "Create banking payin", "request": { "name": "Create banking payin", "description": { "content": "Generate a PIX payin QR Code for a company account.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "order-payins" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"pixKey\": \"\",\n \"description\": \"\",\n \"expiration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f3b6f06c-dc5d-46cf-a897-37746d6676c0", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payins" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"pixKey\": \"\",\n \"description\": \"\",\n \"expiration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"externalId\": \"string\",\n \"status\": \"string\",\n \"qrcodeImageBase64\": \"string\",\n \"qrcodeData\": \"string\",\n \"expireDateTime\": \"string\",\n \"amount\": {\n \"currency\": \"BRL\",\n \"value\": \"string\"\n },\n \"description\": \"string\",\n \"conciliationId\": \"string\",\n \"errorMessage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "182754bb-d285-49b9-865c-f578379d507d", "name": "Bad request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payins" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"pixKey\": \"\",\n \"description\": \"\",\n \"expiration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f60a03b-e618-4126-9d8e-369d5a55ae50", "name": "Forbidden", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payins" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"pixKey\": \"\",\n \"description\": \"\",\n \"expiration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55828217-dc56-4c21-b9b6-4ed4cd9bc15e", "name": "Internal error", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-payins" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"paymentMethod\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"document\": {\n \"type\": \"\",\n \"number\": \"\"\n }\n },\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"pixKey\": \"\",\n \"description\": \"\",\n \"expiration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c75bfea9-be49-4d6a-8589-4fb080fd0f2a", "name": "Create banking refund", "request": { "name": "Create banking refund", "description": { "content": "Create a refund for a banking order.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "order-refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"refundCode\": \"\",\n \"externalId\": \"\",\n \"refundReason\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ac131a88-e93e-48ad-b4cb-fd967a1a981e", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"refundCode\": \"\",\n \"externalId\": \"\",\n \"refundReason\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"externalId\": \"string\",\n \"status\": \"string\",\n \"endToEndId\": \"string\",\n \"amount\": {\n \"currency\": \"ARS\",\n \"value\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e903e38-e896-45ec-b3a6-29d1a7c253e7", "name": "Bad request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"refundCode\": \"\",\n \"externalId\": \"\",\n \"refundReason\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb7b538d-8f8a-43e6-b250-d923a1100e11", "name": "Forbidden", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"refundCode\": \"\",\n \"externalId\": \"\",\n \"refundReason\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05c7a952-ea6d-4c9e-8377-5fc9c6186c08", "name": "Internal error", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "order-refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"refundCode\": \"\",\n \"externalId\": \"\",\n \"refundReason\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2278e43-9172-4e1d-9b90-c360337a6193", "name": "Create static PIX QR Code", "request": { "name": "Create static PIX QR Code", "description": { "content": "Generate a static PIX QR Code for a company account.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "banking", "pix-static-qrcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"pixKey\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66851f94-7c54-446a-9388-86a5fee68454", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "pix-static-qrcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"pixKey\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"qrcodeImageBase64\": \"string\",\n \"qrcodeData\": \"string\",\n \"amount\": {\n \"currency\": \"COP\",\n \"value\": \"string\"\n },\n \"description\": \"string\",\n \"conciliationId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a1bb03-182e-473c-bfce-b6d5f2e9537f", "name": "Bad request", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "pix-static-qrcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"pixKey\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea43b4c3-c4b0-4065-a9f5-bd02d37f5132", "name": "Forbidden", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "pix-static-qrcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"pixKey\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "150768f4-7e42-4b14-9406-c0b9c1036935", "name": "Internal error", "originalRequest": { "url": { "path": [ "order", "v1", "banking", "pix-static-qrcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "disabled": false, "description": "(Required) Unique key for idempotent requests", "key": "idempotency-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"pixKey\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2566314c-d7a2-4c36-a4e3-b33afccfbd8e", "name": "Batch", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1d57d252-de82-4aec-9b21-2599ebd1411d", "name": "List batches - V1", "request": { "name": "List batches - V1", "description": { "content": "List the batches created for your company, cursor paginated.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20", "description": "Maximum number of items returned in the current page (default 20, max 5000)" }, { "disabled": false, "key": "sort", "value": "desc", "description": "Direction of the sort (default: desc)" }, { "disabled": false, "key": "cursor", "value": "", "description": "Cursor used for pagination. Omit this field in the first request. For subsequent requests, set it to the nextCursor value returned in the previous response." }, { "disabled": false, "key": "companyIds", "value": "", "description": "Filter by multiple company ids" }, { "disabled": false, "key": "status", "value": "", "description": "Filter by batch status" }, { "disabled": false, "key": "receiverDocumentNumber", "value": "", "description": "Filter by the receiver document number" }, { "disabled": false, "key": "endToEndId", "value": "", "description": "Filter by end-to-end id. Matches any child transaction of the batch, not just the first one." }, { "disabled": false, "key": "startDate", "value": "", "description": "Filter by creation start date, in the format YYYY-MM-DD" }, { "disabled": false, "key": "endDate", "value": "", "description": "Filter by creation end date, in the format YYYY-MM-DD" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "398eaedf-57d5-488f-af7b-837dc15cbd96", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "20" }, { "key": "sort", "value": "desc" }, { "key": "cursor", "value": "" }, { "key": "companyIds", "value": "" }, { "key": "status", "value": "" }, { "key": "receiverDocumentNumber", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hasNext\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"endToEndId\": \"string\",\n \"status\": \"PAID\",\n \"transactionsCount\": 3144.200168697684,\n \"paidCount\": 777.3465585799988,\n \"failedCount\": 634.9393020578553,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"totalAmount\": \"string\",\n \"feeFix\": \"string\",\n \"feeVar\": \"string\",\n \"senderAccount\": {\n \"accountId\": \"string\",\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"accountType\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\",\n \"ispb\": \"string\"\n },\n \"receiverAccount\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"accountType\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\",\n \"ispb\": \"string\"\n },\n \"company\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n },\n {\n \"id\": \"string\",\n \"endToEndId\": \"string\",\n \"status\": \"INITIAL\",\n \"transactionsCount\": 4467.158128538737,\n \"paidCount\": 3713.528405524722,\n \"failedCount\": 9897.76662855522,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"totalAmount\": \"string\",\n \"feeFix\": \"string\",\n \"feeVar\": \"string\",\n \"senderAccount\": {\n \"accountId\": \"string\",\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"accountType\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\",\n \"ispb\": \"string\"\n },\n \"receiverAccount\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"accountType\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\",\n \"ispb\": \"string\"\n },\n \"company\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n }\n ],\n \"limit\": 2230.6691365702645,\n \"sort\": \"desc\",\n \"nextCursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69f62d54-7278-4a04-a3bb-fa1d39ae68cb", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "20" }, { "key": "sort", "value": "desc" }, { "key": "cursor", "value": "" }, { "key": "companyIds", "value": "" }, { "key": "status", "value": "" }, { "key": "receiverDocumentNumber", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa3329ee-e64a-4e85-be11-a65c7b36409d", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "20" }, { "key": "sort", "value": "desc" }, { "key": "cursor", "value": "" }, { "key": "companyIds", "value": "" }, { "key": "status", "value": "" }, { "key": "receiverDocumentNumber", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1877bb5d-5412-4841-9b7f-fab318420daf", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "20" }, { "key": "sort", "value": "desc" }, { "key": "cursor", "value": "" }, { "key": "companyIds", "value": "" }, { "key": "status", "value": "" }, { "key": "receiverDocumentNumber", "value": "" }, { "key": "endToEndId", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75a4cd69-30e6-4238-abba-968ff138ce82", "name": "Get a batch by id - V1", "request": { "name": "Get a batch by id - V1", "description": { "content": "Get the detail of a batch by its id.", "type": "text/plain" }, "url": { "path": [ "order", "v1", "batch", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The batch ID (UUID)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3de4b440-2e5d-4c36-af8c-3bd4a7202ad4", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "order", "v1", "batch", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The batch ID (UUID)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"endToEndId\": \"string\",\n \"status\": \"PAID\",\n \"transactionsCount\": 7354.234068400274,\n \"paidCount\": 153.86449977502937,\n \"failedCount\": 8677.089946998634,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"totalAmount\": \"string\",\n \"feeFix\": \"string\",\n \"feeVar\": \"string\",\n \"senderAccount\": {\n \"accountId\": \"string\",\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"accountType\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\",\n \"ispb\": \"string\"\n },\n \"receiverAccount\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"accountType\": \"string\",\n \"branchNumber\": \"string\",\n \"accountNumber\": \"string\",\n \"ispb\": \"string\"\n },\n \"company\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 945.9874810756407,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 8760.389983523944,\n \"amount\": \"string\",\n \"status\": \"PENDING\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c67ce26-e5c5-4e14-9003-45780e38b5fc", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "order", "v1", "batch", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The batch ID (UUID)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e5ad7ad-7cf3-49d7-8365-0998a5b5d751", "name": "Unauthorized Request", "originalRequest": { "url": { "path": [ "order", "v1", "batch", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The batch ID (UUID)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e52e9ab8-3da9-49f7-9b11-e31afad78264", "name": "Resource not found", "originalRequest": { "url": { "path": [ "order", "v1", "batch", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The batch ID (UUID)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5b76364-f270-4ad0-8799-1230af527ec8", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "order", "v1", "batch", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) The batch ID (UUID)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "78000fa6-0d43-4fb0-9a55-789e6744b6ef", "name": "Account", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a42925a5-50a6-4315-9e0b-689ca366fbbf", "name": "Get balance", "request": { "name": "Get balance", "description": { "content": "Return holder accounts balance from company authenticated token.\n \nNOTE: Please, to authenticate use the scope: \"api://app-account-hml\" ", "type": "text/plain" }, "url": { "path": [ "account", "v1", "holder", "company", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "accountType", "value": "", "description": "(Required) Represents the account type" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "038aadea-ddc2-43e7-9365-afc7d2fa0a56", "name": "The resource was returned successfully", "originalRequest": { "url": { "path": [ "account", "v1", "holder", "company", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"fullName\": \"string\",\n \"document\": {\n \"type\": \"string\",\n \"number\": \"string\"\n },\n \"country\": \"string\",\n \"createdAt\": \"string\",\n \"accounts\": [\n {\n \"id\": \"string\",\n \"type\": \"PAYMENT\",\n \"balance\": [\n {\n \"currency\": \"BRL\",\n \"value\": \"string\"\n },\n {\n \"currency\": \"USDT\",\n \"value\": \"string\"\n }\n ]\n },\n {\n \"id\": \"string\",\n \"type\": \"ADMINISTRATIVE_OUT\",\n \"balance\": [\n {\n \"currency\": \"BRL\",\n \"value\": \"string\"\n },\n {\n \"currency\": \"USD\",\n \"value\": \"string\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "741529f8-dc40-428f-b2b7-f08f5216bd86", "name": "The request is not valid", "originalRequest": { "url": { "path": [ "account", "v1", "holder", "company", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55803d2b-1f93-483c-9b4b-c92d38064822", "originalRequest": { "url": { "path": [ "account", "v1", "holder", "company", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b2bf40f-4747-412f-bd5a-bc44fb755429", "name": "An unexpected error occurred inside the server", "originalRequest": { "url": { "path": [ "account", "v1", "holder", "company", "balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"string\",\n \"string\"\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://mtls-api-platform-hml.gowd.com", "key": "baseUrl" } ], "info": { "_postman_id": "028fbe1b-aee0-4d7b-a97f-57a579754421", "name": "Gowd Platform API (sandbox)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "", "type": "text/plain" } } }