We provide a diverse range of payment solutions aimed at empowering businesses, expediting transactions, and fostering growth. A standout feature in our portfolio is our merchant account and transaction management API. This manual presents a series of endpoints responsible for managing merchants' transactions. For inquiries or further information, please reach out to our support team at mail to: suporte@onlineips.net.br.
\nThe default environment for this documentation is sandbox, in order to use the production environment change the value of the BASE_URL variable. Below are the values of the base url of each environment:
Sandbox: https://api.sandbox.convrt.cc
\nProduction: https://api.convrt.cc
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Environments","slug":"environments"}],"owner":"33643847","collectionId":"f4aa579b-8983-4bde-9d42-d3a152b294b1","publishedId":"2sA2xnx9Vt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-31T12:00:47.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"11ecdb5e-e6d4-4cb4-84c8-e3d2f62111c8","exec":["var jsonData = JSON.parse(responseBody);","","postman.setEnvironmentVariable(\"API_CLIENT_TOKEN\", jsonData.token);"],"type":"text/javascript","packages":{}}}],"id":"1a2eba8a-179d-4f82-aa1c-01ff1188c568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"clientId\",\n \"clientSecret\": \"clientSecret\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/account/api-client-login","description":"This request is used to authenticate.
\n","urlObject":{"path":["v1","account","api-client-login"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ea7349f9-1dd8-401a-8b55-b8d30fc9c754","name":"Logged in successfully","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"587c417d-be30-461d-9344-443baf26d2d2\",\n \"clientSecret\": \"zh*r%Jg&EoY7wM%v_C_H9,:-KMwD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/account/api-client-login"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"282"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 21 Aug 2023 14:42:51 GMT"},{"key":"x-amzn-RequestId","value":"5f8e3bcc-b71f-4e0f-b69f-b7a2f420fc35"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"KA-seGE4oAMFYSA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64e377e9-3327a7f046ecec7658990b3e;Sampled=0;lineage=7bde04f9:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 836d15812518886911b1ae2be813f462.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C1"},{"key":"X-Amz-Cf-Id","value":"RO4vS7ig-IexoJW2epoRhOtUShKn_w5HjP3gMzy_ElcZQwS5TCQHkw=="}],"cookie":[],"responseTime":null,"body":"{\n \"expiresIn\": 1692632571613,\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjU4N2M0MTdkLWJlMzAtNDYxZC05MzQ0LTQ0M2JhZjI2ZDJkMiIsImFjY291bnRJZCI6IjZjYzVmMjcyLTMyODgtNDBmNy04NGFmLTQwOTA1NTY3NGFlMyIsImlhdCI6MTY5MjYzMjU3MTYxM30.SdGlQ8Wd2j7ytbGLv1eOMwot52llCzaEqsO601u1wq4\"\n}"},{"id":"9e449c97-94d8-446c-9484-34c4c8a8e0cd","name":"Invalid credentials error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"527c417d-be30-461d-9344-443baf26d2d2\",\n \"clientSecret\": \"zh*r%Jg&EoY7wM%v_C_H9,:-KMwD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/account/api-client-login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"109"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 21 Aug 2023 14:47:03 GMT"},{"key":"x-amzn-RequestId","value":"3be13ad7-0e95-44c4-85cf-7d80183a2500"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"KA_UQEs0oAMF9FA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64e378e7-541684fc58a011a94a7eb687;Sampled=0;lineage=7bde04f9:0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 6c1f5fbbdcc06a5ed4d317a0e3609f72.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C1"},{"key":"X-Amz-Cf-Id","value":"otU1OZH7SrXtAey9oEbnW0PHIZMx-SEBYC-BibFBBLY0lyTb3qqxwA=="}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"CCA-002\",\n \"message\": \"The credentials are invalid.\",\n \"shortMessage\": \"CustomerAccessInvalidCredentials\"\n}"},{"id":"ea67b17d-c66b-4334-b49c-35875aba1c47","name":"Invalid clientId error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"57c417d-be30-461d-9344-443baf26d2d2\", // This is an invalid UUID.\n \"clientSecret\": \"zh*r%Jg&EoY7wM%v_C_H9,:-KMwD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/account/api-client-login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"167"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 21 Aug 2023 14:51:47 GMT"},{"key":"x-amzn-RequestId","value":"3b8d6027-21f2-4d1a-807b-2c1a135bf552"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"KBAAlFiKoAMFxMQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64e37a03-6828693b5b34509a3e808eec;Sampled=0;lineage=7bde04f9:0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f92491812e422470607f365e923929b4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C1"},{"key":"X-Amz-Cf-Id","value":"kPRom_VuYu_PKIw4pFhcoqjZLtaHGmK25yypKyedZRh0rI-ZBNStHw=="}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"val-001\",\n \"message\": \"Validation Error\",\n \"shortMessage\": \"validationError\",\n \"details\": [\n {\n \"property\": \"clientId\",\n \"constraints\": {\n \"isUuid\": \"clientId must be a UUID\"\n }\n }\n ]\n}"}],"_postman_id":"1a2eba8a-179d-4f82-aa1c-01ff1188c568"}],"id":"b2788cd7-5c8a-4b34-b9bb-b8106e656918","description":"The following endpoint is responsible for auth management.
\n","_postman_id":"b2788cd7-5c8a-4b34-b9bb-b8106e656918"},{"name":"Transactions","item":[{"name":"PayIn","item":[{"name":"Sandbox","item":[{"name":"3Ds process (Sandbox)","id":"ec742a14-530b-456a-8bb1-fe06846b0730","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","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/charge/credit-card/:orderId/3ds?success=true","description":"This endpoint sends an HTTP GET request to retrieve the 3D Secure status for a credit card charge with a specific order ID.
\norderId (in the URL path): The ID of the order for which the 3D Secure status is being retrieved.success (query parameter): Indicates whether the 3D Secure process was successful.In case of a failed request, the server returns a 400 status with a JSON response containing the following fields:
\ncode: Error code indicating the type of error.message: A detailed error message.shortMessage: A short description of the error.This parameter refers to the simulation status which can be true or false to update the order status
\n","type":"text/plain"},"key":"success","value":"true"}],"variable":[{"id":"d5b35c7c-1723-4f80-af42-529febd7fd48","description":{"content":"This variable refers to a order identifier
\n","type":"text/plain"},"type":"any","value":"5e2b5d00-2d0f-4766-ac23-9e8cb42a47f3","key":"orderId"}]}},"response":[{"id":"7110dab5-a652-4ae8-8fef-a02f3c23d9f5","name":"Order not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/credit-card/:orderId/3ds?success=true","host":["{{BASE_URL}}"],"path":["v1","charge","credit-card",":orderId","3ds"],"query":[{"key":"success","value":"true","description":"This parameter refers to the simulation status which can be true or false to update the order status"}],"variable":[{"key":"orderId","value":"12c0b2a4-18b0-4316-8b3e-dae42f557e51","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"90"},{"key":"Date","value":"Thu, 01 Feb 2024 16:17:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-001\",\n \"message\": \"Order not found for given id\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"b2954a59-fae7-4cc8-b4b1-b5bbe1708392","name":"Oder status not allowed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/credit-card/:orderId/3ds?success=true","host":["{{BASE_URL}}"],"path":["v1","charge","credit-card",":orderId","3ds"],"query":[{"key":"success","value":"true","description":"This parameter refers to the simulation status which can be true or false to update the order status"}],"variable":[{"key":"orderId","value":"01e41e94-73a9-4d7e-a8d3-352a0222f090","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"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, 01 Feb 2024 16:14:36 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-003\",\n \"message\": \"Order status needs to be open\",\n \"shortMessage\": \"OrderIsNotOpen\"\n}"},{"id":"fc797cad-78ff-43d6-a19d-d4f3a1a8cd74","name":"Expired order","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/credit-card/:orderId/3ds?success=true","host":["{{BASE_URL}}"],"path":["v1","charge","credit-card",":orderId","3ds"],"query":[{"key":"success","value":"true","description":"This parameter refers to the simulation status which can be true or false to update the order status"}],"variable":[{"key":"orderId","value":"12c0b2a4-18b0-4316-8b3e-dae42f557e57","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"82"},{"key":"Date","value":"Thu, 01 Feb 2024 16:16:15 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-002\",\n \"message\": \"The order has expired\",\n \"shortMessage\": \"ExpiredOrder\"\n}"},{"id":"20598ebb-d0b8-4441-bb3f-d7c71ecf8583","name":"Validation error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/credit-card/:orderId/3ds?success=true","host":["{{BASE_URL}}"],"path":["v1","charge","credit-card",":orderId","3ds"],"query":[{"key":"success","value":"true","description":"This parameter refers to the simulation status which can be true or false to update the order status"}],"variable":[{"key":"orderId","value":"invalid","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"165"},{"key":"Date","value":"Thu, 01 Feb 2024 16:17:43 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}"}],"_postman_id":"ec742a14-530b-456a-8bb1-fe06846b0730"},{"name":"Pay Order (Sandbox)","id":"20445e13-2997-4a47-8ce3-ba5876f7d12d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","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/charge/:orderId/pay","description":"This endpoint is used to process a payment for a specific order identified by the orderId in the URL. The request should be a HTTP PUT request to the specified URL.
\nThe request body for this endpoint has an undefined type and was null in the last call. No specific parameters are required in the request body.
\nThere are 3 main errors this endpoint can have:
\nOrder not found for given id: If the orderId on the URL does not correspond to any existing order.
\nThe order has expired: If the order expiration time has already passed.
\nOrder status needs to be open: If trying to pay a order that is not with the open status.
\nvalue (boolean): Indicates whether the payment processing was successful. A value of true signifies a successful payment process.This variable refers to a order identifier
\n","type":"text/plain"},"type":"any","value":"9fc148e7-6ea8-4d5b-a746-280913e041a6","key":"orderId"}]}},"response":[{"id":"f0d7840e-31a7-4ad9-b702-17c0aa9138af","name":"Invalid order id","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"invalid","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"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 Sep 2023 18:55:11 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":"80ef4423-7c3b-4565-a850-51a6c5072418","name":"Order not found","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"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 Sep 2023 18:57:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-001\",\n \"message\": \"Order not found for given id\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"8e236f0b-dad7-42fb-8dea-a7536fdbfd68","name":"Order expired","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"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 Sep 2023 18:57:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-002\",\n \"message\": \"The order has expired\",\n \"shortMessage\": \"ExpiredOrder\"\n}"},{"id":"d1730696-09b8-4914-8f63-35011af20975","name":"Order status is not open","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"92"},{"key":"Date","value":"Fri, 01 Sep 2023 18:58:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-003\",\n \"message\": \"Order status needs to be open\",\n \"shortMessage\": \"OrderIsNotOpen\"\n}"},{"id":"e86cccf3-96ac-4e94-8104-6625098b7200","name":"Pay order failed","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"107"},{"key":"Date","value":"Fri, 01 Sep 2023 19:13:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-004\",\n \"message\": \"An error occurred while paying for the order\",\n \"shortMessage\": \"PayOrderFailed\"\n}"},{"id":"adbd76ab-0ded-4cfb-a988-51053e276021","name":"Update order status failed","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"121"},{"key":"Date","value":"Fri, 01 Sep 2023 19:14:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-005\",\n \"message\": \"An error occurred while updating the order status\",\n \"shortMessage\": \"UpdateOrderStatusFailed\"\n}"},{"id":"f1832835-8676-4a1b-8117-0b157a9369cc","name":"Send update order notification failed","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"131"},{"key":"Date","value":"Fri, 01 Sep 2023 19:15:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"NTS-001\",\n \"message\": \"An error has occurred trying to send the notification event.\",\n \"shortMessage\": \"SendNotificationFailed\"\n}"},{"id":"83205ced-1aec-46bb-99d7-03e1f81a29f6","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"26"},{"key":"Date","value":"Fri, 01 Sep 2023 19:22:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"20928e4d-0a54-49ad-a1fc-d7dd1ba52214","name":"Pay order successfully","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/charge/:orderId/pay","host":["{{BASE_URL}}"],"path":["v1","charge",":orderId","pay"],"variable":[{"key":"orderId","value":"51ca1900-ae4f-4011-8dd4-fd3a3ab83691","description":"This variable refers to a order identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"14"},{"key":"Date","value":"Fri, 01 Sep 2023 19:33:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": true\n}"}],"_postman_id":"20445e13-2997-4a47-8ce3-ba5876f7d12d"},{"name":"Update Transaction","id":"77e4e241-d570-4dd5-9c4e-2db26baa8193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"action\": \"pay\" // pay, fail, cancel, schedule\r\n // \"scheduleTo\": \"2026-02-12\" required for action \"schedule\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/charge/transactions/:transactionId","description":"This endpoint is used to simulate transaction events using the sandbox acquirer. mainly useful for the automatic pix workflow. The request should be a HTTP POST request to the specified URL.
\nThe request body for this endpoint is dynamic according to the simulated event. For now, there are 4 types of events that can be simulated: Payment, Failure, Cancellation and Schedule.
\nPayment simulates the payment event of an automatic pix scheduled payment. The request body should be a JSON object contaning a property action with value pay .
Failure simulates a a failure event in the payment of an automatic pix scheduled payment. The request body should be a JSON object contaning a property action with value fail .
Cancellation simulates a cancellation of an automatic pix scheduled payment by the payer. The request body should be a JSON object contaning a property action with value cancel .
Schedule simulates the event when an automatic pix payment is scheduled by the acquirer. The request body should be a JSON object contaning a property action with value schedule and a property scheduledTo with it's value being a date or datetime in ISO 8601.
This endpoint is NOT avaiable in production environment.
\n","urlObject":{"path":["v1","charge","transactions",":transactionId"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"description":{"content":"This variable refers to a transaction identifier
\n","type":"text/plain"},"type":"any","value":"9fc148e7-6ea8-4d5b-a746-280913e041a6","key":"transactionId"}]}},"response":[{"id":"3bf0b57d-4f41-43d4-b7a1-f210c90cc4de","name":"Order Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"action\": \"pay\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/charge/transactions/:transactionId","host":["{{BASE_URL}}"],"path":["v1","charge","transactions",":transactionId"],"variable":[{"key":"transactionId","value":"9fc148e7-6ea8-4d5b-a746-280913e041a6","description":"This variable refers to a transaction identifier"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SBO-001\",\n \"message\": \"Order not found for given id\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"98532b62-d521-473b-bd14-cbec3e1142e6","name":"Invalid transction id","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"action\": \"pay\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/charge/transactions/:transactionId","host":["{{BASE_URL}}"],"path":["v1","charge","transactions",":transactionId"],"variable":[{"key":"transactionId","value":"9fc148e7-6ea8-4d5b-a746-280913e041a6","description":"This variable refers to a transaction identifier"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": \"val-001\",\n \"message\": \"Validation Error\",\n \"shortMessage\": \"validationError\",\n \"details\": [\n {\n \"property\": \"transcationId\",\n \"constraints\": {\n \"isUuid\": \"transactionId must be a UUID\"\n }\n }\n ]\n}"},{"id":"17847be5-9fc5-4fcb-b008-1a21104d3e46","name":"Send notification failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"action\": \"pay\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/charge/transactions/:transactionId","host":["{{BASE_URL}}"],"path":["v1","charge","transactions",":transactionId"],"variable":[{"key":"transactionId","value":"9fc148e7-6ea8-4d5b-a746-280913e041a6","description":"This variable refers to a transaction identifier"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": \"NTS-001\",\n \"message\": \"An error has occurred trying to send the notification event.\",\n \"shortMessage\": \"SendNotificationFailed\"\n}"}],"_postman_id":"77e4e241-d570-4dd5-9c4e-2db26baa8193"}],"id":"9cc0c618-6a16-41fc-bc88-c47bcfbc78e8","description":"The following requests will not be available in production.
\n","_postman_id":"9cc0c618-6a16-41fc-bc88-c47bcfbc78e8"},{"name":"Credit card","item":[{"name":"Create Credit Card","id":"522f1bc9-78a7-467e-955a-11f2fd898458","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"}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\n \"information\": \"failed test\", // optional\n // \"externalId\": \"externalId\", // optional,\n \"capture\": true, // optional (default 'true')\n \"billing\": {\n \"firstName\": \"Bruce\",\n \"lastName\": \"Wayne\",\n \"documentNumber\": \"01234567890\",\n \"address\": \"Address\",\n \"city\": \"City\",\n \"zip\": \"55336890\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"ipAddress\": \"127.0.0.1\",\n \"email\": \"fake@mail.com\",\n \"phoneNumber\": \"12133734253\"\n },\n \"creditCard\": {\n \"holderName\": \"Holder Name\",\n \"cardNumber\": \"4417123456789113\",\n // \"cardNumber\": \"5495585825478838\",\n \"cvv\": \"123\",\n \"expMonth\": 12,\n \"expYear\": 2025,\n \"initiator\": \"CIT\", //Optional, \"CIT\" | \"MIT\" (default: \"CIT\")\n \"walletId\": \"86536b02-e519-4f40-8712-6bd8d5e33115\", // Optional\n \"walletName\": \"Bruce Wayne\", // Optional\n \"threadsPassThrough\": {\n \"mode\": \"challenge\", // \"challenge\" | \"frictionless\" \n \"version\": \"2.1.0\", // \"2.1.0\" | \"2.2.0\",\n \"eci\": \"eci\",\n \"authenticationValue\": \"123\", // Authentication value (CAVV/AAV)\n \"dsTransactionId\": \"123456\",\n \"dsReferenceId\": \"ff13f6f9-9403-41b5-b5c3-7f77f975c20e\" // Optional\n },\n \"installment\": 2,\n \"type\": \"standard\"\n }\n // \"currency\": \"BRL\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/credit-card","description":"This 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.
\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
\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 is R$1.70, the credit card transaction will be rejected, simulating a successful integration, but the acquirer did not accept the transaction and returning an error.
\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):
\namount (number): The amount of the order.
externalId (string, optional): An optional idempotency key.
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.cvv (string): Security code of the credit card.
creditCard.expMonth (number): Expiration month of the credit card.
creditCard.expYear (number): Expiration year of the credit card.
creditCard.walletId (string, optional): Wallet ID (optional).
creditCard.walletName (string, optional): Wallet name (optional).
creditCard.threadsPassThrough.version (string): Version of threads pass through.
creditCard.threadsPassThrough.eci (string): ECI (Electronic Commerce Indicator).
creditCard.threadsPassThrough.authenticationValue (string): Authentication value (CAVV/AAV).
creditCard.threadsPassThrough.dsTrnsactionId (string): DS transaction id returned by the third 3DS service
creditCard.threadsPassThrough.mode (string): 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.
As stated above, billing 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.
\nIf blocked by the blacklist validation, then the transaction is considered a scrub.
\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 \"scrub\": {\n \"isScrub\": true,\n \"blockedBy\": \"blacklist\",\n \"blockedIdentifierType\": [\"email\"],\n \"submittedToAcquirer\": false\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 idempotency 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.
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.
nextStep.type (string): Type of the next step.
nextStep.redirect.method (string): Method for redirection.
nextStep.redirect.url (string): URL for redirection.
nextStep.redirect.params (array): Parameters for redirection.
transactionFees (array): Array of transaction fees with details.
{\n \"currency\": \"\",\n \"orderId\": \"\",\n \"paymentMethod\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"nextStep\": {\n \"type\": \"\",\n \"redirect\": {\n \"method\": \"\",\n \"url\": \"\",\n \"params\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n \"transactionFees\": [\n {\n \"name\": \"\",\n \"value\": 0,\n }\n ]\n}\n\nIt is a required parameter in the request, to allow access to the resource.
\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\",\n \"creditCard\": { // OPTIONAL\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/credit-card/:firstOrderId/recurrence","description":"This endpoint makes an HTTP POST request to create a new order from 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.
\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 authorized after create it. If it's true, order will be created and authorized. If it's false, order only will be created. If capture prop is not sent, the default value is true
\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
\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 is R$1.70, the credit card transaction will be rejected, simulating a successful integration, but the acquirer did not accept the transaction and returning an error.
\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 greater than BRL 5.00, the credit card transaction is confirmed, and the status returns as authorized.
\nMethod: POST
\nEndpoint: https://api.dev.convrt.cc/v1/orders/credit-card/:firstOrderId/recurrence
\namount (number): The amount of the order.
externalId (string, optional): An optional idempotency key.
capture (boolean, optional): Indicates whether to capture the payment immediately.
initiator(string): 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.
As 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.
It is a required parameter in the request, to allow access to the resource.
\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\",\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/credit-card/:firstOrderId/recurrence","description":"This endpoint makes an HTTP POST request to create a new order from 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.
\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 authorized after create it. If it's true, order will be created and authorized. If it's false, order only will be created. If capture prop is not sent, the default value is true
\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
\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 is R$1.70, the credit card transaction will be rejected, simulating a successful integration, but the acquirer did not accept the transaction and returning an error.
\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 greater than BRL 5.00, the credit card transaction is confirmed, and the status returns as authorized.
\nMethod: POST
\nEndpoint: https://api.dev.convrt.cc/v1/orders/credit-card/:firstOrderId/recurrence
\namount (number): The amount of the order.
externalId (string, optional): An optional idempotency key.
capture (boolean, optional): Indicates whether to capture the payment immediately.
initiator(string): 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.
As 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.
It is a required parameter in the request, to allow access to the resource.
\n"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1\n // \"externalId\": \"externalId\" // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/:orderId/capture","description":"This endpoint allows you to capture the payment for a specific order.
\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
\nIf the amount is BRL 0.01, the credit card capture 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 capture transaction will be rejected, and the status will be returned as failed.
\nIf the amount is R$ 1,60, the credit card capture transaction will be rejected, simulating a successful integration, but the acquirer did not accept the transaction and returning an error.
\nif the amount is equal to BRL 5.50 the system will simulate a chargeback dispute, calling the callback API with a chargeback dispute type, the status returned will be success.
\nif the amount is equal to BRL 6.00 the system will simulate a chargeback received, calling the callback API with a chargeback type, the status returned will be success.
\nMethod: POST
Endpoint: {{BASE_URL}}/v1/orders/:orderId/capture
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.
{\n \"transactionId\": \"\",\n \"accountId\": \"\",\n \"merchantId\": \"\",\n \"externalId\": \"\",\n \"orderId\": \"\",\n \"category\": \"\",\n \"origin\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": 0,\n \"fee\": 0,\n \"balanceAfterTransaction\": 0,\n \"transactionData\": {\n \"vendor\": \"\",\n \"vendorId\": \"\",\n \"vendorAccountId\": \"\",\n \"vendorReferenceId\": \"\"\n },\n \"currency\": \"\",\n \"region\": \"\",\n \"payer\": {\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"name\": \"\"\n },\n \"eventName\": \"\",\n \"expectedAmount\": 0,\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"operationId\": null,\n \"information\": null,\n \"refundedAmount\": 0,\n \"notificationUrl\": null,\n \"receiver\": null,\n \"reservationData\": null,\n \"originalTransactionId\": null,\n \"transactionFees\": []\n}\n\nThis variable refers to a order identifier.
\n","type":"text/plain"},"type":"any","value":"6328c581-7137-4e73-b500-7f60809a3ccf","key":"orderId"}]}},"response":[{"id":"46f4b383-ddd3-40b3-997e-40a1649be4ca","name":"Captured successfully","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 7\n // \"externalId\": \"externalId\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":"aa4773c2-b997-4a32-ad08-5b4dc6739206","description":"This variable refers to a order identifier."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"1019"},{"key":"Date","value":"Mon, 26 Feb 2024 21:06:48 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\",\n \"accountId\": \"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3\",\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"externalId\": \"bcec2384-1f0a-4906-9d4b-d002d321a974\",\n \"orderId\": \"aa4773c2-b997-4a32-ad08-5b4dc6739206\",\n \"category\": \"creditCard\",\n \"origin\": \"MerchantConnection\",\n \"type\": \"credit\",\n \"status\": \"success\",\n \"amount\": 0,\n \"fee\": 0,\n \"balanceAfterTransaction\": 1001452.12,\n \"transactionData\": {\n \"vendor\": \"Sandbox\",\n \"vendorId\": \"fc920381-c3be-4e66-9347-08b3c22a870e\",\n \"vendorAccountId\": \"a1205c0d-c813-45f8-9748-7d2e84521731\",\n \"vendorReferenceId\": \"aa4773c2-b997-4a32-ad08-5b4dc6739206\"\n },\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"documentType\": \"CPF\",\n \"name\": \"name of payer\"\n },\n \"eventName\": \"CreditCardIn\",\n \"expectedAmount\": 7,\n \"createdAt\": \"2024-02-26T21:06:47.435Z\",\n \"updatedAt\": \"2024-02-26T21:06:47.435Z\",\n \"operationId\": null,\n \"information\": null,\n \"refundedAmount\": 0,\n \"notificationUrl\": null,\n \"receiver\": null,\n \"reservationData\": null,\n \"originalTransactionId\": null,\n \"transactionFees\": []\n}"},{"id":"f7b34204-257a-412c-b156-a9f0e4cdc3b1","name":"Order Not Found","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 7\n // \"externalId\": \"externalId\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":"aa4773c2-b997-4a32-ad08-5b4dc6739206","description":"This variable refers to a order identifier."}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"77"},{"key":"Date","value":"Mon, 26 Feb 2024 20:48:16 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-002\",\n \"shortMessage\": \"OrderNotFound\",\n \"message\": \"Order Not Found\"\n}"},{"id":"07dda920-2be9-4c0c-9814-98772b37dbbf","name":"Order Not Authorized","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 72\n // \"externalId\": \"externalId\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":"5665b2b3-a192-4c99-aef7-3cd67c810e4e","description":"This variable refers to a order identifier."}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"94"},{"key":"Date","value":"Tue, 27 Feb 2024 13:38:21 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-009\",\n \"shortMessage\": \"OrderNotIsAuthored\",\n \"message\": \"The order not is authorized\"\n}"},{"id":"b7705c68-6367-4d00-b2a9-3f3c1540bd3f","name":"Capture Finished","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 7\n // \"externalId\": \"externalId\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":"aa4773c2-b997-4a32-ad08-5b4dc6739206","description":"This variable refers to a order identifier."}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"137"},{"key":"Date","value":"Mon, 26 Feb 2024 21:09:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-009\",\n \"shortMessage\": \"CreditCardOrderAlreadyFinished\",\n \"message\": \"Capturing the credit card order has already been completed\"\n}"},{"id":"29f78db8-eb89-4eee-81a7-ec0ea608a75e","name":"Invalid amount","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 5\n // \"externalId\": \"externalId\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":"dc892b92-7442-414b-bc59-bb07c7b9e369","description":"This variable refers to a order identifier."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"146"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 05 Mar 2024 12:17:40 GMT"},{"key":"x-amzn-RequestId","value":"331e72c6-b790-412a-9b62-af8d276e1099"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"UJ8HPEGgoAMETnw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-65e70d61-7ee78aad6b1736550900c004;Parent=01839c2664f50625;Sampled=0;lineage=4711fe04:0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 490eeb62e13fcf01361413e801800d04.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FOR50-P4"},{"key":"X-Amz-Cf-Id","value":"8_Jo_cyiSyvHB91_Qc_dy20gskIc2ao1a_6nt4F8WsQDV37Pg4MGdw=="}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-011\",\n \"shortMessage\": \"RequestedValueGreaterThanAvailableAmount\",\n \"message\": \"The requested amount is greater than the available amount\"\n}"},{"id":"46aaee3d-ac36-4534-84ee-027c6674b908","name":"Capture not allowed","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 0.01\n // \"externalId\": \"externalId\" // optional\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId/capture","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId","capture"],"variable":[{"key":"orderId","value":"5665b2b3-a192-4c99-aef7-3cd67c810e4e","description":"This variable refers to a order identifier."}]}},"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":"153"},{"key":"Date","value":"Wed, 08 May 2024 19:34:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"AQS-019\",\n \"shortMessage\": \"captureNotAllowed\",\n \"message\": \"An error occurred during the capture request, for more information please contact support.\"\n}"}],"_postman_id":"43ed2b87-a568-4ffb-a31d-497fb28e4a6a"},{"name":"Cancel Order","id":"8ac0999b-9fd0-4653-abe7-ea6bd05ecfaf","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"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10 // 2 decimal places\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/:orderId/cancel","description":"This endpoint is used to cancel credit card payment for a specific order.
\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
\nDepending on the credit card service, it is not possible to cancel an order's amount and an error is returned.
\nDepending on the acquirer, only full cancellation is possible.
\nMethod: POST
\nEndpoint: {{BASE_URL}}/v1/orders/:orderId/cancel
\n{\n\"amount\": 10\n}\n\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":"8ac0999b-9fd0-4653-abe7-ea6bd05ecfaf"},{"name":"Validate Credit Card","id":"51e20e00-4128-4c9b-b54e-f9df55ac9ba8","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"}],"body":{"mode":"raw","raw":"{\r\n \"holderName\": \"Holder Name\",\r\n \"cardNumber\": \"4417123456789113\",\r\n \"cvv\": \"123\",\r\n \"expMonth\": 12,\r\n \"expYear\": 2025,\r\n \"currency\": \"USD\" // Optional, by default the first account currency will be selected\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/credit-card/validate","description":"This endpoint is used to validate a credit card order.
\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.
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}\n\nIt is a required parameter in the request, to allow access to the resource.
\n"}],"body":{"mode":"raw","raw":"{\n \"amount\": 0.1,\n // \"externalId\": \"18d25568-dded-47d9-b145-977d7d779fe8\", // OPTIONAL\n \"expiresIn\": 8640000,\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"documentType\": \"CPF\",\n \"name\": \"name of payer\"\n },\n \"label\": \"transaction label\" // OPTIONAL\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders","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 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.
\nYou can find the error message in the Reason field on the transaction details screen.
\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.
externalId (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, optional): 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.
\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.
\nIf blocked by the blacklist validation, then the transaction is considered a scrub.
\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 \"scrub\": {\n \"isScrub\": true,\n \"blockedBy\": \"blacklist\",\n \"blockedIdentifierType\": [\"email\"],\n \"submittedToAcquirer\": false\n }\n }\n }\n}\n\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.
\n{\n \"id\": \"\",\n \"status\": \"\",\n \"amount\": 0,\n \"emv\": \"\",\n \"image\": \"\",\n \"location\": \"\",\n \"transactionFees\": []\n}\n\nIt 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":"5f54e4e4-cfa7-4655-b66d-a58ccbcfac88"},{"name":"Create Automatic Pix Payment","id":"84984f63-6c99-46e4-9917-1f80348feb51","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":"","key":"orderId"}]}},"response":[{"id":"736ac892-0c34-41b3-8269-b979672f749b","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":"84984f63-6c99-46e4-9917-1f80348feb51"},{"name":"Cancel Automatic Pix Payment","id":"1af34126-3bfb-455e-9a8f-26ede5681a4f","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 charge.
\nThe cancellation will only be accepted if the charge 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":"3678aa1a-4f82-4092-abd7-116495dff443","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":"1af34126-3bfb-455e-9a8f-26ede5681a4f"}],"id":"4e12d29e-2bb2-4d18-9565-9018b5cc97c1","_postman_id":"4e12d29e-2bb2-4d18-9565-9018b5cc97c1","description":""},{"name":"Mexican payment","item":[{"name":"Create Pay In","id":"ec5ead75-ddda-49ed-bbb4-11323dd47057","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","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10.00,\n \"payer\": {\n \"documentNumber\": \"JOCA220402HBSSNL07\",\n \"documentType\": \"CURP\", //Allowed values: CURP\n \"name\": \"Fernanda\",\n \"email\": \"fernanda@mail.com\"\n },\n \"target\": \"spei\", // (Optional) Allowed values: spei, codi\n \"externalId\": \"externalId\" // (Optional)\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/orders/mexican-payment","description":"This endpoint is used to create a new mexican payment orders.
\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 url 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.
\namount (number, required): The amount of the order.
payer (object, required): The payer information.
documentNumber (string, required): The document number of the payer.
documentType (string, required): The type of document for the payer.
name (string, required): The name of the payer.
target (string, optional): The target flow that it will be used to create mexican payment order. Allowed values: \"spei\" or \"code\".
label (string, optional): An optional label for the transaction.
url (string): The url to pay order.
\namount (amount): The amount of orders.
\nstatus (string): The status of order.
\npaymentMethod (string): The payment method of the order.
\ntransactionFees (array): Array with transaction fees with details.
\n{\n \"url\": \"https://qt-sandbox.etpay.com/session/KK6AT48k2FVA8LCWPnckeQzY6oAkE7JT7kPZ9b4Sblc7ZISRYZGXog2PdFsWvWOK\",\n \"amount\": 1000,\n \"status\": \"open\",\n \"paymentMethod\": \"spei\",\n \"transactionFees\": [\n {\n \"name\": \"Fee 1519\",\n \"value\": 0\n },\n {\n \"name\": \"Fee Requested, Success \",\n \"value\": 0.01\n }\n ]\n}\n\nThis endpoint is used to create a new order.
\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 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.
\ntransferMethod (string, required): The payment method 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.
\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"}],"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}}/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
\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.
\nIt is a required parameter in the request, to allow access to the resource.
\n"}],"body":{"mode":"raw","raw":"{\n \"amount\": 94,\n // \"externalId\": 35373fc2-3dd5-4b71-9958-08bce971a2d2,\n \"payer\": {\n \"name\": \"name of payer\",\n \"email\": \"payer@mail.com\"\n },\n \"redirectUrl\": \"https://google.com\",\n \"label\": \"transaction label\" // Optional\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/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"}],"url":"{{BASE_URL}}/v1/orders","description":"This route is used to list orders
\n","urlObject":{"path":["v1","orders"],"host":["{{BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"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":"1"},{"disabled":true,"description":{"content":"This parameter refers to the current page of the listing
\n","type":"text/plain"},"key":"page","value":"6"},{"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-24T14:08:02.266Z"},{"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-01-24T15:08:02.266Z"}],"variable":[]}},"response":[{"id":"a70ba5c6-581b-441b-a26a-790795da5cde","name":"List orders successfully","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/orders?limit=1&page=1","host":["{{BASE_URL}}"],"path":["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":"ASC","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-24T14:08:02.266Z","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-01-24T15:08:02.266Z","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}]}},"status":"OK","code":200,"_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":"content-encoding","value":"gzip"},{"key":"Date","value":"Thu, 11 Apr 2024 13:42:57 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 \"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\": \"MerchantConnection\",\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":"5a60d18d-7579-4543-9f3f-d1887f1692da","name":"Validation error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/orders?limit=-1&page=-6&order=invalid&startDate=invalid&endDate=invalid","host":["{{BASE_URL}}"],"path":["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":"-6","description":"This parameter refers to the current page of the listing"},{"key":"order","value":"invalid","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."},{"key":"startDate","value":"invalid","description":"This parameter refers to the order creation date, records with a date greater than or equal to the one sent will be returned"},{"key":"endDate","value":"invalid","description":"This parameter refers to the order creation date, records with a date less than or equal to the one sent will be returned"}]}},"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":"507"},{"key":"Date","value":"Thu, 11 Apr 2024 13:44:41 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\": \"limit\",\n \"constraints\": {\n \"min\": \"limit must not be less than 1\"\n }\n },\n {\n \"property\": \"page\",\n \"constraints\": {\n \"min\": \"page must not be less than 1\"\n }\n },\n {\n \"property\": \"order\",\n \"constraints\": {\n \"isIn\": \"order must be one of the following values: ASC, DESC\"\n }\n },\n {\n \"property\": \"startDate\",\n \"constraints\": {\n \"isDate\": \"startDate must be a Date instance\"\n }\n },\n {\n \"property\": \"endDate\",\n \"constraints\": {\n \"isDate\": \"endDate must be a Date instance\"\n }\n }\n ]\n}"}],"_postman_id":"4cbc4e70-88bb-4e93-8a5e-3091b8083d23"},{"name":"Get Order","id":"87bd8dd6-e47d-4b0f-abec-fbb7e476de9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","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","description":"This endpoint makes an HTTP GET request to retrieve details of a specific order identified by the orderId parameter. The response contains information about the order, including its ID, account ID, external ID, status, amount, payment method data, payer details, creation and update timestamps, and transaction details.
\nThe response is in JSON format and includes the orderData object, ID, account ID, external ID, information, status, amount, payment method data such as expiresIn, emv, image, and location, payer details including document number and name, creation and update timestamps, and an array of transactions with details like transaction ID, account ID, merchant ID, external ID, order ID, operation ID, category, type, status, amount, refunded amount, fee, balance after transaction, notification URL, currency, region, payer details, reservation data, event name, original transaction ID, expected amount, creation and update timestamps, and transaction data.
\nExample response:
\n{\n \"id\": \"\",\n \"accountId\": \"\",\n \"externalId\": \"\",\n \"information\": null,\n \"status\": \"\",\n \"amount\": 0,\n \"qrCodeData\": {\n \"emv\": \"\",\n \"image\": \"\",\n \"location\": \"\"\n },\n \"orderData\": {},\n \"payer\": {\n \"documentNumber\": \"\",\n \"name\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"transaction\": {\n \"transactionId\": \"\",\n \"accountId\": \"\",\n \"externalId\": \"\",\n \"orderId\": \"\",\n \"information\": null,\n \"category\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": 0,\n \"fee\": 0,\n \"balanceAfterTransaction\": 0,\n \"receiver\": null,\n \"payer\": {\n \"key\": \"\"\n },\n \"eventName\": \"\",\n \"originalTransactionId\": null,\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}\n\nOrderId to be find
\n","type":"text/plain"},"type":"any","value":"f6597dc3-d610-4b28-a08e-8add393917be","key":"orderId"}]}},"response":[{"id":"7687c90e-c471-4bda-b5b2-571494ec30ea","name":"Get order successfully","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId"],"variable":[{"key":"orderId","value":"f6597dc3-d610-4b28-108e-8add393917be","description":"OrderId to be find"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin,accept-encoding"},{"key":"access-control-allow-credentials","value":"true"},{"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, 13 Sep 2023 14:57:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"orderData\": {},\n \"id\": \"793f41a2-db90-44d3-b5cc-13b67073ed41\",\n \"accountId\": \"0e9b2c69-db69-458c-9ad5-97b35bf63cc7\",\n \"externalId\": \"20349823094824335345343097345567\",\n \"information\": \"PayIn Creation\",\n \"capture\": null,\n \"origin\": \"MerchantConnection\",\n \"status\": \"open\",\n \"paymentMethod\": \"pix\",\n \"amount\": 21,\n \"paymentMethodData\": {\n \"expiresIn\": 100000000,\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,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAxMSURBVO3BQW4sQbLgQDKh+1+Z83bfVwEkqqSO7nEz+4e11hUe1lrXeFhrXeNhrXWNh7XWNR7WWtd4WGtd42GtdY2HtdY1HtZa13hYa13jYa11jYe11jUe1lrXeFhrXeNhrXWNHz6k8pcq3lCZKiaVqWJSeaPiROWkYlKZKiaVqeJEZap4Q2WqeENlqviEylQxqfylik88rLWu8bDWusbDWusaP3xZxTepnKhMFScqU8WkMlVMKlPFpDJVTBWTyn+SylQxqZyoTBXfpPJNFd+k8k0Pa61rPKy1rvGw1rrGD79M5Y2K31QxqbxRMamcqEwVJypTxSdUTipOKt5QmSpOVKaKqWJS+SaVNyp+08Na6xoPa61rPKy1rvHD/+cqJpU3Kk5U3qg4UZkqJpVPqHyi4qRiUvlExf+Sh7XWNR7WWtd4WGtd44f/chWTyhsqf0nlROUNlf9mFZPKVDFV/C97WGtd42GtdY2HtdY1fvhlFTdReUNlqnij4kRlqphUpoo3VE5Upoo3VE5UpopJ5URlqvimips8rLWu8bDWusbDWusaP3yZyl9SmSomlaliUpkqJpUTlaliUpkqvkllqjipmFROVKaK31QxqZyoTBUnKjd7WGtd42GtdY2HtdY17B/+i6mcVLyh8k0Vk8onKt5Q+aaKSeWkYlKZKj6hMlX8N3tYa13jYa11jYe11jXsHz6gMlV8k8pUMalMFd+kclIxqUwVb6j8poo3VE4qJpWTiknljYpJ5Y2KE5U3Kr7pYa11jYe11jUe1lrX+OHLVN6omFSmikllqnhDZao4qfgmlU9UvKHym1SmiknlpGJSOVGZKiaVqeKNikllqvhND2utazysta7xsNa6xg8fqphUpopJ5Q2VqWJSeaPiDZWpYlKZKiaVqWJSOamYVKaKSeVEZaqYVKaKSWWq+ITKVDGpnKhMFZPKVPFNKlPFJx7WWtd4WGtd42GtdY0ffpnKGxVvVKz/U3GiMqlMFScVb1ScVJxUnKhMKicqb1T8pYe11jUe1lrXeFhrXeOHD6m8UXGi8kbFicpUMamcVEwqJyrfpDJVTCrfpHJSMan8popJZao4UZkqJpWp4kTlNz2sta7xsNa6xsNa6xo/fFnFicpJxSdUpopJ5Q2VqeJEZao4qfhNFZPKScWk8kbFGyrfpPIJlZOK3/Sw1rrGw1rrGg9rrWv88MtUTipOVKaKN1Q+UXGicqJyUvGGyknFpDJVnKhMFScVk8obFScqU8VJxYnKGxUnKlPFJx7WWtd4WGtd42GtdQ37hz+kMlVMKlPFpHJSMalMFScq31RxojJVTConFScqb1RMKm9UTCpvVJyoTBUnKicVk8obFd/0sNa6xsNa6xoPa61r2D98QOWbKiaVqWJSmSpOVN6omFROKiaVqeITKicVk8pJxaRyUvFNKlPFpPKJijdUpoq/9LDWusbDWusaD2uta9g/fJHKVDGpvFExqUwVk8pU8U0qJxWTyhsVJyrfVHGiclLxhspJxYnKVHGiMlV8k8pU8YmHtdY1HtZa13hYa13D/uEXqUwVk8obFZPKScWkMlWcqJxUTCpTxaQyVZyoTBWTylQxqbxRMam8UTGpfFPFpHJScaJyUvGXHtZa13hYa13jYa11DfuHD6hMFW+oTBX/SSpvVJyoTBWTylRxojJVvKEyVUwqJxWTyhsVn1CZKiaVb6r4Sw9rrWs8rLWu8bDWusYPH6qYVKaKT6h8U8UbFZ+o+ITKVDGpnFRMFZPKVDGpTCpTxYnKicpUMalMFZPKVDGpnFRMKpPKScU3Pay1rvGw1rrGw1rrGj98WcWJyhsVk8pU8U0Vb6hMFZPKX6qYVKaKT1ScqLxR8U0q31Txlx7WWtd4WGtd42GtdQ37hw+onFScqHxTxaQyVZyovFHxCZWpYlL5popvUpkqJpWp4kTlP6niROWk4hMPa61rPKy1rvGw1rrGD19W8YmKN1TeUDmp+CaVqWKqeKPiDZUTlTcqTlSmijcqTlROKt5Q+UTFNz2sta7xsNa6xsNa6xo/fKhiUvkmlanijYo3VE4qJpU3VKaKSeUNlaniROU3VbyhMlV8k8pU8YmK3/Sw1rrGw1rrGg9rrWv88GUVk8pUMamcVPwnVUwqv6liUjmpeKPiDZVJ5RMqU8UbFZPKScUbKlPFpDJVfNPDWusaD2utazysta5h//ABlZOKE5XfVDGpTBWfUJkqvknlmyomlZOKT6hMFZPKVDGpTBWTyjdVvKEyVXziYa11jYe11jUe1lrXsH/4IpWpYlKZKj6hMlVMKicVb6j8pooTlW+qmFTeqJhUpoo3VN6oOFE5qZhUPlHxiYe11jUe1lrXeFhrXeOHD6lMFScVb6hMFVPFScWk8obKVHGiMlW8ofKJihOVk4pJ5TepnFR8omJSmVTeqPhND2utazysta7xsNa6xg9fpvJGxaQyVZyonFS8oXKiMlVMFZPKJypOVCaVk4pJ5Zsq/pLKVPGJihOVqeKbHtZa13hYa13jYa11jR++rOJEZVI5UZkqTiomlaliUpkqJpWpYlKZKqaKSWWqmFQ+UTGpTCqfqJhUvqniROWbKiaVk4pJZar4xMNa6xoPa61rPKy1rmH/8EUqU8UbKlPFpDJVTCrfVHGiMlVMKt9UMalMFZPKVHGiMlW8oXJSMal8U8UnVN6o+KaHtdY1HtZa13hYa13jhw+pTBWTyknFVDGpfKJiUpkqJpVJZao4UZkqJpWp4kTlExUnKlPFiconVKaKE5U3VKaKE5U3Kn7Tw1rrGg9rrWs8rLWuYf/wi1SmiknlpOI3qXxTxaRyUjGp/KaKE5Wp4g2VqeINlanim1ROKiaVNyo+8bDWusbDWusaD2uta/zwIZWp4kRlqjhROamYVN6omFSmijdUpooTlTcqTlSmihOVqWJS+SaVqWKqOFH5poqTikllqvimh7XWNR7WWtd4WGtd44cPVUwqJxWTylQxVUwqk8pUMalMFZPKVPGGylQxqUwVU8VvUpkqpoo3KiaVqeIvVUwqU8WkcqIyVUwVk8pU8YmHtdY1HtZa13hYa13jh19W8YbKScWk8omKE5WpYqqYVE5UpooTlZOKk4oTlZOKN1SmihOVqWJSOVGZKn6Tym96WGtd42GtdY2HtdY17B8+oDJVnKhMFZPKVPGGylQxqZxUfJPKVPEJlZOKSWWqeENlqphUTiq+SWWqmFTeqJhUpoq/9LDWusbDWusaD2uta/zwoYpJZaqYKt5QmSomlaliUjmpOFGZKk5UpopJ5aTiEyonKm9UTCpTxaQyqUwVk8pfqviEyknFJx7WWtd4WGtd42GtdQ37hy9SeaPiDZVPVJyoTBWTylRxojJVnKicVLyhMlW8oXJScaJyUjGpTBWTyknFicpJxaQyVUwqU8UnHtZa13hYa13jYa11jR8+pPJGxRsqU8UbKpPKVHGiMlV8k8obKp9QmSomlZOKE5Wp4kTlm1R+k8pvelhrXeNhrXWNh7XWNewf/oupfKJiUjmpOFGZKiaVqWJSOal4Q2WqmFSmiknljYoTlZOKN1SmijdUPlHxTQ9rrWs8rLWu8bDWusYPH1L5SxVTxYnKVHFSMal8U8Wk8gmVqeJE5URlqjhR+Usqb6hMFScVk8qJylTxiYe11jUe1lrXeFhrXeOHL6v4JpU3VD6hcqJyUnGiclIxqZxUvFExqZyoTBUnKm9U/KaKN1Smir/0sNa6xsNa6xoPa61r/PDLVN6o+EsqU8Wk8gmVk4o3VD6hMlWcqEwqU8WkMlWcqEwVk8obKt+kMlVMKlPFJx7WWtd4WGtd42GtdY0f/sdUTCpvqHxCZao4UTmpmFSmikllqnhD5aRiUjlRmSo+UTGpnFR8QmVS+U0Pa61rPKy1rvGw1rrGD+uo4kTlROWk4kRlqphUpopJ5ZtUpor/pIo3VKaKSWWqmFR+08Na6xoPa61rPKy1rvHDL6v4SyonKm+ovFHxTRUnFZPKGxUnKt+k8kbFGyrfpDJVTCrf9LDWusbDWusaD2uta/zwZSp/SWWqmFROKiaVNypOVN6oeEPlEypTxRsqU8Wk8gmVqWJSmSr+mz2sta7xsNa6xsNa6xr2D2utKzysta7xsNa6xsNa6xoPa61rPKy1rvGw1rrGw1rrGg9rrWs8rLWu8bDWusbDWusaD2utazysta7xsNa6xsNa6xr/D1oYmkUzq3ObAAAAAElFTkSuQmCC\",\n \"location\": \"https://api.gatewaypix.onlineips.dev.finfy.com.br/v1/orders/793f41a2-db90-44d3-b5cc-13b67073ed41\"\n },\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"name\": \"name of payer\"\n },\n \"createdAt\": \"2023-10-09T15:05:27.457Z\",\n \"updatedAt\": \"2023-10-09T15:05:27.457Z\",\n \"transactions\": [\n {\n \"transactionId\": \"0948821e-fb24-4100-af63-f1d6755b0499\",\n \"accountId\": \"0e9b2c69-db69-458c-9ad5-97b35bf63cc7\",\n \"merchantId\": \"e303f002-3819-4c64-afd6-2bab5b09c51f\",\n \"externalId\": \"20349823094824335345343097345567\",\n \"orderId\": \"793f41a2-db90-44d3-b5cc-13b67073ed41\",\n \"operationId\": null,\n \"information\": \"PayIn Creation\",\n \"category\": \"pix\",\n \"origin\": \"MerchantConnection\",\n \"type\": \"credit\",\n \"status\": \"pending\",\n \"amount\": 0,\n \"refundedAmount\": 0,\n \"fee\": -0.42,\n \"balanceAfterTransaction\": 1002451.25,\n \"notificationUrl\": \"\",\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"name\": \"name of payer\"\n },\n \"reservationData\": null,\n \"eventName\": \"PixIn\",\n \"originalTransactionId\": null,\n \"expectedAmount\": 21,\n \"createdAt\": \"2023-10-09T15:05:27.893Z\",\n \"updatedAt\": \"2023-10-09T15:05:27.893Z\",\n \"transactionData\": {}\n },\n {\n \"transactionId\": \"0948821e-fb24-4100-af63-f1d6755b0497\",\n \"accountId\": \"0e9b2c69-db69-458c-9ad5-97b35bf63cc7\",\n \"merchantId\": \"e303f002-3819-4c64-afd6-2bab5b09c51f\",\n \"externalId\": \"20349823094824335345343097345567a\",\n \"orderId\": \"793f41a2-db90-44d3-b5cc-13b67073ed41\",\n \"operationId\": null,\n \"information\": \"PayIn Creation\",\n \"category\": \"pix\",\n \"origin\": \"MerchantConnection\",\n \"type\": \"credit\",\n \"status\": \"pending\",\n \"amount\": 0,\n \"refundedAmount\": 0,\n \"fee\": -0.42,\n \"balanceAfterTransaction\": 1002451.25,\n \"notificationUrl\": \"https://www.example.com/\",\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"payer\": {\n \"documentNumber\": \"01234567890\",\n \"name\": \"name of payer\"\n },\n \"reservationData\": null,\n \"eventName\": \"PixIn\",\n \"originalTransactionId\": null,\n \"expectedAmount\": 21,\n \"createdAt\": \"2023-10-09T15:05:27.893Z\",\n \"updatedAt\": \"2023-10-09T15:05:27.893Z\",\n \"transactionData\": {}\n }\n ]\n}"},{"id":"d8eba2c5-5e16-4e6b-b55c-543da297792e","name":"Validation error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId"],"variable":[{"key":"orderId","value":"f6597dc3-d610-4b28-a08e-8add393917be","description":"OrderId to be find"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"214"},{"key":"Date","value":"Wed, 13 Sep 2023 14:56:14 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\": \"accountId\",\n \"constraints\": {\n \"isUuid\": \"accountId must be a UUID\",\n \"isNotEmpty\": \"accountId should not be empty\"\n }\n }\n ]\n}"},{"id":"0a1a67e2-366a-49d4-a41c-a612c5688321","name":"Order not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId"],"variable":[{"key":"orderId","value":"f6597dc3-d610-4b28-108e-8add393917be","description":"OrderId to be find"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"77"},{"key":"Date","value":"Wed, 13 Sep 2023 19:14:49 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"IAT-002\",\n \"message\": \"Order Not Found\",\n \"shortMessage\": \"OrderNotFound\"\n}"},{"id":"e624bc2c-1248-4400-9325-3f73aab71180","name":"Get order with recurrence","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/orders/:orderId","host":["{{BASE_URL}}"],"path":["v1","orders",":orderId"],"variable":[{"key":"orderId","value":"5f4aa5d8-d64e-45ae-8db8-ff147c2e376c","description":"OrderId to be find"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"3024"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 08 Dec 2025 19:08:21 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-69372224-22fdce13141555157c011ee0;Parent=0848c39c5e0b5252;Sampled=0;Lineage=1:9b60d56b:0"},{"key":"x-amzn-RequestId","value":"7d080276-b49a-407c-b460-104bfc5b22c2"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-request-id","value":"3c13b4d7-3cd4-4edc-ae19-d2227cbfbff3"},{"key":"x-amz-apigw-id","value":"VSJFzH_ToAMEhcA="},{"key":"logger-request-id","value":"bd93aed6-f2cd-433c-8fc8-e5122224c5f9"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 4e4bbd48efc1c54b445708e694ecba8e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FOR50-P2"},{"key":"X-Amz-Cf-Id","value":"KzgU1IyKZVYDTlkyAsXHJ2_jH9WN5v6H3hBObCksoqKvBLT3LsLQfw=="}],"cookie":[],"responseTime":null,"body":"{\n \"orderData\": {},\n \"id\": \"5f4aa5d8-d64e-45ae-8db8-ff147c2e376c\",\n \"accountId\": \"07738817-de32-4ed8-a693-25f6cb293659\",\n \"externalId\": null,\n \"information\": null,\n \"capture\": null,\n \"origin\": \"MerchantConnection\",\n \"status\": \"open\",\n \"paymentMethod\": \"pix\",\n \"amount\": 0,\n \"currency\": \"BRL\",\n \"paymentMethodData\": {\n \"recurrence\": {\n \"immediate\": false,\n \"type\": \"monthly\",\n \"startDate\": \"2025-12-09\",\n \"endDate\": \"2026-09-15\",\n \"amount\": {\n \"value\": 150000,\n \"maxValue\": 1000000,\n \"minValue\": 50000,\n \"type\": \"variable\"\n },\n \"title\": \"Assinatura Plus\"\n },\n \"emv\": \"00020101021226180014BR.GOV.BCB.PIX5204000053039865802BR5905EFISA6008SAOPAULO62070503***80890014BR.GOV.BCB.PIX2567qrcodespix-h.sejaefi.com.br/v2/rec/8d54bb827ee04e9fae0bb9708cc21f2963045232\",\n \"image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAwfSURBVO3BQQ7c2JLAQFKo+1+Z42WuHiCoytbvyQj7g7XWK1ystV7jYq31Ghdrrde4WGu9xsVa6zUu1lqvcbHWeo2LtdZrXKy1XuNirfUaF2ut17hYa73GxVrrNS7WWq9xsdZ6jQ8PqfxNFXeoTBWTylQxqZxUnKicVDyhclIxqUwVJypPVNyhMlWcqEwVk8rfVPHExVrrNS7WWq9xsdZ6jQ9fVvFNKneoPKFyUnGiMlVMKr9UcYfKScUTKlPFpHKi8k0V36TyTRdrrde4WGu9xsVa6zU+/JjKHRV3qNyhMlVMKneoTBWTylRxh8pUcaIyVUwVk8oTKlPFVHFSMalMFZPKN6ncUfFLF2ut17hYa73GxVrrNT78x1VMKpPKVDGp3KHyhMpUMalMFZPKicpUcaJyUnGHyknFHRX/JRdrrde4WGu9xsVa6zU+/MdU3FFxUnFHxYnKHSonKicqJypTxR0qJxXfVPFfdrHWeo2LtdZrXKy1XuPDj1X8TSonFZPKScUTKlPFpHJHxR0qU8WJyhMVJxWTyqRyUvFNFW9ysdZ6jYu11mtcrLVe48OXqfxLFZPKHRWTylTxSxWTyonKVHGHylQxqUwVk8qJylRxUjGpnKhMFScqb3ax1nqNi7XWa1ystV7jw0MV/59VnFRMKt9UcYfKHRWTylQxqZyoTBV3qEwVJxX/Sy7WWq9xsdZ6jYu11mvYHzygMlVMKt9UcYfKVDGpfFPFHSp/U8UdKlPFicpU8U0qJxWTyjdV/NLFWus1LtZar3Gx1noN+4O/SGWqmFSmihOVqeJE5Y6KJ1ROKiaVqeKXVKaKJ1SmikllqvgllZOKSWWqOFGZKp64WGu9xsVa6zUu1lqvYX/wRSq/VHGickfFicpU8TepnFScqNxR8SYqU8WJylQxqUwVJypTxS9drLVe42Kt9RoXa63XsD/4IpWTin9JZaqYVP6mikllqnhCZaqYVE4qJpWp4g6VqeJE5Y6KSeWOijtUpoonLtZar3Gx1nqNi7XWa3x4SOWk4gmVOyq+qWJSmSomlaliUrlD5Y6KE5U7VKaKSWWqOKm4o2JS+aaKSeWOim+6WGu9xsVa6zUu1lqv8eEvU5kqTiomlROVk4onKiaVqWJSmSruqJhU7qg4UZkqJpWTijtUTipOKk5U7lC5o2JSmSqeuFhrvcbFWus1LtZar/HhoYoTlROVOypOVKaKb1KZKu5QmSqmim9SmSruqLhD5Y6KE5Wp4omKE5Wp4m+6WGu9xsVa6zUu1lqv8eEfq5hUpooTlaniDpWp4qTiiYoTlaliqrijYlK5Q2WqmFTuqDhRmSpOVO5QmSre5GKt9RoXa63XuFhrvcaHh1SmijtUTlROKiaVk4pvUjmpmFROKu5QmSomlZOKk4pJZaq4Q+WkYlKZKk4qJpUTlaliUpkqfulirfUaF2ut17hYa72G/cEDKlPFicpU8YTKVHGHyknFpDJVfJPKVDGpnFR8k8oTFXeoTBUnKndUTConFZPKVPFNF2ut17hYa73GxVrrNT48VHFHxaQyVUwqJxW/pDJVnKhMFZPKVPFExYnKExVPqEwVk8pUMamcVNyhclIxqUwVk8pU8cTFWus1LtZar3Gx1nqNDw+pnFQ8UTGpTConFZPKVHGiMqlMFd9UMamcqNxRMalMFZPKVDGpnFScVJxUTCp3qJxUTCpTxUnFN12stV7jYq31Ghdrrdf48GMqU8VUcaJyR8VJxaQyVUwVJypPqNxRMalMFXdU3KEyVZyo3FHxSxV3qEwVk8pU8cTFWus1LtZar3Gx1nqND19WMamcqEwVU8WJyqQyVZxUnKicVDxRcaIyqUwVT6icVEwqk8pUcVJxojJV3KFyojJVnFScVHzTxVrrNS7WWq9xsdZ6jQ9fpvKEyhMVk8odFVPFpDKpTBWTyi+p3FFxUjGpTBX/UsWk8oTKHSonFU9crLVe42Kt9RoXa63X+PBQxaRyonJScYfKpHJScYfKVDGp3FHxRMUdKn+TylTxhModFXeo3FHxSxdrrde4WGu9xsVa6zU+/FjFpHKHylRxR8UdKlPFN6lMFU+oTBX/UsUdKicVk8odKlPFN6lMFU9crLVe42Kt9RoXa63X+PCQyonKExVPqNxRMamcVNxRcaJyR8UTFScVv1TxSxV3VEwqf9PFWus1LtZar3Gx1nqNDw9VPKEyqTxRcaIyVfxSxYnKHSpvpnJSMamcVEwVk8qk8ksVk8o3Xay1XuNirfUaF2ut1/jwkMpUMalMFScVd6jcUXGiMlX8TRWTyknFicqJyknFicpUcaIyVUwqk8pUMVXcoTJVnFRMKlPFN12stV7jYq31GhdrrdewP/gilX+pYlI5qThReaLiCZWpYlKZKv4llTsqTlTuqJhUpopJ5Y6KSWWqeOJirfUaF2ut17hYa73Ghy+rOFE5qThRuaNiUplUpoqpYlK5Q+VfUpkqTlROKiaVqeIJlaliUnlCZaqYVKaKv+lirfUaF2ut17hYa73Gh4dUTipOKk5UpooTlTsqfqniRGWquKPipGJSOak4UZkqJpWTijtUTip+SWWq+KWLtdZrXKy1XuNirfUaH76sYlI5UTmpOFE5qThRmSpOKu5QeUJlqphUTiqeUJkqJpWp4omKJ1SmiknljopJ5Zcu1lqvcbHWeo2LtdZrfHioYlK5o+JEZar4popJ5X9JxaRyR8WkcqIyVZyoPFExqUwVT6hMFZPK33Sx1nqNi7XWa1ystV7jw5dVTCpPVEwqU8WkMqn8UsWkclJxR8WkcofKN1WcqEwVJyrfVDGpnFScVPxNF2ut17hYa73GxVrrNT48pDJVfJPKicpUcaJyR8WJyjepnFScqDxRcYfKVDGpTBUnFZPKVDGpTBVTxaRyojJVTConFU9crLVe42Kt9RoXa63X+PBlKk+oTBWTyhMVk8qJylRxUnGiMlVMFXeoTBWTyonKVPFNFScVk8pU8YTKN1X80sVa6zUu1lqvcbHWeo0PX1YxqUwVk8qJylQxqUwqU8UTFU+oTBXfVDGp3FFxonJScaLyhModKlPFL6lMFU9crLVe42Kt9RoXa63X+PAyFScq31QxqUwqU8VUcYfKVDGpTBWTyjepTBUnFZPKL1XcofJLKlPFN12stV7jYq31Ghdrrdf48FDFpDJVnFRMKr+kclJxojJVTCpTxS9VTCpTxaQyVdyhclIxqTyhMlVMKlPFicpU8YTKVPHExVrrNS7WWq9xsdZ6jQ8/pnJSMVWcqEwVk8pJxRMVk8odKlPFL6lMFScqU8WJyqRyUjGpTBW/VHFS8S9drLVe42Kt9RoXa63XsD94QOWOijtUvqniDpWp4kRlqjhR+ZcqvkllqphUpopJ5c0qJpWp4omLtdZrXKy1XuNirfUaHx6q+KWKE5U7VE4qnqiYVKaKJyruUJkqTlSmihOVJ1Smiknljoo7VKaKOyq+6WKt9RoXa63XuFhrvYb9wQMqf1PFicodFU+oTBXfpDJVTCpTxaQyVTyh8kTFpPJNFZPKVDGpnFT8TRdrrde4WGu9xsVa6zU+fFnFN6mcqEwVk8o3qUwVk8pUcYfKHRV3qJxUTConFZPKExUnKndU3FFxonJS8cTFWus1LtZar3Gx1nqNDz+mckfFN1VMKk9UTConKicVU8WkMqn8TRUnKlPFHRWTyhMqT6j8Sxdrrde4WGu9xsVa6zU+/MeoTBUnKlPFpDJVTBWTyknFHRUnKlPFicpUMamcVJyoTBVPVEwqJxUnKicVd6h808Va6zUu1lqvcbHWeo0P/zEVk8odKlPFpDJVTBWTyqQyVUwqJxV/U8WkMlVMKpPKVDGpTBWTylRxonJScYfKVPFLF2ut17hYa73GxVrrNT78WMUvVUwqU8WJyonKHSonFXdUTCp3qEwVd6icqJxUTCpTxaQyVUwqU8UTKlPFVDGp/NLFWus1LtZar3Gx1nqND1+m8jepfFPFExV3qEwVJxWTyqRyojJVTBVPqJxUTCp3VNxRcYfKScWk8k0Xa63XuFhrvcbFWus17A/WWq9wsdZ6jYu11mtcrLVe42Kt9RoXa63XuFhrvcbFWus1LtZar3Gx1nqNi7XWa1ystV7jYq31Ghdrrde4WGu9xsVa6zX+D5qsmPUWrUFYAAAAAElFTkSuQmCC\",\n \"location\": \"https://qrcode-pix.dev.convrt.cc?qrc=5f4aa5d8-d64e-45ae-8db8-ff147c2e376c\"\n },\n \"payer\": {\n \"documentNumber\": \"19815209027\",\n \"documentType\": \"CPF\",\n \"name\": \"Marcelo Afonso\"\n },\n \"notificationUrl\": null,\n \"createdAt\": \"2025-12-08T12:41:35.765Z\",\n \"updatedAt\": \"2025-12-08T12:41:35.765Z\",\n \"merchantId\": \"f5066717-60b7-4056-8992-3a9b9a153cf7\",\n \"region\": \"BR\",\n \"transactions\": [\n {\n \"transactionId\": \"77efc27c-c5ba-430d-9217-bfd33aef08a5\",\n \"accountId\": \"07738817-de32-4ed8-a693-25f6cb293659\",\n \"merchantId\": \"f5066717-60b7-4056-8992-3a9b9a153cf7\",\n \"externalId\": null,\n \"orderId\": \"5f4aa5d8-d64e-45ae-8db8-ff147c2e376c\",\n \"operationId\": null,\n \"information\": null,\n \"category\": \"automaticContract\",\n \"origin\": \"MerchantConnection\",\n \"type\": \"credit\",\n \"status\": \"pending\",\n \"amount\": 0,\n \"refundedAmount\": 0,\n \"fee\": 0,\n \"transactionData\": {\n \"isRefundable\": true,\n \"reconciliation\": {\n \"id\": \"RN0908935620251208ecadb5114a2\",\n \"loc\": 16\n }\n },\n \"notificationUrl\": null,\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"payer\": {\n \"documentNumber\": \"19815209027\",\n \"documentType\": \"CPF\",\n \"name\": \"Marcelo Afonso\"\n },\n \"reservationData\": null,\n \"eventName\": \"PixInAutomaticContract\",\n \"originalTransactionId\": null,\n \"expectedAmount\": 0,\n \"paymentMethod\": \"pix\",\n \"createdAt\": \"2025-12-08T12:41:42.486Z\",\n \"updatedAt\": \"2025-12-08T12:41:42.486Z\"\n }\n ]\n}"}],"_postman_id":"87bd8dd6-e47d-4b0f-abec-fbb7e476de9c"},{"name":"Create Refund","id":"1ba81f54-f5b4-44a8-b113-c07359ffe684","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"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"}],"body":{"mode":"formdata","formdata":[{"key":"attachment","description":"This field refers to operation attachment
\n","type":"file","src":"/Users/armando/Downloads/Transactions_Report_Bulls Merchant_1701450214624.csv","disabled":true},{"key":"amount","value":"5","description":"This field refers to operation amount
\n","type":"text"},{"key":"description","value":"Reservation description","description":"This field refers to operation description
\n","type":"text"}]},"url":"{{BASE_URL}}/v1/transactions/:transactionId/refund","description":"This endpoint is used to initiate a refund for a specific transaction.
\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
\nYou can find the error message in the Reason field on the transaction details screen.
\namount (text): This field refers to the amount to be refunded.
description (text): This field refers to the description of the refund operation.
It's optional in credit card and pix orders but required in mexican payment orders.
\nThis field can be required in credit card depending on the acquirer.
\nStatus: 201
\nContent-Type: application/json
\nExample Response:
\n{\n \"id\": \"\",\n \"accountId\": \"\",\n \"amount\": 0,\n \"origin\": \"\",\n \"transactionId\": \"\",\n \"refundTransactionId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}\n\nIn this section you will find all endpoints available for Pay In.
\nTo better understand the responses from Convrt, it is important to keep in mind that it operates with a main order that aggregates various transactions within itself. In other words, when you create an order, there will be transactions made within that order, such as refund, cancel, payment, etc.
\nFor this reason, you should find in various routes both the transaction ID and the order ID, which are different but correlated things. The order ID serves as a primary identifier to group all transactions related to a single purchase or process. The transaction ID, on the other hand, specifically identifies each action or event that occurs within that order.
\n","_postman_id":"0eabf791-e30d-4b05-9a0e-468f4ff1dfec"},{"name":"Payout","item":[{"name":"Pix","item":[{"name":"Create PayOut","id":"abd97ade-82d6-4dd1-bc9e-c0f7df3167bf","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"}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer","description":"Route for Creating a Transfer via pixKey or bankData. Only one field is allowed between pixKey and bankData.
\n\nImportant: Transactions must always occur in the same currency as the region; therefore, the
\ncurrencyproperty is not required in the request.
{\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}\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}\n\nThe bankCode must be filled with the ISPB of the corresponding bank.
For a list of valid ISPB codes
\nRelação de participantes do SPI available on the pageAlternative link
\n\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\nYou also can find the error message in the Reason field on the transaction details screen.
\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\n","urlObject":{"path":["v1","transfer"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"16533dbe-dba5-493c-9b21-45e9b925f6e1","name":"Transfered successfully","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"It is a required parameter in the request, to allow access to the resource."}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\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}","options":{"raw":{"language":"json"}}},"url":"https://api.dev.convrt.cc/v1/transfer"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"490"},{"key":"Date","value":"Wed, 30 Aug 2023 10:29:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": -6,\n \"accountId\": \"17042350-6e46-426d-a009-c0887470d595\",\n \"expectedAmount\": 0,\n \"receiver\": {\n \"documentNumber\": \"01234567890\",\n \"pixKey\": \"cb9121f4-5c8c-419d-bd27-bd7a563bdb8c\",\n \"pixType\": \"key\"\n },\n \"status\": \"pending\",\n \"fee\": 0,\n \"transactionId\": \"b66a6383-8c25-415a-8507-acff6cba1e5d\",\n \"category\": \"transfer\",\n \"origin\": \"MerchantConnection\",\n \"balance\": 52300076,\n \"transactionData\": {},\n \"payer\": {},\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"region\": \"BR\",\n \"currency\": \"BRL\",\n \"paymentMethod\": \"pix\",\n \"transactionFees\": [],\n \"eventName\": \"PixOut\",\n \"type\": \"debit\",\n \"createdAt\": \"2025-01-10T14:17:35.185Z\",\n \"updatedAt\": \"2025-01-10T14:17:35.185Z\",\n \"refundedAmount\": 0\n}"},{"id":"5ccfabec-730d-415a-bc73-f48eebc2ed4a","name":"Transaction Already Created","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"638"},{"key":"Date","value":"Tue, 05 Sep 2023 21:04:21 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"c1f98eaf-3883-4f8d-9d6d-316c664e6f77\",\n \"accountId\": \"17042350-6e46-426d-a009-c0887470d595\",\n \"merchantId\": \"d028210d-78a2-48b1-872a-6b38d2650a29\",\n \"externalId\": \"Your externalId\",\n \"orderId\": null,\n \"operationId\": null,\n \"information\": null,\n \"category\": \"transfer\",\n \"origin\": \"MerchantConnection\",\n \"type\": \"debit\",\n \"status\": \"pending\",\n \"amount\": -6,\n \"refundedAmount\": 0,\n \"fee\": 0,\n \"transactionData\": {},\n \"notificationUrl\": null,\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"receiver\": {\n \"documentNumber\": \"01234567890\",\n \"pixKey\": \"cb9121f4-5c8c-419d-bd27-bd7a563bdb8c\",\n \"pixType\": \"key\"\n },\n \"payer\": {},\n \"reservationData\": null,\n \"eventName\": \"PixOut\",\n \"originalTransactionId\": null,\n \"expectedAmount\": 0,\n \"paymentMethod\": \"pix\",\n \"createdAt\": \"2025-01-10T14:17:58.218Z\",\n \"updatedAt\": \"2025-01-10T14:17:58.218Z\",\n \"transactionFees\": []\n}"},{"id":"b9ed8de3-9ff8-4180-b768-68489afe7c3b","name":"Insufficient Balance Error","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer"},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"94"},{"key":"Date","value":"Tue, 05 Sep 2023 20:56:54 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"TSC-005\",\n \"message\": \"Insufficient balance.\",\n \"shortMessage\": \"InsufficientBalanceError\"\n}"},{"id":"55347871-50fb-4b71-8edd-9a3284753de0","name":"Not Allowed To Create Debit Transactions","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer"},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"140"},{"key":"Date","value":"Tue, 05 Sep 2023 20:58:24 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"TSC-006\",\n \"message\": \"Your account is not allowed to create debit transactions\",\n \"shortMessage\": \"NotAllowedToCreateDebitTransactions\"\n}"},{"id":"f505d354-7b87-4dbd-b085-315f373a9e94","name":"Bad Request","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer"},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"205"},{"key":"Date","value":"Wed, 30 Aug 2023 10:30:06 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\": \"receiver\",\n \"constraints\": {\n \"IsTransactionReceiverValid\": \"Must be a valid transaction receiver data\"\n }\n }\n ]\n}"},{"id":"8e9836e1-0c01-4b08-b8a6-e340e0df999e","name":"Pix Key Has Different Ownership","originalRequest":{"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."}],"body":{"mode":"raw","raw":"{\n \"amount\": 6,\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\": \"12345678909\"\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}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer"},"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":"109"},{"key":"Date","value":"Tue, 24 Sep 2024 18:22:42 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"PIX-011\",\n \"message\": \"Pix key has a different ownership\",\n \"shortMessage\": \"PixKeyHasDifferentOwnership\"\n}"}],"_postman_id":"abd97ade-82d6-4dd1-bc9e-c0f7df3167bf"}],"id":"b3fbed6a-b018-4cdf-abc5-f7c68c1b7492","_postman_id":"b3fbed6a-b018-4cdf-abc5-f7c68c1b7492","description":""},{"name":"Mexican Payment","item":[{"name":"Create PayOut","id":"db56b3d4-bdb3-4cfa-9bb4-8d930eafc356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"When the pixkey field is used by passing a telephone number, use the pattern shown below, with the prefix +55. Ex: +5511912345678
\n
It is a required parameter in the request, to allow access to the resource.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": 10,\n\t\"receiver\": {\n\t\t\"name\": \"name\",\n\t\t\"documentNumber\": \"SABC560626MDFLRN01\",\n\t\t\"documentType\": \"CURP\",\n\t\t\"email\": \"mail@mail.com\"\n\t},\n \"paymentKey\": \"170436989118315370\",\n \"concept\": \"Message of transfer\",\n\t\"externalId\": \"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer/mexican-payment","description":"This endpoint is used to create a new mexican debit payment transaction.
\nThe flow of this operation will always be asynchronous, which means that the transfer will be processed in the background. The response will be sent via webhooks and the convrt system will process the result.
\nexternald (string, required): A unique number string key to identify transaction.
amount (number, required): The amount of the order.
receiver (object, required): The receiver information.
documentNumber (string, required): The document number of the receiver.
documentType (string, required): The type of document for the receiver.
name (string, required): The name of the receiver.
email (string, required): The email of the receiver.
paymentKey (string, required): The account number of the receiver.
concept (string, required): The reason to transfer.
label (string, optional): An optional label for the transaction.
It is a required parameter in the request, to allow access to the resource.
\n"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": 2,\n\t\"receiver\": {\n\t\t\"name\": \"name\",\n\t\t\"documentNumber\": \"SABC560626MDFLRN01\",\n\t\t\"documentType\": \"CURP\",\n\t\t\"email\": \"mail@mail.com\"\n\t},\n \"paymentKey\": \"846180000400000001\",\n \"concept\": \"Message of transfer\",\n\t\"externalId\": \"97846\",\n \"institutionCode\": \"97846\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/transfer/mexican-payment/spei","description":"This endpoint is used to create a new mexican debit payment transaction.
\nThe flow of this operation will always be asynchronous, which means that the transfer will be processed in the background. The response will be sent via webhooks and the convrt system will process the result.
\nexternald (string, required): A unique number string key to identify transaction.
amount (number, required): The amount of the order.
receiver (object, required): The receiver information.
documentNumber (string, required): The document number of the receiver.
documentType (string, required): The type of document for the receiver.
name (string, required): The name of the receiver.
email (string, required): The email of the receiver.
paymentKey (string, required): The account number of the receiver.
concept (string, required): The reason to transfer.
label (string, optional): An optional label for the transaction.
institutionCode(string, required): An required label for the Mexico Institution Bank Codes
The institutionCode must be an valid bank code of Mexico Institution Bank Codes who accepts SPEI transfer.
For a list of valid Mexico Institution Bank Codes
\nMexico Banking Reference Institution Codes available on the pageAlternative link
\n\nIn this section you will find all endpoints available for payout.
\n","_postman_id":"b1efc574-1ac1-4a7b-8537-9c760e745837"},{"name":"Account","item":[{"name":"Get Transaction","id":"31562b12-6329-45f0-8fce-21cfa718d4b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.
\n","type":"text"}],"url":"{{BASE_URL}}/v1/transactions/:transactonId","description":"This route is used to consult a transaction by passing the transaction ID as path parameter.
\n","urlObject":{"path":["v1","transactions",":transactonId"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"description":{"content":"ID of the transaction
\n","type":"text/plain"},"type":"any","value":"7b061b76-ce43-4af2-b830-eb4f126fdfbd","key":"transactonId"}]}},"response":[{"id":"8ef0c158-1de8-41a7-89d3-b3356ff0d4d2","name":"Get transaction success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"}],"url":{"raw":"{{BASE_URL}}/v1/transactions/:transactonId","host":["{{BASE_URL}}"],"path":["v1","transactions",":transactonId"],"variable":[{"key":"transactonId","value":"14ab187e-c609-49f5-b96a-0e23cbedd7d0"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3076"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 21 Jan 2026 15:34:15 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6970f1eb-16fd42e721f26de367496f3a;Parent=5469adfa03245104;Sampled=0;Lineage=2:9c49a884:0"},{"key":"x-amzn-RequestId","value":"c697c533-c244-4819-8c07-38834261dfb3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-request-id","value":"7c221626-53bc-485f-9d39-ca62fb75840d"},{"key":"x-amz-apigw-id","value":"Xiq8yFPaoAMEBtA="},{"key":"logger-request-id","value":"d55d981b-db67-4b6e-8e81-4ec302a62331"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 56a9382de533189c58495d89785cc4bc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-P8"},{"key":"X-Amz-Cf-Id","value":"lhaP7W0G_eecXGghUC1TE8CFVWiZ8UZ0wdmIiFaPhinfjwwyXCiY1Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"merchantId\": \"f5066717-60b7-4056-8992-3a9b9a153cf7\",\n \"accountId\": \"8ec043b6-e98e-468f-9b11-7e8be2d05629\",\n \"transactionId\": \"14ab187e-c609-49f5-b96a-0e23cbedd7d0\",\n \"orderId\": \"58c02355-0485-4f18-9704-68c7aafbd4ad\",\n \"externalId\": null,\n \"information\": null,\n \"category\": \"automaticPayment\",\n \"origin\": \"MerchantConnection\",\n \"currency\": \"BRL\",\n \"region\": \"BR\",\n \"type\": \"credit\",\n \"status\": \"failed\",\n \"amount\": 0,\n \"fee\": 0,\n \"payer\": {\n \"documentNumber\": \"10412762498\",\n \"documentType\": \"CPF\",\n \"name\": \"Alberto Jose Cunha Vitor da Silva\"\n },\n \"expectedAmount\": 0.01,\n \"createdAt\": \"2026-01-20T13:13:08.977Z\",\n \"updatedAt\": \"2026-01-20T13:13:14.857Z\",\n \"paymentMethod\": \"pix\",\n \"refunds\": [],\n \"refundedAmount\": 0,\n \"originalTransaction\": null,\n \"order\": {\n \"orderData\": {},\n \"id\": \"58c02355-0485-4f18-9704-68c7aafbd4ad\",\n \"accountId\": \"8ec043b6-e98e-468f-9b11-7e8be2d05629\",\n \"externalId\": null,\n \"information\": null,\n \"capture\": null,\n \"origin\": \"MerchantConnection\",\n \"status\": \"paid\",\n \"paymentMethod\": \"pix\",\n \"amount\": 0,\n \"currency\": \"BRL\",\n \"paymentMethodData\": {\n \"expiresIn\": 3600,\n \"recurrence\": {\n \"immediate\": false,\n \"type\": \"weekly\",\n \"startDate\": \"2026-01-22\",\n \"endDate\": \"2026-09-15\",\n \"amount\": {\n \"type\": \"fixed\",\n \"value\": 0.01\n },\n \"title\": \"Assinatura Plus\"\n },\n \"emv\": \"00020101021226180014BR.GOV.BCB.PIX5204000053039865802BR5905EFISA6008SAOPAULO62070503***80870014BR.GOV.BCB.PIX2565qrcodespix.sejaefi.com.br/v2/rec/41e194485e02462fb9003b53c6eba78a6304A3BE\",\n \"image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAwJSURBVO3BQY4cSRLAQDLR//8yV0c/BZCoailm4Wb2B2utKzysta7xsNa6xsNa6xoPa61rPKy1rvGw1rrGw1rrGg9rrWs8rLWu8bDWusbDWusaD2utazysta7xsNa6xsNa6xo/fEjlb6qYVN6omFROKj6hMlVMKicVJyqfqDhRmSomlaniROWk4g2VqWJS+ZsqPvGw1rrGw1rrGg9rrWv88GUV36RyUvFNFZPKScWkcrOKE5WpYlI5UfkmlW+q+CaVb3pYa13jYa11jYe11jV++GUqb1R8QmWq+ETFGxVvVLyhMlVMKlPFGxWTylQxqUwVk8obKlPFpPJNKm9U/KaHtdY1HtZa13hYa13jh/84laliUjmpeENlqphUpoo3VN5Q+YTKScWkMlW8UfFNFf9PHtZa13hYa13jYa11jR/+z1WcqJxUnKh8U8Wk8gmVNyomlU9UvKEyVUwV/88e1lrXeFhrXeNhrXWNH35Zxc0q3qiYVE5UTireqHhD5Q2Vk4oTlaliUjmpmFSmim+quMnDWusaD2utazysta7xw5ep3ERlqphUpopJZao4qZhUpopJZap4Q2WqOKmYVKaKSeVEZaqYVKaKSeUTKlPFicrNHtZa13hYa13jYa11jR8+VPFfVnFSMalMFScVk8o3VbyhMlVMKicqU8WkMlV8k8obFf8lD2utazysta7xsNa6hv3BB1SmijdUpopJ5RMVn1CZKiaVk4pPqPymihOVNyo+oXKTihOVqeITD2utazysta7xsNa6xg8fqphUTiqmikllqphUpopJ5URlqnhD5RMqb1S8ofKGylQxVUwqn1CZKt6oeEPljYp/6WGtdY2HtdY1HtZa17A/+IDKVDGpnFScqEwVk8pUMal8ouINlaniDZWTikllqphUTiomlZOKN1TeqJhUTipOVE4q3lA5qfjEw1rrGg9rrWs8rLWu8cOHKiaVk4pJ5aTib6qYVE4qpopJ5aTib6p4o2JSmSomlaniROWkYlKZVE4qJpVJZaqYVE4qvulhrXWNh7XWNR7WWtf44ZdVTCpTxYnKScWkclIxqZxUTCqTyhsVk8o3qUwVJypTxd9U8U0Vk8pUManc5GGtdY2HtdY1HtZa17A/+IDKVDGpTBX/z1SmiknlpOJEZaqYVP6lihOVk4pJ5aRiUjmpOFGZKk5UpopPPKy1rvGw1rrGw1rrGj/8sopJZao4UTmpmFTeqJhUpooTlU9UTConFZPKVDGpTBVvqEwVJypTxVQxqXxTxScqJpWTim96WGtd42GtdY2HtdY17A8+oHJScaIyVZyonFRMKm9UfEJlqnhD5RMVb6hMFW+ovFExqUwVk8pU8QmVqeJE5aTimx7WWtd4WGtd42GtdY0ffpnKVDFVTCq/qWJSmVT+pYo3VCaVqeKkYlKZKm6iclIxqUwVn6iYVKaKTzysta7xsNa6xsNa6xr2B3+RylTxCZWTihOVqWJSmSo+oXJScaJyUjGpnFScqJxUTCpTxRsqf1PFGypTxTc9rLWu8bDWusbDWusaP3xI5aRiqjhR+SaVk4pJ5Q2VqWJSOamYVE4qJpVPqEwVJxWfUJkq/iWVqeJfelhrXeNhrXWNh7XWNewP/iGVqeJE5aRiUpkqJpWTiknlpOINlaniN6lMFZPKVHGi8k0VJypvVEwqU8Wk8kbFNz2sta7xsNa6xsNa6xo//GUqU8WkclJxovJfUnGiMlVMKm9UnFRMKn+TyknFGyonKlPFpDJV/KaHtdY1HtZa13hYa13jh8tUnKhMFVPFpDKpfKLiDZWpYlJ5Q2WqmFSmihOVk4oTlW+qmFTeUDmpmFROKv6mh7XWNR7WWtd4WGtdw/7gi1T+pYo3VN6omFSmihOVqeJE5V+qmFROKj6hMlWcqPxNFb/pYa11jYe11jUe1lrXsD/4gMpJxYnKVPGGyhsVJypTxRsqJxVvqEwVb6hMFScqU8UbKv9SxRsq31TxiYe11jUe1lrXeFhrXeOHD1WcqEwVb6hMFW9UTCqfUJkqpoo3VD6hMlWcqJxUTCqfqDhRmSomlaliUjlRmSpOKt5Q+aaHtdY1HtZa13hYa13jhw+pTBVTxScq3qiYVL6p4kTlExWTyknFJypOKiaVb6qYVL6p4g2Vf+lhrXWNh7XWNR7WWtf44TIqn1A5qThROVH5RMWkMqmcqHyiYlJ5o+JE5URlqjipmFROVD5RcaIyVXzTw1rrGg9rrWs8rLWuYX/wAZU3Kr5JZar4JpWp4ptUTipOVKaKT6hMFScqU8UbKicVb6i8UXGiMlVMKlPFJx7WWtd4WGtd42GtdY0fPlQxqZyo/CaVqeJE5aTiROWkYlI5qThRmSomlTcqpooTlTdUTipOVKaKT1Tc7GGtdY2HtdY1HtZa1/jhyypOVKaKN1SmiknlROUNlanipOKk4g2VT1RMKm+onFRMKlPFN6mcVJyovFHxNz2sta7xsNa6xsNa6xo/fJnKGyp/U8WkMlV8k8pUMalMFVPFpHJS8QmV36RyUvEJlaliqphUpopJ5aTimx7WWtd4WGtd42GtdY0fPqRyUvGGylQxqbyhclLxTSpTxaTyhspUcaIyVZyovFExqZyofKLiRGWqmFSmiqliUjmp+E0Pa61rPKy1rvGw1rrGD19WcaIyVUwVk8obFTdRmSpOVD5RMamcVJyo/E0qJxVTxaQyVXyTyknFJx7WWtd4WGtd42GtdY0fPlQxqUwVn6iYVN5QeaPijYpJ5UTljYoTlaliqnhD5RMVJypTxaTyiYpJZaqYVE4qJpWp4pse1lrXeFhrXeNhrXWNHz6k8gmVT6icVLyhclJxUjGpnFRMKp9Q+U0qU8VNVE5UpopJZVL5mx7WWtd4WGtd42GtdY0fPlTxRsWkMlWcqEwVk8qkclLxTSonFScVk8pJxYnKVHGiclIxqUwVk8qJyknFJyomlZs9rLWu8bDWusbDWusaP3xIZao4UTlROamYVKaKN1Q+ofKGyhsVf1PFpPKGyicq3lD5hMpUcaIyqUwVn3hYa13jYa11jYe11jV+uEzFGxUnKlPFVHGi8kbFGypTxYnKScUbKlPFGxUnKp9QOamYVP6mim96WGtd42GtdY2HtdY17A++SGWqeEPlpOINlU9UTCpTxaQyVbyhclIxqZxUnKicVEwqJxUnKlPFpHJScaLyRsWkclLxmx7WWtd4WGtd42GtdY0ffpnKScVUcaIyVUwqJxUnKpPKicqJyknFN1VMKlPFScWkMlVMKpPKVPFGxW+qOKmYVP6mh7XWNR7WWtd4WGtd44cPqbxR8YbKVPFGxaRyUjGpTBWTyjdVTCqTyonKGxUnFScV/5LKGyonFW+oTBWfeFhrXeNhrXWNh7XWNewP/sNUTipOVN6oOFF5o+JEZap4Q+WkYlKZKk5UpooTlTcqTlSmijdUTir+poe11jUe1lrXeFhrXeOHD6n8TRUnFZPKScWk8obKVDGpTBXfpDJVnFRMKicqb6hMFScVk8qk8gmVqeINlTcqPvGw1rrGw1rrGg9rrWv88GUV36RyUnFScaIyVZyoTBUnFW+ovFHxhspUcaJyUjGpTCpvVEwqn6h4o2JSmSp+08Na6xoPa61rPKy1rvHDL1N5o+INlaniRGWqeKNiUpkq3lCZKiaVSeUTFZPKScWk8omKE5Wp4kRlUvlNKicVn3hYa13jYa11jYe11jV++I+rmFS+SeWkYlKZKiaVE5WTikllqphUTiomlUnlExVvVEwqU8VJxTdVnKh808Na6xoPa61rPKy1rvHD/5mKN1ROKn5TxYnKpDJVTConKicVk8o3qUwVN1F5o+KbHtZa13hYa13jYa11jR9+WcXfpPJNKlPFpDJVnFR8ouKk4kRlqphUpooTlaliUpkqJpWpYqqYVKaKT6i8UfGbHtZa13hYa13jYa11jR++TOVvUpkq3lB5Q2Wq+E0VJypTxaQyVbyhMlX8JpWTihOVqWJSmSomlTdUpopPPKy1rvGw1rrGw1rrGvYHa60rPKy1rvGw1rrGw1rrGg9rrWs8rLWu8bDWusbDWusaD2utazysta7xsNa6xsNa6xoPa61rPKy1rvGw1rrGw1rrGv8DSlZ1H4l5My0AAAAASUVORK5CYII=\",\n \"location\": \"https://qrcode-pix.dev.convrt.cc?qrc=58c02355-0485-4f18-9704-68c7aafbd4ad\",\n \"acceptedAt\": \"2026-01-19T17:51:21.907Z\"\n },\n \"payer\": {\n \"documentNumber\": \"10412762498\",\n \"documentType\": \"CPF\",\n \"name\": \"Alberto Jose Cunha Vitor da Silva\"\n },\n \"createdAt\": \"2026-01-19T17:50:27.915Z\",\n \"updatedAt\": \"2026-01-19T17:51:21.907Z\",\n \"merchantId\": \"f5066717-60b7-4056-8992-3a9b9a153cf7\",\n \"region\": \"BR\",\n \"transactions\": []\n },\n \"transactionData\": {\n \"reconciliation\": {\n \"id\": \"RN09089356202601199b3263f848e\",\n \"loc\": 41\n },\n \"reason\": \"Divergência entre a data de vencimento informada e a periodicidade da recorrência e/ou as regras do produto.\"\n }\n}"},{"id":"2d74e2cb-22a7-488f-a336-b423c79eddad","name":"Transaction not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource.","type":"text"}],"url":{"raw":"{{BASE_URL}}/v1/transactions/:transactonId","host":["{{BASE_URL}}"],"path":["v1","transactions",":transactonId"],"variable":[{"key":"transactonId","value":"7b061b76-ce43-4af2-b830-eb4f126fdfbd","description":"ID of the transaction"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"101"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 21 Jan 2026 15:35:16 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6970f233-4c95020a06d04faf2525be83;Parent=28193cd7811252a7;Sampled=0;Lineage=1:9c49a884:0"},{"key":"x-amzn-RequestId","value":"486e2921-9a27-43fe-8ada-228abae3b4dc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-request-id","value":"d2952a6f-555c-4bf0-a027-1a5f9e2e9f62"},{"key":"x-amz-apigw-id","value":"XirIKEazoAMEDkg="},{"key":"logger-request-id","value":"fa071468-2d21-4efb-bc41-49f42c1d900a"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 56a9382de533189c58495d89785cc4bc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-P8"},{"key":"X-Amz-Cf-Id","value":"FQ0s-btwLIL0CT_AexHmLMi1ckxHxp1qJaVrqxZBI6pf3chl8xDwGQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"PIX-001\",\n \"message\": \"No transaction found for given id\",\n \"shortMessage\": \"TransactionNotFound\"\n}"}],"_postman_id":"31562b12-6329-45f0-8fce-21cfa718d4b0"},{"name":"Get Account Statement","id":"e62cb447-89e2-4f8c-8aba-7dae2d166252","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","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/transactions","description":"This route is used to obtain account bank statement information, using filters or not, all filters are optional, the parameters: limit, page and order refer to paging parameters, the others are filtering parameters and the transactions that have the sent parameters will be returned, if no parameter is sent, all transactions will be returned in a paged form
\n","urlObject":{"path":["v1","transactions"],"host":["{{BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"This parameter refers to the category of transaction, which can be pix, pixReversal or tev
\n","type":"text/plain"},"key":"category","value":"pix"},{"disabled":true,"description":{"content":"This parameter refers to the type of transaction, which can be credit or debit
\n","type":"text/plain"},"key":"type","value":"credit"},{"disabled":true,"description":{"content":"This parameter refers to the document number of reveiver or payer transaction
\n","type":"text/plain"},"key":"documentNumber","value":"01234567890"},{"disabled":true,"description":{"content":"This parameter refers to the status of transaction, which can be pending, success or failed
\n","type":"text/plain"},"key":"status","value":"pending"},{"disabled":true,"description":{"content":"This parameter refers to the transaction amount, records with a amount greater than or equal to the one sent will be returned
\n","type":"text/plain"},"key":"min","value":"10.01"},{"disabled":true,"description":{"content":"This parameter refers to the value of the transaction, records with a value less than or equal to the one sent will be returned
\n","type":"text/plain"},"key":"max","value":"10.99"},{"disabled":true,"description":{"content":"This parameter refers to the transaction creation date, records with a date greater than or equal to the one sent will be returned
\n","type":"text/plain"},"key":"from","value":"2023-09-28T14:50:43.201Z"},{"disabled":true,"description":{"content":"This parameter refers to the transaction creation date, records with a date less than or equal to the one sent will be returned
\n","type":"text/plain"},"key":"to","value":"2023-09-28T21:50:43.201Z"},{"disabled":true,"description":{"content":"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":"1"},{"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 labels savend in account
\n","type":"text/plain"},"key":"labels","value":"label_1,label_2"}],"variable":[]}},"response":[{"id":"10026a79-25a1-47c4-b265-a2e4f9c575ae","name":"Get account statement successfully","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/merchant-panel/v1/transactions?accountId=c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3","host":["{{BASE_URL}}"],"path":["merchant-panel","v1","transactions"],"query":[{"key":"category","value":"pix","description":"This parameter refers to the category of transaction, which can be pix, pixReversal or tev","disabled":true},{"key":"type","value":"credit","description":"This parameter refers to the type of transaction, which can be credit or debit","disabled":true},{"key":"documentNumber","value":"01234567890","description":"This parameter refers to the document number of reveiver or payer transaction","disabled":true},{"key":"status","value":"pending","description":"This parameter refers to the status of transaction, which can be pending, success or failed","disabled":true},{"key":"min","value":"10.01","description":"This parameter refers to the transaction amount, records with a amount greater than or equal to the one sent will be returned","disabled":true},{"key":"max","value":"10.99","description":"This parameter refers to the value of the transaction, records with a value less than or equal to the one sent will be returned","disabled":true},{"key":"from","value":"2023-09-28T14:50:43.201Z","description":"This parameter refers to the transaction creation date, records with a date greater than or equal to the one sent will be returned","disabled":true},{"key":"to","value":"2023-09-28T21:50:43.201Z","description":"This parameter refers to the transaction creation date, records with a date less than or equal to the one sent will be returned","disabled":true},{"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","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":"accountId","value":"c6ee0d6d-f1ea-4007-8b4c-3c67617ac7f3","description":"This parameter refers to the account identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"821"},{"key":"accept-ranges","value":"bytes"},{"key":"Date","value":"Mon, 16 Oct 2023 16:36:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"pagination\": {\n \"limit\": 10,\n \"page\": 1,\n \"totalRecords\": 2,\n \"totalPages\": 1,\n \"nextPage\": null,\n \"prevPage\": null,\n \"hasNextPage\": false,\n \"hasPrevPage\": false\n },\n \"items\": [\n {\n \"transactionId\": \"1087fddf-5fe1-4e8b-9e52-bd698ba59c98\",\n \"externalId\": \"4fbb3f12-315a-4062-b94b-3cca287242028\",\n \"information\": null,\n \"category\": \"pix\",\n \"type\": \"debit\",\n \"status\": \"pending\",\n \"amount\": 15.45,\n \"fee\": -5.86,\n \"balanceAfterTransaction\": 78.69,\n \"expectedAmount\": 0,\n \"createdAt\": \"2023-10-11T17:56:14.964Z\",\n \"updatedAt\": \"2023-10-11T17:56:14.964Z\"\n },\n {\n \"transactionId\": \"1087fddf-5fe1-4e8b-9e52-bd698ba59c97\",\n \"externalId\": \"4fbb3f12-315a-4062-b94b-3cca287242027\",\n \"information\": null,\n \"category\": \"pix\",\n \"type\": \"debit\",\n \"status\": \"pending\",\n \"amount\": 15.45,\n \"fee\": -5.86,\n \"balanceAfterTransaction\": 78.69,\n \"expectedAmount\": 0,\n \"createdAt\": \"2023-10-11T17:56:14.964Z\",\n \"updatedAt\": \"2023-10-11T17:56:14.964Z\"\n }\n ]\n}"},{"id":"8d1e9e31-7aa8-4d19-9247-612c84c0bb5c","name":"Validation error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/merchant-panel/v1/transactions","host":["{{BASE_URL}}"],"path":["merchant-panel","v1","transactions"],"query":[{"key":"category","value":"pix","description":"This parameter refers to the category of transaction, which can be pix, pixReversal or tev","disabled":true},{"key":"type","value":"credit","description":"This parameter refers to the type of transaction, which can be credit or debit","disabled":true},{"key":"documentNumber","value":"01234567890","description":"This parameter refers to the document number of reveiver or payer transaction","disabled":true},{"key":"status","value":"pending","description":"This parameter refers to the status of transaction, which can be pending, success or failed","disabled":true},{"key":"min","value":"10.01","description":"This parameter refers to the transaction amount, records with a amount greater than or equal to the one sent will be returned","disabled":true},{"key":"max","value":"10.99","description":"This parameter refers to the value of the transaction, records with a value less than or equal to the one sent will be returned","disabled":true},{"key":"from","value":"2023-09-28T14:50:43.201Z","description":"This parameter refers to the transaction creation date, records with a date greater than or equal to the one sent will be returned","disabled":true},{"key":"to","value":"2023-09-28T21:50:43.201Z","description":"This parameter refers to the transaction creation date, records with a date less than or equal to the one sent will be returned","disabled":true},{"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","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}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"214"},{"key":"Date","value":"Fri, 13 Oct 2023 13:50:19 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\": \"accountId\",\n \"constraints\": {\n \"isUuid\": \"accountId must be a UUID\",\n \"isNotEmpty\": \"accountId should not be empty\"\n }\n }\n ]\n}"}],"_postman_id":"e62cb447-89e2-4f8c-8aba-7dae2d166252"},{"name":"Get Account Balance V1","id":"81e39043-6de3-4568-bbd1-d616c2df37e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","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/balance","description":"This route is used to check the balance of your account. It returns only the balance in the default currency for the region, which, in the case of PIX as a Brazilian payment method, is BRL (Brazilian Real).
\n","urlObject":{"path":["v1","balance"],"host":["{{BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"End Date Balance
\n","type":"text/plain"},"key":"endDate","value":"2023-09-08"}],"variable":[]}},"response":[{"id":"9c6eb62f-e883-47e2-b284-4f5565907859","name":"Get account balance successfully","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/balance","host":["{{BASE_URL}}"],"path":["v1","balance"],"query":[{"key":"endDate","value":"2023-08-24","description":"If sent in the request, the balance until the informed date will be returned, this parameter is optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"14"},{"key":"accept-ranges","value":"bytes"},{"key":"Date","value":"Thu, 24 Aug 2023 19:44:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"balance\": 20\n}"},{"id":"e20544b6-db08-4aa8-a1cf-0310c35363a7","name":"Invalid end date error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/balance?endDate=invalid","host":["{{BASE_URL}}"],"path":["v1","balance"],"query":[{"key":"endDate","value":"invalid","description":"If sent in the request, the balance until the informed date will be returned, this parameter is optional"}]}},"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-allow-credentials","value":"true"},{"key":"access-control-expose-headers","value":"WWW-Authenticate,Server-Authorization"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"174"},{"key":"Date","value":"Thu, 24 Aug 2023 19:48:09 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\": \"endDate\",\n \"constraints\": {\n \"isDate\": \"endDate must be a Date instance\"\n }\n }\n ]\n}"}],"_postman_id":"81e39043-6de3-4568-bbd1-d616c2df37e4"},{"name":"Get Account Balance V2","id":"6738a96f-347f-41c7-a265-895f881c850e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}"}],"url":"{{BASE_URL}}/v2/balance","description":"This endpoint is an evolution of v1 and is used to check the balance of your account. It returns the balance with support for multiple currencies.
\n","urlObject":{"path":["v2","balance"],"host":["{{BASE_URL}}"],"query":[{"disabled":true,"key":"endDate","value":"2023-09-08"},{"disabled":true,"key":"currency","value":"BRL"}],"variable":[]}},"response":[{"id":"17e72d94-d9cd-4acf-a4fa-aef84d0daa5d","name":"Get Account Balance V2","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}"}],"url":{"raw":"{{BASE_URL}}/v2/balance","host":["{{BASE_URL}}"],"path":["v2","balance"],"query":[{"key":"endDate","value":"2023-09-08","disabled":true},{"key":"currency","value":"BRL","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"currency\": \"BRL\",\n \"balance\": 24\n },\n {\n \"currency\": \"USD\",\n \"balance\": 1\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0\n },\n {\n \"currency\": \"MXN\",\n \"balance\": 0\n },\n {\n \"currency\": \"PEN\",\n \"balance\": 0\n },\n {\n \"currency\": \"GBP\",\n \"balance\": 0\n }\n]"},{"id":"d4b77c6b-aca9-484d-ac7c-c46f899370ea","name":"Validation error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}"}],"url":{"raw":"{{BASE_URL}}/v2/balance","host":["{{BASE_URL}}"],"path":["v2","balance"],"query":[{"key":"endDate","value":"2023-09-08","disabled":true},{"key":"currency","value":"BRL","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"val-001\",\n \"message\": \"Validation Error\",\n \"shortMessage\": \"validationError\",\n \"details\": [\n {\n \"property\": \"endDate\",\n \"constraints\": {\n \"isDate\": \"endDate must be a Date instance\"\n }\n },\n {\n \"property\": \"currency\",\n \"constraints\": {\n \"isIn\": \"each value in currency must be one of the following values: BRL, USD, EUR, MXN, PEN, GBP\"\n }\n }\n ]\n}"},{"id":"7da4c14e-d352-4e09-b459-cd2c0ba49c1d","name":"Invalid currency","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}"}],"url":{"raw":"{{BASE_URL}}/v2/balance?currency=BRL","host":["{{BASE_URL}}"],"path":["v2","balance"],"query":[{"key":"endDate","value":"2023-09-08","disabled":true},{"key":"currency","value":"BRL"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"code\": \"val-001\",\r\n \"message\": \"Validation Error\",\r\n \"shortMessage\": \"validationError\",\r\n \"details\": [\r\n {\r\n \"property\": \"currency\",\r\n \"constraints\": {\r\n \"currency\": \"It is not possible to use the currency provided. Allowed currencies are: USD, EUR\"\r\n }\r\n }\r\n ]\r\n}"}],"_postman_id":"6738a96f-347f-41c7-a265-895f881c850e"}],"id":"fd6b7af9-a869-45a8-be16-ea4f90e89811","_postman_id":"fd6b7af9-a869-45a8-be16-ea4f90e89811","description":""},{"name":"Payment Links","item":[{"name":"Request Payment Link","id":"5d04d2c1-a6cb-48f8-9bc0-d349ab3ceb49","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"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Purchase of product X\",\n \"expiresIn\": 3600,\n \"externalId\": \"1\",\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 \"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://google.com\",\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}}/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"}],"url":"{{BASE_URL}}/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":"7d4919a5-4c96-4626-8a68-76e3bf74184e","name":"Notification failed","originalRequest":{"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."}],"url":{"raw":"{{BASE_URL}}/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["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":"c12ad4ba-9d4e-44f8-aa74-47d4dcdd5393","name":"Unknown error","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["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":"0a23a141-6935-477a-9641-363d5c78d8ae","name":"Invalid code","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["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":"3eab3f26-396b-4ecf-8293-2c02dc24f6db","name":"Payment link not found","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["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":"943f65e1-4a4d-40e1-954b-9f78b1812581","name":"Cancelled successfully","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["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":"34f1d020-0f0e-48d8-aa9f-04796350eb8d","name":"Invalid status","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/payment-links/:code/cancel","host":["{{BASE_URL}}"],"path":["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":"468af97c-f4a1-4e05-863a-905f23daf81e"},{"name":"List Payment Links","id":"31e83e41-d292-4085-b689-3f8eb2759e61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","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/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":"b68d6d17-32b1-476a-b5f2-77e2b356a34a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API_CLIENT_TOKEN}}","description":"It is a required parameter in the request, to allow access to the resource."}],"url":{"raw":"{{BASE_URL}}/v1/payment-links/list","host":["{{BASE_URL}}"],"path":["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":"currencies","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":"chosenPaymentMethods","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":"31e83e41-d292-4085-b689-3f8eb2759e61"},{"name":"Open Payment Link","id":"56ed318b-05ff-41b9-b26e-bfc5f7a8b09d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","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/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\nThe 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.
\nFor comprehensive reference, see the full list of return codes published by the Brazilian Association of Credit Card and Service Companies (ABECS) at:
\n\nEach example represents an event containing transaction information of the Pay In type.
\nNote about response:
\nThe id is the identifier of the generated event.
\nThe transactionid is the identifier of the executed transaction.
\nThe orderId is the primary order identifier that contains all transactions made within it.
\nEach example represents an event containing transaction information of the Pay Out type.
\nNote about response:
\nThe id is the identifier of the generated event.
\nThe transactionid is the identifier of the executed transaction.
\nThe orderId is the primary order identifier that contains all transactions made within it
\nThis type of webhook records payment requests made via PIX, an instant payment system developed by the Central Bank of Brazil.
\nThis transaction is responsible for adding funds to an account. A pay-in transaction can originate in the following ways:
\nQR Code (Quick Response Code): The payer can scan the QR code with their smartphone camera or copy the code to complete the transaction quickly and securely.
\nReversal: This occurs when a pay-out transaction fails, and the amount is returned to the account through a pay-in reversal transaction.
\nRefund: This transfer is made when a PIX payment is returned to the account.
\nThis transaction is responsible for debiting the balance from an account. A pay-out transaction can originate in the following ways:
\nPix Key: The transfer is made using a PIX key, which is an identifier of a bank account within the PIX instant payment system.
\nBank Data: The transfer is made using the bank details of the recipient account.
\nRefund:
This transfer is made when a refund request is processed for a PIX pay-in transaction.
Reserve: This transfer is made when a portion of the amount from a PIX pay-in is reserved in an account that acts as a ledger, holding the funds for a period before returning them to the original account.
\npending: Payment is pending and is currently being processed.
\nsuccess: Payment has been successfully processed.
\nfailed: Payment failed.
\nTRANSACTION.PIX.RECEIVED.REQUESTED → pending
TRANSACTION.PIX.RECEIVED.SUCCEEDED → success
TRANSACTION.PIX.REFUNDED.SUCCEEDED → success
TRANSACTION.PIX.PAYMENT.REVERSAL.SUCCEEDED → success
TRANSACTION.PIX.REFUND.REVERSAL.SUCCEEDED → success
TRANSACTION.PIX.REFUND.FAILED event.TRANSACTION.PIX.AUTOMATIC_CONTRACT.REQUESTED→ pending
TRANSACTION.PIX.AUTOMATIC_CONTRACT.ACCPETED→ 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
TRANSACTION.PIX.PAYMENT.REQUESTED → pending
TRANSACTION.PIX.PAYMENT.SUCCEEDED → success
TRANSACTION.PIX.PAYMENT.FAILED → failed
TRANSACTION.PIX.REFUND.REQUESTED → pending
TRANSACTION.PIX.REFUND.SUCCEEDED → success
TRANSACTION.RESERVE.PAYMENT.SUCCEEDED → success
TRANSACTION.PIX.RECEIVED.SUCCEEDED event is reserved.{Transaction Type} refers to the type of transaction mentioned below:
RECEIVED: Transfer received
REFUND: Transfer sent to return a received transfer
PAYMENT: Transfer sent
REFUNDED: Transfer received from the return of a sent transfer
Each example represents an event containing transaction information of the Pay In type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"3df5364b-d5bb-4bc2-825c-82aa38c9e86a","name":"TRANSACTION.CREDIT_CARD.AUTHORIZATION.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.CREDIT_CARD.AUTHORIZATION.REQUESTED\",\n \"id\": \"9c9c6770-ea4c-41c1-a681-7853ea84b41a\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T14:08:02.372Z\",\n \"eventName\": \"CreditCardInAuthorization\",\n \"fee\": -2.25,\n \"information\": \"information\",\n \"orderId\": \"7a7c7619-39cc-40e3-9746-a24b6d8709f1\",\n \"status\": \"pending\",\n \"transactionFees\": [\n {\n \"name\": \"CC Authorization\",\n \"value\": 1.25\n },\n {\n \"name\": \"Fee\",\n \"value\": 1\n }\n ],\n \"transactionId\": \"e51af8b1-02c1-453f-8c7c-c81db6211712\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T14:08:02.372Z\"\n },\n \"time\": \"2024-07-26T14:08:03.034Z\",\n \"version\": \"v1\"\n}"},{"id":"5d2321c4-8741-4e37-8205-ee7684cbe024","name":"TRANSACTION.CREDIT_CARD.AUTHORIZATION.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.CREDIT_CARD.AUTHORIZATION.FAILED\",\n \"id\": \"b34431e7-409c-4c8c-a5ee-cadb0d84c45b\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T14:08:02.372Z\",\n \"error\": {\n \"code\": \"ACQ-001\",\n \"message\": \"Failed to communicate with acquirer service\"\n },\n \"eventName\": \"CreditCardInAuthorization\",\n \"fee\": -1.25,\n \"information\": \"information\",\n \"orderId\": \"7a7c7619-39cc-40e3-9746-a24b6d8709f1\",\n \"status\": \"failed\",\n \"transactionFees\": [\n {\n \"name\": \"CC Authorization\",\n \"value\": 1.25\n },\n {\n \"name\": \"Fee\",\n \"value\": 1.25\n }\n ],\n \"transactionId\": \"e51af8b1-02c1-453f-8c7c-c81db6211712\",\n \"type\": \"credit\",\n \"updatedAt\": \"2024-07-26T14:08:58.457Z\"\n },\n \"time\": \"2024-07-26T14:08:58.893Z\",\n \"version\": \"v1\"\n}\n"},{"id":"39ebe345-302f-42e1-97f6-36e59f547ec3","name":"TRANSACTION.CREDIT_CARD.AUTHORIZATION.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.AUTHORIZATION.SUCCEEDED\",\r\n \"id\": \"6443ecdc-82de-4b8e-9c1b-2aed48437467\",\r\n \"payload\": {\r\n \"amount\": 0,\r\n \"createdAt\": \"2024-07-26T14:10:52.122Z\",\r\n \"eventName\": \"CreditCardInAuthorization\",\r\n \"fee\": -1.25,\r\n \"information\": \"information\",\r\n \"orderId\": \"c6019e42-9592-4ace-9ed3-c28d822e79db\",\r\n \"status\": \"success\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"CC Authorization\",\r\n \"value\": 1.25\r\n },\r\n {\r\n \"name\": \"Fee\",\r\n \"value\": 1.25\r\n }\r\n ],\r\n \"transactionId\": \"a2e6468b-2296-4475-bdeb-e45ae02ce49c\",\r\n \"type\": \"credit\",\r\n \"updatedAt\": \"2024-07-26T14:11:30.121Z\"\r\n },\r\n \"time\": \"2024-07-26T14:11:30.394Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"8ef5416e-494b-4641-bf55-088c588e3092","name":"TRANSACTION.CREDIT_CARD.CAPTURE.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.CAPTURE.REQUESTED\",\r\n \"id\": \"7cfbd799-df01-4a73-952f-56bdfe19119e\",\r\n \"payload\": {\r\n \"amount\": 0,\r\n \"createdAt\": \"2024-07-26T14:18:22.947Z\",\r\n \"eventName\": \"CreditCardIn\",\r\n \"expectedAmount\": 5,\r\n \"fee\": -2,\r\n \"information\": \"information\",\r\n \"orderId\": \"109d2054-6bba-4c41-afd0-72f4696bdba5\",\r\n \"status\": \"pending\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"Fee Name\",\r\n \"value\": 2\r\n }\r\n ],\r\n \"transactionId\": \"ea7763e6-7814-4e31-bd54-cbb912e26833\",\r\n \"type\": \"credit\",\r\n \"updatedAt\": \"2024-07-26T14:18:22.947Z\"\r\n },\r\n \"time\": \"2024-07-26T14:18:23.340Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"b29c4654-22b4-4552-b4c8-cd541726df8f","name":"TRANSACTION.CREDIT_CARD.CAPTURE.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.CAPTURE.SUCCEEDED\",\r\n \"id\": \"9bd827b3-3d6e-45d0-bd6b-3b8e6b0d51a5\",\r\n \"payload\": {\r\n \"amount\": 5.5,\r\n \"createdAt\": \"2024-07-26T14:16:17.669Z\",\r\n \"eventName\": \"CreditCardIn\",\r\n \"fee\": -2,\r\n \"orderId\": \"791d81ea-4c74-4ec9-b05b-c993e31dcc90\",\r\n \"status\": \"success\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"Brand Mastercard Review Test\",\r\n \"value\": 2\r\n }\r\n ],\r\n \"transactionId\": \"6e7a0ee0-8729-4597-912e-b590513c7894\",\r\n \"type\": \"credit\",\r\n \"updatedAt\": \"2024-07-26T14:16:17.669Z\"\r\n },\r\n \"time\": \"2024-07-26T14:16:20.392Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"e4a98e43-bfa1-48eb-8188-13b1859dd31e","name":"TRANSACTION.CREDIT_CARD.CAPTURE.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.CAPTURE.FAILED\",\r\n \"id\": \"7a41d332-c23d-4ea0-8f3d-a5d1d0f8042a\",\r\n \"payload\": {\r\n \"amount\": 1,\r\n \"createdAt\": \"2024-07-26T14:13:56.526Z\",\r\n \"error\": {\r\n \"code\": \"ACQ-001\",\r\n \"message\": \"Failed to communicate with acquirer service\"\r\n },\r\n \"eventName\": \"CreditCardIn\",\r\n \"fee\": -2,\r\n \"orderId\": \"c6019e42-9592-4ace-9ed3-c28d822e79db\",\r\n \"status\": \"failed\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"Brand Mastercard Review Test\",\r\n \"value\": 2\r\n }\r\n ],\r\n \"transactionId\": \"dbf26682-480b-4d6b-ac33-8016d5099d5c\",\r\n \"type\": \"credit\",\r\n \"updatedAt\": \"2024-07-26T14:13:56.526Z\"\r\n },\r\n \"time\": \"2024-07-26T14:13:56.776Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"ccd89e7a-a344-4f1d-bf21-edd25d89254c","name":"TRANSACTION.CREDIT_CARD.CANCELLATION.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.CREDIT_CARD.CANCELLATION.REVERSAL\",\n \"id\": \"7323932c-7285-411e-bbe1-4175e7cd70e4\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T12:40:20.639Z\",\n \"eventName\": \"CreditCardOutCancellationReversal\",\n \"fee\": 0,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"1abb899e-4225-4287-94a8-769d08bd03cd\",\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"},{"id":"66adef45-f9b9-4652-92ab-15254e9a99a1","name":"TRANSACTION.CREDIT_CARD.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.CREDIT_CARD.REFUND.REVERSAL.SUCCEEDED\",\n \"id\": \"7323932c-7285-411e-bbe1-4175e7cd70e4\",\n \"payload\": {\n \"amount\": 0,\n \"createdAt\": \"2024-07-26T12:40:20.639Z\",\n \"eventName\": \"CreditCardOutCancellationReversal\",\n \"fee\": 1,\n \"orderId\": \"a8654d54-1ba1-42d0-b940-fb87c5806944\",\n \"originalTransactionId\": \"1abb899e-4225-4287-94a8-769d08bd03cd\",\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":"18e7071f-16d3-44c4-a649-f40b0e599463"},{"name":"Pay Out","id":"ff08cfde-4730-4080-a4cf-ce2b8c275b75","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":"fdba75a0-b2c4-4e29-801d-42cea1943124","name":"TRANSACTION.CREDIT_CARD.CANCELLATION.REQUESTED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.CANCELLATION.REQUESTED\",\r\n \"id\": \"875417d8-a4f9-4a63-bf9c-fcd6c1eb8a0a\",\r\n \"payload\": {\r\n \"amount\": 0,\r\n \"createdAt\": \"2024-07-26T14:40:50.566Z\",\r\n \"eventName\": \"CreditCardOutCancellation\",\r\n \"fee\": -1.25,\r\n \"orderId\": \"2c187e99-925f-496b-92d0-533cbf54d7c1\",\r\n \"status\": \"pending\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"Fee Name\",\r\n \"value\": 1\r\n },\r\n {\r\n \"name\": \"Fee\",\r\n \"value\": 0.25\r\n }\r\n ],\r\n \"transactionId\": \"1abb899e-4225-4287-94a8-769d08bd03cd\",\r\n \"type\": \"debit\",\r\n \"updatedAt\": \"2024-07-26T14:40:50.566Z\"\r\n },\r\n \"time\": \"2024-07-26T14:40:50.974Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"6e38337f-6a6d-461b-99f8-3cc6f53e5b27","name":"TRANSACTION.CREDIT_CARD.CANCELLATION.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.CANCELLATION.SUCCEEDED\",\r\n \"id\": \"55e9e2c9-6b24-4868-b9e1-bbc0641f94d6\",\r\n \"payload\": {\r\n \"amount\": 0,\r\n \"createdAt\": \"2024-07-26T14:40:50.566Z\",\r\n \"eventName\": \"CreditCardOutCancellation\",\r\n \"fee\": -1,\r\n \"orderId\": \"2c187e99-925f-496b-92d0-533cbf54d7c1\",\r\n \"status\": \"success\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"Fee Name\",\r\n \"value\": 1\r\n }\r\n ],\r\n \"transactionId\": \"1abb899e-4225-4287-94a8-769d08bd03cd\",\r\n \"type\": \"debit\",\r\n \"updatedAt\": \"2024-07-26T14:41:18.800Z\"\r\n },\r\n \"time\": \"2024-07-26T14:41:19.781Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"ea2b8d33-71af-4770-a7b5-68260a3e9f23","name":"TRANSACTION.CREDIT_CARD.CANCELLATION.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.CANCELLATION.FAILED\",\r\n \"id\": \"55e9e2c9-6b24-4868-b9e1-bbc0641f94d6\",\r\n \"payload\": {\r\n \"amount\": 0,\r\n \"createdAt\": \"2024-07-26T14:40:50.566Z\",\r\n \"eventName\": \"CreditCardOutCancellation\",\r\n \"fee\": -1,\r\n \"orderId\": \"2c187e99-925f-496b-92d0-533cbf54d7c1\",\r\n \"status\": \"failed\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"Fee Name\",\r\n \"value\": 1\r\n }\r\n ],\r\n \"transactionId\": \"1abb899e-4225-4287-94a8-769d08bd03cd\",\r\n \"type\": \"debit\",\r\n \"updatedAt\": \"2024-07-26T14:41:18.800Z\"\r\n },\r\n \"time\": \"2024-07-26T14:41:19.781Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"edfe85d3-40a3-43eb-a853-2ab5fa3658b7","name":"TRANSACTION.CREDIT_CARD.CHARGEBACK.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"TRANSACTION.CREDIT_CARD.CHARGEBACK.SUCCEEDED\",\r\n \"id\": \"43e820aa-3d1d-4b92-b364-9e10e1a888f4\",\r\n \"payload\": {\r\n \"amount\": -6,\r\n \"createdAt\": \"2024-07-26T14:48:34.920Z\",\r\n \"eventName\": \"CreditCardInChargeBack\",\r\n \"fee\": -2.2,\r\n \"orderId\": \"24747172-42f1-4d98-99c8-1ce9099abae0\",\r\n \"originalTransactionId\": \"5193d801-4eac-4219-9825-1a227cb1335e\",\r\n \"status\": \"success\",\r\n \"transactionFees\": [\r\n {\r\n \"name\": \"Fee Name\",\r\n \"value\": 2.2\r\n }\r\n ],\r\n \"transactionId\": \"6bf39876-d62c-45e6-8fb7-363c180c706d\",\r\n \"type\": \"debit\",\r\n \"updatedAt\": \"2024-07-26T14:48:34.920Z\"\r\n },\r\n \"time\": \"2024-07-26T14:48:35.619Z\",\r\n \"version\": \"v1\"\r\n}\r\n"},{"id":"4f5ae6ca-9984-4c30-bee7-4081916aea69","name":"TRANSACTION.RESERVE.PAYMENT.SUCCEEDED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.RESERVE.PAYMENT.SUCCEEDED\",\n \"id\": \"802cd5f1-933a-4461-b331-3a3432d2a2fc\",\n \"payload\": {\n \"amount\": -1.05,\n \"createdAt\": \"2024-07-26T14:18:34.104Z\",\n \"eventName\": \"ReserveOut\",\n \"fee\": 0,\n \"originalTransactionId\": \"18696887-89a9-4d08-bc40-819c93045f9e\",\n \"status\": \"success\",\n \"transactionId\": \"31e8a458-18b6-4000-856f-8f9257cfab08\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T14:18:34.104Z\"\n },\n \"time\": \"2024-07-26T14:18:34.586Z\",\n \"version\": \"v1\"\n}\n"},{"id":"38c0cbbc-5851-485c-960a-d1f82be7c3e2","name":"TRANSACTION.CREDIT_CARD.REFUND.REQUESTED","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.CREDIT_CARD.REFUND.REQUESTED\",\n \"id\": \"29e0163e-dfd8-4065-9d16-9423154d35ec\",\n \"payload\": {\n \"amount\": -0.1,\n \"createdAt\": \"2024-10-08T21:26:33.927Z\",\n \"eventName\": \"CreditCardInRefund\",\n \"externalId\": \"d1e2e5f4-6d2a-42a4-9512-d5b860765523\",\n \"fee\": 0,\n \"orderId\": \"f913edee-0244-4152-90a0-025b1a6a214d\",\n \"originalTransactionId\": \"27d33f74-9436-43cf-b78c-525c7e85df5e\",\n \"status\": \"pending\",\n \"transactionId\": \"d6d731a3-7f5e-4ab0-a55e-7a40a716e491\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-10-08T21:26:33.927Z\"\n },\n \"time\": \"2024-10-08T21:26:34.439Z\",\n \"version\": \"v1\"\n}"},{"id":"820701b8-d082-41bc-a23c-52dfd8f40813","name":"TRANSACTION.CREDIT_CARD.REFUND.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.CREDIT_CARD.REFUND.SUCCEEDED\",\n \"id\": \"f9890f32-c01d-4831-817c-17a67300e9ab\",\n \"payload\": {\n \"amount\": -0.1,\n \"createdAt\": \"2024-10-08T21:29:38.849Z\",\n \"eventName\": \"CreditCardInRefund\",\n \"externalId\": \"ad81b551-c256-4f17-b257-fca3964960d3\",\n \"fee\": 0,\n \"orderId\": \"b85104c4-1767-4456-bf83-6d604389adc4\",\n \"originalTransactionId\": \"f8c1be85-243a-4e72-b318-0dbcbac78904\",\n \"status\": \"success\",\n \"transactionId\": \"f1ceef9b-0642-4053-af30-cf73bad74d8d\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-10-08T21:29:38.849Z\"\n },\n \"time\": \"2024-10-08T21:29:39.142Z\",\n \"version\": \"v1\"\n}"},{"id":"233650a2-f636-45d2-96b4-2cdd1df4335d","name":"TRANSACTION.CREDIT_CARD.REFUND.FAILED","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.CREDIT_CARD.REFUND.FAILED\",\n \"id\": \"6c2ef9a0-fe88-49c6-8bf8-650c47f01440\",\n \"payload\": {\n \"amount\": -0.01,\n \"createdAt\": \"2024-10-08T21:37:20.681Z\",\n \"eventName\": \"CreditCardInRefund\",\n \"externalId\": \"ec9bd318-2289-4b61-9137-57c562b1d40d\",\n \"fee\": 0,\n \"orderId\": \"b85104c4-1767-4456-bf83-6d604389adc4\",\n \"originalTransactionId\": \"f8c1be85-243a-4e72-b318-0dbcbac78904\",\n \"status\": \"failed\",\n \"transactionId\": \"117660f0-3ea8-475b-b8ec-596f852a2899\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-10-08T21:37:20.681Z\"\n },\n \"time\": \"2024-10-08T21:37:23.735Z\",\n \"version\": \"v1\"\n}"}],"_postman_id":"ff08cfde-4730-4080-a4cf-ce2b8c275b75"}],"id":"8ff6e1ea-e768-43f0-8266-827757126e8d","description":"This type of webhook records payment requests made via credit card, where the card issuer (typically a bank or financial institution) is responsible for processing the payment.
\nThis transaction is responsible for adding funds to an account. A pay-in transaction can originate in the following ways:
\nAuthorization: This stage involves the card issuer checking the availability of credit and other security factors (such as purchase history and suspicious behavior) before approving or denying the transaction. If approved, the payment is confirmed and reserved without debiting the card.
\nCapture: This stage refers to the confirmation and finalization of a previously authorized credit card transaction, resulting in the actual debit from the payer's account and the corresponding credit to the account.
\nReversal: This occurs when a cancellation transaction fails, and the amount is returned to the account through a pay-in reversal transaction.
\nThis transaction is responsible for debiting the balance from an account. A pay-out transaction can originate in the following ways:
\nCancellation: This process involves canceling part or all of the value of an order that has already been authorized.
\nChargeback: This process occurs when a credit or debit card transaction is disputed by the cardholder with the card issuer, leading to the transaction being canceled and the amount returned to the payer.
\nReserve: This transaction occurs when a portion of the amount from a credit card pay-in is reserved in an account that functions as a ledger, holding the funds temporarily before returning them to the original account.
\npending: Payment is pending and being processed
success: Payment has been processed successfully
failed: Payment failed
Pay In
\nTRANSACTION.CREDIT_CARD.CAPTURE.REQUESTED → pending
TRANSACTION.CREDIT_CARD.CAPTURE.SUCCEEDED → success
TRANSACTION.CREDIT_CARD.CAPTURE.FAILED → failed
TRANSACTION.CREDIT_CARD.AUTHORIZATION.REQUESTED → pending
TRANSACTION.CREDIT_CARD.AUTHORIZATION.SUCCEEDED → success
TRANSACTION.CREDIT_CARD.AUTHORIZATION.FAILED → failed
TRANSACTION.CREDIT_CARD.CANCELLATION.REVERSAL.SUCCEEDED → success
TRANSACTION.CREDIT_CARD.CANCELLATION.FAILED event occurs.TRANSACTION.CREDIT_CARD.REFUND.REVERSAL.SUCCEEDED
TRANSACTION.CREDIT_CARD.REFUND.FAILED event occurs → successPay Out
\nTRANSACTION.CREDIT_CARD.CANCELLATION.REQUESTED → pending
TRANSACTION.CREDIT_CARD.CANCELLATION.SUCCEEDED → success
TRANSACTION.CREDIT_CARD.CANCELLATION.FAILED → failed
TRANSACTION.CREDIT_CARD.CHARGEBACK.SUCCEEDED → pending
TRANSACTION.RESERVE.PAYMENT.SUCCEEDED → success
TRANSACTION.CREDIT_CARD.CAPTURE.SUCCEEDED event is reserved.TRANSACTION.CREDIT_CARD.REFUND.REQUESTED → pending
TRANSACTION.CREDIT_CARD.REFUND.SUCCEEDED → success
TRANSACTION.CREDIT_CARD.REFUND.FAILED → failed
{Transaction Type} refers to the type of transaction mentioned below:CAPTURE: Confirmation of the transaction, debiting the amount from the customer and crediting the merchant.
AUTHORIZATION: Initial verification that reserves the amount without debiting it.
CANCELLATION: Cancellation of a transaction, preventing or reversing the debit.
CHARGEBACK: Reversal of a transaction disputed by the customer, returning the amount.
Each example represents an event containing transaction information of the Pay In type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"1fe2246e-70e5-48b2-8c6e-2fc39c8e05b5","name":"TRANSACTION.DEPOSIT.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"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cd3a7dd1-9271-4a43-afea-50b7f7c2c2cb\",\n \"time\": \"2024-03-11T17:19:43.993Z\",\n \"event\": \"TRANSACTION.DEPOSIT.SUCCEEDED\",\n \"payload\": {\n \"amount\": 1000,\n \"externalId\": \"8aa125b4-1154-4c8b-9f06-b872f4b79a30\",\n \"eventName\": \"DepositIn\",\n \"type\": \"credit\",\n \"transactionId\": \"792f83f0-055c-4ac1-8e0b-8cc8e4187754\",\n \"status\": \"success\",\n \"createdAt\": \"2023-12-20T18:47:12.413Z\",\n \"updatedAt\": \"2023-12-20T18:47:12.413Z\"\n },\n \"version\": \"v1\"\n}"}],"_postman_id":"433ae901-61a3-4d53-a546-16c7bc766af5"},{"name":"Pay Out","id":"e7508876-183b-45e9-a38c-9cf967efea21","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":"d88341e8-ac07-43e2-9b09-349aad57e851","name":"TRANSACTION.WITHDRAWAL.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":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"TRANSACTION.WITHDRAWAL.SUCCEEDED\",\n \"id\": \"9f02a6fe-b5f8-4a3b-a8c9-ff2cd2eca1fa\",\n \"payload\": {\n \"amount\": -15,\n \"createdAt\": \"2024-07-26T15:00:09.001Z\",\n \"eventName\": \"WithdrawOut\",\n \"externalId\": \"c9b475f3-025e-4b10-a958-fcd76694edc9\",\n \"fee\": 0,\n \"status\": \"success\",\n \"transactionId\": \"a12c07de-65b4-497c-b93d-f50a93ef463b\",\n \"type\": \"debit\",\n \"updatedAt\": \"2024-07-26T15:00:09.001Z\"\n },\n \"time\": \"2024-07-26T15:00:09.697Z\",\n \"version\": \"v1\"\n}\n"}],"_postman_id":"e7508876-183b-45e9-a38c-9cf967efea21"}],"id":"38ab3d6f-21c6-4e5e-8793-42574820eb32","description":"This type of webhook records transactions initiated by the system administrator, including withdrawal or deposit requests.
\nThis transaction is responsible for adding funds to the account. It can be originated in the following way:
\nThis transaction is responsible for removing funds from the account. It can be originated in the following way:
\nsuccess: Payment has been processed successfullyPay In
\nTRANSACTION.DEPOSIT.SUCCEEDED → successPay Out
\nTRANSACTION.WITHDRAWAL.SUCCEEDED → success{Transaction Type} refers to the type of transaction as mentioned below:
DEPOSIT: Manual deposit operation performed by the administrator.
WITHDRAWAL: Manual withdrawal operation performed by the administrator.
Each example represents an event containing transaction information of the Pay In type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"c938574c-1794-48be-909c-2bebafd44b49","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\": \"OnlineBankTransferIn\",\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":"bb0e640a-f69f-4bdf-9fce-c8ddce518874","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\": \"OnlineBankTransferIn\",\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":"0d4e276f-a141-475e-ae1d-6e9147077a93","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\": \"OnlineBankTransferOutRefund\",\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":"5310fb3d-be37-48d4-b5d3-fa3d455d6353","name":"TRANSACTION.ONLINE_BANK_TRANSFER.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.ONLINE_BANK_TRANSFER.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\": \"OnlineBankTransferOutReversal\",\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":"2f238e3e-1eec-489a-a6dd-c778600881f9","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\": \"OnlineBankTransferInRefundReversal\",\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":"071e6de4-eab3-491b-b276-84f91f619887"},{"name":"Pay Out","id":"dc4108e5-ff49-4963-ae1e-14058aa4ab87","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":"f847b901-87c8-4cdf-853f-950c0f4eca7d","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\": \"OnlineBankTransferOut\",\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":"26c60b5d-59f8-45b5-8fdd-025437c938e3","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\": \"OnlineBankTransferOut\",\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":"5e0024de-8211-454f-9c43-f7ddb41458b3","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\": \"OnlineBankTransferOut\",\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":"6311519c-bafa-4470-9cd0-9cc6f71aaa5c","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\": \"OnlineBankTransferInRefund\",\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":"2a572ff7-246d-431c-80f4-ab36a248f660","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\": \"OnlineBankTransferInRefund\",\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":"80602b3a-2a07-4452-b88e-695415fa1bec","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\": \"OnlineBankTransferInRefund\",\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":"dc4108e5-ff49-4963-ae1e-14058aa4ab87"}],"id":"494aef05-63b5-459e-b650-38cf53dcc970","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":"34485cea-4f34-46ad-b891-74d790677c4c","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":"aa95614f-a018-4c8b-9cc5-dec9b236e97b","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":"66ce47e4-d068-489b-a933-30d01dc657b4","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":"4586b7a4-6c05-4b95-b706-1927a7a34d9c","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":"8f221068-1e4a-41bb-931a-2d878e82f3c6","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":"096814c3-b735-4c76-b5f2-89c726bd3f39"},{"name":"Pay Out","id":"6d02406d-b02f-4194-84ed-f6668baf1117","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":"38e22a06-4339-4ef1-b9d1-56b11e3052c3","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":"97ca4a33-2a62-45bf-8c99-0b71eb72bdcf","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":"e1531ceb-7627-4b27-92eb-559b01315da7","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":"2e5174f8-df9c-430b-83ba-f9a87b9ab072","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":"a6339e54-7376-4912-9239-2ea77bb1a79f","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":"93eb3209-2710-4e5d-9425-e2203c5b7939","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":"6d02406d-b02f-4194-84ed-f6668baf1117"}],"id":"d6baeea0-50fd-4412-a625-8abe3761634c","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":"e1362b91-be8e-451a-8387-01d68cf738c9","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":"9900ecc6-69a3-47c3-8ea9-1fa6893e6094","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":"d4bc18dc-6061-4a94-9020-7f14261232b6"}],"id":"8940e11d-bad3-4638-94c2-0fb7a35a9499","description":"Pay In
\nTRANSACTION.OXXO_PAY.RECEIVED.REQUESTED
TRANSACTION.OXXO_PAY.RECEIVED.SUCCEEDED
This type of webhook records payment requests made via SPEI, CODI and SPEI_CODI, an electronic payments system developed and operated by the Bank of Mexico.
\nThis transaction is responsible for adding funds to an account. A pay-in transaction can originate in the following ways:
\nURL (Uniform Resource Locator): The payer can access the link to complete the transaction quickly and securely.
\nReversal: This occurs when a pay-out transaction fails, and the amount is returned to the account through a pay-in reversal transaction.
\nRefund: This transfer is made when a mexican payment is returned to the account.
\nThis transaction is responsible for debiting the balance from an account. A pay-out transaction can originate in the following ways:
\nOutbound Transfers: The transfer is made using the personal details of the recipient account.
\nRefund: This transfer is made when a refund request is processed for a PIX pay-in transaction.
\nReserve: This transfer is made when a portion of the amount from a PIX pay-in is reserved in an account that acts as a ledger, holding the funds for a period before returning them to the original account.
\npending: Payment is pending and is currently being processed.
\nsuccess: Payment has been successfully processed.
\nfailed: Payment failed.
\nTRANSACTION.{mexican payment method}.RECEIVED.REQUESTED → pending
TRANSACTION.{mexican payment method}.RECEIVED.SUCCEEDED → success
TRANSACTION.{mexican payment method}.REFUNDED.SUCCEEDED → success
TRANSACTION.{mexican payment method}.REFUND.REVERSAL.SUCCEEDED → success
TRANSACTION.{mexican payment method}.REFUND.FAILED event.TRANSACTION.{mexican payment method}.PAYMENT.REQUESTED → pending
TRANSACTION.{mexican payment method}.PAYMENT.SUCCEEDED → success
TRANSACTION.{mexican payment method}.PAYMENT.FAILED → failed
TRANSACTION.{mexican payment method}.REFUND.REQUESTED → pending
TRANSACTION.{mexican payment method}.REFUND.SUCCEEDED → success
TRANSACTION.RESERVE.PAYMENT.SUCCEEDED → success
TRANSACTION.{mexican payment method}.RECEIVED.SUCCEEDED event is reserved.{Transaction Type} refers to the type of transaction mentioned below:
RECEIVED: Transfer received
REFUND: Transfer sent to return a received transfer
PAYMENT: Transfer sent
REFUNDED: Transfer received from the return of a sent transfer
Payment Method
\nSPEI : PayIn
CODI : PayIn
SPEI_CODI : PayIn/PayOut
A transaction represents a record of a payment, akin to a line entry in a cash book, where the details necessary to identify the payment or facilitate refund operations are stored.
\nTransactions can be of two types:
\nPayIn (credit):
This occurs when the account receives a transfer originating from an order, resulting in an increase in the account balance. The amount field will be positive.
PayOut (debit):
This occurs when the account sends a transfer, not necessarily linked to an order, leading to a decrease in the account balance. The amount field will be negative.
The fee field relates to the charging of fees. A positive value indicates that a previously charged fee was refunded, while a negative value denotes a fee charged for executing the transaction.
\n\nNote: All monetary values are represented as floating-point numbers with two decimal places.
\n
Example of Payload Field Data
\nFields marked as (Optional) may not be present in all events and will only be included if they exist in the record of the transaction that generated the event.
{\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 Account balance after transaction, always positive\n \"balanceAfterTransaction\": 1013217.69,\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 \"name\": \"Fee Name\",\n \"value\": 10\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\nEach example represents an event containing order information of the Pix type.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"b8c730f3-6078-46ce-bdf3-ce22e1db100f","name":"ORDER.PIX.OPENED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"a5976220-b67c-48a6-bad1-51031aae098f\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.PIX.OPENED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 100,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"pix\",\r\n \"information\": \"Pix order\",\r\n \"id\": \"3bff98e0-afcf-408a-9e93-40c14d2fa575\",\r\n \"status\": \"open\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"c5078110-398e-48c8-80fe-bfca9060360a","name":"ORDER.PIX.PAID","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"a5976220-b67c-48a6-bad1-51031aae098f\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.PIX.PAID\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 100,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"pix\",\r\n \"information\": \"Pix 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":"733ce072-60c7-457d-8642-c6fe7dd9efaa","name":"ORDER.PIX.FAILED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"event\": \"ORDER.PIX.FAILED\",\r\n \"id\": \"43de9466-57d8-45ef-96fa-cb02851d62aa\",\r\n \"payload\": {\r\n \"amount\": 2,\r\n \"createdAt\": \"2024-07-26T15:04:21.960Z\",\r\n \"id\": \"7340d249-f740-4a88-ad69-0c8e353430c5\",\r\n \"paymentMethod\": \"pix\",\r\n \"status\": \"failed\",\r\n \"updatedAt\": \"2024-07-26T15:04:21.960Z\"\r\n },\r\n \"time\": \"2024-07-26T15:04:22.271Z\",\r\n \"version\": \"v1\"\r\n}\r\n"}],"_postman_id":"4693cd95-bcc7-47f3-b62c-2c039aa0226e"}],"id":"806866c6-eca1-438d-8e5a-09c351391f02","description":"This type of webhook records transactions related to payment requests made through PIX, an instant payment system developed by the Central Bank of Brazil. Payments are processed using a QR code (Quick Response Code), which allows the payer to either scan the code with their mobile phone camera or copy it to complete the transaction quickly and securely.
\nopen: The request is open and awaiting payment
failed: The payment for the request failed or was rejected
paid: The payment was successful
ORDER.PIX.OPENED → open
ORDER.PIX.FAILED → failed
ORDER.PIX.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":"eae50dcc-37fc-4ed3-b7e8-bf00d2d63aa9","name":"ORDER.CREDITCARD.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.CREDITCARD.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\": \"creditCard\",\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":"28667378-a9ba-4f47-b558-23011c404766","name":"ORDER.CREDITCARD.AUTHORIZED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"c94fc9af-67c1-4c80-90e9-da4aad72100f\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.CREDITCARD.AUTHORIZED\",\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\": \"creditCard\",\r\n \"information\": \"Credit card order\",\r\n \"id\": \"5abb7012-802e-4564-891b-c5856a95fd56\",\r\n \"status\": \"authorized\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"6f7d62bc-da35-4832-a7af-06f61f1bf73f","name":"ORDER.CREDITCARD.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.CREDITCARD.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\": \"creditCard\",\r\n \"information\": \"Credit card 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":"93f5a8e5-a595-4c22-b2d0-0e13e457fe49","name":"ORDER.CREDITCARD.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.CREDITCARD.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\": \"creditCard\",\r\n \"information\": \"Credit card 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"},{"id":"e1b286fa-a420-4ae9-b73a-40d9e302f57d","name":"ORDER.CREDITCARD.UNAUTHORIZED","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.CREDITCARD.UNAUTHORIZED\",\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\": \"creditCard\",\r\n \"information\": \"Credit card order\",\r\n \"id\": \"fa60d0d0-2e50-43f5-a0c5-02673608af52\",\r\n \"status\": \"unauthorized\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"},{"id":"71f74f9f-4241-472c-bcc0-94f980c51ed1","name":"ORDER.CREDITCARD.CANCELED","originalRequest":{"method":"POST","header":[],"url":""},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"bf363eea-59fb-4266-b55b-f69ff57d9cee\",\r\n \"time\": \"2024-03-13T18:04:59.883Z\",\r\n \"event\": \"ORDER.CREDITCARD.CANCELED\",\r\n \"version\": \"v1\",\r\n \"payload\": {\r\n \"createdAt\": \"2024-03-13T18:12:02.610Z\",\r\n \"amount\": 0,\r\n \"externalId\": \"2d142d23-7d0b-4517-8433-6681\",\r\n \"paymentMethod\": \"creditCard\",\r\n \"information\": \"Credit card order\",\r\n \"id\": \"fa60d0d0-2e50-43f5-a0c5-02673608af52\",\r\n \"status\": \"canceled\",\r\n \"updatedAt\": \"2024-03-13T18:12:02.610Z\"\r\n }\r\n}\r\n"}],"_postman_id":"2ee32d2e-c898-455f-9a31-2ca1fb03698d"}],"id":"852aacb8-899a-40b5-990d-2ba3d14913f2","description":"This type of webhook records transactions related to payment requests made via credit card. In this process, the card issuer (usually a bank or financial institution) is responsible for processing the payment. A critical step in this process is authorization, which involves validating whether the payment can be processed based on factors such as credit limit, card validity, and other criteria defined by the card issuer.
\nopen: The request is open and awaiting payment
failed: Payment for the request failed or was rejected
paid: Payment was successful
authorized: Payment has been authorized by the card issuer
unauthorized: Payment was not authorized by the card issuer
canceled: The order has been canceled, meaning that no further payments can be created through this order.
ORDER.CREDITCARD.OPENED → open
ORDER.CREDITCARD.FAILED → failed
ORDER.CREDITCARD.PAID → paid
ORDER.CREDITCARD.AUTHORIZED → authorized
ORDER.CREDITCARD.UNAUTHORIZED → unauthorized
ORDER.CREDITCARD.CANCELED → canceled
{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":"4595eb75-e50e-4db9-a0d6-493db783ec15","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":"ce5753c0-4e03-40d4-a5e5-b253479a5825","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":"e85764ca-ce4e-452c-9299-de4aae70f6dd","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":"be8f5c53-883a-43fd-a8c8-8adc5ce6a7e9"}],"id":"8fe16f09-0191-4a25-a809-371e1c6eb361","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":"00d4b595-154c-43f0-b4ce-1f68dc33e7b9","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":"0394b71e-b072-4506-9d44-244404c5efa0","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":"c8561ca8-5735-4a81-8493-dcfb043c809d","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":"e5dde917-64a7-4280-8ed3-5ad943e9436a"}],"id":"12c3e18e-98ef-4d19-a522-fba04aa1ffa3","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":"7c7cd840-c2e7-4203-a7c6-b8707a941a96","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\": \"OxxoPay 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":"f0302a91-ec62-449a-8646-927e7392a3a2","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\": \"OxxoPay 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":"4f34991c-c558-4869-be22-b7971f4b0a0d","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\": \" OxxoPay 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":"29db2a61-7ebf-4ea7-ae57-c20598bbc8a5"}],"id":"35d3e9f6-b785-4b78-b9fb-ee4807f54b16","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 apiAn order represents a request for a charge, where the account has received an external transfer made by someone.
\nOrders are classified by payment method:
\nPix: Payment was received via a Pix transfer.Credit Card: Payment was received via a charge processed by the card issuer.Online Bank Transfer: Payment was received via a Online Bank transfer.\n\nNote: All monetary values are represented as floating-point numbers with two decimal places.
\n
Example of Payload Field Data
\nFields marked as (Optional) may not be present in every event, and they will only be included if they exist in the order record that generated the event.
{\n \"amount\": 100.50, // Order amount, awas positive\n (Optional)\n \"externalId\": \"Idempotency key\",\n \"paymentMethod\": \"pix\" | \"creditCard\",\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\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
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 \"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
PRODUCTION: 44.213.150.110
Example Webhook Data
\nThe data in the payload property depends on the entity type, examples of data present in each entity below. The list of possible events will be described in each section.
{\n Event type of the Webhook Event\n \"event\": \"ENTITY.PAYMENT_METHOD.TYPE.STATUS\" | \"ENTITY.PAYMENT_METHOD.STATUS\",\n \"id\": \"Webhook event identifier\",\n \"payload\": {},\n \"time\": \"Time of webhook event creation\",\n \"version\": \"Version of the wehook API\"\n}\n\nRetry proccess
\nIn cases where an unexpected status code is received during a webhook attempt, the attempt is cached for a retry. The retry is scheduled based on the number of previous attempts, with increasing time intervals between each attempt. After ten failed attempts, the system will cease retrying, and the attempt will be removed from the cache. The table below outlines the retry intervals:
\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 Example for HMAC Validation
\nThe following example demonstrates how to convert the webhook payload to a JSON string and then use the CryptoJS library's HmacSHA256 function to generate the HMAC hash. The secret key, which is generated when registering the webhook in the merchant panel, is used in this process. The generated HMAC hash is then compared with the one received to verify its validity.
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\n