The following endpoint collection is responsible for credit card request by proxy.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33643847","collectionId":"bf7f2a36-4d61-492e-927d-b19ef433b2dc","publishedId":"2sA358eRPe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-31T11:57:33.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","","postman.setEnvironmentVariable(\"THIRD_PARTY_PROXY_TOKEN\", jsonData.token);"],"type":"text/javascript","id":"6660734b-f6c5-4f85-82fd-9db92d760d19"}}],"id":"944d21ac-f535-4ef8-b83d-89277bda2811","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"{{CLIENT_ID}}\",\r\n\t\"clientSecret\": \"{{CLIENT_SECRET}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/login","description":"This endpoint makes an HTTP POST request to authenticate credentials. The request body should include a client id and a client secret
\nclientId (string, required): Client id that allows access to the system.clientSecret (string, required): Client secret that allows access to the system.token (string): Access token to send in Authorization header that allows access for APIs. Example: Authorization: \"Bearer {TOKEN}\".expiresIn (number): Maximum time in miliseconds that the token is valid.The following endpoint is responsible for auth login.
\n","_postman_id":"e2c95858-0b95-4fb6-b9ab-e5e4ecc15718"},{"name":"Webhooks","item":[{"name":"Transactions","item":[{"name":"Pix","item":[{"name":"Pay In","id":"9ab19e58-e379-4249-9620-0ebdfc9fe7a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[{"id":"a00fcb53-4176-4460-9353-bacad944013b","name":"TRANSACTION.PIX.RECEIVED.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.RECEIVED.REQUESTED\",\n \"id\": \"99b17993-7cb7-42bc-8938-f4367b91179d\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"PixIn\",\n \"expectedAmount\": 10,\n \"fee\": -1.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"requested\",\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"feeId\": \"11a479b9-3e14-49be-964b-6378d2c7bdef\",\n \"id\": \"09676742-641f-456b-b0c6-75d568ee35bb\",\n \"name\": \"Fee\",\n \"operation\": \"pix\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"max\": null,\n \"min\": 0,\n \"name\": \"Rule\",\n \"ruleId\": \"2bdd2027-3af6-49ab-bde0-5237761b5bdc\",\n \"type\": \"percentage\",\n \"value\": 0.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"updatedAt\": \"2024-07-26T12:32:49.770Z\",\n \"value\": 0.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:32:49.770Z\"\n },\n \"time\": \"2024-07-26T12:32:52.825Z\",\n \"version\": \"v1\"\n}\n"},{"id":"41def9bc-67e3-4812-a724-ed54e5d83d3c","name":"TRANSACTION.PIX.RECEIVED.SUCCEEDED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"url":{"raw":"","query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.RECEIVED.SUCCEEDED\",\n \"id\": \"f59258f9-9ebf-4fc9-bdda-af48b27ece02\",\n \"payload\": {\n \"amount\": 10,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"PixIn\",\n \"expectedAmount\": 10,\n \"fee\": -3,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"requested\",\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"feeId\": \"11a479b9-3e14-49be-964b-6378d2c7bdef\",\n \"id\": \"09676742-641f-456b-b0c6-75d568ee35bb\",\n \"name\": \"Fee\",\n \"operation\": \"pix\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"max\": null,\n \"min\": 0,\n \"name\": \"Rule\",\n \"ruleId\": \"2bdd2027-3af6-49ab-bde0-5237761b5bdc\",\n \"type\": \"percentage\",\n \"value\": 0.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"updatedAt\": \"2024-07-26T12:32:49.770Z\",\n \"value\": 0.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:34:36.763Z\"\n },\n \"time\": \"2024-07-26T12:34:40.889Z\",\n \"version\": \"v1\"\n}\n"},{"id":"fa0b8ee3-46cc-4201-baa0-0ed9a4074cef","name":"TRANSACTION.PIX.AUTOMATIC_CONTRACT.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.RECEIVED.REQUESTED\",\n \"id\": \"99b17993-7cb7-42bc-8938-f4367b91179d\", // Event ID\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"PixIn\",\n \"expectedAmount\": 10,\n \"fee\": -0.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 1.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:32:49.770Z\"\n },\n \"time\": \"2024-07-26T12:32:52.825Z\",\n \"version\": \"v1\"\n}\n"},{"id":"0e878c42-5391-470f-a130-31b5a3e2606c","name":"TRANSACTION.PIX.AUTOMATIC_CONTRACT.ACCEPTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.AUTOMATIC_CONTRACT.ACCEPTED\",\n \"id\": \"843d15b1-52a8-4d77-bae5-5b3f43644409\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2025-12-23T16:52:38.839Z\",\n \"eventName\": \"PixInAutomaticContract\",\n \"fee\": -3.5,\n \"orderId\": \"38c74933-d545-439d-b985-061f0e2d3931\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"name\": \"Fee Contract\",\n \"value\": 3.5\n }\n ],\n \"transactionId\": \"195357e6-b615-40da-87d6-c302ec1dc5eb\",\n \"type\": \"credit\",\n \"updatedAt\": \"2025-12-23T17:16:23.112Z\"\n },\n \"time\": \"2025-12-23T17:16:31.627Z\",\n \"version\": \"v1\"\n}"},{"id":"fc6f0823-dbd9-4eef-af86-e4c6110e7a2a","name":"TRANSACTION.PIX.AUTOMATIC_PAYMENT.RECEIVED.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.AUTOMATIC_PAYMENT.RECEIVED.SUCCEEDED\",\n \"id\": \"02784f58-61e8-4143-9852-635e51ab8ba7\",\n \"payload\": {\n \"amount\": 15,\n \"createdAt\": \"2025-12-23T17:16:26.780Z\",\n \"eventName\": \"PixInAutomaticPayment\",\n \"fee\": 0,\n \"orderId\": \"38c74933-d545-439d-b985-061f0e2d3931\",\n \"originalTransactionId\": \"195357e6-b615-40da-87d6-c302ec1dc5eb\",\n \"status\": \"success\",\n \"transactionId\": \"97803c61-60fe-4c06-ad44-fbe17a96f4d7\",\n \"type\": \"credit\",\n \"updatedAt\": \"2025-12-23T17:16:26.780Z\"\n },\n \"time\": \"2025-12-23T17:16:31.674Z\",\n \"version\": \"v1\"\n}"},{"id":"be5d3aaf-9d31-4d0e-ae21-17062482f579","name":"TRANSACTION.PIX.AUTOMATIC_PAYMENT.SCHEDULED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.AUTOMATIC_PAYMENT.SCHEDULED\",\n \"id\": \"10db828d-107e-434f-8b25-5046ed56a34b\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2026-01-20T13:13:08.977Z\",\n \"eventName\": \"PixInAutomaticPayment\",\n \"expectedAmount\": 0.01,\n \"fee\": 0,\n \"orderId\": \"58c02355-0485-4f18-9704-68c7aafbd4ad\",\n \"status\": \"pending\",\n \"transactionId\": \"14ab187e-c609-49f5-b96a-0e23cbedd7d0\",\n \"type\": \"credit\",\n \"updatedAt\": \"2026-01-20T13:13:08.977Z\"\n }\n}"},{"id":"939d158e-b10c-4e3e-b6f0-f0e324c208a2","name":"TRANSACTION.PIX.AUTOMATIC_PAYMENT.SCHEDULED_REJECTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.AUTOMATIC_PAYMENT.SCHEDULED_REJECTED\",\n \"id\": \"ee55a30b-ecd0-49e1-a169-3279bf9f2927\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2026-01-20T13:13:08.977Z\",\n \"eventName\": \"PixInAutomaticPayment\",\n \"expectedAmount\": 0.01,\n \"fee\": 0,\n \"orderId\": \"58c02355-0485-4f18-9704-68c7aafbd4ad\",\n \"status\": \"failed\",\n \"transactionId\": \"14ab187e-c609-49f5-b96a-0e23cbedd7d0\",\n \"type\": \"credit\",\n \"updatedAt\": \"2026-01-20T13:13:14.857Z\"\n },\n \"time\": \"2026-01-20T13:13:15.050Z\",\n \"version\": \"v1\"\n}"},{"id":"4e43f733-eade-4dbd-bda0-b9c982a14d34","name":"TRANSACTION.PIX.AUTOMATIC_PAYMENT.CANCELED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.AUTOMATIC_PAYMENT.CANCELED\",\n \"id\": \"7dbf8fcb-7ffa-435e-a126-36eeecde4c78\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2026-01-20T13:11:38.257Z\",\n \"eventName\": \"PixInAutomaticPayment\",\n \"expectedAmount\": 0.01,\n \"fee\": 0,\n \"orderId\": \"58c02355-0485-4f18-9704-68c7aafbd4ad\",\n \"status\": \"failed\",\n \"transactionId\": \"871c6d29-a46e-437a-83ca-8a5672b4562e\",\n \"type\": \"credit\",\n \"updatedAt\": \"2026-01-20T13:12:48.127Z\"\n },\n \"time\": \"2026-01-20T13:12:48.750Z\",\n \"version\": \"v1\"\n}"},{"id":"0a3f7d62-d239-45e1-b6d6-c60e17b84ff8","name":"TRANSACTION.PIX.AUTOMATIC_PAYMENT.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.AUTOMATIC_PAYMENT.FAILED\",\n \"id\": \"9460a064-5ff2-4739-beff-1bd06a850d28\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2026-01-29T19:06:09.052Z\",\n \"eventName\": \"PixInAutomaticPayment\",\n \"expectedAmount\": 0.54,\n \"fee\": 0,\n \"orderId\": \"f05cd400-9bef-4b8e-a4f7-e21531594665\",\n \"reason\": \"Sandbox failure\",\n \"status\": \"failed\",\n \"transactionId\": \"2c990825-b4ea-473a-bd13-b124afb2aa73\",\n \"type\": \"credit\",\n \"updatedAt\": \"2026-01-29T19:06:57.395Z\"\n },\n \"time\": \"2026-01-29T19:06:57.666Z\",\n \"version\": \"v1\"\n}"},{"id":"2856386c-174c-492f-9676-f2cec1c23de6","name":"TRANSACTION.PIX.AUTOMATIC_PAYMENT.PAID","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.AUTOMATIC_PAYMENT.PAID\",\n \"id\": \"7cc64a25-8e5b-42c4-8b8b-fb78d8787dfd\",\n \"payload\": {\n \"amount\": 0.7,\n \"createdAt\": \"2026-01-29T18:32:50.848Z\",\n \"eventName\": \"PixInAutomaticPayment\",\n \"expectedAmount\": 0.7,\n \"fee\": 0,\n \"orderId\": \"f812bfa7-9b2a-48e1-977a-6833bba7bff3\",\n \"paidAt\": \"2026-01-29T18:33:40.633Z\",\n \"status\": \"success\",\n \"transactionId\": \"8a958404-8ad5-4480-9217-df601824c214\",\n \"type\": \"credit\",\n \"updatedAt\": \"2026-01-29T18:33:40.633Z\"\n },\n \"time\": \"2026-01-29T18:33:40.833Z\",\n \"version\": \"v1\"\n}"},{"id":"db2114e8-da5c-4aec-8429-8ceca2c6e346","name":"TRANSACTION.PIX.REFUNDED.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.REFUNDED.SUCCEEDED\",\n \"id\": \"88bc5087-b11e-4bea-a90a-7c9bd40496ed\",\n \"payload\": {\n \"amount\": 3,\n \"createdAt\": \"2024-07-26T12:17:04.144Z\",\n \"eventName\": \"PixOutRefund\",\n \"externalId\": \"1735e2a9-5436-47bc-995a-162a6087584f\",\n \"fee\": 0,\n \"originalTransactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"status\": \"success\",\n \"transactionId\": \"53e7e754-0001-4236-b651-1bac9954d699\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:17:04.144Z\"\n },\n \"time\": \"2024-07-26T12:17:04.411Z\",\n \"version\": \"v1\"\n}\n"},{"id":"26c2d66d-c8c4-4c8b-9bbd-296ca183971b","name":"TRANSACTION.PIX.PAYMENT.REVERSAL.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.PIX.PAYMENT.REVERSAL.SUCCEEDED\",\r\n \"id\": \"80a84dce-560b-4b16-8934-05d82f2c8898\",\r\n \"payload\": {\r\n \"amount\": 2,\r\n \"createdAt\": \"2024-07-26T12:22:51.902Z\",\r\n \"eventName\": \"PixOutReversal\",\r\n \"externalId\": \"1b650419-972c-4972-96e6-787f1d86a321\",\r\n \"fee\": 10,\r\n \"originalTransactionId\": \"082a7970-f160-4b02-a330-b58e016d8b7a\",\r\n \"status\": \"success\",\r\n \"transactionId\": \"2c73b369-ae88-4f88-a678-a672d730ad70\",\r\n \"type\": \"credit\",\r\n \"updatedAt\": \"2024-07-26T12:22:51.902Z\"\r\n },\r\n \"time\": \"2024-07-26T12:22:54.612Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"a6cf515d-cfb1-4bec-9036-dda54d0a50a5","name":"TRANSACTION.PIX.REFUND.REVERSAL.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.REFUND.REVERSAL.SUCCEEDED\",\n \"id\": \"7323932c-7285-411e-bbe1-4175e7cd70e4\",\n \"payload\": {\n \"amount\": 0.01,\n \"createdAt\": \"2024-07-26T12:40:20.639Z\",\n \"eventName\": \"PixInRefundReversal\",\n \"fee\": 0,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"0e32f3e4-d161-4896-990f-64a74502a8bf\",\n \"status\": \"success\",\n \"transactionId\": \"c1e1d1ed-31b1-4d91-bd70-37f7dbaa4d13\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:40:20.639Z\"\n },\n \"time\": \"2024-07-26T12:40:23.779Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"9ab19e58-e379-4249-9620-0ebdfc9fe7a1"},{"name":"Pay Out","id":"501afabb-3a55-4b8f-891c-3c34ff4c12b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[{"id":"c56de310-0187-4b21-8782-5f776f443ac6","name":"TRANSACTION.PIX.PAYMENT.REQUESTED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.PAYMENT.REQUESTED\",\n \"id\": \"8f9afb1b-47a8-4648-8f37-d8ee1eb05a7b\",\n \"payload\": {\n \"amount\": -6,\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"eventName\": \"PixOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"success\",\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"feeId\": \"4b18acc3-91ec-4bfb-9bf8-78f4db2f2257\",\n \"id\": \"af5db776-e122-49c4-b88f-ed7f0a97c927\",\n \"name\": \"Fee\",\n \"operation\": \"pix\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"max\": null,\n \"min\": 0,\n \"name\": \"Rule\",\n \"ruleId\": \"c1a1430e-a35f-45b2-ae16-dd066dca6478\",\n \"type\": \"flatFee\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"updatedAt\": \"2024-07-26T12:16:08.232Z\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:16:08.232Z\"\n },\n \"time\": \"2024-07-26T12:16:23.309Z\",\n \"version\": \"v1\"\n}\n"},{"id":"b3de0592-fd3b-446f-ba9b-972b2762393d","name":"TRANSACTION.PIX.PAYMENT.SUCCEEDED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.PAYMENT.SUCCEEDED\",\n \"id\": \"fefe9a8a-117b-4fe5-a5ba-6dd1fe31ecdf\",\n \"payload\": {\n \"amount\": -6,\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"eventName\": \"PixOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"success\",\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"feeId\": \"4b18acc3-91ec-4bfb-9bf8-78f4db2f2257\",\n \"id\": \"af5db776-e122-49c4-b88f-ed7f0a97c927\",\n \"name\": \"Fee\",\n \"operation\": \"pix\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"max\": null,\n \"min\": 0,\n \"name\": \"Rule\",\n \"ruleId\": \"c1a1430e-a35f-45b2-ae16-dd066dca6478\",\n \"type\": \"flatFee\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"updatedAt\": \"2024-07-26T12:16:08.232Z\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:16:33.520Z\"\n },\n \"time\": \"2024-07-26T12:16:34.169Z\",\n \"version\": \"v1\"\n}\n"},{"id":"c98bbe70-54f4-4f39-b417-d6d86ba87994","name":"TRANSACTION.PIX.PAYMENT.FAILED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.PAYMENT.FAILED\",\n \"id\": \"df5721b1-f70a-4a7d-b3fe-503ac98d83d7\",\n \"payload\": {\n \"amount\": -2,\n \"createdAt\": \"2024-07-26T12:22:32.016Z\",\n \"error\": {\n \"code\": \"PIS-018\",\n \"message\": \"The minimum amount to send a successfully pix is R$ 5 and you sent R$ -2\"\n },\n \"eventName\": \"PixOut\",\n \"fee\": -20,\n \"information\": \"Your information\",\n \"status\": \"failed\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"failed\",\n \"createdAt\": \"2024-07-26T12:22:51.525Z\",\n \"feeId\": \"4b18acc3-91ec-4bfb-9bf8-78f4db2f2257\",\n \"id\": \"422acb9d-e02b-4300-acf4-7b519bae6d6a\",\n \"name\": \"Fee\",\n \"operation\": \"pix\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"name\": \"Rule\",\n \"ruleId\": \"c1a1430e-a35f-45b2-ae16-dd066dca6478\",\n \"type\": \"flatFee\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"082a7970-f160-4b02-a330-b58e016d8b7a\",\n \"updatedAt\": \"2024-07-26T12:22:51.525Z\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"082a7970-f160-4b02-a330-b58e016d8b7a\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:22:51.527Z\"\n },\n \"time\": \"2024-07-26T12:22:52.158Z\",\n \"version\": \"v1\"\n}\n"},{"id":"a5a0d05b-1bbb-4a9e-918c-8d5ff1f82167","name":"TRANSACTION.PIX.REFUND.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.REFUND.REQUESTED\",\n \"id\": \"afb98873-9681-4cc6-aef6-4cebc5dd4586\",\n \"payload\": {\n \"amount\": -5,\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"eventName\": \"PixInRefund\",\n \"externalId\": \"343f71fd-a7dd-40b1-853e-09b473b94a79\",\n \"fee\": 0,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"requested\",\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"feeId\": \"9804f648-acb8-419a-9ad2-1ff9c8c01af6\",\n \"id\": \"5787d6bd-3f84-4622-84b9-738914bd2f67\",\n \"name\": \"Fee Success\",\n \"operation\": \"pixRefund\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"max\": null,\n \"min\": 1000,\n \"name\": \"Rule\",\n \"ruleId\": \"1c648231-f147-425d-86f8-00424fe2d0c4\",\n \"type\": \"flatFee\",\n \"value\": 0\n }\n ],\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"updatedAt\": \"2024-07-26T12:37:58.542Z\",\n \"value\": 0\n }\n ],\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:37:58.542Z\"\n },\n \"time\": \"2024-07-26T12:37:59.279Z\",\n \"version\": \"v1\"\n}\n"},{"id":"cacc8416-6e6b-4e6c-a063-3c345b8f9f4f","name":"TRANSACTION.PIX.REFUND.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.REFUND.SUCCEEDED\",\n \"id\": \"b43f22bf-2ddf-4acb-9ae1-e46cbaf5c942\",\n \"payload\": {\n \"amount\": -5,\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"eventName\": \"PixInRefund\",\n \"externalId\": \"343f71fd-a7dd-40b1-853e-09b473b94a79\",\n \"fee\": 0,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"requested\",\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"feeId\": \"9804f648-acb8-419a-9ad2-1ff9c8c01af6\",\n \"id\": \"5787d6bd-3f84-4622-84b9-738914bd2f67\",\n \"name\": \"Fee Success\",\n \"operation\": \"pixRefund\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"max\": null,\n \"min\": 1000,\n \"name\": \"Rule\",\n \"ruleId\": \"1c648231-f147-425d-86f8-00424fe2d0c4\",\n \"type\": \"flatFee\",\n \"value\": 0\n }\n ],\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"updatedAt\": \"2024-07-26T12:37:58.542Z\",\n \"value\": 0\n }\n ],\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:38:33.594Z\"\n },\n \"time\": \"2024-07-26T12:38:34.600Z\",\n \"version\": \"v1\"\n}\n"},{"id":"24249f73-bb9c-4e72-b620-c4743bef233d","name":"TRANSACTION.PIX.REFUND.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.PIX.REFUND.FAILED\",\n \"id\": \"2cca4db7-0a52-472c-9ac6-37bb8438f50c\",\n \"payload\": {\n \"amount\": -0.01,\n \"createdAt\": \"2024-07-26T12:39:49.839Z\",\n \"eventName\": \"PixInRefund\",\n \"externalId\": \"699d84b2-12fd-4b6b-9418-498f8495a174\",\n \"fee\": 0,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"failed\",\n \"transactionFees\": [\n {\n \"chargeMode\": \"failed\",\n \"createdAt\": \"2024-07-26T12:40:20.539Z\",\n \"feeId\": \"9804f648-acb8-419a-9ad2-1ff9c8c01af6\",\n \"id\": \"ffb6c6f9-d6e6-4083-bef5-b07f18804d77\",\n \"name\": \"Fee Success\",\n \"operation\": \"pixRefund\",\n \"rules\": [\n {\n \"currency\": \"BRL\",\n \"exchangeRate\": 1,\n \"name\": \"Rule\",\n \"ruleId\": \"1c648231-f147-425d-86f8-00424fe2d0c4\",\n \"type\": \"flatFee\",\n \"value\": 0\n }\n ],\n \"transactionId\": \"0e32f3e4-d161-4896-990f-64a74502a8bf\",\n \"updatedAt\": \"2024-07-26T12:40:20.539Z\",\n \"value\": 0\n }\n ],\n \"transactionId\": \"0e32f3e4-d161-4896-990f-64a74502a8bf\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:40:20.540Z\"\n },\n \"time\": \"2024-07-26T12:40:21.605Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"501afabb-3a55-4b8f-891c-3c34ff4c12b7"}],"id":"23fbfb94-f27f-41a1-a874-5038622c76aa","description":"Pay In
\nTRANSACTION.PIX.RECEIVED.REQUESTED
TRANSACTION.PIX.RECEIVED.SUCCEEDED
TRANSACTION.PIX.REFUNDED.SUCCEEDED
TRANSACTION.PIX.PAYMENT.REVERSAL.SUCCEEDED
TRANSACTION.PIX.PAYMENT.FAILED event occursTRANSACTION.PIX.REFUND.REVERSAL.SUCCEEDED
TRANSACTION.PIX.REFUND.FAILED event occursTRANSACTION.PIX.AUTOMATIC_CONTRACT.REQUESTED→ pending
TRANSACTION.PIX.AUTOMATIC_CONTRACT.ACCEPTED→ success
TRANSACTION.PIX.AUTOMATIC_PAYMENT.SCHEDULED → pending
TRANSACTION.PIX.AUTOMATIC_PAYMENT.RECEIVED.SCHEDULED_REJECTED→ failed
TRANSACTION.PIX.AUTOMATIC_PAYMENT.RECEIVED.SUCCEEDED → success
TRANSACTION.PIX.AUTOMATIC_PAYMENT.CANCELED → failed
TRANSACTION.PIX.AUTOMATIC_PAYMENT.FAILED→ failed
TRANSACTION.PIX.AUTOMATIC_PAYMENT.PAID→ success
Pay Out
\nTRANSACTION.PIX.PAYMENT.REQUESTED
TRANSACTION.PIX.PAYMENT.SUCCEEDED
TRANSACTION.PIX.PAYMENT.FAILED
TRANSACTION.PIX.REFUND.REQUESTED
TRANSACTION.PIX.REFUND.SUCCEEDED
TRANSACTION.PIX.REFUND.FAILED
TRANSACTION.RESERVE.PAYMENT.SUCCEEDED
TRANSACTION.PIX.RECEIVED.SUCCEEDED event is reserved.Pay In
\nTRANSACTION.CREDIT_CARD.CAPTURE.REQUESTED
TRANSACTION.CREDIT_CARD.CAPTURE.SUCCEEDED
TRANSACTION.CREDIT_CARD.CAPTURE.FAILED
TRANSACTION.CREDIT_CARD.AUTHORIZATION.REQUESTED
TRANSACTION.CREDIT_CARD.AUTHORIZATION.SUCCEEDED
TRANSACTION.CREDIT_CARD.AUTHORIZATION.FAILED
TRANSACTION.CREDIT_CARD.CANCELLATION.REVERSAL.SUCCEEDED
TRANSACTION.CREDIT_CARD.CANCELLATION.FAILED event occurs.TRANSACTION.CREDIT_CARD.REFUND.REVERSAL.SUCCEEDED
TRANSACTION.CREDIT_CARD.REFUND.FAILED event occursPay Out
\nTRANSACTION.CREDIT_CARD.CANCELLATION.REQUESTED
TRANSACTION.CREDIT_CARD.CANCELLATION.SUCCEEDED
TRANSACTION.CREDIT_CARD.CANCELLATION.FAILED
TRANSACTION.CREDIT_CARD.CHARGEBACK.SUCCEEDED
TRANSACTION.RESERVE.PAYMENT.SUCCEEDED
TRANSACTION.CREDIT_CARD.CAPTURE.SUCCEEDED event is reserved.TRANSACTION.CREDIT_CARD.REFUND.REQUESTED
TRANSACTION.CREDIT_CARD.REFUND.SUCCEEDED
TRANSACTION.CREDIT_CARD.REFUND.FAILED
Each example represents an event containing transaction information of the Pay In type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"bbb7c33f-1488-416b-a866-88dcaa02e50b","name":"TRANSACTION.ONLINE_BANK_TRANSFER.RECEIVED.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.RECEIVED.REQUESTED\",\n \"id\": \"99b17993-7cb7-42bc-8938-f4367b91179d\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"PixIn\",\n \"expectedAmount\": 10,\n \"fee\": -0.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 1.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:32:49.770Z\"\n },\n \"time\": \"2024-07-26T12:32:52.825Z\",\n \"version\": \"v1\"\n}\n"},{"id":"2164a6ec-530c-4282-a3dc-f7dd293a96f2","name":"TRANSACTION.ONLINE_BANK_TRANSFER.RECEIVED.SUCCEEDED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"url":{"raw":"","query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.RECEIVED.SUCCEEDED\",\n \"id\": \"f59258f9-9ebf-4fc9-bdda-af48b27ece02\",\n \"payload\": {\n \"amount\": 10,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"PixIn\",\n \"expectedAmount\": 10,\n \"fee\": -1.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 0.5\n },\n {\n \"name\": \"Fee Name\",\n \"value\": 1\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:34:36.763Z\"\n },\n \"time\": \"2024-07-26T12:34:40.889Z\",\n \"version\": \"v1\"\n}\n"},{"id":"950241ed-8b1c-4f7e-8a14-621b6828e609","name":"TRANSACTION.ONLINE_BANK_TRANSFER.REFUNDED.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.REFUNDED.SUCCEEDED\",\n \"id\": \"88bc5087-b11e-4bea-a90a-7c9bd40496ed\",\n \"payload\": {\n \"amount\": 3,\n \"createdAt\": \"2024-07-26T12:17:04.144Z\",\n \"eventName\": \"PixOutRefund\",\n \"externalId\": \"1735e2a9-5436-47bc-995a-162a6087584f\",\n \"fee\": 0,\n \"originalTransactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"status\": \"success\",\n \"transactionId\": \"53e7e754-0001-4236-b651-1bac9954d699\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:17:04.144Z\"\n },\n \"time\": \"2024-07-26T12:17:04.411Z\",\n \"version\": \"v1\"\n}\n"},{"id":"5b22bf6e-179e-4dbc-a1f9-6ece2032405a","name":"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.REVERSAL.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.REVERSAL.SUCCEEDED\",\r\n \"id\": \"80a84dce-560b-4b16-8934-05d82f2c8898\",\r\n \"payload\": {\r\n \"amount\": 2,\r\n \"createdAt\": \"2024-07-26T12:22:51.902Z\",\r\n \"eventName\": \"PixOutReversal\",\r\n \"externalId\": \"1b650419-972c-4972-96e6-787f1d86a321\",\r\n \"fee\": 0,\r\n \"originalTransactionId\": \"082a7970-f160-4b02-a330-b58e016d8b7a\",\r\n \"status\": \"success\",\r\n \"transactionId\": \"2c73b369-ae88-4f88-a678-a672d730ad70\",\r\n \"type\": \"credit\",\r\n \"updatedAt\": \"2024-07-26T12:22:51.902Z\"\r\n },\r\n \"time\": \"2024-07-26T12:22:54.612Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"0f4c186e-08a3-4d5b-815d-0f6ac9231f33","name":"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.REVERSAL.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.REVERSAL.SUCCEEDED\",\n \"id\": \"7323932c-7285-411e-bbe1-4175e7cd70e4\",\n \"payload\": {\n \"amount\": 0.01,\n \"createdAt\": \"2024-07-26T12:40:20.639Z\",\n \"eventName\": \"PixInRefundReversal\",\n \"fee\": 0,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"0e32f3e4-d161-4896-990f-64a74502a8bf\",\n \"status\": \"success\",\n \"transactionId\": \"c1e1d1ed-31b1-4d91-bd70-37f7dbaa4d13\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:40:20.639Z\"\n },\n \"time\": \"2024-07-26T12:40:23.779Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"887b3ba6-86d3-417d-8805-2172547d8788"},{"name":"Pay Out","id":"a3e1aff9-4dfb-4dd1-8779-d846fc929c49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"Each example represents an event containing transaction information of the Pay Out type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"016d8e9d-a4e0-4059-9f83-bb0911f9ac70","name":"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.REQUESTED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.REQUESTED\",\n \"id\": \"8f9afb1b-47a8-4648-8f37-d8ee1eb05a7b\",\n \"payload\": {\n \"amount\": -6,\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"eventName\": \"PixOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:16:08.232Z\"\n },\n \"time\": \"2024-07-26T12:16:23.309Z\",\n \"version\": \"v1\"\n}\n"},{"id":"a93c29a5-6aea-4d63-9b3c-2f9df6f48e57","name":"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.SUCCEEDED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.SUCCEEDED\",\n \"id\": \"fefe9a8a-117b-4fe5-a5ba-6dd1fe31ecdf\",\n \"payload\": {\n \"amount\": -6,\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"eventName\": \"PixOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 9\n },\n {\n \"name\": \"Fee Name\",\n \"value\": 1\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:16:33.520Z\"\n },\n \"time\": \"2024-07-26T12:16:34.169Z\",\n \"version\": \"v1\"\n}\n"},{"id":"ea4f1b53-1566-44fc-9cc7-49e709dadf98","name":"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.FAILED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.FAILED\",\n \"id\": \"df5721b1-f70a-4a7d-b3fe-503ac98d83d7\",\n \"payload\": {\n \"amount\": -2,\n \"createdAt\": \"2024-07-26T12:22:32.016Z\",\n \"error\": {\n \"code\": \"PIS-018\",\n \"message\": \"The minimum amount to send a successfully pix is R$ 5 and you sent R$ -2\"\n },\n \"eventName\": \"PixOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"failed\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"082a7970-f160-4b02-a330-b58e016d8b7a\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:22:51.527Z\"\n },\n \"time\": \"2024-07-26T12:22:52.158Z\",\n \"version\": \"v1\"\n}\n"},{"id":"df98b05a-3807-44c9-b835-9ade6ce0a18e","name":"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.REQUESTED\",\n \"id\": \"afb98873-9681-4cc6-aef6-4cebc5dd4586\",\n \"payload\": {\n \"amount\": -5,\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"eventName\": \"PixInRefund\",\n \"externalId\": \"343f71fd-a7dd-40b1-853e-09b473b94a79\",\n \"fee\": -1,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"pending\",\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:37:58.542Z\"\n },\n \"time\": \"2024-07-26T12:37:59.279Z\",\n \"version\": \"v1\"\n}\n"},{"id":"1d6b9b8b-d04e-4fc4-a64e-7c7711c65bc1","name":"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.SUCCEEDED\",\n \"id\": \"b43f22bf-2ddf-4acb-9ae1-e46cbaf5c942\",\n \"payload\": {\n \"amount\": -5,\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"eventName\": \"PixInRefund\",\n \"externalId\": \"343f71fd-a7dd-40b1-853e-09b473b94a79\",\n \"fee\": -1,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"success\",\n \"transactionFees\": [],\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:38:33.594Z\"\n },\n \"time\": \"2024-07-26T12:38:34.600Z\",\n \"version\": \"v1\"\n}\n"},{"id":"11adc0db-cd71-4ce4-becd-e45a9e20e760","name":"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.ONLINE_BANK_TRANSFER.REFUND.FAILED\",\n \"id\": \"2cca4db7-0a52-472c-9ac6-37bb8438f50c\",\n \"payload\": {\n \"amount\": -0.01,\n \"createdAt\": \"2024-07-26T12:39:49.839Z\",\n \"eventName\": \"PixInRefund\",\n \"externalId\": \"699d84b2-12fd-4b6b-9418-498f8495a174\",\n \"fee\": -1,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"failed\",\n \"transactionFees\": [],\n \"transactionId\": \"0e32f3e4-d161-4896-990f-64a74502a8bf\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:40:20.540Z\"\n },\n \"time\": \"2024-07-26T12:40:21.605Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"a3e1aff9-4dfb-4dd1-8779-d846fc929c49"}],"id":"50ef9510-dba4-4570-864b-39ec5fca0511","description":"TRANSACTION.ONLINE_BANK_TRANSFER.RECEIVED.REQUESTEDTRANSACTION.ONLINE_BANK_TRANSFER.RECEIVED.SUCCEEDEDTRANSACTION.ONLINE_BANK_TRANSFER.REFUNDED.SUCCEEDEDTRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.REVERSAL.SUCCEEDEDTRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.FAILED event occursTRANSACTION.ONLINE_BANK_TRANSFER.REFUND.REVERSAL.SUCCEEDEDTRANSACTION.ONLINE_BANK_TRANSFER.REFUND.FAILED event occursTRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.REQUESTEDTRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.SUCCEEDEDTRANSACTION.ONLINE_BANK_TRANSFER.PAYMENT.FAILEDTRANSACTION.ONLINE_BANK_TRANSFER.REFUND.REQUESTEDTRANSACTION.ONLINE_BANK_TRANSFER.REFUND.SUCCEEDEDTRANSACTION.ONLINE_BANK_TRANSFER.REFUND.FAILEDTRANSACTION.RESERVE.PAYMENT.SUCCEEDEDTRANSACTION.ONLINE_BANK_TRANSFER.RECEIVED.SUCCEEDED event is reserved.Each example represents an event containing transaction information of the Pay In type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"de6640fe-1d50-4a77-b7cd-330a0dd16e69","name":"TRANSACTION.E_WALLET.RECEIVED.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.RECEIVED.REQUESTED\",\n \"id\": \"99b17993-7cb7-42bc-8938-f4367b91179d\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"EWalletIn\",\n \"expectedAmount\": 10,\n \"fee\": -0.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 1.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:32:49.770Z\"\n },\n \"time\": \"2024-07-26T12:32:52.825Z\",\n \"version\": \"v1\"\n}\n"},{"id":"d6c791eb-4dfd-4525-b248-3b78731b81d8","name":"TRANSACTION.E_WALLET.RECEIVED.SUCCEEDED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"url":{"raw":"","query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.RECEIVED.SUCCEEDED\",\n \"id\": \"f59258f9-9ebf-4fc9-bdda-af48b27ece02\",\n \"payload\": {\n \"amount\": 10,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"EWalletIn\",\n \"expectedAmount\": 10,\n \"fee\": -1.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 0.5\n },\n {\n \"name\": \"Fee Name\",\n \"value\": 1\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:34:36.763Z\"\n },\n \"time\": \"2024-07-26T12:34:40.889Z\",\n \"version\": \"v1\"\n}\n"},{"id":"7a186f99-8df0-41d0-9ff2-fb810cae1a84","name":"TRANSACTION.E_WALLET.REFUNDED.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.REFUNDED.SUCCEEDED\",\n \"id\": \"88bc5087-b11e-4bea-a90a-7c9bd40496ed\",\n \"payload\": {\n \"amount\": 3,\n \"createdAt\": \"2024-07-26T12:17:04.144Z\",\n \"eventName\": \"EWALLETOutRefund\",\n \"externalId\": \"1735e2a9-5436-47bc-995a-162a6087584f\",\n \"fee\": 0,\n \"originalTransactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"status\": \"success\",\n \"transactionId\": \"53e7e754-0001-4236-b651-1bac9954d699\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:17:04.144Z\"\n },\n \"time\": \"2024-07-26T12:17:04.411Z\",\n \"version\": \"v1\"\n}\n"},{"id":"72dbaabf-6710-43d2-b29d-d76347996684","name":"TRANSACTION.E_WALLET.PAYMENT.REVERSAL.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.PAYMENT.REVERSAL.SUCCEEDED\",\n \"id\": \"80a84dce-560b-4b16-8934-05d82f2c8898\",\n \"payload\": {\n \"amount\": 2,\n \"createdAt\": \"2024-07-26T12:22:51.902Z\",\n \"eventName\": \"EWalletOutReversal\",\n \"externalId\": \"1b650419-972c-4972-96e6-787f1d86a321\",\n \"fee\": 0,\n \"originalTransactionId\": \"082a7970-f160-4b02-a330-b58e016d8b7a\",\n \"status\": \"success\",\n \"transactionId\": \"2c73b369-ae88-4f88-a678-a672d730ad70\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:22:51.902Z\"\n },\n \"time\": \"2024-07-26T12:22:54.612Z\",\n \"version\": \"v1\"\n}"},{"id":"40fe2bfc-219d-491f-a70f-c942e47efc84","name":"TRANSACTION.E_WALLET.REFUND.REVERSAL.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.REFUND.REVERSAL.SUCCEEDED\",\n \"id\": \"7323932c-7285-411e-bbe1-4175e7cd70e4\",\n \"payload\": {\n \"amount\": 0.01,\n \"createdAt\": \"2024-07-26T12:40:20.639Z\",\n \"eventName\": \"EWalletInRefundReversal\",\n \"fee\": 0,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"0e32f3e4-d161-4896-990f-64a74502a8bf\",\n \"status\": \"success\",\n \"transactionId\": \"c1e1d1ed-31b1-4d91-bd70-37f7dbaa4d13\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:40:20.639Z\"\n },\n \"time\": \"2024-07-26T12:40:23.779Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"1fa8773f-d1bb-474a-8a4e-207d09617a47"},{"name":"Pay Out","id":"bd514d60-f148-4cb0-ab5a-614fdcbe1a97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"Each example represents an event containing transaction information of the Pay Out type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"634b662d-84f5-4629-b03c-8d846565ce6d","name":"TRANSACTION.E_WALLET.PAYMENT.REQUESTED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.PAYMENT.REQUESTED\",\n \"id\": \"8f9afb1b-47a8-4648-8f37-d8ee1eb05a7b\",\n \"payload\": {\n \"amount\": -6,\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"eventName\": \"EWalletOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:16:08.232Z\"\n },\n \"time\": \"2024-07-26T12:16:23.309Z\",\n \"version\": \"v1\"\n}\n"},{"id":"7bfd1fcf-d91d-4b55-8d9c-30ad93865423","name":"TRANSACTION.E_WALLET.PAYMENT.SUCCEEDED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.PAYMENT.SUCCEEDED\",\n \"id\": \"fefe9a8a-117b-4fe5-a5ba-6dd1fe31ecdf\",\n \"payload\": {\n \"amount\": -6,\n \"createdAt\": \"2024-07-26T12:16:08.232Z\",\n \"eventName\": \"EWalletOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 9\n },\n {\n \"name\": \"Fee Name\",\n \"value\": 1\n }\n ],\n \"transactionId\": \"966c8cdb-16bb-4d88-a468-4d2e17bac055\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:16:33.520Z\"\n },\n \"time\": \"2024-07-26T12:16:34.169Z\",\n \"version\": \"v1\"\n}\n"},{"id":"c3dc2c94-43be-4f50-a679-33fcbad2bab6","name":"TRANSACTION.E_WALLET.PAYMENT.FAILED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.PAYMENT.FAILED\",\n \"id\": \"df5721b1-f70a-4a7d-b3fe-503ac98d83d7\",\n \"payload\": {\n \"amount\": -2,\n \"createdAt\": \"2024-07-26T12:22:32.016Z\",\n \"error\": {\n \"code\": \"PIS-018\",\n \"message\": \"The minimum amount to send a successfully pix is R$ 5 and you sent R$ -2\"\n },\n \"eventName\": \"EWalletOut\",\n \"fee\": -10,\n \"information\": \"Your information\",\n \"status\": \"failed\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 10\n }\n ],\n \"transactionId\": \"082a7970-f160-4b02-a330-b58e016d8b7a\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:22:51.527Z\"\n },\n \"time\": \"2024-07-26T12:22:52.158Z\",\n \"version\": \"v1\"\n}\n"},{"id":"f25256c8-ae0b-40f8-a351-169f5af1dcf7","name":"TRANSACTION.E_WALLET.REFUND.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.REFUND.REQUESTED\",\n \"id\": \"afb98873-9681-4cc6-aef6-4cebc5dd4586\",\n \"payload\": {\n \"amount\": -5,\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"eventName\": \"EWalletInRefund\",\n \"externalId\": \"343f71fd-a7dd-40b1-853e-09b473b94a79\",\n \"fee\": -1,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"pending\",\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:37:58.542Z\"\n },\n \"time\": \"2024-07-26T12:37:59.279Z\",\n \"version\": \"v1\"\n}\n"},{"id":"c17ac8f1-3466-4eba-9cb5-47c212ebe9d4","name":"TRANSACTION.E_WALLET.REFUND.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.REFUND.SUCCEEDED\",\n \"id\": \"b43f22bf-2ddf-4acb-9ae1-e46cbaf5c942\",\n \"payload\": {\n \"amount\": -5,\n \"createdAt\": \"2024-07-26T12:37:58.542Z\",\n \"eventName\": \"EWalletInRefund\",\n \"externalId\": \"343f71fd-a7dd-40b1-853e-09b473b94a79\",\n \"fee\": -1,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"success\",\n \"transactionFees\": [],\n \"transactionId\": \"def1d235-077f-4abb-b6f1-7e4a1ccf6270\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:38:33.594Z\"\n },\n \"time\": \"2024-07-26T12:38:34.600Z\",\n \"version\": \"v1\"\n}\n"},{"id":"58f56a38-9c68-40b5-abd1-923ef3f3204d","name":"TRANSACTION.E_WALLET.REFUND.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.E_WALLET.REFUND.FAILED\",\n \"id\": \"2cca4db7-0a52-472c-9ac6-37bb8438f50c\",\n \"payload\": {\n \"amount\": -0.01,\n \"createdAt\": \"2024-07-26T12:39:49.839Z\",\n \"eventName\": \"EWalletInRefund\",\n \"externalId\": \"699d84b2-12fd-4b6b-9418-498f8495a174\",\n \"fee\": -1,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"status\": \"failed\",\n \"transactionFees\": [],\n \"transactionId\": \"0e32f3e4-d161-4896-990f-64a74502a8bf\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T12:40:20.540Z\"\n },\n \"time\": \"2024-07-26T12:40:21.605Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"bd514d60-f148-4cb0-ab5a-614fdcbe1a97"}],"id":"d2a6be9c-259d-4970-9a24-979381067114","description":"TRANSACTION.E_WALLET.RECEIVED.REQUESTEDTRANSACTION.E_WALLET.RECEIVED.SUCCEEDEDTRANSACTION.E_WALLET.REFUNDED.SUCCEEDEDTRANSACTION.E_WALLET.PAYMENT.REVERSAL.SUCCEEDEDTRANSACTION.E_WALLET.PAYMENT.FAILED event occursTRANSACTION.E_WALLET.REFUND.REVERSAL.SUCCEEDEDTRANSACTION.E_WALLET.REFUND.FAILED event occursTRANSACTION.E_WALLET.PAYMENT.REQUESTEDTRANSACTION.E_WALLET.PAYMENT.SUCCEEDEDTRANSACTION.E_WALLET.PAYMENT.FAILEDTRANSACTION.E_WALLET.REFUND.REQUESTEDTRANSACTION.E_WALLET.REFUND.SUCCEEDEDTRANSACTION.E_WALLET.REFUND.FAILEDTRANSACTION.RESERVE.PAYMENT.SUCCEEDEDTRANSACTION.E_WALLET.RECEIVED.SUCCEEDED event is reserved.Each example represents an event containing transaction information of the Pay In type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"3752f874-7515-4020-9d98-6028ed207b18","name":"TRANSACTION.OXXO_PAY.RECEIVED.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.OXXO_PAY.RECEIVED.REQUESTED\",\n \"id\": \"99b17993-7cb7-42bc-8938-f4367b91179d\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"OxxoPayIn\",\n \"expectedAmount\": 10,\n \"fee\": -0.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 1.5\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:32:49.770Z\"\n },\n \"time\": \"2024-07-26T12:32:52.825Z\",\n \"version\": \"v1\"\n}\n"},{"id":"93091e45-7a23-407d-835f-db1cd6f3b2a9","name":"TRANSACTION.OXXO_PAY.RECEIVED.SUCCEEDED","originalRequest":{"method":"POST","header":[{"key":"content-hmac","value":"sha256=09a180e94a2616aa1865851cb37d8f8c7903278f070587c33a147b8d8fad55a2","description":"The hmac should be used to validate the request origin with the secret key of received when webhook is registered"}],"url":{"raw":"","query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.OXXO_PAY.RECEIVED.SUCCEEDED\",\n \"id\": \"f59258f9-9ebf-4fc9-bdda-af48b27ece02\",\n \"payload\": {\n \"amount\": 10,\n \"createdAt\": \"2024-07-26T12:32:49.770Z\",\n \"eventName\": \"OxxoPayIn\",\n \"expectedAmount\": 10,\n \"fee\": -1.5,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"status\": \"success\",\n \"transactionFees\": [\n {\n \"name\": \"Fee\",\n \"value\": 0.5\n },\n {\n \"name\": \"Fee Name\",\n \"value\": 1\n }\n ],\n \"transactionId\": \"2b696f25-1c99-4104-a4d6-385721f69010\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T12:34:36.763Z\"\n },\n \"time\": \"2024-07-26T12:34:40.889Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"5811c705-19d4-4631-bb65-4371eb98507b"}],"id":"a47db656-a129-4400-bfcf-33c54e698584","description":"Pay In
\nTRANSACTION.OXXO_PAY.RECEIVED.REQUESTED
TRANSACTION.OXXO_PAY.RECEIVED.SUCCEEDED
This section contains some examples of transaction webhooks.
\n\n\nAll monetary values are floating point numbers with two decimal places.
\n
Payload field data example
\nIf a field has the description (Optional) it means that depending on the event it may not be present, the field will be sent if it exists in the record of the transaction that generated the event.
\n{\n Transaction amount\n It is negative if the type is debit and positive if the type is credit\n \"amount\": -0.6,\n (Optional) Expected amount if is a pending credit transaction\n \"expectedAmount\": 0,\n \"createdAt\": \"Creation date\",\n \"eventName\": \"PixInRefund\",\n (Optional)\n \"information\": \"Some aditional information\"\n (Optional)\n \"externalId\": \"Idempotency key\",\n Total fee paid\n \"fee\": 0,\n (Optional) This field is empty if it is a debit type transaction\n \"orderId\": \"Order identifier\",\n (Optional) This field exists when the transaction was generated from \n another transaction\n \"originalTransactionId\": \"Original transaction identifier\",\n Transaction status\n \"status\": \"pending\" | \"success\" | \"failed\",\n (Optional) Fees paid\n \"transactionFees\": [\n {\n Indicates the status of the transaction at the time of billing\n \"chargeMode\": \"requested\" | \"success\" | \"failed\"\n \"createdAt\": \"Creation date\",\n \"feeId\": \"Fee identifier\",\n \"id\": \"Transaction fee identifier\",\n \"name\": \"Fee Name\",\n Indicates the category of transaction in which the fee was charged\n \"operation\": \"pix\" | \"pixRefund\" | \"creditCard\" | \"creditCardRefund\" |\n \"creditCardChargeBack\" | \"creditCardAuthorization\" | \n \"creditCardCancellation\" | \"mexicanPayment\" | \"mexicanPaymentRefund\"\n \"rules\": [\n {\n The fee rule currency\n \"currency\": \"BRL\" | \"USD\" | \"MXN\",\n Exchange rate value when a currency conversion occurs for billing\n \"exchangeRate\": 1,\n Maximum transaction amount for charging the fee\n \"max\": null | 2000,\n Minimum transaction amount to charge the fee\n \"min\": 1000,\n \"name\": \"Rule Name\",\n \"ruleId\": \"Rule identifier\",\n Rule type\n Whether it is a fee calculated with a percentage or a fixed amount\n \"type\": \"percentage\" | \"flatFee\",\n \"value\": 0\n }\n ],\n Reference of the transaction in which the fee was charged\n \"transactionId\": \"Transaction identifier\",\n \"updatedAt\": \"Update date\",\n It is the sum of the value of all rules\n \"value\": 0\n }\n ],\n \"transactionId\": \"Transaction identifier\",\n Transaction type\n \"type\": \"credit\" | \"debit\",\n (Optional) Error data\n \"error\": {\n Error details \n \"message\": \"Failed to communicate with pix service\",\n Error code\n \"code\": \"ACQ-001\"\n }\n \"updatedAt\": \"Update date\"\n}\n\nORDER.PIX.OPENED
ORDER.PIX.FAILED
ORDER.PIX.PAID
ORDER.CREDITCARD.OPENED
ORDER.CREDITCARD.FAILED
ORDER.CREDITCARD.PAID
ORDER.CREDITCARD.AUTHORIZED
ORDER.CREDITCARD.UNAUTHORIZED
ORDER.CREDITCARD.CANCELED
Each example represents an event containing order information of the Credit Card type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"3e310d48-7c25-4175-ae5f-18faeeb828d7","name":"ORDER.ONLINE_BANK_TRANSFER.OPENED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"b25bc5e8-defc-4815-babc-bd06d1919a60\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.ONLINE_BANK_TRANSFER.OPENED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 2,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"onlineBankTransfer\",\r\n \"information\": \"Credit card order\",\r\n \"id\": \"d2d3b719-965a-4f6c-9ba6-469c44aced54\",\r\n \"status\": \"open\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"2c38a232-942a-4a41-a84f-a3dde3f4cefb","name":"ORDER.ONLINE_BANK_TRANSFER.PAID","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"47af4182-1786-4203-b4b2-4bdb584e80df\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.ONLINE_BANK_TRANSFER.PAID\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 7,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"onlineBankTransfer\",\r\n \"information\": \"Online Bank Transfer order\",\r\n \"id\": \"3bff98e0-afcf-408a-9e93-40c14d2fa575\",\r\n \"status\": \"paid\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"4915c94c-535c-4866-9ad5-99f0ae38bf10","name":"ORDER.ONLINE_BANK_TRANSFER.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"08727c3f-9711-412a-a182-c762ddb4838d\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.ONLINE_BANK_TRANSFER.FAILED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 0.02,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"onlineBankTransfer\",\r\n \"information\": \"Online Bank Transfer order\",\r\n \"id\": \"3bff98e0-afcf-408a-9e93-40c14d2fa575\",\r\n \"status\": \"failed\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"}],"_postman_id":"f0cde9d4-9484-4d95-86dc-f08226d38bbe"}],"id":"afd949e1-4f9c-4e4f-9a89-6989df6b82a8","description":"This type of webhook records transactions related to payment requests made via Online Bank Transfer
\nopen: The request is open and awaiting paymentfailed: The payment for the request failed or was rejectedpaid: The payment was successfulORDER.ONLINE_BANK_TRANSFER.OPENED → openORDER.ONLINE_BANK_TRANSFER.FAILED → failedORDER.ONLINE_BANK_TRANSFER.PAID → paid{Convert Gateway} is the base url for convrt apiEach example represents an event containing order information of the Credit Card type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"570c8f47-7e5b-4617-a538-0a2c5bff7543","name":"ORDER.E_WALLET.OPENED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"b25bc5e8-defc-4815-babc-bd06d1919a60\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.E_WALLET.OPENED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 2,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"eWallet\",\r\n \"information\": \"EWallet order\",\r\n \"id\": \"d2d3b719-965a-4f6c-9ba6-469c44aced54\",\r\n \"status\": \"open\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"dede9523-35fa-42d3-99ca-4010f2770135","name":"ORDER.E_WALLET.PAID","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"47af4182-1786-4203-b4b2-4bdb584e80df\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.E_WALLET.PAID\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 7,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"eWallet\",\r\n \"information\": \"EWallet order\",\r\n \"id\": \"3bff98e0-afcf-408a-9e93-40c14d2fa575\",\r\n \"status\": \"paid\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"497a5dfc-32e7-43ae-ba1f-fad96aadaef5","name":"ORDER.E_WALLET.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"08727c3f-9711-412a-a182-c762ddb4838d\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.E_WALLET.FAILED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 0.02,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"eWallet\",\r\n \"information\": \" EWallet order\",\r\n \"id\": \"3bff98e0-afcf-408a-9e93-40c14d2fa575\",\r\n \"status\": \"failed\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"}],"_postman_id":"9fa599e6-5776-4ccc-abf4-1a1fd0728669"}],"id":"34755dca-fe11-4622-870e-3b14d2a9375e","description":"This type of webhook records transactions related to payment requests made via E-Wallet
\nopen: The request is open and awaiting paymentfailed: The payment for the request failed or was rejectedpaid: The payment was successfulORDER.E_WALLET.OPENED → openORDER.E_WALLET.FAILED → failedORDER.E_WALLET.PAID → paid{Convert Gateway} is the base url for convrt apiEach example represents an event containing order information of the Credit Card type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"36198f1e-6341-40e5-8b18-8b015e31f354","name":"ORDER.OXXO_PAY.OPENED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"b25bc5e8-defc-4815-babc-bd06d1919a60\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.OXXO_PAY.OPENED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 2,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"oxxoPay\",\r\n \"information\": \"Oxxo Pay order\",\r\n \"id\": \"d2d3b719-965a-4f6c-9ba6-469c44aced54\",\r\n \"status\": \"open\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"25dfb624-0b32-4f78-baff-0a9e6fc14499","name":"ORDER.OXXO_PAY.PAID","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"47af4182-1786-4203-b4b2-4bdb584e80df\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.OXXO_PAY.PAID\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 7,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"oxxoPay\",\r\n \"information\": \"Oxxo Pay order\",\r\n \"id\": \"3bff98e0-afcf-408a-9e93-40c14d2fa575\",\r\n \"status\": \"paid\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"1196b512-c08d-4d59-be82-b2898d1b4ae8","name":"ORDER.OXXO_PAY.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"08727c3f-9711-412a-a182-c762ddb4838d\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.OXXO_PAY.FAILED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 0.02,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"oxxoPay\",\r\n \"information\": \" Oxxo pay order\",\r\n \"id\": \"3bff98e0-afcf-408a-9e93-40c14d2fa575\",\r\n \"status\": \"failed\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"}],"_postman_id":"ba3f1f1d-962b-4a31-a106-660203112dd8"}],"id":"193de51e-5eb6-4a63-8c37-0d6abd897186","description":"This type of webhook records transactions related to payment requests made via Oxxo Pay
\nopen: The request is open and awaiting payment
failed: The payment for the request failed or was rejected
paid: The payment was successful
ORDER.OXXO_PAY.OPENED → open
ORDER.OXXO_PAY.FAILED → failed
ORDER.OXXO_PAY.PAID → paid
{Convert Gateway} is the base url for convrt apiThis section contains some examples of order webhooks
\n\n\nAll monetary values are floating point numbers with two decimal places.
\n
Payload field data example
\nIf a field has the description (Optional) it means that depending on the event it may not be present, the field will be sent if it exists in the record of the order that generated the event.
{\n \"amount\": 100.50, // Order amount, awas positive\n (Optional)\n \"externalId\": \"Idempotency key\",\n \"paymentMethod\": \"pix\" | \"creditCard\" | \"codi\" | \"speiCodi\" | \"spei\",\n (Optional)\n \"information\": \"Some additional information\",\n \"id\": \"Oder identifier\",\n \"status\": \"open\" | \"paid\" | \"authorized\" | \"unauthorized\" | \"canceled\" | \"failed\"\n \"updatedAt\": \"Update date\",\n \"createdAt\": \"Creation date\"\n}\n\nORDER.PIX.OPENED
ORDER.PIX.FAILED
ORDER.PIX.PAID
This section contains some examples of payment link webhooks
\n\n\nAll monetary values are floating point numbers with two decimal places.
\n
Payload field data example
\nIf a field has the description (Optional) it means that depending on the event it may not be present, the field will be sent if it exists in the record of the order that generated the event.
{ \n \"amount\": 100.39, \n \"chosenPaymentMethod\": \"pix\", \n \"accountType\": \"payIn\" | \"payOut\" | \"full\",\n \"expiresIn\": 7200, \n \"code\": \"ABC1234\", \n \"merchantId\": \"Merchant identifier\", \n (Optional)\n \"accountId\": \"Account identifier\", \n (Optional)\n \"description\": \"Some additional information\", \n (Optional)\n \"transactionId\": \"Transaction identifier\",\n (Optional)\n \"orderId\": \"Order identifier\", \n \"currencies\": [\"BRL\", \"USD\"], \n \"currency\": \"BRL\", \n \"id\": \"Payment link identifier\", \n \"status\": \"pending\" | “paid” | “expired” | “cancelled” | “awaitingPayment” | “failed” | “processing”,\n \"notificationChannels\": [\"channel 1\", \"channel 2\"], \n \"updatedAt\": \"Update date\", \n \"createdAt\": \"Creation date\" \n}\n\nThis type of webhook records events related to payment requests made through the system. Payment links are generated for the available payment methods, allowing the payer to access a secure page and complete the transaction quickly and conveniently, without the need for manual.
\npending: The payment link was created
paid: The payment was successful paid
expired: The payment link was expired
cancelled: The payment link was cancelled
processing: The payment link is being processed
awaitingPayment: Payment generated awaiting customer action
failed: Payment failed
PAYMENT_LINK.PENDING → pending
PAYMENT_LINK.PAID → paid
PAYMENT_LINK.EXPIRED → expired
PAYMENT_LINK.CANCELLED → cancelled
PAYMENT_LINK.PROCESSING → processing
PAYMENT_LINK.AWAITING_PAYMENT → awaitingPayment
PAYMENT_LINK.FAILED → failed
{Convert Gateway} is the base url for convrt apiThis section contains some examples of payment link webhooks
\n\n\nAll monetary values are floating point numbers with two decimal places.
\n
Payload field data example
\nIf a field has the description (Optional) it means that depending on the event it may not be present, the field will be sent if it exists in the record of the order that generated the event.
{ \n \"amount\": 100.39, \n \"chosenPaymentMethod\": \"pix\", \n \"accountType\": \"payIn\" | \"payOut\" | \"full\",\n \"expiresIn\": 7200, \n \"code\": \"ABC1234\", \n \"merchantId\": \"Merchant identifier\", \n (Optional)\n \"accountId\": \"Account identifier\", \n (Optional)\n \"description\": \"Some additional information\", \n (Optional)\n \"transactionId\": \"Transaction identifier\",\n (Optional)\n \"orderId\": \"Order identifier\", \n \"currencies\": [\"BRL\", \"USD\"], \n \"currency\": \"BRL\", \n \"id\": \"Payment link identifier\", \n \"status\": \"pending\" | “paid” | “expired” | “cancelled” | “awaitingPayment” | “failed” | “processing”,\n \"notificationChannels\": [\"channel 1\", \"channel 2\"],\n \"origin\": \"MerchantPanel\",\n \"orderData\": {\n Order data depending on de chosen payment method\n },\n \"product\": {\n \"lowerName\": \"product\",\n \"name\": \"Product\",\n (Optional)\n \"description\": \"Product Description\"\n },\n \"updatedAt\": \"Update date\",\n \"createdAt\": \"Creation date\" \n}\n\nThis section contain the possible webhook notifications
\nWe expect to receive the status HTTP 200 in the response
\nOutput IPs
\nSANDBOX: 34.237.15.246
PRODUÇÃO: 44.213.150.110
Webhook data example
\n{\n Event type of the Webhook Event\n The list of possible events will be described in each section.\n \"event\": \"ENTITY.PAYMENT_METHOD.TYPE.STATUS\" | \"ENTITY.PAYMENT_METHOD.STATUS\",\n \"id\": \"Webhook event identifier\",\n The data in the payload depends on the entity type\n Examples of data present in each entity below\n \"payload\": {},\n \"time\": \"Time of webhook event creation\",\n \"version\": \"Version of the wehook API\"\n}\n\nRetry proccess
\nWhen we receive an unexpected status while sending the webhook, the attempt is cached so that it can be resent at another time. A timeout is added for the next attempt based on the number of previous attempts. After ten attempts, we consider the sending a failure and remove the attempt from the cache. The table below indicates the time interval between attempts.
\nInstructions for Validating HMAC Hash
\nAbout HMAC
\nHMAC (Hash-based Message Authentication Code) is a method used for verifying the integrity of information transmitted over an untrusted medium. It involves utilizing a secret key shared between parties to validate the transmitted information.
\nWe employ CryptoJS with the HmacSHA256 method to generate a hash using the hash key passed as a parameter.
Request Body prop data
const cryptoJS = require(\"crypto-js\");\nconst hmac = \"42b29f4a6432b45b20cff60f9587bcae0188680b137b2a39a285714525c90af3\";\nconst data = {\n id: \"92c429cd-2d14-4cd4-a870-2a6590343c26\", // Webhook Event Id\n time: \"2024-03-11T14:26:02.778Z\", // Time of Webhook Event creation\n event: \"TRANSACTION.PIX.REFUNDED.SUCCEEDED\", // Event type of the Webhook Event\n payload: {\n amount: 12.5, // Amount to be transfer\n orderId: \"d6d55e06-b0ef-462f-8f14-eb5fa9cca92e\", // Order Id\n fee: 0, // Fee Value to be paid\n externalId: \"279dc90b-92ef-4ad3-824c-1c070e72fa36\", // External Id\n eventName: \"PixIn\", // Event Name\n transactionFees: [], // Array of Transaction Fees\n type: \"credit\", // Transaction type\n balanceAfterTransaction: 18967.75, // Balance After This Transaction\n transactionId: \"34a12bf9-e7b7-43a5-9d06-40c0dc2ce5fe\", // Transaction Id\n status: \"success\", // Transaction Status [pending, success, failed]\n expectedAmount: 0, // Expected amount if is a pending credit transaction\n createdAt: \"2023-12-20T19:28:18.281Z\", // Created Date\n updatedAt: \"2023-12-20T19:28:34.038Z\", // Updated Date\n },\n version: \"v1\", // Version of the Wehook API\n};\nconst key = \"secretKey\";\nfunction main(receivedHmac) {\n const dataText = JSON.stringify(data);\n const hmac = cryptoJS.HmacSHA256(dataText, key);\n const hash = hmac.toString(cryptoJS.enc.Hex);\n console.log(hash);\n const hmacIsValid = receivedHmac === hash;\n console.log(`IsValid: ${hmacIsValid}`);\n}\nmain(hmac);\n\nIt is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\n \"capture\": true,\n \"amount\": 5.01,\n \"information\": \"information\", // optional\n //\"externalId\": \"1\",\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\",\n \"billing\": {\n \"firstName\": \"Dennis\",\n \"lastName\": \"Delarosa\",\n \"documentNumber\": \"01234567890\",\n \"address\": \"Rua Principal\",\n \"city\": \"São Paulo\",\n \"zip\": \"11222-100\",\n \"country\": \"US\",\n \"ipAddress\": \"1.1.1.1\",\n \"email\": \"johnlenon.silva@luby.com.br\",\n \"phoneNumber\": \"12133734253\"\n },\n \"creditCard\": {\n \"holderName\": \"Dennis Delarosa\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expMonth\": 6,\n \"expYear\": 2027,\n // \"walletId\": \"86536b02-e519-4f40-8712-6bd8d5e33115\", // Optional\n // \"walletName\": \"Bruce Wayne\", // Optional\n \"installment\": 1,\n \"type\": \"standard\",\n \"threadsPassThrough\": {\n \"mode\": \"frictionless\", // \"challenge\" | \"frictionless\" \n \"version\": \"2.1.0\", // \"2.1.0\" | \"2.2.0\",\n \"eci\": \"eci\",\n \"authenticationValue\": \"NDI0NjMxNTM1MzE1OTg3MjA2Mjc=\", // Authentication value (CAVV/AAV)\n \"dsTransactionId\": \"123456\",\n \"dsReferenceId\": \"ff13f6f9-9403-41b5-b5c3-7f77f975c20e\" // Optional\n }\n }\n // \"currency\": \"BRL\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/create-order-credit-card","description":"The endpoint makes an HTTP POST request to create a new order using a credit card. The request body should include the amount, external ID (optional), billing information, credit card details, installment, type, and notification URL. The credit card details should include the token, first six and last four digits, expiration month and year, and optionally wallet information and threads pass through details.
\nIf the capture field is sent as false and the amount is 1, instead of a regular authorization, Convrt will perform a Zero Auth authentication (only Cielo for now).
In Brazil, some cards have both types enabled, credit and debit, and these are categorized as multiple. However, despite having both functions, only one of them can be effectively enabled, and in a credit transaction, the reason for the failure may be that the card is only enabled for debit, for example. In these cases, we will return the error AQS-025 - Authorization failed - SCA is required, indicating that the transaction requires 3DS and that the card has been stored for 30 minutes for a future retry, where Convrt should redirect the transaction as a debit in an attempt to succeed.
\nThe flow of this operation will depend on the payment processor and whether the capture field sent in the request is true. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the payment and returned the result
\nAsynchronous: means that the payment will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nCapture: true
Sandbox: Synchronous
\nInovio: Synchronous
\nPmi: Synchronous
\nXpate: Asynchronous or Synchronous
\nthreadsPassThrough field is provided in the requestPXP: Synchronous
\nCielo: Synchronous
\nAndamos Creando: Asynchronous or Synchronous
\nCapture: false
Sandbox: Synchronous
\nInovio: Synchronous
\nPmi: Asynchronous
\nXpate: This processor does not perform this operation
\nPXP: Synchronous
\nCielo: Synchronous
\nAndamos Creando: This processor does not perfom this operation
\nIf the amount is BRL 0.01, the credit card transaction will be rejected, simulating an integration error and returning an error.
\nIf the amount falls within the range of BRL 0.2 to BRL 1.99, the credit card transaction will be rejected, and the status will be returned as failed.
\nIf the amount falls within the range of BRL 2.00 to BRL 4.99, the credit card transaction will be rejected, and the status will be returned as unauthorized.
\nIf the amount is BRL 5.00, the credit card transaction is accepted, and the status returns as open.
\nIf the amount is greater than BRL 5.00, the credit card transaction is confirmed, and the status returns as authorized.
\nAutomatic blacklist blocking timeout simulations (status returned as failed):
\nCapture must be true, Xpate can't create a standalone authorization order, only sale orders. If capture prop is false, an error is returned like the example: Capture Option Is Not Available
Amount value must be between $5.00 and $1000.00. If value is not in the range, an error is returned like the example: Amount Out Of Range
\nIf threadsPassThrough is not sent in request, Xpate will send a redirect URL to initiate 3DS flow, customer will need to confirm credit card data. Like example in Redirect URl.
\nTest Credit card :
\nNumber: 5286940020000304 - CVV: 196
\nNumber: 4761070000000004 - CVV: 196
\nNumber: 5286940020000908 - CVV: 196
\nIf Xpate returns an failed status, the order and transactions will be with failed status and a processorReason e failedReason object will be returned with order data. Like Example Failed Status Order
\nIn threadsPassThrough property, PXP doesn't accept \"mode\": \"challenge\". If threadsPassThrough mode is challenge, an error is returned like example: Not Option Available To 3DS param
To use recurrent type, it's ncessary use specific cards:
\nNumber: 4522947655492323 - CVV: (any 3 numbers value, example: 389)
\nNumber: 5580071186345292 - CVV: (any 3 numbers value, example: 910)
\nIf PXP returns an failed status, the order and transactions will be with failed status and a processorReason e failedReason object will be returned with order data. Like Example Failed Status Order
\nOnly credit cards issued in Mexico will be accepted.
\nTo create a recurring order, you must include \"type\": \"recurrent\" in the request data.
The billing document number property needs to be a CPF or CNPJ.
\nIf the threadsPassThrough field is provided with 3ds data, the dsReferenceId field must be provided with the RequestID returned in the authentication process.
To make the most of the Simulated payment method, you can create a card number using an online card generator or by choosing random numbers.
\nFor either option, the first 15 digits of the card can be random and the last digit must be the number corresponding to the status of the transaction you want to test.
\nThe Security Code (CVV) and validity information can be random, keeping the CVV with 3 digits and the validity year and month.
\nThe table below shows the simulation scenarios for each card ending.
\nCapture must be true, Andamos Creando can't create a standalone authorization order, only sale orders. If capture prop is false, an error is returned like the example: Capture Option Is Not Available
If Andamos Creando returns an failed status, the order and transactions will be with failed status and a processorReason e failedReason object will be returned with order data. Like Example Failed Status Order
\nTest Credit Cards
\nNumber: 4242424242424242 - Synchronous Success
\nNumber: 4032037236725541 - Synchronous Decline
\nNumber: 4242424242424846 - Asynchronous 3DS
\nThe externalId prop is an optional unique idempotency key saved in order's data. When request send a externalId that already exists, the saved order is returned and It's not updated. See Already saved External Id example.
\nThe capture prop is a boolean that indicates if the credit card order must be standalone authorization or a sale. If it's true, order will be salve as a sale, If it's false, order will be a standalone authorization. If capture prop is not sent, the default value is true.
\nFor standalone authorizations, the response will not contain the transactionId because it is only an authorization transaction. To obtain the transactionId, it is necessary to capture the transaction in the credit card capture API.
\nDuring the creation of the order, validation may occur where risk tools are used. If validation results in failure, the request will be rejected and the reason for failure indicating the validations that failed.
\ncapture (boolean): Indicates whether to capture the payment immediately.
amount (number): The amount of the order.
externalId (string, optional): An optional idempotency key.
notificationUrl (string): URL for receiving notifications.
billing (object): An object with different requirements according to acquirer. For more details, read the section below.
creditCard.holderName(string): Credit card holder name.
creditCard.cardNumber (string): Credit card full PAN.
creditCard.cvv (string): Credit card security code.
creditCard.expMonth (number): Expiration month of the credit card.
creditCard.expYear (number): Expiration year of the credit card.
creditCard.threadsPassThrough.version (enum(\"2.1.0\", \"2.2.0\")): Version of threads pass through.
creditCard.threadsPassThrough.eci (string): ECI (Electronic Commerce Indicator).
creditCard.threadsPassThrough.authenticationValue (string): Authentication value (CAVV/AAV).
creditCard.threadsPassThrough.dsTransactionId (string): DS transaction id returned by the third 3DS service. This ID is usually returned as a UUID.
creditCard.threadsPassThrough.dsReferenceId (string): DS reference id returned by the third 3DS service. This field works similarly to a traceId. It is returned in most cases and is used to track an authentication request.
creditCard.threadsPassThrough.mode (enum(\"challenge\", \"frictionless\")): Method used in 3DS authentication. Possible values: \"challenge\" or \"frictionless\".
creditCard.installment (number): Number of installments.
creditCard.type (enum(\"standard\", \"recurrent\")): Indicate if transaction will be availiable for recurrence.
notificationUrl (string): URL for receiving notifications.
Network tokenization allows integrators to send a DPAN (Device Primary Account Number) and cryptogram instead of raw card data. When externalTokenization is present in the request, cardNumber, cvv, and other card-specific fields are not required.
The externalTokenization object is nested inside the creditCard (or debitCard) object.
{\n \"amount\": 1000,\n \"capture\": true,\n \"notificationUrl\": \"https://your-webhook-url.com\",\n \"creditCard\": {\n \"holderName\": \"John Doe\",\n \"type\": \"standard\",\n \"installment\": 1,\n \"externalTokenization\": {\n \"dpan\": \"5067220000000001\",\n \"cryptogram\": \"YwAAAAAABaYcCMX/OhNRQAAAAAA=\",\n \"expMonth\": 12,\n \"expYear\": 2030\n }\n },\n \"billing\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"documentNumber\": \"11222333000181\",\n \"address\": \"Rua Example 123\",\n \"city\": \"Sao Paulo\",\n \"zip\": \"01310100\",\n \"country\": \"BRA\",\n \"ipAddress\": \"127.0.0.1\",\n \"email\": \"john@example.com\",\n \"phoneNumber\": \"5511999999999\"\n }\n}\n\nAs stated above, billing properties can vary depending on acquirer. The table below contains the properties each acquirer supports
As stated above, creditCard.threadsPassThrough properties can vary depending on acquirer. The table below contains the properties each acquirer supports
Creating a payment is subject to undergoing a risk validation process. The transaction will only check risk validation if is provided the document number and if the documentNumber is a CPF.
\nRisk validation is an anti-fraud procedure performed to determine whether the payer is eligible for the payment transaction. Currently, we consider the following criteria:
\nAge: Checks if the CPF holder, the payer, is of legal age.
\nLife Status: Verifies that the CPF holder does not have a death record—ensuring the person is alive at the time of the inquiry. This is important for preventing fraud or registration errors.
\nGovernment Restrictions: Assesses whether there are any active government restrictions on the CPF, such as prohibitions related to public agencies, which could hinder the transaction.
\nDuring order creation, payer information is validated against blacklist/whitelist rules.
\nIf one or more blacklist matches are found and no whitelist match exists, the order can be blocked.
\nIf a whitelist match exists for the same context, blacklist validation is bypassed.
\nThe following identifier types may be used in blacklist validation:
\ndocumentNumber
ipv4
address
email
zip
phoneNumber
bin
emailDomain
cardFingerprint
{\n \"code\": \"TSC-009\",\n \"message\": \"Some payer's information are invalid because they are in blacklist\",\n \"shortMessage\": \"PayerIsInBlacklist\",\n \"details\": {\n \"failedReason\": {\n \"code\": \"TSC-009\",\n \"origin\": \"blacklist\",\n \"details\": \"Some payer's information are invalid because they are in blacklist\",\n \"data\": {\n \"email\": \"blocked-user@example.com\"\n }\n }\n }\n}\n\n200 Ok: The order already exists, you will see the data of the created order. For a new order you must check the externalId property, it works as an idepotency key and the field must be unique to create a new order. A new order is created if you do not provide the field either.
201 Created: The order has been successfully created and the request has been processed by the processor, you will see the result in the response data.
202 Accepted: The order request has been accepted and the request will be processed by the processor, you will see the result in the response data.
cardBrand: mastercard, amex, visa, elo
cardType: multiple, credit, debit or debit_meal
{\n \"type\": \"object\",\n \"properties\": {\n \"currency\": { \"type\": \"string\" },\n \"orderId\": { \"type\": \"string\" },\n \"paymentMethod\": { \"type\": \"string\" },\n \"status\": { \"type\": \"string\" },\n \"transactionFees\": { \"type\": \"array\" },\n \"cardType\": \"multiple\",\n \"cardBrand\": \"mastercard\"\n }\n}\n\nDepending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"information\": \"information\", // optional\n // \"externalId\": \"externalId\", // optional,\n \"capture\": true, // optional (default 'true')\n \"processorName\": \"Cielo\", // OPTIONAL\n \"creditCard\": { // REQUIRED\n \"holderName\": \"Bruce Wayne\",\n \"cardNumber\": \"2340132000588364\",\n \"expMonth\": 1,\n \"expYear\": 2026\n // \"cvv\": \"970\", // OPTIONAL\n },\n \"billing\": {\n \"firstName\": \"Bruce\",\n \"lastName\": \"Wayne\",\n \"documentNumber\": \"01234567890\",\n \"address\": \"Address\",\n \"city\": \"City\",\n \"zip\": \"55336890\",\n \"country\": \"US\",\n \"ipAddress\": \"127.0.0.1\",\n \"email\": \"fake@mail.com\",\n \"phoneNumber\": \"12133734253\"\n },\n \"initiator\": \"CIT\" // Values: CIT | MIT\n // \"currency\": \"BRL\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/credit-card/:firstOrderId/recurrence","description":"This endpoint makes an HTTP POST request to create a new order using a previously created recurring order without credit card information. The request's body should include the amount, information (optional), externalId (optional), capture (optional), billing and initiator.
\nThis does not happen here, as credit card details are mandatory in the body of the call.
\nThe flow of this operation will depend on the payment processor and whether the capture field sent in the request is true. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the payment and returned the result
\nAsynchronous: means that the payment will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nCapture: true
Sandbox: Synchronous
\nInovio: This processor does not perform this operation
\nPmi: Synchronous
\nXpate: Asynchronous or Synchronous
\nthreadsPassThrough field is provided in the requestPXP: Synchronous
\nCielo: Synchronous
\nCapture: false
Sandbox: Synchronous
\nInovio: This processor does not perform this operation
\nPmi: Asynchronous
\nXpate: This processor does not perform this operation
\nPXP: Synchronous
\nCielo: Synchronous
\nIf the amount is BRL 0.01, the credit card transaction will be rejected, simulating an integration error and returning an error.
\nIf the amount falls within the range of BRL 0.02 to BRL 1.99, the credit card transaction will be rejected, and the status will be returned as failed.
\nIf the amount falls within the range of BRL 2.00 to BRL 4.99, the credit card transaction will be rejected, and the status will be returned as unauthorized.
\nIf the amount is BRL 5.00, the credit card transaction is accepted, and the status returns as open.
\nIf the amount is greater than BRL 5.00, the credit card transaction is confirmed, and the status returns as authorized.
\nCapture must to be true, Xpate can't create a standalone authorization, only sale orders. If capture prop is false, an error is returned like the example: Capture Option Is Not Available
Amount value must be between $5.00 and $1000.00. If value is not in the range, an error is returned like the example: Amount Out Of Range
\nIf Xpate returns an failed status, the order and transactions will be with failed status and a processorReason e failedReason object will be returned with order data. Like Example Failed Status Order
\nCapture must to be true, PXP accepts only recurrent sale orders. If capture prop is false, an error is returned like the example: Capture Option Is Not Available
\nIf Xpate returns an failed status, the order and transactions will be with failed status and a processorReason e failedReason object will be returned with order data. Like Example: Failed Status Order
\nThe result of the recurring order will depend on the simulation chosen in the first order, if the simulation resulted in authorized or paid.
\nThe table below shows the simulation scenarios for each card ending.
\nThe recurrent order will only be created if the original order's status is paid, its type is recurrent and is not expired(Original order is expired after 1 year).
\nThe capture prop is a boolean that indicates if the credit card order must be standalone authorization or a sale. If it's true, order will be salve as a sale, If it's false, order will be a standalone authorization. If capture prop is not sent, the default value is true.
\nDepeding of the credit card service, it is not possible to create a recurrent order
\nDepeding of the credit card service, it is not possible to create a recurrent order.
\nThe currency property must be the same as the original order.
\nMethod: POST
\nEndpoint: https://api.sandbox.convrt.cc/proxy/v1/orders/credit-card/:firstOrderId/recurrence
\namount (number, required): The amount of the order.
externalId (string, optional): An optional idempotency key.
capture (boolean, optional): Indicates whether to capture the payment immediately.
initiator(enum(\"CIT\", \"MIT\"), , required): The type of transactions Indicators. Possible values: \"CIT\" (Customer-Initiated Transactions) or \"MIT\" (Merchant-Initiated Transactions).
information (string, optional): Information or description about order.
billing (object): An object with different requirements according to acquirer. For more details, read the section below.
Network tokenization allows integrators to send a DPAN (Device Primary Account Number) and cryptogram instead of raw card data. When externalTokenization is present in the request, cardNumber, cvv, and other card-specific fields are not required.
The externalTokenization object is nested inside the creditCard (or debitCard) object.
{\n \"amount\": 1000,\n \"capture\": true,\n \"notificationUrl\": \"https://your-webhook-url.com\",\n \"initiator\": \"MIT\",\n \"creditCard\": {\n \"holderName\": \"John Doe\",\n \"externalTokenization\": {\n \"dpan\": \"5067220000000001\",\n \"cryptogram\": \"YwAAAAAABaYcCMX/OhNRQAAAAAA=\",\n \"expMonth\": 12,\n \"expYear\": 2030\n }\n }\n \"billing\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"documentNumber\": \"11222333000181\",\n \"address\": \"Rua Example 123\",\n \"city\": \"Sao Paulo\",\n \"zip\": \"01310100\",\n \"country\": \"BRA\",\n \"ipAddress\": \"127.0.0.1\",\n \"email\": \"john@example.com\",\n \"phoneNumber\": \"5511999999999\"\n }\n}\n\nAs stated above, billing properties can vary depending on acquirer. The table below contains the properties each acquirer supports
200 Ok: The recurrent order already exists, you will see the data of the created transactions. For a new transaction you must check the externalId property, it works as an idepotency key and the field must be unique to create a new transaction. A new transaction is created if you do not provide the field either.
201 Created: The recurrent order has been successfully created and the request has been processed by the processor, you will see the result in the response data.
202 Accepted: The order request has been accepted and the request will be processed by the processor, you will see the result in the response data.
currency (string): Currency of the order.
orderId (string): ID of the order.
paymentMethod (string): Payment method used.
status (string): Status of the order.
detail (string): Details of the order.
transactionFees (array): Array of transaction fees with details.
cardBrand: mastercard, amex, visa, elo
cardType: multiple, credit, debit or debit_meal
Depending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"information\": \"information\", // optional\n // \"externalId\": \"externalId\", // optional,\n \"capture\": true, // optional (default 'true')\n \"processorName\": \"Cielo\", // OPTIONAL\n \"creditCard\": { // REQUIRED\n \"holderName\": \"Bruce Wayne\",\n \"cardNumber\": \"2340132000588364\",\n \"expMonth\": 1,\n \"expYear\": 2026\n // \"cvv\": \"970\", // OPTIONAL\n },\n \"billing\": {\n \"firstName\": \"Bruce\",\n \"lastName\": \"Wayne\",\n \"documentNumber\": \"01234567890\",\n \"address\": \"Address\",\n \"city\": \"City\",\n \"zip\": \"55336890\",\n \"country\": \"US\",\n \"ipAddress\": \"127.0.0.1\",\n \"email\": \"fake@mail.com\",\n \"phoneNumber\": \"12133734253\"\n },\n \"initiator\": \"CIT\" // Values: CIT | MIT\n // \"currency\": \"BRL\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/credit-card/recurrence","description":"This endpoint creates a new order (HTTP POST) to process a recurring payment that was initiated outside Convrt — i.e., when there is no Convrt‑generated first order ID. In this case the request body must include credit card details (card number and expiration; CVV is optional). The field processorName is optional: when provided, Convrt uses it to determine which processor will execute the transaction; when omitted, Convrt will use the single configured credit‑card acquirer account if only one exists — if more than one acquirer account is configured, the request fails with a MultipleCreditCardAcquirerAccountsConfigured error. The request should also include amount, billing and initiator. The fields information, externalId and capture remain optional.
\nIf the capture field is sent as false and the amount is 1, instead of a regular authorization, Convrt will perform a Zero Auth authentication (only Cielo for now).
The flow of this operation will depend on the payment processor and whether the capture field sent in the request is true. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the payment and returned the result
\nAsynchronous: means that the payment will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nCapture: true
Sandbox: Synchronous
\nInovio: This processor does not perform this operation
\nPmi: Synchronous
\nXpate: Asynchronous or Synchronous
\nthreadsPassThrough field is provided in the requestPXP: Synchronous
\nCielo: Synchronous
\nCapture: false
Sandbox: Synchronous
\nInovio: This processor does not perform this operation
\nPmi: Asynchronous
\nXpate: This processor does not perform this operation
\nPXP: Synchronous
\nCielo: Synchronous
\nThe result of the recurring order will depend on the simulation chosen in the first order, if the simulation resulted in authorized or paid.
\nThe table below shows the simulation scenarios for each card ending.
\nThe recurrent order will only be created if the original order's status is paid, its type is recurrent and is not expired(Original order is expired after 1 year).
\nThe capture prop is a boolean that indicates if the credit card order must be standalone authorization or a sale. If it's true, order will be salve as a sale, If it's false, order will be a standalone authorization. If capture prop is not sent, the default value is true.
\nDepeding of the credit card service, it is not possible to create a recurrent order
\nDepeding of the credit card service, it is not possible to create a recurrent order.
\nThe currency property must be the same as the original order.
\nMethod: POST
\nEndpoint: https://api.sandbox.convrt.cc/proxy/v1/orders/credit-card/recurrence
\namount (number, required): The amount of the order.
externalId (string, optional): An optional idempotency key.
capture (boolean, optional): Indicates whether to capture the payment immediately.
initiator(enum(\"CIT\", \"MIT\"), , required): The type of transactions Indicators. Possible values: \"CIT\" (Customer-Initiated Transactions) or \"MIT\" (Merchant-Initiated Transactions).
information (string, optional): Information or description about order.
billing (object): An object with different requirements according to acquirer. For more details, read the section below.
Network tokenization allows integrators to send a DPAN (Device Primary Account Number) and cryptogram instead of raw card data. When externalTokenization is present in the request, cardNumber, cvv, and other card-specific fields are not required.
The externalTokenization object is nested inside the creditCard (or debitCard) object.
{\n \"amount\": 1000,\n \"capture\": true,\n \"notificationUrl\": \"https://your-webhook-url.com\",\n \"creditCard\": {\n \"holderName\": \"John Doe\",\n \"installment\": 1,\n \"externalTokenization\": {\n \"dpan\": \"5067220000000001\",\n \"cryptogram\": \"YwAAAAAABaYcCMX/OhNRQAAAAAA=\",\n \"expMonth\": 12,\n \"expYear\": 2030\n }\n },\n \"billing\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"documentNumber\": \"11222333000181\",\n \"address\": \"Rua Example 123\",\n \"city\": \"Sao Paulo\",\n \"zip\": \"01310100\",\n \"country\": \"BRA\",\n \"ipAddress\": \"127.0.0.1\",\n \"email\": \"john@example.com\",\n \"phoneNumber\": \"5511999999999\"\n }\n}\n\nAs stated above, billing properties can vary depending on acquirer. The table below contains the properties each acquirer supports
200 Ok: The recurrent order already exists, you will see the data of the created transactions. For a new transaction you must check the externalId property, it works as an idepotency key and the field must be unique to create a new transaction. A new transaction is created if you do not provide the field either.
201 Created: The recurrent order has been successfully created and the request has been processed by the processor, you will see the result in the response data.
202 Accepted: The order request has been accepted and the request will be processed by the processor, you will see the result in the response data.
currency (string): Currency of the order.
orderId (string): ID of the order.
paymentMethod (string): Payment method used.
status (string): Status of the order.
detail (string): Details of the order.
transactionFees (array): Array of transaction fees with details.
cardBrand: mastercard, amex, visa, elo
cardType: multiple, credit, debit or debit_meal
Depending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It is a required parameter in the request, to allow access to the resource.
\n"},{"key":"external-connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"notificationUrl\": \"https://webhook.site/2577daa8-d199-4996-af11-2a2f667238c3\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\" // optional\n // \"currency\": \"BRL\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/:orderId/capture","description":"This endpoint makes an HTTP POST request to capture a standalone authorization order. The endpoint's URL should include a order id value and the request body should include the amount, external ID (optional) and notification URL (optional).
\nIt`s possible to make a full capture or make multiple partial captures while the order still has available amount to capture.
\nThe flow of this operation will depend on the payment processor. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the capture and returned the result
\nAsynchronous: means that the capture will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nSandbox: Synchronous
\nInovio: Synchronous
\nPmi: Asynchronous
\nXpate: This processor does not perform this operation
\nPXP: Synchronous
\n\"capture\": false and using the capture route, the same value as the order creation must be provided.Multiples captures are not accepted. When creating an order with \"capture\": false and using the capture route.
Any capture value will be accepted and processed, but on a second attempt the following error will be returned:
\nMultiples captures are not accepted. When creating an order with \"capture\": false and using the capture route.
Any capture value will be accepted and processed, but on a second attempt the following error will be returned:
\namount (number, required): The amount of the order.
externalId (string, optional): A unique identifier for the order.
notificationUrl (string, optional): URL for receiving notifications.
200 Ok: The capture transaction already exists, you will see the data of the created transactions. For a new transaction you must check the externalId property, it works as an idepotency key and the field must be unique to create a new transaction. A new transaction is created if you do not provide the field either.
201 Created: The capture transaction has been successfully created and the request has been processed by the processor, you will see the result in the response data.
202 Accepted: The order request has been accepted and the request will be processed by the processor, you will see the result in the response data.
currency (string): Currency of the order.
region (string): Region of the order.
orderId (string): ID of the order.
transactionId (string): ID of the transaction.
accountId (string): ID of account.
merchantId (string): ID of merchant.
status (string): Status of the order.
externalId (string): A unique identifier for the order.
notificationUrl (string): A url where the notification will be sent.
category (string): Order category.
type (string): Transaction type.
amount (number): Order amount value.
fee (number): Order total fee value.
transactionData.vendor (string): Vendor name.
transactionData.vendorId (string): ID of vendor.
transactionData.vendorAccountId (string): ID of vendor's account.
transactionData.vendorReferenceId (string): Reference ID of vendor.
payer.firstName (string) : First name of customer.
payer.lastName (string) : Last name of customer.
payer.documentNumber (string) : Document number of customer.
payer.address (string) : Address of customer.
payer.city (string) : City of customer.
payer.zip (string) : ZIP of customer.
payer.country (string) : Country of customer.
payer.ipAddress (string) : IP address of customer.
transactionFees (array): Array of transaction fees with details
Depending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It's a parameter to find order by id
\n","type":"text/plain"},"type":"any","value":null,"key":"orderId"}]}},"response":[{"id":"694f527f-9df0-4d22-86ba-8650c2b914b6","name":"Capture Credit Card Order Successfully","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"notificationUrl\": \"https://webhook.site/2577daa8-d199-4996-af11-2a2f667238c3\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":null}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"dc883771-1fed-42d1-ba3f-41098ea17550\",\n \"accountId\": \"be1c848a-f1f4-4891-90d3-51f29202c521\",\n \"merchantId\": \"4793eaf9-dda3-43b3-aed5-f1e04d99bda4\",\n \"externalId\": \"dc883771-1fed-42d1-ba3f-41098ea17550\",\n \"orderId\": \"8f640e96-9961-42a8-bc00-2d6e91a4bb4e\",\n \"category\": \"creditCard\",\n \"origin\": \"MerchantConnection\",\n \"type\": \"credit\",\n \"status\": \"success\",\n \"amount\": 10,\n \"fee\": 0,\n \"balanceAfterTransaction\": 2070,\n \"transactionData\": {\n \"vendor\": \"Sandbox\",\n \"vendorId\": \"fc920381-c3be-4e66-9347-08b3c22a870e\",\n \"vendorAccountId\": \"71e4829c-2520-4812-9472-15f24e2cdfac\",\n \"vendorReferenceId\": \"779e2f57-ca2d-496c-8e45-d7802373c74f\"\n },\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"payer\": {\n \"firstName\": \"albs\",\n \"lastName\": \"albs\",\n \"documentNumber\": \"10412762498\",\n \"address\": \"albs\",\n \"city\": \"albs\",\n \"zip\": \"albs\",\n \"country\": \"albs\",\n \"ipAddress\": \"1.1.1.1\"\n },\n \"eventName\": \"CreditCardIn\",\n \"createdAt\": \"2024-03-04T16:24:31.575Z\",\n \"updatedAt\": \"2024-03-04T16:24:31.575Z\",\n \"operationId\": null,\n \"information\": null,\n \"refundedAmount\": 0,\n \"notificationUrl\": null,\n \"receiver\": null,\n \"reservationData\": null,\n \"originalTransactionId\": null,\n \"expectedAmount\": 0,\n \"transactionFees\": []\n}"},{"id":"a8174625-43e0-430c-ae2c-0408850bbbb0","name":"External Connection Does not Exist","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"notificationUrl\": \"https://webhook.site/2577daa8-d199-4996-af11-2a2f667238c3\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":null}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ETC-002\",\n \"message\": \"External Connection Does Not Exist.\",\n \"shortMessage\": \"ExternalConnectionDoesNotExist\"\n}"},{"id":"b1806878-2b56-49d4-91e9-fa1379d16fdd","name":"Order Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"external-connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"notificationUrl\": \"https://webhook.site/2577daa8-d199-4996-af11-2a2f667238c3\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":null,"description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-002\",\n \"message\": \"Order Not Found\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"e36789a2-ca18-47f1-ba6e-747169269717","name":"Order Isn't Authorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"external-connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"notificationUrl\": \"https://webhook.site/2577daa8-d199-4996-af11-2a2f667238c3\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":null,"description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-009\",\n \"message\": \"The order is not authorized\",\n \"shortMessage\": \"OrderNotIsAuthorized\"\n}"},{"id":"b9660f5d-d987-443d-ab8f-fc56bb3fedb4","name":"Order Has Already Been Captured","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"external-connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"notificationUrl\": \"https://webhook.site/2577daa8-d199-4996-af11-2a2f667238c3\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":null,"description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-010\",\n \"message\": \"Capturing the credit card order has already been completed\",\n \"shortMessage\": \"CreditCardOrderAlreadyFinished\"\n}"},{"id":"7105a66f-c3c4-42ec-9b8c-44345404dd2f","name":"Amount is Greater Than The Availabel Amount","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"external-connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"notificationUrl\": \"https://webhook.site/2577daa8-d199-4996-af11-2a2f667238c3\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":null,"description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-011\",\n \"message\": \"The requested amount is greater than the available amount\",\n \"shortMessage\": \"RequestedValueGreaterThanAvailableAmount\"\n}"}],"_postman_id":"4dd01f09-52f6-44d7-9b5b-be4ca81fbcfa"},{"name":"Cancel Credit Card Order","id":"325f5099-cfcd-44cf-b6a4-ba9275ef1e69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\"\n // \"currency\": \"BRL\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/:orderId/cancel","description":"This endpoint makes an HTTP POST request to cancel a specific order. The endpoint's URL should include an order id value and the request body should include amount and notification URL (optional).
\nIt`s possible to make a full cancellation or make multiple partial cancellations while the order still has available amount to cancel.
\nThe flow of this operation will depend on the payment processor. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the cancellation and returned the result
\nAsynchronous: means that the cancellation will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nSandbox: Synchronous or Asynchronous
\nInovio: Synchronous
\nPmi: Asynchronous
\nXpate: This processor does not perform this operation
\nPXP: Synchronous
\nCielo: Synchronous
\nDepending on the credit card service, it is not possible to capture an order's amount and an error is returned.
\nDepending on the acquirer, only full cancellation is possible.
\nIt's possible cancel a standalone authorization order.
\nIt's only accepts full cancelations, it means that if the amount is lower than the standalone authorization order an error will be returned, like the example: Only Full Cancelation
\nPartial cancellations are not accepted. When creating an order with \"capture\": false and using the cancellation route, the same value as the order creation must be provided.
If the value is less than the order value, the request will be rejected, and the following error will be returned:
\nPartial cancellations are not accepted. When creating an order with \"capture\": false and using the cancellation route, the same value as the order creation must be provided.
If the value is less than the order value, the request will be rejected, and the following error will be returned:
\namount (number, required): The amount associated with the order.
notificationUrl (string, optional): The URL to send notifications related to the order cancellation.
transactionId (string): The ID of the transaction.
accountId (string): The account ID associated with the transaction.
merchantId (string): The ID of the merchant.
orderId (string): The ID of the order.
category (string): The category of the transaction.
origin (string): The origin of the transaction.
type (string): The type of the transaction.
status (string): The status of the transaction.
amount (number): The amount of the transaction.
fee (number): The fee associated with the transaction.
balanceAfterTransaction (number): The balance after the transaction.
notificationUrl (string): The URL for notifications related to the transaction.
currency (string): The currency of the transaction.
region (string): The region of the transaction.
payer (object): Details of the payer including first name, last name, document number, address, city, zip, country, and IP address.
eventName (string): The name of the event associated with the transaction.
createdAt (string): The timestamp when the transaction was created.
updatedAt (string): The timestamp when the transaction was last updated.
externalId (string): The external ID associated with the transaction.
operationId (string): The operation ID associated with the transaction.
information (string): Additional information related to the transaction.
refundedAmount (number): The refunded amount of the transaction.
receiver (object): Details of the receiver, if applicable.
reservationData (string): Data related to the reservation of the transaction.
originalTransactionId (string): The ID of the original transaction, if applicable.
expectedAmount (number): The expected amount of the transaction.
transactionFees (array): Array of transaction fees.
transactionData (object): Additional data related to the transaction.
Partial cancellations are not accepted. When creating an order with \"capture\": false and using the cancellation route, the same value as the order creation must be provided.
If the value is less than the order value, the operation will be requested but when a new cancellation request is sent, the error will be returned:
\nDepending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
{\n \"transactionId\": \"\",\n \"accountId\": \"\",\n \"merchantId\": \"\",\n \"orderId\": \"\",\n \"category\": \"\",\n \"origin\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": 0,\n \"fee\": 0,\n \"balanceAfterTransaction\": 0,\n \"notificationUrl\": \"\",\n \"currency\": \"\",\n \"region\": \"\",\n \"payer\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"documentNumber\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"ipAddress\": \"\"\n },\n \"eventName\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"externalId\": null,\n \"operationId\": null,\n \"information\": null,\n \"refundedAmount\": 0,\n \"receiver\": null,\n \"reservationData\": null,\n \"originalTransactionId\": null,\n \"expectedAmount\": 0,\n \"transactionFees\": [],\n \"transactionData\": {}\n}\n\nIt's a parameter to find order by id
\n","type":"text/plain"},"type":"any","value":"9b7b67d7-d744-4056-8d30-ab9b10432f4c","key":"orderId"}]}},"response":[{"id":"cc128513-b8e1-4f9a-ab43-c3c206bfa480","name":"Cancel Credit Card Order Successfully","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/63e7d578-06f3-4d73-b085-c94cb4f6859d\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dev.convrt.cc/proxy/v1/orders/:orderId/cancel","protocol":"https","host":["api","dev","convrt","cc"],"path":["proxy","v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"9da9da8a-aff6-4205-b70c-52363899057f\",\n \"accountId\": \"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3\",\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"orderId\": \"30a8fa18-7935-4096-ab92-033ab93f6c83\",\n \"category\": \"creditCardCancellation\",\n \"origin\": \"Inovio\",\n \"type\": \"credit\",\n \"status\": \"success\",\n \"amount\": 0,\n \"fee\": 0,\n \"balanceAfterTransaction\": 1013951.85,\n \"notificationUrl\": \"https://webhook.site/63e7d578-06f3-4d73-b085-c94cb4f6859d\",\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"payer\": {\n \"firstName\": \"John\",\n \"lastName\": \"Jones\",\n \"documentNumber\": \"01234567890\",\n \"address\": \"Rua Principal\",\n \"city\": \"São Paulo\",\n \"zip\": \"11222-100\",\n \"country\": \"Brasil\",\n \"ipAddress\": \"1.1.1.1\"\n },\n \"eventName\": \"CreditCardInCancellation\",\n \"createdAt\": \"2024-03-25T12:31:48.203Z\",\n \"updatedAt\": \"2024-03-25T12:31:48.203Z\",\n \"externalId\": null,\n \"operationId\": null,\n \"information\": null,\n \"refundedAmount\": 0,\n \"receiver\": null,\n \"reservationData\": null,\n \"originalTransactionId\": null,\n \"expectedAmount\": 0,\n \"transactionFees\": [],\n \"transactionData\": {}\n}"},{"id":"76a91e82-fd97-4938-818b-8c2402219efd","name":"External Connection Does Not Exist","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"},{"key":"external-connection","value":"external connection","description":"It is a required parameter to find account","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/63e7d578-06f3-4d73-b085-c94cb4f6859d\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":null}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ETC-002\",\n \"message\": \"External Connection Does Not Exist.\",\n \"shortMessage\": \"ExternalConnectionDoesNotExist\"\n}"},{"id":"7e16b153-b2ae-473a-81cc-df32786cfabb","name":"Only Full Cancelation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":"9b7b67d7-d744-4056-8d30-ab9b10432f4c","description":"It's a parameter to find order by id"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"CCS-025\",\n \"message\": \"This acquirer only accepts full cancellation\",\n \"shortMessage\": \"OnlyAcceptsFullCancelation\"\n}"},{"id":"aac627c3-e674-4886-9bb0-53fbb98a6346","name":"Order Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":"9b7b67d7-d744-4056-8d30-ab9b10432f4c","description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-002\",\n \"message\": \"Order Not Found\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"63be92a1-142a-4c9d-a702-79688c788a84","name":"Order's Payment Method Not Allowed To Cancel","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":"9b7b67d7-d744-4056-8d30-ab9b10432f4c","description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ONT-005\",\n \"message\": \"The provided paymentMethod provided is invalid for this operation\",\n \"shortMessage\": \"OrderPaymentMethodNotAllowed\"\n}"},{"id":"15e01611-6ca8-4306-ad50-626155f4a708","name":"Order Isn't Authorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":"9b7b67d7-d744-4056-8d30-ab9b10432f4c","description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-009\",\n \"message\": \"The order is not authorized\",\n \"shortMessage\": \"OrderNotIsAuthorized\"\n}"},{"id":"84f963c6-7fd3-45fd-828f-bb7a5388d527","name":"Amount is Greater Than The Availabel Amount","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":"9b7b67d7-d744-4056-8d30-ab9b10432f4c","description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-011\",\n \"message\": \"The requested amount is greater than the available amount\",\n \"shortMessage\": \"RequestedValueGreaterThanAvailableAmount\"\n}"}],"_postman_id":"325f5099-cfcd-44cf-b6a4-ba9275ef1e69"},{"name":"Refund Credit Card Transaction","id":"5dcf334f-4411-4bba-853f-991c0df692e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"amount","value":"5","description":"This field refers to operation amount
\n","type":"text"},{"key":"description","value":"Description","description":"This field refers to operation description
\n","type":"text"},{"key":"attachment","description":"This field refers to operation attachment
\n","type":"file","src":"/home/albertojcvs/Downloads/Attachment.csv"}]},"url":"{{BASE_URL}}/proxy/v1/transactions/:transactionId/refund","description":"This endpoint makes an HTTP POST request to refund a order's transaction. The endpoint's URL should include a order id value and the request body should include the amount, description (optional), attachment (optional).
\nIt`s possible to make a full refund or make multiple partial refunds while the transaction still has available amount to refund.
\nThe flow of this operation will always be asynchronous, which means that the refund will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nIt's possible make partially and full refunds
\nDescription is required to make refund. If this prop is not sent in request a error is returned like the example: Description is required.
\nTo make the refund reach the success status, you must access the portal provided by PXP and move the transaction status to \"Refunded\". The webhook will be sent to CONVRT and the order will be updated successfully.
\namount (number, required): The amount to refund.
description (string, optional): The description of the refund.
attachment (file, optional): The attachment of the refund.
id (string): Id of order
accountId (string): AccountId of order
amount (number): Amount to refund
transactionId (string): Id of transaction
refundTransactionId (string): Id of refund transaction
status(optional enum: failed, pending, success): Status of refund transaction
Depending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"url":"{{BASE_URL}}/proxy/v1/orders","description":"This endpoint makes an HTTP GET request to list account's orders. The request query params could include the startDate(optional), endDate(optional), limit (optional), page (optional), order(optional).
\nFormat of the startDate and endDate filters: YYYY-MM-DD. Example: 2024-01-01
\nitems (array): List with orders's data.
pagination.limit (number): Limit used to paginate.
pagination.page (number): Page of pagination.
pagination.totalRecords (number): Number of total saved orders.
pagination.totalPages (number): Number of total pages
pagination.nextPage (boolean): Indicate next page number.
pagination.prevPage (number): Indicate previus page number.
pagination.hasNextPage (number): Indicate if there are more pages to request after actual page.
pagination.hasPrevPage (number): Indicate if there are more pages to request before actual page.
This parameter refers to the maximum number of items that must be returned per page, it is optional with a default value of 10
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"This parameter refers to the current page of the listing
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"This parameter refers to how the list is sorted based on the date the order was created, which can be DESC for descending and ASC for ascending.
\n","type":"text/plain"},"key":"order","value":"DESC"},{"disabled":true,"description":{"content":"This parameter refers to the order creation date, records with a date greater than or equal to the one sent will be returned
\n","type":"text/plain"},"key":"startDate","value":"2024-01-01"},{"disabled":true,"description":{"content":"This parameter refers to the order creation date, records with a date less than or equal to the one sent will be returned
\n","type":"text/plain"},"key":"endDate","value":"2024-12-31"}],"variable":[]}},"response":[{"id":"c8f6dacf-4f63-4cd0-ad47-f4e9368c4fe2","name":"List Orders Succesfully","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account"}],"url":{"raw":"{{BASE_URL}}/proxy/v1/orders?limit=1&page=1","host":["{{BASE_URL}}"],"path":["proxy","v1","orders"],"query":[{"key":"limit","value":"1","description":"This parameter refers to the maximum number of items that must be returned per page, it is optional with a default value of 10"},{"key":"page","value":"1","description":"This parameter refers to the current page of the listing"},{"key":"order","value":"DESC","description":"This parameter refers to how the list is sorted based on the date the order was created, which can be DESC for descending and ASC for ascending.","disabled":true},{"key":"startDate","value":"2024-01-01","description":"This parameter refers to the order creation date, records with a date greater than or equal to the one sent will be returned","disabled":true},{"key":"endDate","value":"2024-12-31","description":"This parameter refers to the order creation date, records with a date less than or equal to the one sent will be returned","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"orderData\": {},\n \"id\": \"097d39d2-1dbf-41cf-a0e6-68b3846be13b\",\n \"accountId\": \"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3\",\n \"externalId\": \"externalId\",\n \"information\": null,\n \"capture\": null,\n \"origin\": \"Inovio\",\n \"status\": \"failed\",\n \"paymentMethod\": \"creditCard\",\n \"amount\": 1,\n \"paymentMethodData\": {\n \"token\": \"token\",\n \"firstSix\": \"411111\",\n \"lastFour\": \"1111\",\n \"expMonth\": 12,\n \"expYear\": 2024,\n \"walletId\": \"86536b02-e519-4f40-8712-6bd8d5e33115\",\n \"walletName\": \"Bruce Wayne\",\n \"threadsPassThrough\": {\n \"version\": \"2.1.0\",\n \"eci\": \"eci\",\n \"authenticationValue\": \"123\"\n },\n \"installment\": 2,\n \"type\": \"standard\",\n \"canceledAmount\": 0\n },\n \"payer\": {\n \"firstName\": \"Bruce\",\n \"lastName\": \"Wayne\",\n \"documentNumber\": \"01234567890\",\n \"address\": \"Address\",\n \"city\": \"City\",\n \"zip\": \"55336890\",\n \"country\": \"Country\",\n \"ipAddress\": \"127.0.0.1\"\n },\n \"notificationUrl\": null,\n \"createdAt\": \"2024-02-13T12:50:45.907Z\",\n \"updatedAt\": \"2024-02-13T12:50:45.907Z\",\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"transactions\": [\n {\n \"transactionId\": \"818cb86d-361e-4e89-aa49-7cc429bec3a4\",\n \"accountId\": \"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3\",\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"externalId\": \"eaaxtaernaaaaasaasdaals07sa[a4-isad4daaa4a*\",\n \"orderId\": \"097d39d2-1dbf-41cf-a0e6-68b3846be13b\",\n \"operationId\": null,\n \"information\": null,\n \"category\": \"creditCard\",\n \"origin\": \"MerchantConnection\",\n \"type\": \"credit\",\n \"status\": \"failed\",\n \"amount\": 0,\n \"refundedAmount\": 0,\n \"fee\": -0.01,\n \"balanceAfterTransaction\": 1001333.75,\n \"notificationUrl\": \"https://www.inoviopay.com/webhook-return-luby\",\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"receiver\": null,\n \"payer\": {\n \"documentNumber\": \"01234567890\"\n },\n \"reservationData\": null,\n \"eventName\": \"CreditCardIn\",\n \"originalTransactionId\": null,\n \"expectedAmount\": 1,\n \"createdAt\": \"2024-02-13T12:50:46.512Z\",\n \"updatedAt\": \"2024-02-13T12:50:53.651Z\",\n \"transactionData\": {\n \"failedReason\": {\n \"code\": \"ACQ-001\",\n \"details\": \"Failed to communicate with acquirer service\",\n \"origin\": \"acquirer\"\n }\n }\n }\n ]\n }\n ],\n \"pagination\": {\n \"limit\": 1,\n \"page\": 1,\n \"totalRecords\": 178,\n \"totalPages\": 178,\n \"nextPage\": 2,\n \"prevPage\": null,\n \"hasNextPage\": true,\n \"hasPrevPage\": false\n }\n}"},{"id":"df128a9a-7cb7-4c92-82ef-47d330c1ecee","name":"External Connection Does Not Exist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account"}],"url":{"raw":"{{BASE_URL}}/proxy/v1/orders","host":["{{BASE_URL}}"],"path":["proxy","v1","orders"],"query":[{"key":"limit","value":"10","description":"This parameter refers to the maximum number of items that must be returned per page, it is optional with a default value of 10","disabled":true},{"key":"page","value":"1","description":"This parameter refers to the current page of the listing","disabled":true},{"key":"order","value":"DESC","description":"This parameter refers to how the list is sorted based on the date the order was created, which can be DESC for descending and ASC for ascending.","disabled":true},{"key":"startDate","value":"2024-01-01","description":"This parameter refers to the order creation date, records with a date greater than or equal to the one sent will be returned","disabled":true},{"key":"endDate","value":"2024-12-31","description":"This parameter refers to the order creation date, records with a date less than or equal to the one sent will be returned","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ETC-002\",\n \"message\": \"External Connection Does Not Exist.\",\n \"shortMessage\": \"ExternalConnectionDoesNotExist\"\n}"}],"_postman_id":"a849c2b6-cbb4-4738-a830-99730e119879"},{"name":"Get Order","id":"0a45801c-a51b-4743-b322-a7da0358fc29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"url":"{{BASE_URL}}/proxy/v1/orders/:orderId","description":"This endpoint makes an HTTP GET request to get a order's information. The endpoint's URL should include a order id value.
\nid (string): ID of order.
accountId (string): ID of account.
externalId (string): A unique identifier for the order..
status (string): Status of order.
amount (number): Amount of order.
qrCodeData.emv (string): QR code emv.
qrCodeData.image (string): QR code imgae.
qrCodeData.location (string): QR code location.
payer.documentNumber (string): Document number of payer.
payer.name (string): Name of payer.
transaction.transactionId (string): ID of the transaction.
transaction.orderId (string): ID of the order.
transaction.accountId (string): ID of account.
transaction.status (string): Status of the order.
transaction.externalId (string): A unique identifier for the transaction.
transaction.category (string): Order category.
transaction.type (string): Transaction type.
transaction.amount (number): Order amount value.
transaction.fee (number): Order total fee value.
transaction.eventName (string): Transaction event name total fee value.
It's a parameter to find order by id
\n","type":"text/plain"},"type":"any","value":null,"key":"orderId"}]}},"response":[{"id":"c04bbe0b-e7b6-4860-adf0-75850989c20e","name":"Get Order Succesfully","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","type":"text","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","type":"text","description":"It is a required parameter to find account"}],"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId"],"variable":[{"key":"orderId","value":null,"description":"It's a parameter to find order by id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f6597dc3-d610-4b28-a08e-8add393917be\",\n \"accountId\": \"6cc5f272-3288-40f7-84af-409055674ae3\",\n \"externalId\": \"id of new consumer system \",\n \"information\": null,\n \"status\": \"open\",\n \"amount\": 200.5,\n \"qrCodeData\": {\n \"emv\": \" \\n \\n █▀▀▀▀▀█ ▀█▄██▀▄███▀ █ █▄ █▀ ▀█▀ ▀█▀ ▀ ▄▄█ █▀▀▀▀▀█ \\n █ ███ █ ▀▄█▄█ ▄▀▄▀ █▀▄▀ ▀ █▄ ▀█▀▄ ▀█▀ █▀ █ ███ █ \\n █ ▀▀▀ █ ▄▀▀ ▀█▀▀▄ ██▀▄█▀▀▀█ ▀ █▀█▀█▄▄ █ ▀▀▀ █ \\n ▀▀▀▀▀▀▀ ▀▄█▄▀▄█▄▀ █ ▀ █ ▀ █ ▀ ▀▄▀▄▀ █ ▀ █ ▀▀▀▀▀▀▀ \\n █▄█▄▄ ▀█ ▀ ▄▄▄█ ▄█ ▀ ▀▀█▀▀▀▀ █▀▄▀█▀▄▀▀▀█▄▄▄█▄▄█▄█ \\n ▄█▄▄ ▀ █▄▀▄█▀ ▀▄▄▀ ▄▄██▀ ▄▀█▄▄▄█▀▄▀█▄ █▀█▄ ██▀ \\n ▀ ██ ▀ ▄█▀▀▄█ ▄█▀██▄██▀▄█ █ ▀▄▀█▀▀▀ █ ▄▄▀█ ▀█▀█ \\n ▄▀█▄█ ▀ ▄▄█▄▀▀▀▄▄██▄█▄█ ▀▀▀▀█▄ ▀██▀▀▀█▄▀▀ ▄█ ██ \\n █▀█▀▄▀ ▄█▄▄ ▀▀▀█ █▀█ ▄█▄ ▄█▄ ▄▄▄ ▀ ▀█ █▄ \\n █▀▄▀▄▀▀▀▀▄▄ █ ▄ ▄▀ ▄█▀▄███▄ ▀█ ▄▀▀ ▄▀ ▀ ▄███ ▄█ \\n ▄▄▄█▄▀▀▀▀▄▀▀▄▄██▀ ▀▀█▀▄█▀█▄█▀▄▀█ █ ▀ ▄█▄█▀ ██ \\n ██▄█▀▀▀██▀ ▄▄▀▄ ▄▀██▀█▀▀▀████▄▀▄█ ▀▄ ▄██▀▀▀█▀▀█ \\n ▄▄█ █ ▀ █▀▀█▀█ ▄ ▄█ █ ▀ █▀ █▄ ▀▀ ▀█▀▀█ ▀ ██▄██ \\n ▄▄ ▀▀▀▀██▀▀▀ █▀ ▄██▄█▀▀▀█▀▀▀▄▀▀▀▄ ▀█▄▀▄ ▀█▀██▄█▀█ \\n ▀ ██▀▀▀█▄▄█▄▄█▄▀▀▄█ ▀▀███ █▀███ ▀▀██▀ █▀ █▄▀▀ ▀▄█ \\n ▄▄█▀▀▀▀▀▀ █ ██▀█▀ ▀▀██▄███ ▀▄▀ ▄▀ █▀▄▀█ ▀▄█ \\n ▀▀█▀▀█▀ █ ▀ █████▀▀▀█▀ █▀█▀ ▀█▀ ▀█▀▀▀ ▄ █▀▀ ▀ \\n ▀▀▄▀▀▀ █ ▀ █ ▄█ ▀█ ▄▀ ▀█▄▀█▀▄█▀▀▀▀▄█▄█▄▀▄▀█▀ \\n ▄██ ▀█▀▀ ▄▀ ▀█ █ █▀█▄ ██▄█▄▄▀▀▀▄▀▄ ▀ ▀▀▀▄▀ █ █▄█ \\n █▄▄ ▀▀▀▄█ ▄▀ ▄ █ █▄█▄▀ █▀▀▀▄▀▀ █▄▄ ▄▀▀██▀ ▀█ \\n ▀▀▀ ▀▀█ ▀██▀▀▄▀ ▀ ▀█▀▀▀█▀ ██ ▀▀█▀ ▀▀█▀▀▀█▄ █▄ \\n █▀▀▀▀▀█ ▀ █ ▄█▄ ▀█ ██ ▀ █▄█ ▀▀▄ ▀▄▄█ ██ ▀ █ █▀▀ \\n █ ███ █ ▄▀▄ █▄▄ █▄██ ███▀▀▀█ ▀ █▀▀▀▀▄██▀▀▀▀█ ▄█ \\n █ ▀▀▀ █ ▀▄▀█▄ ▄▄▄▄█▄███▀ ▀▀▀▄█▀▀▄▄▀▀███▄ ▀▄▀ ▄▀▀ \\n ▀▀▀▀▀▀▀ ▀ ▀▀ ▀▀▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀▀ ▀ \\n \\n \",\n \"image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAwDSURBVO3BQW4sy7LgQDKh/W+ZfYY+CiBRJb24v93M/mGtdYWHtdY1HtZa13hYa13jYa11jYe11jUe1lrXeFhrXeNhrXWNh7XWNR7WWtd4WGtd42GtdY2HtdY1HtZa13hYa13jhw+p/KWKSeWkYlJ5o2JS+UTFpDJVTCpTxYnKScWk8kbFpPJGxaQyVbyhMlVMKn+p4hMPa61rPKy1rvGw1rrGD19W8U0qJxWTyqTyRsWk8omKb1KZKk4qTiomlanipGJSmSpOKk5Uvqnim1S+6WGtdY2HtdY1HtZa1/jhl6m8UfGGylQxqUwVk8pJxaQyVUwqJyqfqJhUpopJZap4Q+WkYqo4UXmjYlL5JpU3Kn7Tw1rrGg9rrWs8rLWu8cN/XMWkcqLyhspUMalMFW9UTCpTxUnFGypTxVQxqUwVk8pUcVIxqUwVb1T8X/Kw1rrGw1rrGg9rrWv88P+ZikllUjlRmSpOVE5UpopJ5ZsqfpPKb6r4v+xhrXWNh7XWNR7WWtf44ZdV/CaVqeKNikllqjhRmSreqJhUTireUPlExRsVk8pUMalMKicV31Rxk4e11jUe1lrXeFhrXeOHL1O5icpUMalMFZPKVPGJikllqphUTlSmijdUpopJZar4TRWTyonKVHGicrOHtdY1HtZa13hYa13jhw9V/C9VTConKlPFpHKiMlV8ouITFZ+oOKmYVKaKSWWq+ETFJyr+Sx7WWtd4WGtd42GtdQ37hw+oTBWTylTxhspJxaQyVXxCZao4UZkqJpWpYlL5SxWTyknFpPJGxaTyiYo3VKaKE5WpYlKZKj7xsNa6xsNa6xoPa61r2D98QOWbKk5Upoo3VD5RMamcVHyTylTxTSpTxaQyVUwqU8WkMlW8oXKzik88rLWu8bDWusbDWusa9g+/SGWqeENlqphUpopJZaqYVE4qJpWp4kRlqnhD5Y2KE5WTijdUTiomlZOKT6i8UXGi8kbFJx7WWtd4WGtd42GtdQ37hy9S+UTFGyonFZPKScUbKicVJyqfqDhRmSomlW+qmFSmiknlpOINlaliUjmpmFROKr7pYa11jYe11jUe1lrXsH/4IpWpYlI5qZhUpooTlTcqJpWp4g2VT1RMKm9UTCpTxaQyVUwqU8Wk8k0Vk8pU8YbKScWk8omKTzysta7xsNa6xsNa6xo/fFnFN1WcqJxUnKh8QuWkYlI5UXmjYlL5popJZaqYVKaK36RyUjGpnFRMKlPFpPJND2utazysta7xsNa6xg9fpnJSMamcqEwVU8UbKlPFpDKpnFScqJxUTCpTxaTyCZUTlaliqphUTlRuUjGpTBVTxaTymx7WWtd4WGtd42GtdQ37hw+oTBWTyhsVn1D5RMUbKv9LFd+kclJxonJS8YbKScUbKicVJyonFZ94WGtd42GtdY2HtdY1fvhQxaTyTSpTxUnFpDJV3KRiUrlJxScqPlHxhspU8ZsqvulhrXWNh7XWNR7WWtf44ZdVTCpTxaQyVbyhcqJyUvFGxRsqb1RMKt+kcqIyVUwqJypTxaTyRsVJxUnFpPIJlaniEw9rrWs8rLWu8bDWusYPH1L5TSpvVLyh8ptUpoo3VKaKSeWNiqliUnmjYlJ5o2JSmSpOVKaKE5UTlaliqphUvulhrXWNh7XWNR7WWtf44csqJpWpYlKZKj6hclLxhspUcaIyVZyonFRMKp9QmSqmiknlRGWqeENlqnij4kTlm1R+08Na6xoPa61rPKy1rvHDhypOKiaVqWJS+UTFpDKpTBVvqJxUTCr/SxWTyqQyVZyoTBWTylRxUjGpTBXfVDGp3ORhrXWNh7XWNR7WWtf44UMqn1CZKj6hMlWcqHyi4qTiRGWqmFROKiaVSeWkYlKZKiaV31TxCZUTlZOK/6WHtdY1HtZa13hYa13D/uGLVE4qJpW/VPGGylTxhsp/WcWkMlVMKlPFpDJVvKFyk4pvelhrXeNhrXWNh7XWNX74YyonFW+onFScqJxUTCpTxaQyVUwqJxWTylTxhsonVKaKSeWNikllqphU3qh4Q2WqOFH5TQ9rrWs8rLWu8bDWusYPX1YxqUwVk8qJylTxhso3VZxUvFHxCZWp4o2KE5WTikllUpkqTlS+SWWqOFGZKk5UpopPPKy1rvGw1rrGw1rrGj98SOU3VbxRcaIyVUwqJypTxYnKb6p4o+ITKlPFVPFGxaQyVZyonFR8QuUvPay1rvGw1rrGw1rrGj98qOINlROVT6h8k8pUcaJyUjGpvKHyCZWpYlL5JpWTim9S+UTFpPKXHtZa13hYa13jYa11DfuHD6icVHyTyknFJ1SmihOVb6p4Q2WqeENlqnhDZao4UTmpmFSmihOVqWJS+UTFpDJVfOJhrXWNh7XWNR7WWtf44csqJpXfVHGiMlV8QuWkYlKZKiaVSeWbVN5QOak4UflNKlPFN1VMKn/pYa11jYe11jUe1lrX+OFDFZ+oeENlUnlD5Q2VqeJE5Y2KE5VvqphUPlFxonJS8UbFGypTxRsVk8pvelhrXeNhrXWNh7XWNX74H1P5popJZao4UTlReaPiROUTFZPKicpUcaJyojJVTBUnKlPFicpU8ZtUpopJ5Zse1lrXeFhrXeNhrXWNHz6k8kbFf1nFpDJVvFFxonKi8psqJpWp4g2VqeKNikllqphUPlExqfymh7XWNR7WWtd4WGtdw/7hAyp/qWJSmSpOVKaKE5WbVUwqn6iYVN6omFS+qeKbVN6omFSmik88rLWu8bDWusbDWusaP3yo4kRlqjhRmSq+qeJ/qeINlanijYpJZao4qZhUpoqTikllqvhNKlPFScUbFd/0sNa6xsNa6xoPa61r/PDHVKaKE5WTihOVqWJSmSpOKk5Upoo3VP6SylQxqZyoTBWTyonKGxWTylTxTSpvVHziYa11jYe11jUe1lrX+OGXVZyoTBV/qeITKt9UMamcqEwVJxWTyqQyVUwqU8WkclLxCZUTlROVqWJSmSomlanimx7WWtd4WGtd42GtdY0fvkzlpOJE5Y2KT6icVEwqU8WkMqmcVLyhMlVMKlPFJ1SmikllqjhRmSomlTcqJpWpYlK52cNa6xoPa61rPKy1rvHDh1Q+UTGpTBVvqEwVJxWTyjdVTCqTylTxhsqJyknFGypTxaQyVUwVJxVvqEwV36Tylx7WWtd4WGtd42GtdY0fPlQxqUwVn1A5qfhLFScVk8pUMam8UTGpTBWTyonKScWJylRxojJVfJPKGypTxaTylx7WWtd4WGtd42GtdY0ffpnKScVU8YbKJ1SmijdUpopPqJyoTBVvVLyhMlV8k8pJxaQyVZyonFScVEwqv+lhrXWNh7XWNR7WWtewf/iAyhsVb6i8UXGi8k0Vk8pUMalMFZPKX6o4UTmpmFQ+UTGp/KWKE5Wp4pse1lrXeFhrXeNhrXUN+4f/MJWp4g2Vk4oTlanim1SmijdUpoo3VE4q3lCZKj6hMlW8oXJSMamcVHziYa11jYe11jUe1lrX+OFDKn+p4g2VqWKqOFGZKqaKSeWk4kTlDZWp4g2VqeKbVKaKE5WpYlJ5Q2WqOKmYVP7Sw1rrGg9rrWs8rLWu8cOXVXyTyknFN6mcqEwVU8Wk8psq3lB5o+JEZaqYKiaVv1TxTRW/6WGtdY2HtdY1HtZa1/jhl6m8UXGTijdUpopJ5aRiUplU/pLKVHGi8omKSeUNlW+qOFGZKj7xsNa6xsNa6xoPa61r/PB/jMpUMalMFScqJxUnKn+p4g2Vk4o3Kj6h8kbFJ1TeUPlND2utazysta7xsNa6xg//cSpTxaTyRsUnKk5UpopJ5ZtUPqHyTSp/SWWquNnDWusaD2utazysta5h//ABlanim1SmihOVqWJSOak4UblJxTepnFScqJxUnKh8ouJEZao4UZkqftPDWusaD2utazysta7xw5ep/CWVqeI3VUwqb1S8oTJVTCpTxaQyVbxR8YmKT1RMKlPFGxUnKm+oTBWfeFhrXeNhrXWNh7XWNewf1lpXeFhrXeNhrXWNh7XWNR7WWtd4WGtd42GtdY2HtdY1HtZa13hYa13jYa11jYe11jUe1lrXeFhrXeNhrXWNh7XWNf4fgj1tJGNXHeoAAAAASUVORK5CYII=\",\n \"location\": \"https://api.gatewaypix.onlineips.dev.finfy.com.br/orders/f6597dc3-d610-4b28-a08e-8add393917be\"\n },\n \"orderData\": {},\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"name\": \"name of payer\"\n },\n \"createdAt\": \"2023-09-08T18:24:52.171Z\",\n \"updatedAt\": \"2023-09-08T18:24:52.171Z\",\n \"transaction\": {\n \"transactionId\": \"d95fe4ad-ec0b-4798-b1fb-4bc23f04981c\",\n \"accountId\": \"6cc5f272-3288-40f7-84af-409055674ae3\",\n \"externalId\": \"order-id of new consumer system \",\n \"orderId\": \"f6597dc3-d610-4b28-a08e-8add393917be\",\n \"information\": null,\n \"category\": \"pix\",\n \"type\": \"credit\",\n \"status\": \"success\",\n \"amount\": 20050,\n \"fee\": 0,\n \"balanceAfterTransaction\": 99995079,\n \"receiver\": null,\n \"payer\": {\n \"key\": \"36e6c36a-f294-4f34-9086-eb30b2124525\"\n },\n \"eventName\": \"PixIn\",\n \"originalTransactionId\": null,\n \"createdAt\": \"2023-09-08T18:25:21.483Z\",\n \"updatedAt\": \"2023-09-08T18:25:21.483Z\"\n }\n}"},{"id":"8761ecc6-45de-4c81-b08e-394a757d3d55","name":"Order Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","type":"text","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","type":"text","description":"It is a required parameter to find account"}],"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId"],"variable":[{"key":"orderId","value":null,"description":"It's a parameter to find order by id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-002\",\n \"message\": \"Order Not Found\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"e5a16f4b-6bfb-433d-be04-748a7a33b871","name":"External Connection Does Not Exist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","type":"text","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","type":"text","description":"It is a required parameter to find account"}],"url":{"raw":"{{BASE_URL}}/proxy/v1/orders/:orderId","host":["{{BASE_URL}}"],"path":["proxy","v1","orders",":orderId"],"variable":[{"key":"orderId","value":null,"description":"It's a parameter to find order by id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ETC-002\",\n \"message\": \"External Connection Does Not Exist.\",\n \"shortMessage\": \"ExternalConnectionDoesNotExist\"\n}"}],"_postman_id":"0a45801c-a51b-4743-b322-a7da0358fc29"},{"name":"Validate Credit Card","id":"209493ae-20ac-4939-98c3-b64335c8a517","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"{{EXTERNAL_CONNECTION}}","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\r\n “holderName”: “Allexis R F Soares”,\r\n “cardNumber”: “5502099283943870”,\r\n “cvv”: “077”,\r\n “expMonth”: 11,\r\n “expYear”: 2033\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/credit-card/validate","description":"This endpoint is used to validate a credit card order.
\nThe Sandbox acquirer available for tests (homologation/staging environment) will consider the following credit cards as valid:
\nAny other cardNumber and cvv combination will be considered invalid by the service.
To simulate an acquirer error send the card bellow
\nTo return a valid card, use the cards below:
\n5502095822650000
\n5505536536504170
\nholderName (string): The name of the card holder.
cardNumber (string): The credit card number.
cvv (string): The card verification value.
expMonth (integer): The expiration month of the card.
expYear (integer): The expiration year of the card.
currency (string): The currency in which the transaction will be processed.
valid (boolean): Indicates whether the credit card order is valid.
message (string): Additional message related to the validation.
processorId (string): The processor id.
processorAccountId(string): The processor account id.
processorName(string): The processor name.
processorReferenceId(string): The processor reference id.
Request Body:
\n{\n \"holderName\": \"Holder Name\",\n \"cardNumber\": \"4417123456789113\",\n \"cvv\": \"123\",\n \"expMonth\": 12,\n \"expYear\": 2025,\n \"currency\": \"USD\"\n}\n\nResponse:
\n{\n \"valid\": true,\n \"message\": \"\",\n \"processorId\": \"string\",\n \"processorAccountId\": \"string\",\n \"processorName\": \"string\",\n \"processorReferenceId\": \"string\"\n}\n\nIt is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 0.60,\n \"externalId\": \"279dc90b-9eef-4ad3-824c-1c070e72fa36\",\n \"expiresIn\": 8640000,\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"documentType\": \"CPF\",\n \"name\": \"Name of payer\"\n },\n \"label\": \"transaction label\", //Optional\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\" // Optional, is necessary to receive the webhooks\n // \"currency\": \"EUR\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders","description":"This endpoint is used to create a new pix order.
\nThe flow of this operation will always be synchronous, that means that the processor has finished processing the payment and returned the result, but an external action is required to finalize the payment. You will receive a QR Code that you can share with the payer. When the payer makes the payment, the response will be sent via webhooks and the convrt system will process the result.
\n\n\nFor the Sandbox acquirer, payment can be made through the PayOrder route. For other acquirers, payment must be made through a financial institution using the QR code returned in the request response.
\n
amount (number, required): The amount of the order
\nexternalId (string, optional): An idempotent ID for transaction tracking, it will be returned via webhook (when a 'notificationUrl' is provided) if it is sent; if it is not sent in the request, it will also not be returned.
\nexpiresIn (number, required): The expiration time for the order.
\nIf the value is less than 1 minute (60 seconds), a validation error will be returned;
\nIf the value is greater than 2 hours (7200 seconds), a validation error will be returned.
\npayer.documentNumber (string, required): The document number of the payer.
\npayer.documentType (string, required): The type of document for the payer.
\npayer.name (string, required): The name of the payer.
\nlabel (string, optional): An optional label for the transaction.
\nnotificationUrl (url, optional): A URL to receive the transaction notification
\ncurrency (string, optional): A Currency for the transaction.
\nThe CONVRT system needs to allow merchants to create recurring payment contracts via automatic Pix, establishing recurring billing mandates with their clients. To create an automatic Pix payment, you need to pass the recurrence object in the request body. The payment method remains Pix and the payment is created with the Automatic Contract category.
If the endDate prop is sent in recurrence information. The CONVRT system will expire it automatically in the end of the day set.
\nexternalId (string, optional): An idempotent ID for transaction tracking, it will be returned via webhook (when a 'notificationUrl' is provided) if it is sent; if it is not sent in the request, it will also not be returned.
expiresIn (number, required): The expiration time for the order.
If the value is less than 1 minute (60 seconds), a validation error will be returned;
\nIf the value is greater than 2 hours (7200 seconds), a validation error will be returned.
\npayer (object, required): The payer information.
documentNumber (string, required): The document number of the payer.
\ndocumentType (string, required): The type of document for the payer.
\nname (string, required): The name of the payer.
\nlabel (string, optional): An optional label for the transaction.
notificationUrl (string, optional): An optional url to receive a notification by webhook.
recurrence (object, required): The recurrence information.
immediate (boolean, required): Determines whether the transaction will be charged immediately or not.
type (string, required): can be one of the values: weekly, monthly, quarter, semester, yearly.
startDate (string, required): The start date of the recurrence.
endDate (string, optional): The final date of the recurrence.
amount (object, required):
type (string, required): can be one of the values: variable, fixed.
value (number, required): The value of the recurrence transaction.
minValue (number, required): The min value accepted for the receiver. This property is only required when amount type is variable.
maxValue (number, required): This property is only required when amount type is variable.
title (string, optional): the title of the recurrence.
Creating a payment is subject to undergoing a risk validation process. The transaction will only check risk validation if is provided the document number and if the documentNumber is a CPF.
\nRisk validation is an anti-fraud procedure performed to determine whether the payer is eligible for the payment transaction. Currently, we consider the following criteria:
\nAge: Checks if the CPF holder, the payer, is of legal age.
\nLife Status: Verifies that the CPF holder does not have a death record—ensuring the person is alive at the time of the inquiry. This is important for preventing fraud or registration errors.
\nGovernment Restrictions: Assesses whether there are any active government restrictions on the CPF, such as prohibitions related to public agencies, which could hinder the transaction.
\nDepeding on the service, the response will contain the QR Code information(image and emv) or a link(redirectPaymentUrl) that will redict user to a web page with the QR Code information
The currency property does not need to be sent in the request because transactions must occur in the same currency as the region. If an unallowed currency is sent, the api will return an error
\nDuring the creation of the order, validation may occur where risk tools are used. If validation results in failure, the request will be rejected and the reason for failure indicating the validations that failed.
\nIt is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"lonzoId","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\n \"amount\": 86,\n // \"externalId\": \"Your externalId\", // optional\n // \"information\": \"Your information\", // Optional\n // \"label\": \"Your transaction label\", //Optional\n \"receiver\": {\n \"documentNumber\": \"01234567890\",\n \"documentType\": \"CPF\",\n \"pixKey\": \"cb9121f4-5c8c-419d-bd27-bd7a563bdb8c\"\n // Optional: Only one field is allowed between pixType and bankData.\n // \"bankData\": {\n // \"bankCode\": \"2939824\",\n // \"branchCode\": \"2291\",\n // \"accountNumber\": \"76543-8\",\n // \"name\": \"Account Name\",\n // \"accountType\": \"CC\" // CC for current, PG for payment or PP for saving\n // }\n },\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\" // Optional, is necessary to receive the webhooks\n // \"currency\": \"EUR\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/transfer","description":"Route for Creating a Transfer via pixKey or bankData. Only one field is allowed between pixKey and bankData.
\n\nImportant: The currency property does not need to be sent in the request because transactions must occur in the same currency as the region. If an unallowed currency is sent, the api will return an error
\n
{\n \"amount\": 6,\n \"externalId\": \"Your externalId\", // Optional\n \"information\": \"Your information\", // Optional\n \"receiver\": {\n \"documentNumber\": \"01234567890\",\n \"documentType\": \"CPF\",\n \"pixKey\": \"cb9121f4-5c8c-419d-bd27-bd7a563bdb8c\"\n },\n \"label\": \"Your transaction label\" //Optional\n \"notificationUrl\": \"Your webhook url\"\n}\n\n{\n \"amount\": 6,\n \"externalId\": \"Your externalId\", // Optional\n \"information\": \"Your information\", // Optional\n \"receiver\": {\n \"documentNumber\": \"01234567890\",\n \"documentType\": \"CPF\",\n \"bankData\": {\n \"bankCode\": \"ISPB_CODE\",\n \"branchCode\": \"2291\",\n \"accountNumber\": \"76543-8\",\n \"name\": \"Account Name\",\n \"accountType\": \"CC\"\n }\n },\n \"label\": \"Your transaction label\" //Optional\n \"notificationUrl\": \"Your webhook url\"\n}\n\nThe bankCode must be filled with the ISPB of the corresponding bank.
For a list of valid ISPB codes, refer to the Banco Central Official List.
\nBelow are described the account type options accepted by the API.
\nCreating a payment is subject to undergoing a risk validation process. The transaction will only check risk validation if is provided the document number and if the documentNumber is a CPF.
\nRisk validation is an anti-fraud procedure performed to determine whether the payer is eligible for the payment transaction. Currently, we consider the following criteria:
\nAge: Checks if the CPF holder, the payer, is of legal age.
\nLife Status: Verifies that the CPF holder does not have a death record—ensuring the person is alive at the time of the inquiry. This is important for preventing fraud or registration errors.
\nGovernment Restrictions: Assesses whether there are any active government restrictions on the CPF, such as prohibitions related to public agencies, which could hinder the transaction.
\nThis operation is always asynchronous. The transfer is processed in the background, and the response will be sent via webhooks. The convrt system will process the result accordingly.
When the pix key is a document, it must belong to the receiver, this means that the documentNumber must be equal to the pix key. If they are different in this scenario, the following error will be returned:
\n{\n \"code\": \"PIX-011\",\n \"message\": \"Pix key has a different ownership\",\n \"shortMessage\": \"PixKeyHasDifferentOwnership\"\n}\n\nIf the amount is between BRL 0.01 and BRL 0.03, the Pix transaction will be rejected, simulating an integration error and returning an error.
\nIf the amount falls within the range of BRL 0.03 to BRL 4.99, the Pix transaction will be rejected, and the status will be returned as failed.
\nIf the Pix key is fail-pix-key, the Pix transaction will be rejected, the status will be returned as failed, and an invalid key error will be displayed.
\nIf the Pix key is not-found-pix-key, the Pix transaction will be rejected, the status will be returned as failed, and a key not found error will be displayed.
\nIf the bank data document number is 05730495056 and the document type is CPF, the Pix transaction will be rejected and a bank data error with status failed will be returned.
\nIf the amount is either BRL 5.00 or BRL 6.00, the Pix transaction is accepted, and the status returns as success.
\nIf the amount equals BRL 5.00, a full refund will be issued.
\nIf the amount equals BRL 6.00, two partial refunds of BRL 3.00 each will be issued.
\nIf the amount is greater than BRL 5.00, the Pix transaction is confirmed, and the status is set to success.
\n\n\nWhen the pixkey field is used by passing a telephone number, use the pattern shown below, with the prefix +55. Ex: +5511912345678
\n
For the pix to be sent successfully, the document number below must be sent:
\nFor sending pix with pix key to be successful, one of the following pix keys must be used:
\nCPF → 77517432125
\nEmail → testecelbaas@celcoin.com.br
\nPhone → +5532976886942
\n\n\nFor any other key or pix with bank details the result will be a failure
\n
For sending pix with bank data to be successful, the following data must be sent:
\nDocument Number → 77517432125
\nBank Code → 13935893
\nBranch Code → 0001
\nAccount Number → 30023646094934
\nName → Margaret Gusikowski
\nAccount Type → PG
\namount (number, required): The amount of the transaction.
\nexternalId (string, required): The unique identifier for the transaction.
\nreceiver.documentNumber (string, required): The document number of the receiver.
\nreceiver.documentType (string, required): The type of document for the receiver.
\nreceiver.pixKey (string, optional): The pix key of the receiver. It's required if bank data object is not sent in request, but only one field is allowed between pixKey and bankData
\nreceiver.bankData: Object with bank account information of the receiver. It's required if pixKey field is not sent in request, but only one field is allowed between pixKey and bankData
\nreceiver.bankData.bankCode(string, required) : The bank's code of the receiver
\nreceiver.bankData.branchCode(string, required) : The bank's branch code of the receiver
\nreceiver.bankData.accountNumber(string, required) : The bank's account number of the receiver
\nreceiver.bankData.name(string, required) : The name of the receiver
\nreceiver.bankData.accountType(string, required) : The bank's account type of the receiver
\nlabel (string, optional): An optional label for the transaction.
\ncurrency (string, optional): A Currency for the transaction.
\nIt is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"url":"{{BASE_URL}}/proxy/v1/charge/:orderId/pay","description":"Route used to make pix payments for orders in sandbox, when the order is pending and has not expired.
\nThe created order must have an expiration date greater than the current date. If the order has expired, the following error will be returned:
\n{\n \"code\": \"AQO-002\",\n \"message\": \"The order has expired\",\n \"shortMessage\": \"ExpiredOrder\"\n}\n\nIt's a parameter to find order by id
\n","type":"text/plain"},"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"9d994b5d-b918-4735-8446-7034b4103b1e","name":"Payd Successfully","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["proxy","v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"","description":"It's a parameter to find order by id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin,accept-encoding"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"Date","value":"Fri, 01 Nov 2024 13:21:59 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null},{"id":"6b95fa10-930e-4df7-ad14-afad168b65eb","name":"Order Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["proxy","v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"","description":"It's a parameter to find order by id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"90"},{"key":"Date","value":"Fri, 01 Nov 2024 12:28:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AQO-001\",\n \"message\": \"Order not found for given id\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"1ec97276-3e51-4406-815a-8658cb0e853e","name":"Validation Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["proxy","v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"wrongId","description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"165"},{"key":"Date","value":"Fri, 01 Nov 2024 12:29:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"val-001\",\n \"message\": \"Validation Error\",\n \"shortMessage\": \"validationError\",\n \"details\": [\n {\n \"property\": \"orderId\",\n \"constraints\": {\n \"isUuid\": \"orderId must be a UUID\"\n }\n }\n ]\n}"},{"id":"ceaccdf3-3383-497b-9d44-e5574ff3f041","name":"Expired Order","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"external connection","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["proxy","v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"e959e48c-31c3-4f0c-a181-d114dfa564eb","description":"It's a parameter to find order by id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"82"},{"key":"Date","value":"Fri, 01 Nov 2024 12:32:24 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AQO-002\",\n \"message\": \"The order has expired\",\n \"shortMessage\": \"ExpiredOrder\"\n}"}],"_postman_id":"7e14f923-748b-4236-af6f-5d31e3d81526"},{"name":"Cancel Order","id":"1fdc1708-5829-4672-9aa1-22102fcffe16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n"}],"url":"{{BASE_URL}}/v1/orders/:orderId/cancel","description":"This endpoint is used to cancel a automatic pix contract for a specific order.
\nThis operation can be processed asynchronously
\nAsynchronous: means that the cancellation will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nIf there are pending transactions releated to the this order, the transactions will be updated to failed status
\nIt's not possible to reopen a canceled order
\nA webhook notification will be sent to the URLs saved in merchant panel.
\nMethod: POST
\nEndpoint: {{BASE_URL}}/v1/orders/:orderId/cancel
\nStatus: 204
\nContent-Type: application/json
\nThis variable refers to a order identifier.
\n","type":"text/plain"},"type":"any","value":"78a89b67-ab50-4019-be02-fb407d9cd168","key":"orderId"}]}},"response":[],"_postman_id":"1fdc1708-5829-4672-9aa1-22102fcffe16"},{"name":"Create Automatic Pix Payment","id":"e5e80e4c-3805-46a5-ba4a-c00018b991e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 15.00, //optional,\r\n \"title\": \"Cobrança 1\",\r\n \"scheduledTo\": \"2026-12-31\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/:orderId/payments","description":"This endpoint makes an HTTP POST request to create a new automatic pix payment from a previously created order. The request's body should include the title, scheduledTo, amount(optional), externalId (optional). The automatic pix payment will only be created if the original order's status is paid, its category is automaticContract and is not expired.
The amount in request's body only be accepted if the original order's recurrence type is variable and it value is between the minValue and maxValue set in order's recurrence
The payment date must respect the D10 and D2 rules.
\nD10: The current day must be at least 10 days before the next payment
\nD2: The current day e must be at most 2 days before the next payment
\nExample:
\nThe next payment date is 2026-03-24
\nBy the D10 and D2 rules, the rage date we can create a new payment is: 2026-03-14(D10) to 2026-03-22(D2)
\namount (number, optional): The amount of the order
\ntitle(string, required): The name of payment in client's bank statement.
\nscheduledTo(string, required): The date that the processor can retry payment in rejected cases.
\nexternalId (string, optional): An idempotent ID for transaction tracking, it will be returned via webhook (when a 'notificationUrl' is provided) if it is sent; if it is not sent in the request, it will also not be returned.
\nnotificationUrl (url, optional): A URL to receive the transaction notification
\nThis variable refers to a order identifier.
\n","type":"text/plain"},"type":"any","value":"uuid","key":"orderId"}]}},"response":[{"id":"a7bc14df-6f2e-416b-807b-ab586ffd8d56","name":"Create Payment Successfuly","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 15.00,\r\n \"title\": \"Cobrança 1\",\r\n \"scheduledTo\": \"2026-12-31\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId/payments","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId","payments"],"variable":[{"key":"orderId","value":""}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 0,\n \"accountId\": \"8ec043b6-e98e-468f-9b11-7e8be2d05629\",\n \"expectedAmount\": 0.01,\n \"orderId\": \"58c02355-0485-4f18-9704-68c7aafbd4ad\",\n \"status\": \"pending\",\n \"fee\": 0,\n \"transactionId\": \"b026f7d6-6125-4144-8dfe-f6b39a93a40d\",\n \"category\": \"automaticPayment\",\n \"origin\": \"MerchantConnection\",\n \"balance\": 0,\n \"transactionData\": {},\n \"payer\": {\n \"documentNumber\": \"10412762498\",\n \"documentType\": \"CPF\",\n \"name\": \"Alberto Jose Cunha Vitor da Silva\"\n },\n \"merchantId\": \"f5066717-60b7-4056-8992-3a9b9a153cf7\",\n \"region\": \"BR\",\n \"currency\": \"BRL\",\n \"paymentMethod\": \"pix\",\n \"eventName\": \"PixInAutomaticPayment\",\n \"type\": \"credit\",\n \"createdAt\": \"2026-01-19T22:34:27.338Z\",\n \"updatedAt\": \"2026-01-19T22:34:27.338Z\",\n \"refundedAmount\": 0\n}"}],"_postman_id":"e5e80e4c-3805-46a5-ba4a-c00018b991e9"},{"name":"Cancel Automatic Pix Payment","id":"be44253e-3f60-48ae-a760-272dbc991762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{BASE_URL}}/v1/transactions/:transactionId/cancel","description":"This endpoint makes a HTTP PATCH request to cancel a automatic payment transaction.
\nThe cancellation will only be accepted if the transaction is pending.
\n","urlObject":{"path":["v1","transactions",":transactionId","cancel"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"description":{"content":"This variable refers to a transaction identifier.
\n","type":"text/plain"},"type":"any","value":"uuid","key":"transactionId"}]}},"response":[{"id":"4cbf21aa-fb1f-4282-a9e4-629589f1e484","name":"Cancel Successfully","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{BASE_URL}}/v1/transactions/:transactionId/cancel","host":["{{BASE_URL}}"],"path":["v1","transactions",":transactionId","cancel"],"variable":[{"key":"transactionId","value":"uuid","description":"This variable refers to a transaction identifier."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"orderId\": \"3c84dd58-9a0a-4969-9b43-84fd8609a6ba\",\n \"accountId\": \"8ec043b6-e98e-468f-9b11-7e8be2d05629\",\n \"transactionId\": \"754403ce-dd08-4363-80de-f8c2aff16738\",\n \"origin\": \"MerchantConnection\",\n \"status\": \"failed\",\n \"createdAt\": \"2026-01-19T16:56:27.549Z\",\n \"updatedAt\": \"2026-01-19T16:57:07.794Z\"\n}"}],"_postman_id":"be44253e-3f60-48ae-a760-272dbc991762"}],"id":"bc454c06-4a73-490b-b05f-c1c66a9a75fc","_postman_id":"bc454c06-4a73-490b-b05f-c1c66a9a75fc","description":""},{"name":"Online Bank Transfer","item":[{"name":"Create Online Bank Transfer Order (PayIn)","id":"4f35e0ce-375a-4edd-a92b-d5b460c838f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\r\n \"transferMethod\": \"Trustly\",\r\n \"description\": \"description here\",\r\n \"amount\": 6,\r\n \"country\": \"DE\",\r\n \"notificationUrl\": \"https://webkook.com\",\r\n \"payer\": {\r\n \"email\": \"fake@mail.com\",\r\n \"firstName\": \"Bruce\",\r\n \"lastName\": \"Wayne\",\r\n \"documentNumber\": \"61610283015\",\r\n \"address\": \"Address\",\r\n \"city\": \"City\",\r\n \"zip\": \"55336890\",\r\n \"ipAddress\": \"127.0.0.1\",\r\n \"phoneNumber\": \"12133734253\"\r\n }\r\n // \"currency\": \"BRL\" // optional\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/online-bank-transfer","description":"This endpoint is used to create a new order.
\nIf charge was created can inside the Sandbox acquirer it can be paid using the Pay Order endpoint, passing the order ID as a query param. This route can only be used on the homologation environment.
\nThe flow of this operation will depend on the payment processor. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the payment and returned the result
\nAsynchronous: means that the payment will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nSandbox: Synchronous or Asynchronous
\nDaopay: Asynchronous
\nIf the amount is either EUR 0.01 the create transaction will be rejected simulating in an error of integration error.
\nIf the amount is less than EUR 5.00 the create transaction will be rejected simulating in an error of failed to communicate with acquirer service.
\namount (number, required): The amount of the order.
\ndescription (string, required): The description of the order.
\ncountry (string, required): The country to send to processor.
\ntransferMethod (string, required): The payment method that processor will use.
\nreturnUrl (string, required): The URL that customer wil be redirected after complete payment.
\npayer (object, required): The payer information.
\nemail (string, required): Customer's email address.
\nfirstName (string, optional): First name of the customer.
\nlastName (string, optional): Last name of the customer.
\ndocumentNumber (string, optional): Customer's document number.
\naddress (string, optional): Customer's address.
\ncity (string, optional): Customer's city.
\nzip (string, optional): Customer's zip code.
\nipAddress (string, optional): Customer's IP address.
\nphoneNumber (string, optional): Customer's phone number.
\nlabel (string, optional): An optional label for the transaction.
\nexternalId (string, optional): An optional idempotency key.
\nnotificationUrl (string): URL for receiving notifications.
\nThere is a relationship between transfer methods, countries and currencies. In this table you can see which countries and which currencies the transfer metho accepts.
\namount (number): Amount of the order.
\norderId (string): ID of the order.
\ntransactionId (string): ID of the transaction.
\nstatus (string): Status of the order.
\ncheckoutUrl (string): Url to pay the order.
\ntransactionFees (array): Array of transaction fees with details.
\n{\n \"amount\": 0,\n \"checkoutUrl\": \"\",\n \"orderId\": \"\",\n \"status\": \"\",\n \"transactionId\": \"\",\n \"transactionFees\": []\n}\n\nIt is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"amount","value":"5","description":"This field refers to operation amount
\n","type":"text"},{"key":"description","value":"Description","description":"This field refers to operation description
\n","type":"text"},{"key":"attachment","description":"This field refers to operation attachment
\n","type":"file","src":"/home/albertojcvs/Downloads/Attachment.csv"}]},"url":"{{BASE_URL}}/proxy/v1/transactions/:transactionId/refund","description":"This endpoint makes an HTTP POST request to refund a order's transaction. The endpoint's URL should include a order id value and the request body should include the amount, description (optional), attachment (optional).
\nIt`s possible to make a full refund or make multiple partial refunds while the transaction still has available amount to refund.
\nThe flow of this operation will always be asynchronous, which means that the refund will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nEstonian Banks, Latvian Banks, Lithuanian Banks and Multibanco transfer methods can't make any type of refund requestsamount (number, required): The amount to refund.
notificationUrl (string, optional): URL for receiving notifications.
description (string, optional): The description of the refund.
attachment (file, optional): The attachment of the refund.
id (string): Id of order
accountId (string): AccountId of order
amount (number): Amount to refund
transactionId (string): Id of transaction
refundTransactionId (string): Id of refund transaction
status(optional enum: failed, pending, success): Status of refund transaction
Depending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 94,\r\n // \"externalId\": abe78aec-637d-41e6-9f33-85612634564c,\r\n \"payer\": {\r\n \"name\": \"name of payer\",\r\n \"email\": \"payer@mail.com\"\r\n },\r\n \"redirectUrl\": \"https://google.com\",\r\n \"notificationUrl\": \"https://webkook.com\",\r\n \"label\": \"transaction label\" // Optional\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/oxxo-pay","description":"This endpoint is used to create a new order using oxxo pay payment method. The required information are the transfer method, description, amount, country and payer information
\nThe flow of this operation will depend on the payment processor. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the payment and returned the result
\nAsynchronous: means that the payment will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nIf the amount is either $ 0.01 the create transaction will be rejected simulating in an error of integration error.
\nIf the amount is less than $ 5.00 the create transaction will be rejected simulating in an error of failed to communicate with acquirer service.
\nIf the amount is greater than $ 5.00, the e-Wallet transaction is created, and the status returns as open.
\namount (number, required): The amount of the order.
\nexternalId (string, optional): Idempotence key that you can use to identify a transaction.
\nredirectUrl (string, required): Idempotence key that you can use to identify transactions on your end.
\npayer (object, required): The payer information.
\nemail (string, required): Customer's email address.
\nname (string, required): Name of the customer.
\nlabel (string, optional): An optional label for the transaction.
\namount (number): Amount of the order.
\nid (string): ID of the order.
\nstatus (string): Status of the order.
\nurl (string): Url to pay the order.
\ntransactionFees (array): Array of transaction fees with details.
\nIt is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\n \"transferMethod\": \"PayPal\",\n \"description\": \"description\",\n \"amount\": 6,\n \"country\": \"BR\",\n \"returnUrl\": \"www.website.com\",\n \"payer\": {\n \"email\": \"fake@mail.com\",\n \"firstName\": \"Bruce\",\n \"lastName\": \"Wayne\",\n \"documentNumber\": \"61610283015\",\n \"address\": \"Address\",\n \"city\": \"City\",\n \"zip\": \"55336890\",\n \"ipAddress\": \"127.0.0.1\",\n \"phoneNumber\": \"12133734253\"\n },\n \"label\": \"label\"\n // \"currency\": \"BRL\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders/e-wallet","description":"This endpoint is used to create a new order using e-Wallet payment method. The required information are the transfer method, description, amount, country and payer information
\nThe flow of this operation will depend on the payment processor. This operation can be processed synchronously or asynchronously
\nSynchronous: means that the processor has finished processing the payment and returned the result
\nAsynchronous: means that the payment will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\nSandbox: Synchronous or Asynchronous
\nDaopay: Asynchronous
\nIf the amount is either $ 0.01 the create transaction will be rejected simulating in an error of integration error.
\nIf the amount is less than $ 5.00 the create transaction will be rejected simulating in an error of failed to communicate with acquirer service.
\nIf the amount is greater than $ 5.00, the e-Wallet transaction is created, and the status returns as open.
\namount (number, required): The amount of the order.
\ndescription (string, required): The description of the order.
\ntransferMethod (string, required): The payment service that processor will use.
\ncountry (string, required): The country to send to processor.
\nreturnUrl (string, required): The URL that customer wil be redirected after complete payment.
\npayer (object, required): The payer information.
\nemail (string, required): Customer's email address.
\nfirstName (string, optional): First name of the customer.
\nlastName (string, optional): Last name of the customer.
\ndocumentNumber (string, optional): Customer's document number.
\naddress (string, optional): Customer's address.
\ncity (string, optional): Customer's city.
\nzip (string, optional): Customer's zip code.
\nipAddress (string, optional): Customer's IP address.
\nphoneNumber (string, optional): Customer's phone number.
\nlabel (string, optional): An optional label for the transaction.
\nadditionalData (object, optional): An optional additional data for e-wallet acquirer transfer method specific configuration.
\nCurrently, the Convrt Cielo integration handles additionalData for the following transfer methods:
ApplePay:
\nephemeralPublicKey (string, required, max length 512): The ephemeral public key used for the transaction encryption.
\nwalletKey (string, required, max length 512): The specific key or token from the Apple Pay wallet.
\nCreating a payment is subject to undergoing a risk validation process. The transaction will only check risk validation if is provided the document number and if the documentNumber is a CPF.
\nRisk validation is an anti-fraud procedure performed to determine whether the payer is eligible for the payment transaction. Currently, we consider the following criteria:
\nAge: Checks if the CPF holder, the payer, is of legal age.
\nLife Status: Verifies that the CPF holder does not have a death record—ensuring the person is alive at the time of the inquiry. This is important for preventing fraud or registration errors.
\nGovernment Restrictions: Assesses whether there are any active government restrictions on the CPF, such as prohibitions related to public agencies, which could hinder the transaction.
\nThere is a relationship between transfer methods, countries and currencies. In this table you can see which countries and which currencies the transfer metho accepts.
\namount (number): Amount of the order.
\norderId (string): ID of the order.
\ntransactionId (string): ID of the transaction.
\nstatus (string): Status of the order.
\ncheckoutUrl (string): Url to pay the order.
\ntransactionFees (array): Array of transaction fees with details.
\nDepending on the acquirer, this prop will be returned in case of creation error, it will be return the processor error reason with the follow properties:
\nprocessorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"amount","value":"5","description":"This field refers to operation amount
\n","type":"text"},{"key":"description","value":"Description","description":"This field refers to operation description
\n","type":"text"},{"key":"attachment","description":"This field refers to operation attachment
\n","type":"file","src":"/home/albertojcvs/Downloads/Attachment.csv"}]},"url":"{{BASE_URL}}/proxy/v1/transactions/:transactionId/refund","description":"This endpoint makes an HTTP POST request to refund a order's transaction. The endpoint's URL should include a order id value and the request body should include the amount, description (optional), attachment (optional).
\nIt`s possible to make a full refund or make multiple partial refunds while the transaction still has available amount to refund.
\nThe flow of this operation will always be asynchronous, which means that the refund will be processed in the background and the response will be sent via webhooks and the convrt system will process the result
\namount (number, required): The amount to refund.
description (string, optional): The description of the refund.
attachment (file, optional): The attachment of the refund.
id (string): Id of order
accountId (string): AccountId of order
amount (number): Amount to refund
transactionId (string): Id of transaction
refundTransactionId (string): Id of refund transaction
status(optional enum: failed, pending, success): Status of refund transaction
processorCode: It should return the error code from the acquirer when exists
processorDetails: It should return the error reason/details from the acquirer when exists
processorName: It should return the name of the acquirer responsible for the operation
processorRaw: It should return the other details to help to debug failures
It is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"lonzoId","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"\n{\n \"description\": \"Purchase of product X\",\n \"expiresIn\": 3600,\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\",\n \"amount\": 99.99,\n \"currency\": \"BRL\",\n \"paymentMethods\": [\n \"pix\",\n \"creditCard\"\n ],\n \"chosenPaymentMethod\": \"pix\", // Optional: Can be omitted if the payer chooses later\n // Optional: Can be omitted if there is no data for payment methods\n \"data\": {\n \"pix\": {\n \"expiresIn\": 3600\n \n }\n },\n \"product\": {\n \"name\": \"Product z\",\n \"description\": \"Purchase of product X\"\n },\n // Optional: If you want the user to be redirected after paying for the link\n \"redirectUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\",\n // Optional: If you want to add parameters to the redirect url\n \"customRedirectParameters\": {\n \"id\": \"product-x\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/payment-links","description":"The request body should include the following parameters:
\ndescription (string): A description of the purchase.
expiresIn (number): The expiration time of the payment link in seconds.
externalId (string, optional): An optional idempotency key.
amount (number): The amount of the order.
currency (string): Currency of the order.
paymentMethods (array): An array of accepted payment methods.
chosenPaymentMethod (string): The chosen payment method.
data (object): Additional data for the payment method.
product (object): Information about the product.
redirectUrl (string): The URL to redirect after payment.
customRedirectParameters (object): Custom parameters for redirection.
The data information in a pix payment link should include:
\nname (string)
\ndocument (string)
\nexpiresIn (number)
\n{\n \"description\": \"Purchase of product X\",\n \"expiresIn\": 3600,\n \"externalId\": \"1\",\n \"amount\": 99.99,\n \"currency\": \"BRL\",\n \"paymentMethods\": [\n \"pix\",\n ],\n \"chosenPaymentMethod\": \"pix\",\n \"data\": {\n \"pix\": {\n \"name\": \"John Doe\",\n \"document\": \"254.730.700-60\",\n \"expiresIn\": 7200\n }\n },\n \"product\": {\n \"name\": \"Product z\",\n \"description\": \"Purchase of product X\"\n },\n \"redirectUrl\": \"https://google.com\",\n \"customRedirectParameters\": {\n \"id\": \"product-x\"\n }\n}\n\nThe data information in a e-wallet payment link should include:
\nfirstName (string)
\nlastName (string)
\ndocument (string)
\ncountry (string)
\ntransferMethod (string): Currently the only accepted value is \"ApplePay\"
\n{\n \"description\": \"Purchase of product X\",\n \"expiresIn\": 3600,\n \"externalId\": \"1\",\n \"amount\": 99.99,\n \"currency\": \"BRL\",\n \"paymentMethods\": [\n \"eWallet\",\n ],\n \"chosenPaymentMethod\": \"eWallet\",\n \"data\": {\n \"eWallet\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"document\": \"254.730.700-60\",\n \"country\": \"BR\",\n \"transferMethod\": \"ApplePay\"\n }\n },\n \"product\": {\n \"name\": \"Product z\",\n \"description\": \"Purchase of product X\"\n },\n \"redirectUrl\": \"https://google.com\",\n \"customRedirectParameters\": {\n \"id\": \"product-x\"\n }\n}\n\nThe response body returns the following parameter:
\npaymentLinkUrl (string): The URL for the payment link.Example response:
\n{\n \"paymentLinkUrl\": \"https://payment-link-url.com\"\n}\n\nIt is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"url":"{{BASE_URL}}/proxy/v1/payment-links/:code/cancel","description":"This endpoint makes an HTTP PATCH request to cancel a payment link. There is no data that needs to be sent in the request body. You need to provide the payment link code in the request parameters.
\ncode: The identifier of the payment link to be cancelled.
There is no data that needs to be sent in the request body.
\n204 No Content: The payment link has ben successfully cancelled.
400 Bad Request: Invalid or missing parameters were sent in the request. Additionally, an unknown internal error may have occurred.
422 Unprocessable Entity: The payment link status must be pending to be cancelled.
500 Internal Server Error: An internal server error has ocurred.
Payment link code
\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[{"id":"c7e28932-181a-47c1-9db7-784b1ccdad10","name":"Notification failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code","cancel"],"variable":[{"key":"code","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"27aec06d-473d-4f52-bb64-c672963438db"},{"key":"x-request-id","value":"78c85f2c-83a3-4001-8048-ba3a04b0df30"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"98"},{"key":"Date","value":"Wed, 12 Mar 2025 12:40:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"NTF-001\",\n \"message\": \"Failed to send notification\",\n \"shortMessage\": \"SendNotificationFailed\"\n}"},{"id":"bb9f1134-ccac-4e20-83ea-ea5aa32751bc","name":"Unknown error","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code","cancel"],"variable":[{"key":"code","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"46a4b168-ef6d-4776-b0de-2483bf05811c"},{"key":"x-request-id","value":"4dddcfdd-545a-46b1-8b59-21bc7d9daf52"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"92"},{"key":"Date","value":"Thu, 20 Mar 2025 13:20:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"GEN-002\",\n \"message\": \"CancelPaymentLinkUseCase failed\",\n \"shortMessage\": \"unknownError\"\n}"},{"id":"4dae50b1-f21a-450d-a995-1d0f7cbf9526","name":"Invalid code","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code","cancel"],"variable":[{"key":"code","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"5080ad8b-2ef6-496f-a792-8896edad7bae"},{"key":"x-request-id","value":"97070fcb-30f7-4c22-9323-0c701d8d10d4"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"203"},{"key":"Date","value":"Thu, 20 Mar 2025 14:42:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"val-001\",\n \"message\": \"Validation Error\",\n \"shortMessage\": \"validationError\",\n \"details\": [\n {\n \"property\": \"code\",\n \"constraints\": {\n \"isString\": \"code must be a string\",\n \"isNotEmpty\": \"code should not be empty\"\n }\n }\n ]\n}"},{"id":"b99e8bb7-dc67-4ffa-bfbc-ddf0cd672188","name":"Payment link not found","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code","cancel"],"variable":[{"key":"code","value":"ABDH281"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"41f1ffe5-d1dd-4abb-a3f5-fcabab06e7b0"},{"key":"x-request-id","value":"5c41f58a-7bb7-47da-abb8-022b97fa030d"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"98"},{"key":"Date","value":"Thu, 20 Mar 2025 14:46:40 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"PLK-001\",\n \"message\": \"The payment link was not found\",\n \"shortMessage\": \"PaymentLinkNotFound\"\n}"},{"id":"adf7218a-0557-4caf-817c-52ce97c6f0bb","name":"Cancelled successfully","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code","cancel"],"variable":[{"key":"code","value":"FN3A829"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"6411e5d8-6d4f-4868-b053-c3eed65837f2"},{"key":"x-request-id","value":"1461ad35-950d-4abc-b56a-ad2298a1e169"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin,accept-encoding"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"Date","value":"Thu, 20 Mar 2025 14:51:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null},{"id":"fa3f81c2-9051-43ee-a781-b8bfaad6f32d","name":"Invalid status","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code","cancel"],"variable":[{"key":"code","value":"FN3A829"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"5cffa131-65f4-4075-bf42-e9903f50a021"},{"key":"x-request-id","value":"083847f5-e297-4288-b3c8-142d0eab7341"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"129"},{"key":"Date","value":"Thu, 20 Mar 2025 14:53:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"PLM-007\",\n \"message\": \"Only pending payment links are allowed to be paid\",\n \"shortMessage\": \"OnlyPendingLinksAllowedBeToPaid\"\n}"}],"_postman_id":"43d99f2f-3ac1-48f7-bbc5-1d6aa3cc984f"},{"name":"List Payment Links","id":"b5bc431f-afaf-4b18-8e2c-04c7f3e716f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"url":"{{BASE_URL}}/proxy/v1/payment-links/list","description":"This endpoint retrieves a list of payment links.
\nThis is a GET request and does not require a request body.
\nitems (array): An array of payment link objects, each containing details such as ID, code, description, expiration, merchant ID, account ID, amount, currency, payment methods, status, and more.
pagination (object): An object containing pagination details such as limit, page, total records, total pages, next page, previous page, and flags for existence of next and previous pages.
{\n \"items\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"description\": \"\",\n \"expiresIn\": 0,\n \"merchantId\": \"\",\n \"accountId\": \"\",\n \"amount\": 0,\n \"currency\": \"\",\n \"paymentMethods\": [\"\"],\n \"status\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": 0,\n \"page\": 0,\n \"totalRecords\": 0,\n \"totalPages\": 0,\n \"nextPage\": 0,\n \"prevPage\": null,\n \"hasNextPage\": true,\n \"hasPrevPage\": true\n }\n}\n\n200 Ok: The request was successful and the response contains the list of payment links and pagination details.Optional description to filter the payment links by their description.
\n","type":"text/plain"},"key":"description","value":"optional"},{"disabled":true,"description":{"content":"Minimum expiration time in seconds for the payment link.
\n","type":"text/plain"},"key":"minExpiresIn","value":"3600"},{"disabled":true,"description":{"content":"Maximum expiration time in seconds for the payment link.
\n","type":"text/plain"},"key":"maxExpiresIn","value":"86400"},{"disabled":true,"description":{"content":"Minimum amount for the payment link, in the smallest unit of the currency (e.g., cents).
\n","type":"text/plain"},"key":"minAmount","value":"100"},{"disabled":true,"description":{"content":"Maximum amount for the payment link, in the smallest unit of the currency (e.g., cents).
\n","type":"text/plain"},"key":"maxAmount","value":"1000"},{"disabled":true,"description":{"content":"List of currencies to filter the payment links.
\n","type":"text/plain"},"key":"currencies","value":"USD,EUR"},{"disabled":true,"description":{"content":"List of payment methods to filter the payment link.
\n","type":"text/plain"},"key":"paymentMethods","value":"pix,creditCard"},{"disabled":true,"description":{"content":"The chosen payment method for the payment link.
\n","type":"text/plain"},"key":"chosenPaymentMethods","value":"creditCard"},{"disabled":true,"description":{"content":"The unique order ID associated with the payment link.
\n","type":"text/plain"},"key":"orderId","value":"d028210d-78a2-48b1-872a-6b38d2650a29"},{"disabled":true,"description":{"content":"The unique transaction ID associated with the payment link.
\n","type":"text/plain"},"key":"transactionId","value":"d028210d-78a2-48b1-872a-6b38d2650a29"},{"disabled":true,"description":{"content":"List of statuses to filter the payment links.
\n","type":"text/plain"},"key":"status","value":"pending,paid"},{"disabled":true,"description":{"content":"Starting date for filtering payment links, in ISO 8601 format.
\n","type":"text/plain"},"key":"from","value":"2023-01-01T00:00:00Z"},{"disabled":true,"description":{"content":"Ending date for filtering payment links, in ISO 8601 format.
\n","type":"text/plain"},"key":"to","value":"2023-12-31T23:59:59Z"},{"disabled":true,"description":{"content":"Page number for pagination of results (default is 1).
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Maximum number of payment links to return per page (default is 10).
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"Sort order for the results (e.g., ASC for ascending, DESC for descending).
\n","type":"text/plain"},"key":"order","value":"DESC"}],"variable":[]}},"response":[{"id":"ba502e3e-f51d-4d35-a8b4-009a65e81b10","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/list","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links","list"],"query":[{"key":"description","value":"optional","description":"Optional description to filter the payment links by their description.","disabled":true},{"key":"minExpiresIn","value":"3600","description":"Minimum expiration time in seconds for the payment link.","disabled":true},{"key":"maxExpiresIn","value":"86400","description":"Maximum expiration time in seconds for the payment link.","disabled":true},{"key":"minAmount","value":"100","description":"Minimum amount for the payment link, in the smallest unit of the currency (e.g., cents).","disabled":true},{"key":"maxAmount","value":"1000","description":"Maximum amount for the payment link, in the smallest unit of the currency (e.g., cents).","disabled":true},{"key":"currency","value":"USD,EUR","description":"List of currencies to filter the payment links.","disabled":true},{"key":"paymentMethods","value":"pix,creditCard","description":"List of payment methods to filter the payment lin","disabled":true},{"key":"chosenPaymentMethod","value":"pix","description":"The chosen payment method for the payment link.","disabled":true},{"key":"orderId","value":"d028210d-78a2-48b1-872a-6b38d2650a29","description":"The unique order ID associated with the payment link.","disabled":true},{"key":"transactionId","value":"d028210d-78a2-48b1-872a-6b38d2650a29","description":"The unique transaction ID associated with the payment link.","disabled":true},{"key":"status","value":"pending,paid","description":"List of statuses to filter the payment links.","disabled":true},{"key":"from","value":"2023-01-01T00:00:00Z","description":"Starting date for filtering payment links, in ISO 8601 format.","disabled":true},{"key":"to","value":"2023-12-31T23:59:59Z","description":"Ending date for filtering payment links, in ISO 8601 format.","disabled":true},{"key":"page","value":"1","description":"Page number for pagination of results (default is 1).","disabled":true},{"key":"limit","value":"10","description":"Maximum number of payment links to return per page (default is 10).","disabled":true},{"key":"order","value":"DESC","description":"Sort order for the results (e.g., ASC for ascending, DESC for descending).","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"4acc3c50-ac3d-48f3-bc17-0ba8ba854f8d"},{"key":"x-request-id","value":"9868ebbc-f597-40f3-af8c-40286bb38c30"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin,accept-encoding"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-encoding","value":"gzip"},{"key":"Date","value":"Wed, 12 Mar 2025 18:20:42 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"1d841d85-822b-4460-8caa-6189b9f5525a\",\n \"code\": \"E523E5\",\n \"description\": \"Purchase of product Z\",\n \"expiresIn\": 8500,\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"accountId\": \"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3\",\n \"accountType\": \"full\",\n \"region\": \"BR\",\n \"amount\": 99.99,\n \"currency\": \"BRL\",\n \"currencies\": [\n \"BRL\"\n ],\n \"paymentMethods\": [\n \"pix\",\n \"creditCard\"\n ],\n \"chosenPaymentMethod\": \"pix\",\n \"orderId\": null,\n \"transactionId\": null,\n \"data\": {\n \"pix\": {\n \"expiresIn\": 3600\n }\n },\n \"status\": \"pending\",\n \"notificationChannels\": [\n \"f7fd75de-fa50-46eb-82ec-c223acc2b549\",\n \"e76dd07a-46a3-4e9f-b251-4a8ddeaae37b\"\n ],\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\",\n \"origin\": \"Inovio\",\n \"createdAt\": \"2025-03-14T13:37:01.838Z\",\n \"updatedAt\": \"2025-03-14T13:37:01.838Z\"\n }\n ],\n \"pagination\": {\n \"limit\": 10,\n \"page\": 1,\n \"totalRecords\": 1,\n \"totalPages\": 1,\n \"nextPage\": null,\n \"prevPage\": null,\n \"hasNextPage\": false,\n \"hasPrevPage\": false\n }\n}"}],"_postman_id":"b5bc431f-afaf-4b18-8e2c-04c7f3e716f9"},{"name":"Open Payment Link","id":"911e63d4-a786-495b-a98f-681a959ee6a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"url":"{{BASE_URL}}/proxy/v1/payment-links/:code","description":"This endpoint retrieves a specific payment link based on the code.
\n \"id\": \"d03d8802-73ac-4dd5-82d2-88a7fde7ba79\",\n \"code\": \"8E7FCA\",\n \"description\": \"Purchase of product Y\",\n \"expiresIn\": 3600,\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"accountId\": \"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3\",\n \"region\": \"BR\",\n \"amount\": 0,\n \"currency\": \"BRL\",\n \"currencies\": [\n \"BRL\"\n ],\n \"paymentMethods\": [\n \"pix\",\n \"creditCard\"\n ],\n \"chosenPaymentMethod\": \"pix\",\n \"orderId\": null,\n \"transactionId\": null,\n \"data\": {\n \"pix\": {\n \"expiresIn\": 3600\n }\n },\n \"status\": \"pending\",\n \"notificationChannels\": [\n \"f7fd75de-fa50-46eb-82ec-c223acc2b549\",\n \"e76dd07a-46a3-4e9f-b251-4a8ddeaae37b\"\n ],\n \"createdAt\": \"2025-03-14T16:29:05.261Z\",\n \"updatedAt\": \"2025-03-14T16:29:05.261Z\"\n}\n\nPayment link code
\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[{"id":"c7075339-9041-4fc8-9e2b-87c5f59fb934","name":"Payment Link Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code"],"variable":[{"key":"code","value":"test","description":"Payment link code"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"9a23be88-7818-4737-9ddb-58f67ea13fe5"},{"key":"x-request-id","value":"63d11191-be8d-4249-ae17-9eb8511bc4d5"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"98"},{"key":"Date","value":"Mon, 17 Mar 2025 16:57:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"PLK-001\",\n \"message\": \"The payment link was not found\",\n \"shortMessage\": \"PaymentLinkNotFound\"\n}"},{"id":"749ace5c-2ebe-4893-a99c-ae430449e024","name":"Open Payment Link Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{THIRD_PARTY_PROXY_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."},{"key":"External-Connection","value":"accountName_currency_acquirer","description":"It is a required parameter to find account. It is recommended to follow the string pattern: accountName_currency_acquirer."}],"url":{"raw":"{{BASE_URL}}/proxy/v1/payment-links/:code","host":["{{BASE_URL}}"],"path":["proxy","v1","payment-links",":code"],"variable":[{"key":"code","value":"8E7FCA","description":"Payment link code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"logger-request-id","value":"7a8da426-fbb6-4f63-82fb-8db84c038da3"},{"key":"x-request-id","value":"2f22fb7e-25e4-4511-add8-032f97cdd178"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"618"},{"key":"accept-ranges","value":"bytes"},{"key":"Date","value":"Fri, 14 Mar 2025 20:35:21 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d03d8802-73ac-4dd5-82d2-88a7fde7ba79\",\n \"code\": \"8E7FCA\",\n \"description\": \"Purchase of product Y\",\n \"expiresIn\": 3600,\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"accountId\": \"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3\",\n \"region\": \"BR\",\n \"amount\": 0,\n \"currency\": \"BRL\",\n \"currencies\": [\n \"BRL\"\n ],\n \"paymentMethods\": [\n \"pix\",\n \"creditCard\"\n ],\n \"chosenPaymentMethod\": \"pix\",\n \"orderId\": null,\n \"transactionId\": null,\n \"data\": {\n \"pix\": {\n \"expiresIn\": 3600\n }\n },\n \"status\": \"pending\",\n \"notificationChannels\": [\n \"f7fd75de-fa50-46eb-82ec-c223acc2b549\",\n \"e76dd07a-46a3-4e9f-b251-4a8ddeaae37b\"\n ],\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\",\n \"origin\": \"Inovio\",\n \"createdAt\": \"2025-03-14T16:29:05.261Z\",\n \"updatedAt\": \"2025-03-14T16:29:05.261Z\"\n}"}],"_postman_id":"911e63d4-a786-495b-a98f-681a959ee6a5"}],"id":"9fd5a9e8-0869-4711-a664-4c92bf4e44ea","_postman_id":"9fd5a9e8-0869-4711-a664-4c92bf4e44ea","description":""},{"name":"Risk Tool","item":[{"name":"Risk Tool Validation","id":"05643ee9-f8b1-4975-95c2-00bef7f03a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"// PIX Request Example\n{\n \"amount\": 0.60,\n \"externalId\": \"279dc90b-9eef-4ad3-824c-1c070e72fa36\", //Optional\n \"expiresIn\": 7200,\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"documentType\": \"CPF\",\n \"name\": \"Name of payer\"\n },\n \"label\": \"transaction label\", //Optional\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/orders","description":"The Risk Tool is a comprehensive risk management solution that provides real-time validations for financial transactions, ensuring regulatory compliance and security in payment operations. The system integrates multiple validation providers and offers a unified API for different types of risk checks.
\nAvailable Risk Validations:
\nAge Validation - Age compliance verification (Min. 18 in Brazil)
\nLive Validation - Vital status confirmation
\nGovernment Restriction Validation - Official blocklist verification
\nRegional Coverage:
\nSupported Account Types:
\nPay In - Resource inflow
\nPay Out - Resource outflow
\nCurrently, risk validation only occurs for PIX, as it is the only payment method where the document number is mandatory, and it is through this number alone that risk validations can be performed.
\nSupplementary reference for the Credilink Risk Validation endpoint.
\nSuccessful validation results are stored in a Redis cache with a 30-day TTL (2,592,000 seconds). The cache key follows the pattern:
\nriskCheckResult:{documentNumber}:{providerName}:{validationType}\n\nIf all requested validations for a given document already exist in cache, no call to the Credilink API is made — the cached results are returned directly. If any single validation is missing from cache, a full Credilink API call is performed for all validations.
\nWhen a result is served from cache:
\nThe origin field in the validation object reads \"cached\" instead of \"provider\".
The providerReferenceId field is absent (it is not stored in cache).
The validation message includes the : cached: indicator in its text, for example, \"The transaction was rejected because it failed the following risk validation(s): cached: Live validation\".
Each individual validation within the response includes an origin field indicating the data source:
The providerReferenceId field (Credilink's codigo_consulta) is present only when origin is \"provider\" and the call was successful. Its presence confirms that a real query to Credilink was executed.
The final result of a validation request is determined by evaluating all individual validation results using the following priority (highest first):
\nWhen the Credilink API call fails (network error, timeout, invalid credentials, or invalid data), all validations in that call are marked as FAILED.
\nFAILED results are not cached — only successful results (POSITIVE or NEGATIVE) are written to Redis.
\nIn the transaction flow, a FAILED result does not block the transaction. It is treated as POSITIVE for flow-continuity purposes; only NEGATIVE results effectively block a transaction.
\nIt is a required parameter in the request, to allow access to the resource.
\n"},{"key":"External-Connection","value":"{{EXTERNAL_CONNECTION}}","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n"}],"body":{"mode":"raw","raw":"{\n \"capture\": true,\n \"amount\": 10,\n // \"information\": \"information\", // optional\n // \"externalId\": \"123456789\", // optional\n \"notificationUrl\": \"https://webhook.site/d06095ff-b17c-41c9-bba6-d236b320c8e7\",\n \"billing\": {\n \"firstName\": \"Dennis\",\n \"lastName\": \"Delarosa\",\n \"documentNumber\": \"01234567890\",\n \"address\": \"Rua Principal\",\n \"city\": \"São Paulo\",\n \"zip\": \"11222-100\",\n \"country\": \"US\",\n \"ipAddress\": \"1.1.1.1\",\n \"email\": \"johnlenon.silva@luby.com.br\",\n \"phoneNumber\": \"12133734253\"\n },\n \"debitCard\": {\n \"holderName\": \"Dennis Delarosa\",\n \"cardNumber\": \"\",\n \"cvv\": \"\",\n \"expMonth\": 6,\n \"expYear\": 2027,\n \"threadsPassThrough\": {\n \"mode\": \"frictionless\", // \"challenge\" | \"frictionless\" \n \"version\": \"2.1.0\", // \"2.1.0\" | \"2.2.0\",\n \"eci\": \"eci\",\n \"authenticationValue\": \"NDI0NjMxNTM1MzE1OTg3MjA2Mjc=\", // Authentication value (CAVV/AAV)\n \"dsTransactionId\": \"123456\",\n \"dsReferenceId\": \"ff13f6f9-9403-41b5-b5c3-7f77f975c20e\" // Optional\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/proxy/v1/create-order-debit-card","description":"The endpoint makes an HTTP POST request to create a new order using a debit card. The request body should include the amount, external ID (optional), billing information, debit card details. The debit card details should include the token, first six and last four digits, expiration month and year, and optionally wallet information and threads pass through details.
\nThe flow of this operation will depend on the payment processor and whether the capture field sent in the request is true. This operation can be processed synchronously or asynchronously
\ntruefalsethreadsPassThrough field is provided with 3ds data, the dsReferenceId field must be provided with the RequestID returned in the authentication process.capture (boolean): Indicates whether to capture the payment immediately.amount (number): The amount of the order.externalId (string, optional): An optional idempotency key.notificationUrl (string): URL for receiving notifications.billing (object): An object with different requirements according to acquirer. For more details, read the section below.debitCard.holderName(string): Debit card holder name.debitCard.cardNumber (string): Debit card full PAN.debitCard.cvv (string): Credit card security code.debitCard.expMonth (number): Expiration month of the credit card.debitCard.expYear (number): Expiration year of the credit card.debitCard.threadsPassThrough.version (enum(\"2.1.0\", \"2.2.0\")): Version of threads pass through.debitCard.threadsPassThrough.eci (string): ECI (Electronic Commerce Indicator).debitCard.threadsPassThrough.authenticationValue (string): Authentication value (CAVV/AAV).debitCard.threadsPassThrough.dsTransactionId (string): DS transaction id returned by the third 3DS service. This ID is usually returned as a UUID.debitCard.threadsPassThrough.dsReferenceId (string): DS reference id returned by the third 3DS service. This field works similarly to a traceId. It is returned in most cases and is used to track an authentication request.debitCard.threadsPassThrough.mode (enum(\"challenge\", \"frictionless\")): Method used in 3DS authentication. Possible values: \"challenge\" or \"frictionless\".notificationUrl (string): URL for receiving notifications.As stated above, billing properties can vary depending on acquirer. The table below contains the properties each acquirer supports
As stated above, debitCard.threadsPassThrough properties can vary depending on acquirer. The table below contains the properties each acquirer supports
Creating a payment is subject to undergoing a risk validation process. The transaction will only check risk validation if is provided the document number and if the documentNumber is a CPF.
\nRisk validation is an anti-fraud procedure performed to determine whether the payer is eligible for the payment transaction. Currently, we consider the following criteria:
\n200 Ok: The order already exists, you will see the data of the created order. For a new order you must check the externalId property, it works as an idepotency key and the field must be unique to create a new order. A new order is created if you do not provide the field either.201 Created: The order has been successfully created and the request has been processed by the processor, you will see the result in the response data.202 Accepted: The order request has been accepted and the request will be processed by the processor, you will see the result in the response data.cardBrand: mastercard, amex, visa, elocardType: multiple, credit, debit or debit_meal{\n \"type\": \"object\",\n \"properties\": {\n \"currency\": { \"type\": \"string\" },\n \"orderId\": { \"type\": \"string\" },\n \"paymentMethod\": { \"type\": \"string\" },\n \"status\": { \"type\": \"string\" },\n \"transactionFees\": { \"type\": \"array\" }\n \"cardType\": \"multiple\",\n \"cardBrand\": \"mastercard\"\n }\n}\n\nprocessorCode: It should return the error code from the acquirer when existsprocessorDetails: It should return the error reason/details from the acquirer when existsprocessorName: It should return the name of the acquirer responsible for the operationprocessorRaw: It should return the other details to help to debug failuresIt is a required parameter in the request, to allow access to the resource.
\n","type":"text"},{"key":"External-Connection","value":"{{EXTERNAL_CONNECTION}}","description":"It is a required parameter to find account. \nIt is recommended to follow the string pattern: accountName_currency_acquirer.
\n","type":"text"}],"url":"{{BASE_URL}}/proxy/v1/transactions/:transactionId","description":"This route is used to consult a transaction by passing the transaction ID as path parameter.
\n","urlObject":{"path":["proxy","v1","transactions",":transactionId"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"description":{"content":"ID of the transaction
\n","type":"text/plain"},"type":"any","value":"14ab187e-c609-49f5-b96a-0e23cbedd7d0","key":"transactionId"}]}},"response":[],"_postman_id":"3775faaf-0687-4bee-8e38-dcf88a5a6ddd"}],"id":"33515cf9-7a89-46b7-b882-169fd4ecb4ab","_postman_id":"33515cf9-7a89-46b7-b882-169fd4ecb4ab","description":""}],"id":"5b4672da-5b5b-49ba-84b0-819c971e6609","description":"The following endpoints is responsible for transactions management.
\nBelow are possible errors that may be returned during the creation of transactions. You could contact support for more details.
\nVelocity erros
\nlegend:
\ncountNumber = rules counter for the rule type
ex: TRV-001, NTR-005
maxValue = limit amount value to transaction
\ntransactionCounter = maximum number of transactions
\nperiodAmount = amount by period
\nformattedPeriod = period type configured in the rule (minute | hour | day)
\ndocumentNumber = number of document related in the transaction
\nThis table describes the error codes for authorization denied.
\n