{ "item": [ { "id": "89181c31-fa8e-49eb-bf24-4f04ee33bf9f", "name": "Authentication Token", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f6cd00a8-9a1b-4bec-a9e4-a21453cd5dad", "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": "ee0d1fdf-cecd-4099-8355-7984630fa482", "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\": 6566.768832821434,\n \"token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6cc00a2-476d-4b76-bacf-6dabe2302837", "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": "8d576f02-dcab-4859-aeb3-6e93af4a1392", "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": "f8967915-40c1-425d-8558-023454f26e4d", "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": "cafa0c01-5a1b-45e6-a400-7e52deffc84a", "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": "81a1cca0-5deb-4986-9480-f218f53b2d5a", "name": "Postback", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fdcb7471-3622-4a5c-bc53-749e8eb8ff54", "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": "a4850806-bb7a-484a-9a0d-696b27745a8a", "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": "c3e48db1-2d23-4f8a-8097-9c5dd5914d43", "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": "0475ac78-9a45-44a0-9342-91d3fc023614", "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": "a5bff33f-631a-4e90-a443-4e4ee4a14dc5", "name": "Banking - Postback", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ff2f585e-2d73-44a7-9bf8-85dac0ebd480", "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": "cadac291-a50c-4f44-9c9b-72ab45fc07de", "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": "02c2e834-b82a-4fdf-bfde-468b8e3a465b", "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": "4c25bb7a-cd8b-4f2f-9106-b3f2037672af", "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": "91ed5095-ba78-49c5-a0b9-633794dc5e7b", "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": "0a0814db-8ed3-4fac-91a1-8dfd81cb93b5", "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": "7bdb1edf-cb70-4048-8389-5d10a632758c", "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": "61bf7a5a-0d85-4888-9f30-60719797b18a", "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": "18d62eec-6b04-4d39-bdc4-11733a619eb7", "name": "Order", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "18347659-8c67-4d45-aa00-ed3d9c957d28", "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-prd\" ", "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": "065d03de-727c-476b-8f04-b546f9e775ac", "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\": \"ORGANIZATION\",\n \"document\": {\n \"type\": \"CPF\",\n \"number\": \"string\"\n }\n },\n \"amount\": {\n \"currency\": \"USD\",\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\": \"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\": \"PHONE\",\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\": \"PAYMENT_ACCOUNT\",\n \"code\": \"string\",\n \"pix\": {\n \"type\": \"CPF\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 9117.042518391332,\n \"paidCount\": 425.8665329148981,\n \"failedCount\": 4255.561053024182,\n \"pendingCount\": 3000.8276392054477,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 4968.588684057875,\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\": 7585.889082890436,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\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\": \"ORGANIZATION\",\n \"document\": {\n \"type\": \"OTHERS\",\n \"number\": \"string\"\n }\n },\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": \"string\"\n },\n \"baseAmount\": {\n \"currency\": \"BUSD\",\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\": \"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\": \"CNPJ\",\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\": \"PAYMENT_ACCOUNT\",\n \"code\": \"string\",\n \"pix\": {\n \"type\": \"PHONE\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 5777.828209920568,\n \"paidCount\": 9943.086166756279,\n \"failedCount\": 4147.970282893043,\n \"pendingCount\": 1401.5370374549052,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 5779.509799205691,\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\": 2539.8983919828156,\n \"amount\": \"string\",\n \"status\": \"PARTIALLY_PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n }\n ],\n \"currentPage\": 7940.092198760606,\n \"perPage\": 9001.85821044141\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c07d506-65d3-4c5a-8fbe-b1764d2c91bc", "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": "0def94b1-6459-41bd-ae27-4b13c24ec100", "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": "d2101c9b-75e3-4d5c-8102-7990cbe4213f", "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": "54105011-8576-46d6-b048-6402f6c0ee4a", "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": "6becd5e7-3107-44f3-a03e-8aea5d0856cd", "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-prd\" ", "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": "bb58d67c-0cea-4354-ba00-6019f9786250", "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\": \"ORGANIZATION\",\n \"document\": {\n \"type\": \"CURP\",\n \"number\": \"string\"\n }\n },\n \"amount\": {\n \"currency\": \"BUSD\",\n \"value\": \"string\"\n },\n \"baseAmount\": {\n \"currency\": \"BRL\",\n \"value\": \"string\"\n },\n \"createdAt\": \"string\",\n \"paymentMethod\": \"OXXO\",\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\": \"EMAIL\",\n \"key\": \"string\"\n }\n }\n },\n \"payer\": {\n \"name\": \"string\",\n \"document\": {\n \"type\": \"PASSPORT\",\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\": \"CNPJ\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 5770.997414337353,\n \"paidCount\": 3808.8490455986835,\n \"failedCount\": 7729.390228672126,\n \"pendingCount\": 8609.343376213368,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 1092.0984620995312,\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\": 2224.0545087960227,\n \"amount\": \"string\",\n \"status\": \"PARTIALLY_PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33d37017-e49f-4e32-a260-949fb03e8be9", "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": "d03f9a4e-b613-4126-882e-e3bf3c35d325", "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": "bc799556-35f6-40f8-a18a-6a3485a8a39e", "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": "c7626d93-ddfc-46e8-98ce-dd449c5aa337", "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": "176cd28a-76c1-45f9-97be-e544054fae10", "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": "e9735782-9c37-482b-a348-70166845055c", "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": "0138738d-d7f9-475e-9fcf-b12168e74c1e", "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": "956eb154-de75-40eb-9aa7-8cc4382ff59f", "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": "e211151f-69c0-4c57-a2d6-3cf1c4b0c1bf", "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": "38b9861c-06bf-4fd9-9097-a112941410d5", "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-prd\"\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": "1585fd55-df08-4cad-8fc0-14059d6aa760", "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": "0c77fe73-aa87-4fc8-9c38-d9d4a9037cf4", "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": "e769aaa9-3e87-4053-ad72-68a3c2cd5bc3", "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": "2c529703-3d63-40df-85a4-3b81c07fd557", "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": "4277ddc7-312e-4fb9-8c64-f26c2871677d", "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": "704c012c-b55b-4f90-a121-558fefe3684f", "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": "10d3ef52-b898-4724-83f3-f5333efe7c81", "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": "d646005c-75eb-4599-b7fd-aa2b5eff1655", "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": "48cb181b-8a82-42b8-af71-559996fd0f11", "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-prd\"", "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": "4fe735e4-53fb-44b3-b186-796428c5ccf5", "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\": \"USD\",\n \"value\": \"string\"\n },\n \"status\": \"ERROR\",\n \"type\": \"PARTIAL\",\n \"operationType\": \"PAYIN\",\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\": \"BRL\",\n \"value\": \"string\"\n },\n \"status\": \"SUCCESS\",\n \"type\": \"PARTIAL\",\n \"operationType\": \"PAYIN\",\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": "05814eda-9601-4158-88ed-f7c2f84b3f92", "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": "ed00de92-9662-4db9-9c33-ed3615dc59af", "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": "697cc221-8bb3-4b00-beed-c6ecf844660f", "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-prd\" \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": "9b39fabe-66c4-459e-b766-b3ddee486a80", "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": "3011c5ce-54e6-47c9-9234-86c1a74462ec", "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": "f7a69bba-6b5e-4b58-b9ba-44fe41d17bc0", "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": "21a5a8be-962b-4ff1-8a3b-c82b401f1e88", "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": "c48d7ed5-4c1a-448b-9cf6-7f951020db4a", "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": "344b7f10-5a66-46a4-8ae7-797e722b2cf9", "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-prd\"\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": "e73144e2-49e1-425a-912b-64edb7784a64", "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": "c85f0ea9-84a8-40f2-95a6-a9f9f1d74079", "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": "d9197271-dc64-4abe-9de0-d8c6d99f3580", "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": "7e77147e-38cb-48f5-97ef-352b94713f76", "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": "ce0c4e7b-95e9-4f82-ad50-6fc9805b785e", "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-prd\"\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": "414dd3b8-d03c-4b31-b683-158cdadfd946", "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": "92bb3036-c38e-4848-9e73-81547209485a", "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": "89cf8bf7-90ba-4b43-88fd-4b56950cc6a5", "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": "f00b1928-b6dd-48c1-93ee-a5de8adf4da7", "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": "71b012ae-7d36-4e0f-8e72-4a1607149c88", "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 } } ], "event": [] }, { "id": "104f3e02-2604-4179-b17e-67cab8af472d", "name": "Payout", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "dcb93958-da6c-4d58-a107-64dd5b39ec66", "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-prd\" \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": "4220d2fe-2390-4b5f-9a06-83f0a251932c", "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\": \"ERROR\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 3854.9020844334027,\n \"paidCount\": 9609.700653435164,\n \"failedCount\": 8378.92715178083,\n \"pendingCount\": 8934.025727227057,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 6565.76062078033,\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\": 2847.973610489352,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e433c86-bf46-415f-a39b-5071cb11da0f", "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": "656563af-07bf-46e8-a2e2-c47df60fac60", "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": "37347738-32df-4fc7-b651-03275a449439", "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": "bfd275e1-4352-4a0e-a273-963d0aeb2f75", "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-prd\" \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": "d420077d-fd03-46d4-92da-efee3ddbeba2", "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\": \"PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"crypto\": {\n \"address\": \"string\",\n \"memo\": \"string\"\n },\n \"paymentMethod\": \"PIX\",\n \"bank\": {\n \"pix\": {\n \"type\": \"CPF\",\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\": \"CPF\",\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\": \"PHONE\",\n \"key\": \"string\"\n },\n \"account\": {\n \"type\": \"EMAIL\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 4902.84087803567,\n \"paidCount\": 8635.553592987295,\n \"failedCount\": 4678.227866636184,\n \"pendingCount\": 1769.5869500626516,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 837.4763893171289,\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\": 9390.686778699628,\n \"amount\": \"string\",\n \"status\": \"REFUNDED\",\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\": \"PHONE\",\n \"key\": \"string\"\n }\n }\n },\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b46192f-c30f-42fd-a967-e9a73f6cbed7", "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": "d6bd57b9-d9bc-4cf3-a02e-1a415580a3c5", "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": "eb41093c-c114-4b0b-9538-f1e5fa82002b", "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": "bc720bdb-7416-4e52-bf31-798ba8deb60f", "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": "6b50babd-a0d6-4fcf-8083-ce700e666a6f", "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-prd\" \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": "6336f21a-c04b-48b8-b664-263d8e2388eb", "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\": \"PAID\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"crypto\": {\n \"address\": \"string\",\n \"memo\": \"string\"\n },\n \"paymentMethod\": \"PIX\",\n \"bank\": {\n \"pix\": {\n \"type\": \"CPF\",\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\": \"CPF\",\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\": \"PHONE\",\n \"key\": \"string\"\n },\n \"account\": {\n \"type\": \"EMAIL\",\n \"key\": \"string\"\n }\n }\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 4902.84087803567,\n \"paidCount\": 8635.553592987295,\n \"failedCount\": 4678.227866636184,\n \"pendingCount\": 1769.5869500626516,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 837.4763893171289,\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\": 9390.686778699628,\n \"amount\": \"string\",\n \"status\": \"REFUNDED\",\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\": \"PHONE\",\n \"key\": \"string\"\n }\n }\n },\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33b5a01d-6bb5-423c-8af5-642185caedff", "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": "0d9d5300-6c1e-43a8-ba2f-6d982fb17cce", "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": "2045a45c-3b73-4592-b20e-ffcf5a004db0", "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": "c8010490-5657-443f-aece-f2c2a446e832", "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": "3c267876-2b89-404a-af2f-a80c05fbba2d", "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-prd\" \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": "96ab4fc2-8c68-468c-bfd6-bf7e71bef0b4", "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\": \"ERROR\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 3854.9020844334027,\n \"paidCount\": 9609.700653435164,\n \"failedCount\": 8378.92715178083,\n \"pendingCount\": 8934.025727227057,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 6565.76062078033,\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\": 2847.973610489352,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7df2bbac-59a4-4d4b-b1b6-5468d517f9b1", "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": "2d36f0f1-2219-4925-a8a1-c6b8e5e241e1", "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": "e8c49be8-294f-45e5-9143-8c121326bfff", "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": "7fbcca73-c918-41a6-b585-39574d0196c3", "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-prd\" \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": "ad55ed3a-728b-4bde-8e15-6ec1daa03460", "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\": \"PARTIALLY_PAID\",\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\": \"RFC\",\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\": 5547.329566263601,\n \"paidCount\": 3651.0931064740594,\n \"failedCount\": 7537.268488624633,\n \"pendingCount\": 7284.827826040241,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 3111.192945431467,\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\": 94.54630291129584,\n \"amount\": \"string\",\n \"status\": \"REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f7632a1-261c-4ea9-a46e-8b7624335171", "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": "bedb891d-07e0-40cb-9b6a-4f26c950977f", "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": "527bed20-2866-4ca6-9a9e-4558374bbb1b", "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": "1d24d0a0-bfad-466a-8072-dc6b41283bd3", "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": "489c10b3-668d-4ef8-9bc6-93fb8575e83b", "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-prd\" \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": "2d966730-5717-4906-85fe-7def3af733aa", "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\": \"ERROR\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 3854.9020844334027,\n \"paidCount\": 9609.700653435164,\n \"failedCount\": 8378.92715178083,\n \"pendingCount\": 8934.025727227057,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 6565.76062078033,\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\": 2847.973610489352,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ead0453-324b-45e4-884b-9a62d10604ec", "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": "0940965e-a80e-4e8a-9b20-ef9fba0cf6a9", "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": "711652c3-88d9-455b-b7e5-c16c0f672fb5", "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": "6efb9f2e-c5f9-4eb9-89e0-7675a734f266", "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-prd\"\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": "c23908f5-c105-4d95-b4fb-49a936be3031", "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\": \"ERROR\",\n \"errorMessage\": \"string\",\n \"createdAt\": \"string\",\n \"fee\": {\n \"fixed\": {},\n \"variable\": {},\n \"additional\": {}\n },\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 3854.9020844334027,\n \"paidCount\": 9609.700653435164,\n \"failedCount\": 8378.92715178083,\n \"pendingCount\": 8934.025727227057,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 6565.76062078033,\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\": 2847.973610489352,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "778f185f-a6dd-4ff2-9608-a808b57ca9f1", "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": "8b948d42-7775-4ff8-9324-b00282957665", "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": "d5e2c3bb-e798-47a4-a703-84587bf3ded0", "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": "f42ce136-cb59-484b-8ab9-b8e0b55d6402", "name": "Client Token 3DS", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a095f6af-4c73-47c2-a58a-ed40a9eaf85b", "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": "0581bd73-bddf-40e5-83dd-71242931dc03", "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": "83230e05-9e99-4264-9b99-2723fc08747f", "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": "8bc477e5-b688-48b0-9796-4385ea7fa776", "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": "9283a92d-d96b-44ad-8ad0-ccb4abe52e5b", "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": "82ab73e2-40f3-4d7f-95d8-e22daf887e65", "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-prd\"\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": "a23d357b-fe4d-4f12-963c-d2635805c98c", "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": "c7b923f0-207f-445a-b0f1-3bbe8908ec1b", "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": "2ba82c74-0bf8-4e74-b5d0-ede8d5ebedbc", "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": "52c63aac-56c0-4355-8a19-51e68e7c2b33", "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": "ef37541b-0eb2-40ee-8795-0dc5c09edf2e", "name": "Checkout", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fc1ba267-bbcd-4219-ab15-09ea3b0d170a", "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-prd\" ", "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": "2afe13a6-d734-4e76-9c9e-1b844f680b4a", "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": "6ea965c9-ffb2-4f4b-8252-433a30f90c2b", "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": "97a0ce10-a06d-4712-b929-2318bddf7693", "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": "995b12cc-e6bb-4712-af8e-764447ac5317", "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": "06bce35d-aa6f-4a54-a758-67cbf0e32f55", "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-prd\" ", "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": "0cc57c31-e014-41f0-85d9-d9cd520c8074", "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\": \"ORGANIZATION\",\n \"document\": {\n \"type\": \"OTHERS\",\n \"number\": \"string\"\n },\n \"email\": \"string\",\n \"phone\": \"string\",\n \"country\": \"RUS\",\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\": \"BUSD\",\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": "919275af-bf6c-440e-be8a-2ecf158143a2", "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": "716893ae-8e95-4f3b-946c-3c0859276928", "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": "a1d326b4-f3d0-4783-8de6-e78f22ed4782", "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": "4d46c358-3c51-4b27-b62f-5a40e85e5e78", "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-prd\" ", "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": "8f2fb518-56ab-4887-8438-844ffbb62f73", "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": "ef317bad-fabf-430d-8aa3-8555fd5c720a", "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": "9e10b90d-dbb3-4ac0-ad06-d618491de91f", "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": "c8652403-d3d9-4266-b40a-878504d5d212", "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 } } ], "event": [] }, { "id": "e11528eb-4354-41db-9342-c2d52d03f87f", "name": "Banks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a55c35e5-5575-4bec-9fd7-fba1e71a410d", "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-prd\"\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": "2ae38020-7719-4f31-8170-53b1374a3346", "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": "b7c8edb7-81ff-4056-a40e-c980083f3451", "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": "a2ca6b6d-ee47-4db7-85ea-6fe63c69479f", "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": "9e5b9edc-4ed3-4ffa-a984-e69fd14f8300", "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": "4b1ab3f5-0e9d-4cde-bf00-0dba77524ff2", "name": "Banking - Accounts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "bdb261dc-fac6-44ce-9475-a78e537f813b", "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": "86a1e554-de23-4b69-8314-b2ad3456a677", "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": "703cdcd9-4331-4836-8857-825f59160a3c", "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": "03b91b36-b746-4259-a2c4-068f985dcbcd", "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": "5df74e5b-70b7-4608-87a9-55cc9098151b", "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": "1c654648-4b46-4f9f-9e35-a4404610a08b", "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": "164c9cf3-9683-4a14-aba9-8fc07e755f8f", "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": "1c1afc7d-fa0f-4a92-bfac-d373ac4b6a36", "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\": \"70ffb3c6-42af-9f6f-9dff-f669e055f326\",\n \"url\": \"string\",\n \"documentType\": \"cnpjCard\",\n \"attached\": true,\n \"accountRequestId\": \"730cefcc-0196-b3fa-9310-38355b9685b0\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "445246c0-9e7e-436a-b032-9a35954384a9", "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": "4ab7b264-0d2c-4454-905b-508ff28c8118", "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": "bb647fd9-8c0e-4f24-817c-527e93930150", "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": "8e5fb19e-320c-4ba4-96bc-87dd7d335d3a", "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": "22014b63-8b2a-4dcf-b850-dd05afe1f9c4", "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": "272095f3-a804-425b-9719-0514af46a9e7", "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\": \"CUW\",\n \"holderType\": \"INDIVIDUAL\",\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"birthdate\": \"string\",\n \"document\": {\n \"type\": \"RUC\",\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\": \"PLW\",\n \"fullName\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"documentNumber\": \"string\",\n \"birthdate\": \"string\"\n },\n {\n \"country\": \"JPN\",\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": "bc8ded5b-d8ee-4a97-93f8-b5941c5bd812", "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": "68fbcef7-ea10-41d0-a720-53597a9fa276", "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": "a02c5c5f-f2d0-407a-b28b-a17e815f85b5", "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": "9270ce9b-90ed-47e3-9603-9bea85cd7db3", "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": "a17b50c2-fc56-4161-be67-0b5ecf41585c", "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": "46446cc0-9d65-4993-98cd-cec1d04865d2", "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\": 8795.251806057477,\n \"sort\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"operation\": \"out\",\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\": \"PIX\",\n \"description\": \"string\",\n \"refundId\": \"string\",\n \"batch\": {\n \"id\": \"string\",\n \"transactionsCount\": 9794.413260784693,\n \"paidCount\": 4165.082571784254,\n \"failedCount\": 2684.089819223772,\n \"pendingCount\": 5435.506438517821,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 2614.3813640519165,\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\": 526.4769500010647,\n \"amount\": \"string\",\n \"status\": \"ANALYSIS\",\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\": \"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\": 1522.8648040624316,\n \"paidCount\": 5484.449396206001,\n \"failedCount\": 8073.26210047371,\n \"pendingCount\": 8617.87221501575,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 2390.908975479109,\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\": 857.5339034145957,\n \"amount\": \"string\",\n \"status\": \"PENDING\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd65708c-04a0-48fe-8c2e-40d18f115e0e", "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": "ce9423d3-386a-43a0-bfe0-7f48ea57b861", "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": "5bf16e62-131c-4ad6-ab43-67b1c270056a", "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": "b3935b97-61fa-4add-a09d-d2a2186acea4", "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": "c5a87e18-7607-4bd8-8481-93a8850a0305", "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\": \"EMAIL\",\n \"key\": \"string\",\n \"createdAt\": \"string\",\n \"possedAt\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48417029-9675-4acf-8cd2-5d31cb2c60b6", "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": "b6d7b7f5-fec1-473d-b6ae-421a879da836", "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": "be5daa5c-bb40-4fc6-a07c-97d4b6a08694", "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": "2456ee51-00e4-4bcf-8345-74ec8d13c6bc", "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": "5267f6fe-28fa-42e4-ba7e-274762b383ac", "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\": \"CNPJ\",\n \"key\": \"string\",\n \"createdAt\": \"string\",\n \"possedAt\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"CPF\",\n \"key\": \"string\",\n \"createdAt\": \"string\",\n \"possedAt\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "141997c2-81f9-4718-b9ac-2b0eab1ae5af", "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": "50a2e8f1-93ee-4b78-b993-f65b76b1b7c6", "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": "ba8b0a22-171f-4a62-a129-2dab76b9b7bf", "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": "548fd15c-cf28-4310-a8c0-64ce8f3e3991", "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": "29e01762-ced5-499b-934c-a3c41222ed03", "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": "4a711da7-5677-4508-9d1e-bc8ebfd3d2c6", "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": "2f12526a-a797-4f61-8596-f10de874b2c3", "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": "834285e7-5648-4af5-8fb4-2f2897d22290", "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": "cf637b21-1e94-462d-8b38-4a8b7d215a8c", "name": "Banking - Payments", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7ab75945-6924-4795-9b9b-95b4581e29f3", "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": "7341069a-3623-4090-8462-07b009c2b3cb", "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\": 1092.07831066086,\n \"paidCount\": 307.1756363284295,\n \"failedCount\": 6403.9095931545535,\n \"pendingCount\": 2453.417368426638,\n \"paidAmount\": \"string\",\n \"pendingAmount\": \"string\",\n \"transactions\": [\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 7921.191026105399,\n \"amount\": \"string\",\n \"status\": \"EXPIRED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 3965.802800353335,\n \"amount\": \"string\",\n \"status\": \"PARTIAL_REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448bb6a9-78c0-4126-9058-75a9e3555b3a", "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": "4521d676-44f4-4699-9fce-b1d830283c74", "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": "115cc36b-9845-4e2f-8661-a59669f4b577", "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": "cdf1485e-25f4-4ad0-8a29-687541091d65", "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": "78fc09d4-6c43-4640-a98a-47c5e4eeba89", "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": "63c9b450-7d30-4a58-a3d9-901b624ddb78", "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": "4f21cfee-2a08-4df7-9855-a4cba4ce012b", "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": "7c990cee-7bfe-4500-b54d-cd761849d965", "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": "ae179c56-abfa-46a1-a62c-9cd0e1e0e807", "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": "ff67eae7-2e39-44f3-a303-b71dd914415b", "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\": \"USDT\",\n \"value\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b044f79-f3e9-4b76-b99a-9dfd84e801cc", "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": "a0000329-e9e5-4c1e-94ce-ae7e3a4e32a7", "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": "57b20277-3f1a-4903-9df4-e3d4e592c7f1", "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": "b4262ea7-bbe1-4800-bd67-24917ce99ba5", "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": "8fde3735-b298-4238-811b-eba45d3536dd", "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\": \"ARS\",\n \"value\": \"string\"\n },\n \"description\": \"string\",\n \"conciliationId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f24920c-6ae2-4f44-abd2-97508bd730b1", "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": "00edf8c1-c160-4ba5-8d19-728494c357b6", "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": "055be6ab-20da-4617-b9e2-029f4eb63d56", "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": "9c9de15d-a6c3-43cf-ab8c-1e09e04d5d0d", "name": "Batch", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5ceea33f-81e8-40cd-aed3-dbbe40ce7675", "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": "160aa9ce-fffb-4b29-95bf-d77ea14a90f2", "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\": \"PENDING\",\n \"transactionsCount\": 7569.191138101416,\n \"paidCount\": 9095.34908011974,\n \"failedCount\": 3375.321707303505,\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\": \"ERROR\",\n \"transactionsCount\": 5263.262038843939,\n \"paidCount\": 2741.2683542392347,\n \"failedCount\": 381.924472163786,\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\": 7997.202972234371,\n \"sort\": \"desc\",\n \"nextCursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f3cad51-b527-47d4-8064-43d8b70caaf6", "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": "a7805825-8559-4c74-b470-33163deaa243", "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": "02531411-54b9-4da4-985f-52b3f936c220", "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": "1779fec9-fb58-471d-9757-2468222eb984", "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": "6b9d004e-1e06-4fd0-bc08-5dde13523924", "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\": \"INITIAL\",\n \"transactionsCount\": 2745.743546693433,\n \"paidCount\": 9184.890451662835,\n \"failedCount\": 6221.413980913606,\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\": 7830.863480095476,\n \"amount\": \"string\",\n \"status\": \"REFUNDED\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"idempotencyKey\": \"string\",\n \"sequence\": 2016.8213702141347,\n \"amount\": \"string\",\n \"status\": \"PAID\",\n \"endToEndId\": \"string\",\n \"paidAt\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eea12cba-0315-4ada-a8c5-33033e80e159", "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": "8517cd0e-1bb1-4d94-b9a3-e15f40515f37", "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": "62f15603-d00a-4a83-bcdf-a522ffddb06c", "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": "ea160062-51b3-4ee3-a735-430ab058a22e", "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": "e6bbaf26-ae71-47fe-883d-157d39de46a3", "name": "Account", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d61da0c3-f5e2-489c-9455-f24304574e76", "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-prd\" ", "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": "5b1cd9b8-4295-4d9f-a76e-e7067e581bb3", "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\": \"FEE_OUT\",\n \"balance\": [\n {\n \"currency\": \"MXN\",\n \"value\": \"string\"\n },\n {\n \"currency\": \"MXN\",\n \"value\": \"string\"\n }\n ]\n },\n {\n \"id\": \"string\",\n \"type\": \"COMMON\",\n \"balance\": [\n {\n \"currency\": \"MXN\",\n \"value\": \"string\"\n },\n {\n \"currency\": \"USDT\",\n \"value\": \"string\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beee38d1-1fc0-4558-bd96-73bd92d205a1", "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": "a1e855df-8e1e-44f2-a753-dc8843d86fe3", "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": "1c900f3e-d0cb-4bf0-a20b-66c2fc0308f7", "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.gowd.com", "key": "baseUrl" } ], "info": { "_postman_id": "3d41d547-19ee-4484-8ed1-cb54b164e013", "name": "Gowd Platform API (production)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "", "type": "text/plain" } } }