{ "item": [ { "id": "1056eca6-a87d-4e95-8efd-226c4a85f133", "name": "Token", "description": { "content": "Authentication and access token issuance", "type": "text/plain" }, "item": [ { "id": "1f363cbe-b5ee-4252-94eb-1bf475dc58bf", "name": "Get API token", "request": { "name": "Get API token", "description": { "content": "Returns a JWT token to authenticate the routes. Send your account's `client_id` and `client_secret` via Basic Auth, over the mTLS connection.\n\nSee [Authentication](https://docs.payzu.com.br/docs/cartao/authentication).", "type": "text/plain" }, "url": { "path": [ "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "540cd968-65ca-4e55-a271-9b1023bb95ad", "name": "Successful request", "originalRequest": { "url": { "path": [ "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c5e0be1c-6906-472d-9734-244c2a030886", "name": "Charges", "description": { "content": "Creation, query and reversal of card charges", "type": "text/plain" }, "item": [ { "id": "8cbd4b1c-8d98-4be4-a1ca-9543deeebba8", "name": "Create Charge", "request": { "name": "Create Charge", "description": { "content": "Creates a new credit card charge.\n\n- For 3DS authentication, see [Using 3DS](https://docs.payzu.com.br/docs/cartao/three-d-secure).\n- For the antifraud engine, see [Using Antifraud](https://docs.payzu.com.br/docs/cartao/antifraud).\n- For foreign currency charges, see [International charges](https://docs.payzu.com.br/docs/cartao/international).\n- For recurring payments, send the `recurrence` node. See [Recurring Payments](https://docs.payzu.com.br/docs/cartao/recurrence).", "type": "text/plain" }, "url": { "path": [ "charges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 10000,\n \"paymentType\": \"creditcard\",\n \"externalId\": \"pedido-1234\",\n \"postbackUrl\": \"https://seusite.com.br/webhooks/payzu\",\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"identity\": \"11144477735\",\n \"identityType\": \"CPF\",\n \"email\": \"maria.souza@example.com\",\n \"phone\": \"11999998888\"\n },\n \"cart\": [\n {\n \"name\": \"Plano Pro\",\n \"quantity\": 1,\n \"sku\": \"PRO\",\n \"unitPrice\": 10000\n }\n ],\n \"creditCardPayment\": {\n \"installments\": 1,\n \"authenticate\": false,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"holder\": \"MARIA SOUZA\",\n \"expiration\": \"12/2030\",\n \"cvv\": \"123\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4fb1a931-dcb3-4fca-b901-4e1881f1e67a", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 10000,\n \"paymentType\": \"creditcard\",\n \"externalId\": \"pedido-1234\",\n \"postbackUrl\": \"https://seusite.com.br/webhooks/payzu\",\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"identity\": \"11144477735\",\n \"identityType\": \"CPF\",\n \"email\": \"maria.souza@example.com\",\n \"phone\": \"11999998888\"\n },\n \"cart\": [\n {\n \"name\": \"Plano Pro\",\n \"quantity\": 1,\n \"sku\": \"PRO\",\n \"unitPrice\": 10000\n }\n ],\n \"creditCardPayment\": {\n \"installments\": 1,\n \"authenticate\": false,\n \"card\": {\n \"number\": \"4111111111111111\",\n \"holder\": \"MARIA SOUZA\",\n \"expiration\": \"12/2030\",\n \"cvv\": \"123\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"externalId\": \"pedido-1234\",\n \"postbackUrl\": \"https://seusite.com.br/webhooks/payzu\",\n \"amount\": 10000,\n \"paymentType\": \"creditcard\",\n \"createdAt\": \"2026-06-12T14:35:22.000Z\",\n \"updatedAt\": \"2026-06-12T14:35:24.000Z\",\n \"customer\": {\n \"id\": 501,\n \"name\": \"Maria Souza\",\n \"identity\": \"11144477735\",\n \"identityType\": \"CPF\",\n \"email\": \"maria.souza@example.com\",\n \"birthdate\": \"1990-04-15\",\n \"phone\": \"11999998888\",\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"zipCode\": \"01310100\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BR\",\n \"district\": \"Bela Vista\",\n \"complement\": \"Conjunto 101\"\n }\n },\n \"cart\": [\n {\n \"name\": \"Plano Pro\",\n \"quantity\": 1,\n \"sku\": \"PRO\",\n \"unitPrice\": 10000\n }\n ],\n \"creditCardPayment\": {\n \"installments\": 1,\n \"authenticate\": false,\n \"currency\": \"BRL\",\n \"acquirerTransactionId\": \"1049329871283a5d2b8e\",\n \"authorizationCode\": \"128734\",\n \"reasonCode\": 0,\n \"reasonMessage\": \"Successful\",\n \"status\": 2,\n \"returnCode\": \"6\",\n \"returnMessage\": \"Operação realizada com sucesso\",\n \"externalAuthentication\": {},\n \"reversedAmount\": null,\n \"reversedDate\": null,\n \"chargeId\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"card\": {\n \"id\": 42,\n \"number\": \"4111111111111111\",\n \"holder\": \"MARIA SOUZA\",\n \"expiration\": \"12/2030\",\n \"brand\": \"Visa\"\n },\n \"chargebacks\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3f322bf-2892-4136-b872-575232a141d7", "name": "List Charges", "request": { "name": "List Charges", "description": { "content": "Returns a list of charges", "type": "text/plain" }, "url": { "path": [ "charges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startDate", "value": "string", "description": "Start date to filter the results" }, { "disabled": false, "key": "endDate", "value": "string", "description": "End date to filter the results" }, { "disabled": false, "key": "limit", "value": "10", "description": "Maximum number of items to return in the query" }, { "disabled": false, "key": "page", "value": "1", "description": "Page number for result pagination" }, { "disabled": false, "key": "recurrentPaymentId", "value": "string", "description": "Filters the initial charge and the cycles generated by a recurrence" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f7f1e769-932f-4b2d-969e-e9a944e6831e", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "string" }, { "key": "endDate", "value": "string" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" }, { "key": "recurrentPaymentId", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"page\": 1,\n \"total\": 1,\n \"totalPages\": 1,\n \"charges\": [\n {\n \"id\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"externalId\": \"pedido-1234\",\n \"postbackUrl\": \"https://seusite.com.br/webhooks/payzu\",\n \"amount\": 10000,\n \"paymentType\": \"creditcard\",\n \"createdAt\": \"2026-06-12T14:35:22.000Z\",\n \"updatedAt\": \"2026-06-12T14:35:24.000Z\",\n \"customer\": {\n \"id\": 501,\n \"name\": \"Maria Souza\",\n \"identity\": \"11144477735\",\n \"identityType\": \"CPF\",\n \"email\": \"maria.souza@example.com\",\n \"birthdate\": \"1990-04-15\",\n \"phone\": \"11999998888\",\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"zipCode\": \"01310100\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BR\",\n \"district\": \"Bela Vista\",\n \"complement\": \"Conjunto 101\"\n }\n },\n \"cart\": [\n {\n \"name\": \"Plano Pro\",\n \"quantity\": 1,\n \"sku\": \"PRO\",\n \"unitPrice\": 10000\n }\n ],\n \"creditCardPayment\": {\n \"installments\": 1,\n \"authenticate\": false,\n \"currency\": \"BRL\",\n \"acquirerTransactionId\": \"1049329871283a5d2b8e\",\n \"authorizationCode\": \"128734\",\n \"reasonCode\": 0,\n \"reasonMessage\": \"Successful\",\n \"status\": 2,\n \"returnCode\": \"6\",\n \"returnMessage\": \"Operação realizada com sucesso\",\n \"externalAuthentication\": {},\n \"reversedAmount\": null,\n \"reversedDate\": null,\n \"chargeId\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"card\": {\n \"id\": 42,\n \"number\": \"4111111111111111\",\n \"holder\": \"MARIA SOUZA\",\n \"expiration\": \"12/2030\",\n \"brand\": \"Visa\"\n },\n \"chargebacks\": []\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "660416df-d1a1-41fc-b5a5-1f1cc0f9cd85", "name": "Retrieve Charge", "request": { "name": "Retrieve Charge", "description": { "content": "Returns the details of a given charge", "type": "text/plain" }, "url": { "path": [ "charges", ":chargeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "chargeId", "description": "(Required) Charge id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "b40e7c49-772e-4080-888c-acd895376a36", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges", ":chargeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "chargeId", "description": "(Required) Charge id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"externalId\": \"pedido-1234\",\n \"postbackUrl\": \"https://seusite.com.br/webhooks/payzu\",\n \"amount\": 10000,\n \"paymentType\": \"creditcard\",\n \"createdAt\": \"2026-06-12T14:35:22.000Z\",\n \"updatedAt\": \"2026-06-12T14:35:24.000Z\",\n \"customer\": {\n \"id\": 501,\n \"name\": \"Maria Souza\",\n \"identity\": \"11144477735\",\n \"identityType\": \"CPF\",\n \"email\": \"maria.souza@example.com\",\n \"birthdate\": \"1990-04-15\",\n \"phone\": \"11999998888\",\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"zipCode\": \"01310100\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BR\",\n \"district\": \"Bela Vista\",\n \"complement\": \"Conjunto 101\"\n }\n },\n \"cart\": [\n {\n \"name\": \"Plano Pro\",\n \"quantity\": 1,\n \"sku\": \"PRO\",\n \"unitPrice\": 10000\n }\n ],\n \"creditCardPayment\": {\n \"installments\": 1,\n \"authenticate\": false,\n \"currency\": \"BRL\",\n \"acquirerTransactionId\": \"1049329871283a5d2b8e\",\n \"authorizationCode\": \"128734\",\n \"reasonCode\": 0,\n \"reasonMessage\": \"Successful\",\n \"status\": 2,\n \"returnCode\": \"6\",\n \"returnMessage\": \"Operação realizada com sucesso\",\n \"externalAuthentication\": {},\n \"reversedAmount\": null,\n \"reversedDate\": null,\n \"chargeId\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"card\": {\n \"id\": 42,\n \"number\": \"4111111111111111\",\n \"holder\": \"MARIA SOUZA\",\n \"expiration\": \"12/2030\",\n \"brand\": \"Visa\"\n },\n \"chargebacks\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46d1dddf-8b86-4a0d-9d66-d018dd3a8e6c", "name": "Reverse Charge", "request": { "name": "Reverse Charge", "description": { "content": "Refunds the full amount of a paid charge. Only a charge with creditCardPayment.status 2 (PaymentConfirmed) can be refunded, and only once. Partial refunds are not accepted: do not send amount.", "type": "text/plain" }, "url": { "path": [ "charges", ":chargeId", "reverse" ], "host": [ "{{baseUrl}}" ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "chargeId", "description": "(Required) Charge id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT" }, "response": [ { "id": "e854c773-5d3a-4f9e-a729-069799f7a940", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges", ":chargeId", "reverse" ], "host": [ "{{baseUrl}}" ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "chargeId", "description": "(Required) Charge id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"externalId\": \"pedido-1234\",\n \"postbackUrl\": \"https://seusite.com.br/webhooks/payzu\",\n \"amount\": 10000,\n \"paymentType\": \"creditcard\",\n \"createdAt\": \"2026-06-12T14:35:22.000Z\",\n \"updatedAt\": \"2026-06-12T14:35:24.000Z\",\n \"customer\": {\n \"id\": 501,\n \"name\": \"Maria Souza\",\n \"identity\": \"11144477735\",\n \"identityType\": \"CPF\",\n \"email\": \"maria.souza@example.com\",\n \"birthdate\": \"1990-04-15\",\n \"phone\": \"11999998888\",\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"zipCode\": \"01310100\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"BR\",\n \"district\": \"Bela Vista\",\n \"complement\": \"Conjunto 101\"\n }\n },\n \"cart\": [\n {\n \"name\": \"Plano Pro\",\n \"quantity\": 1,\n \"sku\": \"PRO\",\n \"unitPrice\": 10000\n }\n ],\n \"creditCardPayment\": {\n \"installments\": 1,\n \"authenticate\": false,\n \"currency\": \"BRL\",\n \"acquirerTransactionId\": \"1049329871283a5d2b8e\",\n \"authorizationCode\": \"128734\",\n \"reasonCode\": 0,\n \"reasonMessage\": \"Successful\",\n \"status\": 11,\n \"returnCode\": \"6\",\n \"returnMessage\": \"Operação realizada com sucesso\",\n \"externalAuthentication\": {},\n \"reversedAmount\": 10000,\n \"reversedDate\": \"2026-06-13T09:12:45.000Z\",\n \"chargeId\": \"e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90\",\n \"card\": {\n \"id\": 42,\n \"number\": \"4111111111111111\",\n \"holder\": \"MARIA SOUZA\",\n \"expiration\": \"12/2030\",\n \"brand\": \"Visa\"\n },\n \"chargebacks\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b9d5b11e-c5f1-4adb-aaf5-a407e5ef2a87", "name": "Recurrences", "description": { "content": "Query and management of recurring payments", "type": "text/plain" }, "item": [ { "id": "88a780f3-aa55-4d67-8699-ab1903a48864", "name": "Retrieve Recurrence", "request": { "name": "Retrieve Recurrence", "description": { "content": "Returns the current state of the recurrence.\n\nTo list the initial charge and the cycles already generated, use [List Charges](https://docs.payzu.com.br/docs/cartao/endpoints/charges/get_charges) with the `recurrentPaymentId` filter.", "type": "text/plain" }, "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "47b55f13-6cd4-49eb-9db6-1a8273cb11d1", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"recurrentPaymentId\": \"5f1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n \"interval\": \"MONTHLY\",\n \"status\": \"ACTIVE\",\n \"amount\": 10000,\n \"nextRecurrency\": \"2026-07-12T00:00:00.000Z\",\n \"endDate\": \"2027-06-12T00:00:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14c2080c-585a-425b-90ae-77d8cc56d922", "name": "Update Recurrence amount", "request": { "name": "Update Recurrence amount", "description": { "content": "Updates the amount of the next charges of the recurrence. Cycles already generated are not affected.", "type": "text/plain" }, "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId", "amount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": 12000\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ddaf7570-cdf5-443a-8f9e-e4b45b4119de", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId", "amount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"amount\": 12000\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"recurrentPaymentId\": \"5f1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n \"interval\": \"MONTHLY\",\n \"status\": \"ACTIVE\",\n \"amount\": 12000,\n \"nextRecurrency\": \"2026-07-12T00:00:00.000Z\",\n \"endDate\": \"2027-06-12T00:00:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18f94532-2c88-4437-b6a7-b3c1f6d1ab49", "name": "Deactivate Recurrence", "request": { "name": "Deactivate Recurrence", "description": { "content": "Stops the recurrence: no new cycle is generated and the status becomes `INACTIVE`.", "type": "text/plain" }, "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT" }, "response": [ { "id": "d12318e8-6647-4292-aa00-4b44b9e958ae", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"recurrentPaymentId\": \"5f1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n \"interval\": \"MONTHLY\",\n \"status\": \"INACTIVE\",\n \"amount\": 10000,\n \"nextRecurrency\": \"2026-07-12T00:00:00.000Z\",\n \"endDate\": \"2027-06-12T00:00:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44a86e00-ba30-4895-8ec2-dde355e69dd0", "name": "Reactivate Recurrence", "request": { "name": "Reactivate Recurrence", "description": { "content": "Resumes a deactivated recurrence: the status returns to `ACTIVE` and cycles are generated again.", "type": "text/plain" }, "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT" }, "response": [ { "id": "a1cd7e01-4d12-40f8-a089-2442344ee1c8", "name": "Successful request", "originalRequest": { "url": { "path": [ "charges", "recurrences", ":recurrentPaymentId", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "recurrentPaymentId", "description": "(Required) Recurrence id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"recurrentPaymentId\": \"5f1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n \"interval\": \"MONTHLY\",\n \"status\": \"ACTIVE\",\n \"amount\": 10000,\n \"nextRecurrency\": \"2026-07-12T00:00:00.000Z\",\n \"endDate\": \"2027-06-12T00:00:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b4cc2aa9-cc4a-40bb-b69d-4867ecf91590", "name": "Currencies", "description": { "content": "Foreign-exchange reference rates and conversion for international charges", "type": "text/plain" }, "item": [ { "id": "e8c87557-b440-46c7-bc27-ce31a7226ca8", "name": "Get currency rate", "request": { "name": "Get currency rate", "description": { "content": "Returns the current bid/ask rate for a currency, in BRL per foreign unit.", "type": "text/plain" }, "url": { "path": [ "currencies", ":code", "rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "USD", "key": "code", "description": "(Required) ISO 4217 currency code. BRL is not accepted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "872041a2-78cb-44d6-870b-396ae7e277ca", "name": "Current rate.", "originalRequest": { "url": { "path": [ "currencies", ":code", "rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "USD", "key": "code", "description": "(Required) ISO 4217 currency code. BRL is not accepted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"USD\",\n \"rate\": {\n \"bid\": 5.42,\n \"ask\": 5.43\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fb956ee-b7dd-4cb6-89aa-b3783f387f27", "name": "Convert amount", "request": { "name": "Convert amount", "description": { "content": "Converts an amount given in BRL cents to the target currency, using the bid or ask rate.", "type": "text/plain" }, "url": { "path": [ "currencies", ":code", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "amount", "value": "10000", "description": "(Required) Amount in BRL cents. Minimum 100 (R$1.00)." }, { "disabled": false, "key": "type", "value": "ask", "description": "(Required) Which side of the rate to use." } ], "variable": [ { "disabled": false, "type": "any", "value": "USD", "key": "code", "description": "(Required) ISO 4217 currency code. BRL is not accepted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e2a26c27-7329-43c7-be8a-0d42d8d93c1f", "name": "Converted amount.", "originalRequest": { "url": { "path": [ "currencies", ":code", "convert" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "amount", "value": "10000" }, { "key": "type", "value": "ask" } ], "variable": [ { "disabled": false, "type": "any", "value": "USD", "key": "code", "description": "(Required) ISO 4217 currency code. BRL is not accepted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": 1841.62,\n \"currency\": {\n \"code\": \"USD\",\n \"rate\": {\n \"ask\": 5.43\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8563b5d-7fe5-4903-84ff-0a0591222028", "name": "List currency rates", "request": { "name": "List currency rates", "description": { "content": "Lists the bid/ask rates for every currency from the latest BCB close.", "type": "text/plain" }, "url": { "path": [ "currencies", "rates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "d2b96e8b-f913-454c-9f07-eef71a0df0c8", "name": "List of rates.", "originalRequest": { "url": { "path": [ "currencies", "rates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"USD\",\n \"rate\": {\n \"bid\": 5.42,\n \"ask\": 5.43\n }\n },\n {\n \"code\": \"EUR\",\n \"rate\": {\n \"bid\": 5.88,\n \"ask\": 5.89\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.payzu.io/v1", "type": "string", "description": "Base URL da API PayZu Cartão (sandbox: https://api.sandbox.payzu.io/v1)" }, { "key": "token", "value": "", "type": "string", "description": "Bearer token PayZu" }, { "key": "basicAuthUsername", "value": "", "type": "string", "description": "Usuário do Basic Auth usado só na rota de emissão de token" }, { "key": "basicAuthPassword", "value": "", "type": "string", "description": "Senha do Basic Auth usada só na rota de emissão de token" } ], "info": { "_postman_id": "6bbced5b-25b2-4969-85fb-56e01ea3e2ec", "name": "PayZu Credit Card API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Esta API exige conexão mTLS. Sem certificado de cliente configurado, o servidor encerra a conexão logo depois do envio da requisição e o Postman mostra erro de socket. Isso não indica indisponibilidade da API. Configure o certificado em Settings, Certificates, para o host api.payzu.io.\n\nPayZu credit card charges API: authorization, 3DS, antifraud, recurring payments, reversals and chargebacks.\n\nAuthentication: mTLS + Bearer token. See [Authentication](https://docs.payzu.com.br/docs/cartao/authentication).\n\nGuides and full reference at [docs.payzu.com.br/docs/cartao](https://docs.payzu.com.br/docs/cartao)." }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] } }