{ "info": { "name": "PayZu Conta Digital API", "description": "PayZu Digital Account API: Pix charges, withdrawals, Pix copy-and-paste payments, transfers between accounts, Pix keys, statement, MED disputes and webhooks.\n\nAmounts in cents, percentages in basis points (`150` = 1.5%), dates in ISO 8601 (UTC). Every operation runs on the credential account.\n\nHow to authenticate: [Authentication](https://docs.payzu.com.br/en/docs/conta-digital/authentication). Guides and full reference at [docs.payzu.com.br/en/docs/conta-digital](https://docs.payzu.com.br/en/docs/conta-digital).\n\nRun \"Get access token\" first: it stores the access token in the `token` variable.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.hub.payzu.com.br/api/v1" }, { "key": "clientId", "value": "" }, { "key": "clientSecret", "value": "" }, { "key": "token", "value": "" } ], "item": [ { "name": "oauth", "item": [ { "name": "token", "item": [ { "name": "Get access token", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "token" ] }, "description": "Exchanges the credential for an access token valid for 15 minutes. Send `client_id` and `client_secret` in the `Authorization: Basic` header or in the body, as `application/x-www-form-urlencoded` or JSON. Exchanges are limited per `client_id` and IP, and the credential IP allowlist applies here too.", "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials" } ] }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{clientId}}", "type": "string" }, { "key": "password", "value": "{{clientSecret}}", "type": "string" } ] } }, "response": [ { "name": "Token issued", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "token" ] }, "description": "Exchanges the credential for an access token valid for 15 minutes. Send `client_id` and `client_secret` in the `Authorization: Basic` header or in the body, as `application/x-www-form-urlencoded` or JSON. Exchanges are limited per `client_id` and IP, and the credential IP allowlist applies here too.", "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials" } ] }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{clientId}}", "type": "string" }, { "key": "password", "value": "{{clientSecret}}", "type": "string" } ] } }, "status": "Token issued.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..mQ3Zy1hbVhpbXBsZQ.ZXhlbXBsbw.c2lnbmF0dXJl\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 900,\n \"scope\": \"PAYMENT_WRITE PAYMENT_READ STATEMENT_READ\"\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 200) {", " pm.collectionVariables.set('token', pm.response.json().access_token);", "}" ] } } ] } ] } ] }, { "name": "transactions", "item": [ { "name": "payment", "item": [ { "name": "Create Pix charge", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/payment", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment" ] }, "description": "Scope: `PAYMENT_WRITE`.\n\nGenerates a charge and returns the Pix copy-and-paste code your customer will pay. The code comes in `pix.qrCodeText`. The charge starts as `PENDING`; the balance changes when the payment is confirmed, and the confirmation arrives through the `PAYMENT_PAID` webhook. Request limit: 60 per minute per credential and 120 per account.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1500,\n \"method\": \"PIX\",\n \"description\": \"Pedido 4821\",\n \"externalRef\": \"pedido-4821\",\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"email\": \"maria.souza@exemplo.com\",\n \"phone\": \"+5511999998888\"\n },\n \"metadata\": {\n \"pedido\": \"4821\",\n \"canal\": \"checkout-web\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Existing charge", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/payment", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment" ] }, "description": "Scope: `PAYMENT_WRITE`.\n\nGenerates a charge and returns the Pix copy-and-paste code your customer will pay. The code comes in `pix.qrCodeText`. The charge starts as `PENDING`; the balance changes when the payment is confirmed, and the confirmation arrives through the `PAYMENT_PAID` webhook. Request limit: 60 per minute per credential and 120 per account.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1500,\n \"method\": \"PIX\",\n \"description\": \"Pedido 4821\",\n \"externalRef\": \"pedido-4821\",\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"email\": \"maria.souza@exemplo.com\",\n \"phone\": \"+5511999998888\"\n },\n \"metadata\": {\n \"pedido\": \"4821\",\n \"canal\": \"checkout-web\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "The `externalRef` already had a charge with the same data; it is returned and nothing is created.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005K7Q2M9XB4T127431\",\n \"method\": \"PIX\",\n \"status\": \"PENDING\",\n \"amount\": 1500,\n \"description\": \"Pedido 4821\",\n \"serviceFee\": 105,\n \"netAmount\": 1395,\n \"refundedAmount\": 0,\n \"refundFee\": 0,\n \"refundInProgressAmount\": 0,\n \"refundableAmount\": 0,\n \"openInfractionProtocol\": null,\n \"externalRef\": \"pedido-4821\",\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T14:32:05.123Z\",\n \"paidAt\": null,\n \"refundedAt\": null,\n \"pix\": {\n \"qrCodeText\": \"00020126580014br.gov.bcb.pix0136b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03520400005303986540515.005802BR5912LOJA EXEMPLO6009SAO PAULO62070503***63041EC4\",\n \"qrCodeUrl\": null,\n \"qrCodeBase64\": null,\n \"conciliationId\": null\n },\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"email\": \"maria.souza@exemplo.com\",\n \"phone\": \"+5511999998888\"\n },\n \"payer\": null,\n \"refunds\": []\n}" }, { "name": "Charge created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/payment", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment" ] }, "description": "Scope: `PAYMENT_WRITE`.\n\nGenerates a charge and returns the Pix copy-and-paste code your customer will pay. The code comes in `pix.qrCodeText`. The charge starts as `PENDING`; the balance changes when the payment is confirmed, and the confirmation arrives through the `PAYMENT_PAID` webhook. Request limit: 60 per minute per credential and 120 per account.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1500,\n \"method\": \"PIX\",\n \"description\": \"Pedido 4821\",\n \"externalRef\": \"pedido-4821\",\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"email\": \"maria.souza@exemplo.com\",\n \"phone\": \"+5511999998888\"\n },\n \"metadata\": {\n \"pedido\": \"4821\",\n \"canal\": \"checkout-web\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Charge created.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005K7Q2M9XB4T127431\",\n \"method\": \"PIX\",\n \"status\": \"PENDING\",\n \"amount\": 1500,\n \"description\": \"Pedido 4821\",\n \"serviceFee\": 105,\n \"netAmount\": 1395,\n \"refundedAmount\": 0,\n \"refundFee\": 0,\n \"refundInProgressAmount\": 0,\n \"refundableAmount\": 0,\n \"openInfractionProtocol\": null,\n \"externalRef\": \"pedido-4821\",\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T14:32:05.123Z\",\n \"paidAt\": null,\n \"refundedAt\": null,\n \"pix\": {\n \"qrCodeText\": \"00020126580014br.gov.bcb.pix0136b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03520400005303986540515.005802BR5912LOJA EXEMPLO6009SAO PAULO62070503***63041EC4\",\n \"qrCodeUrl\": null,\n \"qrCodeBase64\": null,\n \"conciliationId\": null\n },\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"email\": \"maria.souza@exemplo.com\",\n \"phone\": \"+5511999998888\"\n },\n \"payer\": null,\n \"refunds\": []\n}" } ] }, { "name": "List charges", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/payment?externalRef=pedido-4821", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "method", "value": "", "description": "Payment method.", "disabled": true }, { "key": "status", "value": "", "description": "Charge status.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "search", "value": "", "description": "Id, name or document of the customer informed on creation. 3 to 120 characters.", "disabled": true }, { "key": "externalRef", "value": "pedido-4821", "description": "Your reference, exact match.", "disabled": false } ] }, "description": "Scope: `PAYMENT_READ`.\n\nReturns the account charges, newest first, cursor paginated." }, "response": [ { "name": "Page of charges", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/payment?externalRef=pedido-4821", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "method", "value": "", "description": "Payment method.", "disabled": true }, { "key": "status", "value": "", "description": "Charge status.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "search", "value": "", "description": "Id, name or document of the customer informed on creation. 3 to 120 characters.", "disabled": true }, { "key": "externalRef", "value": "pedido-4821", "description": "Your reference, exact match.", "disabled": false } ] }, "description": "Scope: `PAYMENT_READ`.\n\nReturns the account charges, newest first, cursor paginated." }, "status": "Page of charges.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"hubp-20261005K7Q2M9XB4T127431\",\n \"method\": \"PIX\",\n \"status\": \"PAID\",\n \"amount\": 1500,\n \"netAmount\": 1395,\n \"refundedAmount\": 0,\n \"refundInProgressAmount\": 0,\n \"description\": \"Pedido 4821\",\n \"payerName\": \"Maria Souza\",\n \"payerDocument\": \"52998224725\",\n \"createdAt\": \"2026-10-05T14:32:05.123Z\",\n \"paidAt\": \"2026-10-05T14:33:10.004Z\"\n }\n ],\n \"nextCursor\": \"cmu2wbljx0000e8gtlic8q1gi\"\n}" } ] }, { "name": "{paymentId}", "item": [ { "name": "Get charge", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/payment/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment", ":paymentId" ], "variable": [ { "key": "paymentId", "value": "hubp-20261005K7Q2M9XB4T127431", "description": "Charge identifier." } ] }, "description": "Scope: `PAYMENT_READ`.\n\nReturns a charge with its Pix copy-and-paste code, the payer and the refunds. Accepts the charge `id` and the webhook `paymentId`." }, "response": [ { "name": "Paid charge", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/payment/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment", ":paymentId" ], "variable": [ { "key": "paymentId", "value": "hubp-20261005K7Q2M9XB4T127431", "description": "Charge identifier." } ] }, "description": "Scope: `PAYMENT_READ`.\n\nReturns a charge with its Pix copy-and-paste code, the payer and the refunds. Accepts the charge `id` and the webhook `paymentId`." }, "status": "Charge.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005K7Q2M9XB4T127431\",\n \"method\": \"PIX\",\n \"status\": \"PAID\",\n \"amount\": 1500,\n \"description\": \"Pedido 4821\",\n \"serviceFee\": 105,\n \"netAmount\": 1395,\n \"refundedAmount\": 0,\n \"refundFee\": 0,\n \"refundInProgressAmount\": 0,\n \"refundableAmount\": 1500,\n \"openInfractionProtocol\": null,\n \"externalRef\": \"pedido-4821\",\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T14:32:05.123Z\",\n \"paidAt\": \"2026-10-05T14:33:10.004Z\",\n \"refundedAt\": null,\n \"pix\": {\n \"qrCodeText\": \"00020126580014br.gov.bcb.pix0136b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03520400005303986540515.005802BR5912LOJA EXEMPLO6009SAO PAULO62070503***63041EC4\",\n \"qrCodeUrl\": null,\n \"qrCodeBase64\": null,\n \"conciliationId\": \"E99999999202610051433a1b2c3d4e5f\"\n },\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"email\": \"maria.souza@exemplo.com\",\n \"phone\": \"+5511999998888\"\n },\n \"payer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"***.982.247-**\",\n \"bankName\": \"Banco Exemplo S.A.\"\n },\n \"refunds\": []\n}" } ] }, { "name": "receipt", "item": [ { "name": "Charge receipt", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/payment/:paymentId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment", ":paymentId", "receipt" ], "variable": [ { "key": "paymentId", "value": "hubp-20261005K7Q2M9XB4T127431", "description": "Charge identifier." } ] }, "description": "Scope: `PAYMENT_READ`.\n\nReturns the charge receipt as a PDF, base64 encoded. Only for `PAID` or `REFUNDED` charges." }, "response": [ { "name": "Receipt", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/payment/:paymentId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment", ":paymentId", "receipt" ], "variable": [ { "key": "paymentId", "value": "hubp-20261005K7Q2M9XB4T127431", "description": "Charge identifier." } ] }, "description": "Scope: `PAYMENT_READ`.\n\nReturns the charge receipt as a PDF, base64 encoded. Only for `PAID` or `REFUNDED` charges." }, "status": "Receipt.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"filename\": \"comprovante-pix-hubp-20261005K7Q2M9XB4T127431.pdf\",\n \"contentType\": \"application/pdf\",\n \"fileBase64\": \"JVBERi0xLjcKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCvkMlAwUDC1NNUzMjNSMDEz\"\n}" } ] } ] }, { "name": "refund", "item": [ { "name": "Refund charge", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/payment/:paymentId/refund", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment", ":paymentId", "refund" ], "variable": [ { "key": "paymentId", "value": "hubp-20261005K7Q2M9XB4T127431", "description": "Charge identifier." } ] }, "description": "Scope: `REFUND`.\n\nReturns all or part of the amount of a paid charge to the payer. Without `amount`, returns the remaining amount; the refund fee is added on top. The amount leaves the available balance when you make the request and returns if the refund fails. One refund at a time per charge; the result arrives through the `REFUND_COMPLETED` or `REFUND_FAILED` webhooks. Counts towards the withdrawal request limit. Does not accept `Idempotency-Key`: on a `502`, get the charge before retrying.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1000\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Refund on its way", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/payment/:paymentId/refund", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "payment", ":paymentId", "refund" ], "variable": [ { "key": "paymentId", "value": "hubp-20261005K7Q2M9XB4T127431", "description": "Charge identifier." } ] }, "description": "Scope: `REFUND`.\n\nReturns all or part of the amount of a paid charge to the payer. Without `amount`, returns the remaining amount; the refund fee is added on top. The amount leaves the available balance when you make the request and returns if the refund fails. One refund at a time per charge; the result arrives through the `REFUND_COMPLETED` or `REFUND_FAILED` webhooks. Counts towards the withdrawal request limit. Does not accept `Idempotency-Key`: on a `502`, get the charge before retrying.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1000\n}", "options": { "raw": { "language": "json" } } } }, "status": "The updated charge, with the refund in `refunds`.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005K7Q2M9XB4T127431\",\n \"method\": \"PIX\",\n \"status\": \"PAID\",\n \"amount\": 1500,\n \"description\": \"Pedido 4821\",\n \"serviceFee\": 105,\n \"netAmount\": 1395,\n \"refundedAmount\": 0,\n \"refundFee\": 0,\n \"refundInProgressAmount\": 1000,\n \"refundableAmount\": 0,\n \"openInfractionProtocol\": null,\n \"externalRef\": \"pedido-4821\",\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T14:32:05.123Z\",\n \"paidAt\": \"2026-10-05T14:33:10.004Z\",\n \"refundedAt\": null,\n \"pix\": {\n \"qrCodeText\": \"00020126580014br.gov.bcb.pix0136b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03520400005303986540515.005802BR5912LOJA EXEMPLO6009SAO PAULO62070503***63041EC4\",\n \"qrCodeUrl\": null,\n \"qrCodeBase64\": null,\n \"conciliationId\": \"E99999999202610051433a1b2c3d4e5f\"\n },\n \"customer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"email\": \"maria.souza@exemplo.com\",\n \"phone\": \"+5511999998888\"\n },\n \"payer\": {\n \"name\": \"Maria Souza\",\n \"document\": \"***.982.247-**\",\n \"bankName\": \"Banco Exemplo S.A.\"\n },\n \"refunds\": [\n {\n \"id\": \"cmu7r2f9k000301s6abcd5678\",\n \"status\": \"SENT\",\n \"amount\": 1000,\n \"serviceFee\": 100,\n \"totalDebited\": 1100,\n \"endToEndId\": null,\n \"rejectedReason\": null,\n \"requestedAt\": \"2026-10-06T09:15:00.000Z\",\n \"settledAt\": null,\n \"releasedAt\": null\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "withdraw", "item": [ { "name": "Withdraw to Pix key", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey_post_withdraw}}", "description": "Unique value per operation, 1 to 255 visible ASCII characters, no spaces. Repeating the key with the same amount and destination returns the original operation; with a different amount or destination, `409`. Scoped to the account, no expiration. In this collection the key is created before the first send and kept until a response below 500 arrives: after a 5xx or a network failure, sending again retries the same operation." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw" ] }, "description": "Scope: `WITHDRAW`.\n\nSends a Pix from the account to a Pix key. `amount` is what reaches the destination; the fee is added on top. The total leaves the available balance when you make the request and returns if the withdrawal fails. A `201` response is not money delivered: confirmation comes through the `WITHDRAW_COMPLETED` webhook and failure through `WITHDRAW_FAILED`. Request limit: 5 per minute per credential and 10 per account, shared with Pix copy-and-paste payments and refunds.", "body": { "mode": "raw", "raw": "{\n \"amount\": 10000,\n \"pixKey\": \"fulano@exemplo.com\",\n \"pixKeyType\": \"EMAIL\",\n \"comment\": \"Repasse semanal\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Withdrawal approved by the bank", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey_post_withdraw}}", "description": "Unique value per operation, 1 to 255 visible ASCII characters, no spaces. Repeating the key with the same amount and destination returns the original operation; with a different amount or destination, `409`. Scoped to the account, no expiration. In this collection the key is created before the first send and kept until a response below 500 arrives: after a 5xx or a network failure, sending again retries the same operation." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw" ] }, "description": "Scope: `WITHDRAW`.\n\nSends a Pix from the account to a Pix key. `amount` is what reaches the destination; the fee is added on top. The total leaves the available balance when you make the request and returns if the withdrawal fails. A `201` response is not money delivered: confirmation comes through the `WITHDRAW_COMPLETED` webhook and failure through `WITHDRAW_FAILED`. Request limit: 5 per minute per credential and 10 per account, shared with Pix copy-and-paste payments and refunds.", "body": { "mode": "raw", "raw": "{\n \"amount\": 10000,\n \"pixKey\": \"fulano@exemplo.com\",\n \"pixKeyType\": \"EMAIL\",\n \"comment\": \"Repasse semanal\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Withdrawal registered. With the same `Idempotency-Key` and data, the existing withdrawal, in its current state.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005R4D8TN2WQZ127431\",\n \"status\": \"APPROVED\",\n \"amount\": 10000,\n \"serviceFee\": 250,\n \"totalDebited\": 10250,\n \"pixKey\": \"fulano@exemplo.com\",\n \"comment\": \"Repasse semanal\",\n \"e2e\": null,\n \"providerRejectedReason\": null,\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T14:40:11.002Z\",\n \"sentAt\": \"2026-10-05T14:40:11.380Z\",\n \"approvedAt\": \"2026-10-05T14:40:11.702Z\",\n \"confirmedAt\": null\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "if (!pm.collectionVariables.get('idempotencyKey_post_withdraw')) {", " pm.collectionVariables.set('idempotencyKey_post_withdraw', pm.variables.replaceIn('{{$guid}}'));", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code < 500) pm.collectionVariables.unset('idempotencyKey_post_withdraw');" ] } } ] }, { "name": "List withdrawals", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "status", "value": "", "description": "Withdrawal status.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true } ] }, "description": "Scope: `WITHDRAW_READ`.\n\nReturns the account withdrawals, including Pix copy-and-paste payments, newest first, cursor paginated." }, "response": [ { "name": "Page of withdrawals", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "status", "value": "", "description": "Withdrawal status.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true } ] }, "description": "Scope: `WITHDRAW_READ`.\n\nReturns the account withdrawals, including Pix copy-and-paste payments, newest first, cursor paginated." }, "status": "Page of withdrawals.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"hubp-20261005R4D8TN2WQZ127431\",\n \"status\": \"CONFIRMED\",\n \"operation\": \"WITHDRAW\",\n \"amount\": 10000,\n \"serviceFee\": 250,\n \"totalDebited\": 10250,\n \"destination\": {\n \"pixKey\": \"f***@exemplo.com\",\n \"pixKeyType\": \"EMAIL\"\n },\n \"comment\": \"Repasse semanal\",\n \"e2e\": \"E99999999202610051440f6e5d4c3b2a\",\n \"createdAt\": \"2026-10-05T14:40:11.002Z\",\n \"confirmedAt\": \"2026-10-05T14:40:14.120Z\"\n }\n ],\n \"nextCursor\": \"cmu36b0bn000cbngtb7mhzyzw\"\n}" } ] }, { "name": "{withdrawId}", "item": [ { "name": "Get withdrawal", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/withdraw/:withdrawId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw", ":withdrawId" ], "variable": [ { "key": "withdrawId", "value": "hubp-20261005R4D8TN2WQZ127431", "description": "Withdrawal or Pix copy-and-paste payment identifier." } ] }, "description": "Scope: `WITHDRAW_READ`.\n\nReturns a withdrawal or a Pix copy-and-paste payment, with its current status. Accepts the withdrawal `id` and the webhook `withdrawId`." }, "response": [ { "name": "Completed withdrawal", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/withdraw/:withdrawId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw", ":withdrawId" ], "variable": [ { "key": "withdrawId", "value": "hubp-20261005R4D8TN2WQZ127431", "description": "Withdrawal or Pix copy-and-paste payment identifier." } ] }, "description": "Scope: `WITHDRAW_READ`.\n\nReturns a withdrawal or a Pix copy-and-paste payment, with its current status. Accepts the withdrawal `id` and the webhook `withdrawId`." }, "status": "Withdrawal.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005R4D8TN2WQZ127431\",\n \"status\": \"CONFIRMED\",\n \"operation\": \"WITHDRAW\",\n \"amount\": 10000,\n \"serviceFee\": 250,\n \"totalDebited\": 10250,\n \"destination\": {\n \"pixKey\": \"f***@exemplo.com\",\n \"pixKeyType\": \"EMAIL\"\n },\n \"comment\": \"Repasse semanal\",\n \"e2e\": \"E99999999202610051440f6e5d4c3b2a\",\n \"providerRejectedReason\": null,\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T14:40:11.002Z\",\n \"sentAt\": \"2026-10-05T14:40:11.380Z\",\n \"approvedAt\": \"2026-10-05T14:40:11.702Z\",\n \"confirmedAt\": \"2026-10-05T14:40:14.120Z\",\n \"failedAt\": null\n}" } ] }, { "name": "receipt", "item": [ { "name": "Withdrawal receipt", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/withdraw/:withdrawId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw", ":withdrawId", "receipt" ], "variable": [ { "key": "withdrawId", "value": "hubp-20261005R4D8TN2WQZ127431", "description": "Withdrawal or Pix copy-and-paste payment identifier." } ] }, "description": "Scope: `WITHDRAW_READ`.\n\nReturns the withdrawal receipt as a PDF, base64 encoded. Only for `CONFIRMED` withdrawals." }, "response": [ { "name": "Receipt", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/withdraw/:withdrawId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "withdraw", ":withdrawId", "receipt" ], "variable": [ { "key": "withdrawId", "value": "hubp-20261005R4D8TN2WQZ127431", "description": "Withdrawal or Pix copy-and-paste payment identifier." } ] }, "description": "Scope: `WITHDRAW_READ`.\n\nReturns the withdrawal receipt as a PDF, base64 encoded. Only for `CONFIRMED` withdrawals." }, "status": "Receipt.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"filename\": \"comprovante-pix-hubp-20261005R4D8TN2WQZ127431.pdf\",\n \"contentType\": \"application/pdf\",\n \"fileBase64\": \"JVBERi0xLjcKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCvkMlAwUDC1NNUzMjNSMDEz\"\n}" } ] } ] } ] } ] }, { "name": "pix", "item": [ { "name": "decode", "item": [ { "name": "Decode Pix code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix/decode", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix", "decode" ] }, "description": "Scope: `PIX_DICT_READ`.\n\nExtracts the data in a Pix copy-and-paste code, such as key and amount, without querying the bank. It does not count towards the request limit, does not identify the holder and does not pay anything. For a dynamic code, `pixKey` is `null` and only `url` is filled.", "body": { "mode": "raw", "raw": "{\n \"brCode\": \"00020126400014br.gov.bcb.pix0118fulano@exemplo.com520400005303986540525.005802BR5913FULANO DE TAL6009SAO PAULO62140510PEDIDO482163048572\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Static code with amount", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix/decode", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix", "decode" ] }, "description": "Scope: `PIX_DICT_READ`.\n\nExtracts the data in a Pix copy-and-paste code, such as key and amount, without querying the bank. It does not count towards the request limit, does not identify the holder and does not pay anything. For a dynamic code, `pixKey` is `null` and only `url` is filled.", "body": { "mode": "raw", "raw": "{\n \"brCode\": \"00020126400014br.gov.bcb.pix0118fulano@exemplo.com520400005303986540525.005802BR5913FULANO DE TAL6009SAO PAULO62140510PEDIDO482163048572\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Decoded code.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pixKey\": \"fulano@exemplo.com\",\n \"url\": null,\n \"amount\": 2500,\n \"merchantName\": \"FULANO DE TAL\",\n \"merchantCity\": \"SAO PAULO\",\n \"txid\": \"PEDIDO4821\",\n \"isDynamic\": false,\n \"isAmountFixed\": true\n}" } ] } ] }, { "name": "destination", "item": [ { "name": "Look up recipient", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix/destination", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix", "destination" ] }, "description": "Scope: `PIX_DICT_READ`.\n\nShows the holder and institution of a Pix key or Pix copy-and-paste code, to check before paying. Request limit: 30 lookups per minute per account.", "body": { "mode": "raw", "raw": "{\n \"pixKey\": \"52998224725\",\n \"pixKeyType\": \"CPF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Recipient", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix/destination", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix", "destination" ] }, "description": "Scope: `PIX_DICT_READ`.\n\nShows the holder and institution of a Pix key or Pix copy-and-paste code, to check before paying. Request limit: 30 lookups per minute per account.", "body": { "mode": "raw", "raw": "{\n \"pixKey\": \"52998224725\",\n \"pixKeyType\": \"CPF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Recipient.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"PIX_KEY\",\n \"pixKey\": \"***.982.247-**\",\n \"pixKeyType\": \"CPF\",\n \"holder\": {\n \"name\": \"Maria Aparecida Souza\",\n \"document\": \"***.982.247-**\"\n },\n \"bank\": {\n \"name\": \"Banco Exemplo S.A.\",\n \"ispb\": \"99999999\",\n \"branch\": \"0001\",\n \"accountNumber\": \"****7788\"\n },\n \"amount\": null,\n \"isAmountFixed\": false,\n \"isVerified\": true\n}" } ] } ] }, { "name": "qr-payments", "item": [ { "name": "Pay Pix code", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey_post_pix_qr_payment}}", "description": "Unique value per operation, 1 to 255 visible ASCII characters, no spaces. Repeating the key with the same amount and destination returns the original operation; with a different amount or destination, `409`. Scoped to the account, no expiration. In this collection the key is created before the first send and kept until a response below 500 arrives: after a 5xx or a network failure, sending again retries the same operation." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix/qr-payments", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix", "qr-payments" ] }, "description": "Scope: `WITHDRAW`.\n\nPays a Pix copy-and-paste code, static or dynamic, from the account available balance. It works like a withdrawal: same response, limits, daily cap and request limit, with the Pix copy-and-paste payment fee (`externalPayment` in limits). `Idempotency-Key` also compares the paid code. Track it through the `WITHDRAW_*` webhooks and the withdrawal lookup, with `operation: EXTERNAL_PAYMENT`.", "body": { "mode": "raw", "raw": "{\n \"brCode\": \"00020126400014br.gov.bcb.pix0118fulano@exemplo.com520400005303986540525.005802BR5913FULANO DE TAL6009SAO PAULO62140510PEDIDO482163048572\",\n \"comment\": \"Pedido 4821\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Payment approved by the bank", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey_post_pix_qr_payment}}", "description": "Unique value per operation, 1 to 255 visible ASCII characters, no spaces. Repeating the key with the same amount and destination returns the original operation; with a different amount or destination, `409`. Scoped to the account, no expiration. In this collection the key is created before the first send and kept until a response below 500 arrives: after a 5xx or a network failure, sending again retries the same operation." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix/qr-payments", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix", "qr-payments" ] }, "description": "Scope: `WITHDRAW`.\n\nPays a Pix copy-and-paste code, static or dynamic, from the account available balance. It works like a withdrawal: same response, limits, daily cap and request limit, with the Pix copy-and-paste payment fee (`externalPayment` in limits). `Idempotency-Key` also compares the paid code. Track it through the `WITHDRAW_*` webhooks and the withdrawal lookup, with `operation: EXTERNAL_PAYMENT`.", "body": { "mode": "raw", "raw": "{\n \"brCode\": \"00020126400014br.gov.bcb.pix0118fulano@exemplo.com520400005303986540525.005802BR5913FULANO DE TAL6009SAO PAULO62140510PEDIDO482163048572\",\n \"comment\": \"Pedido 4821\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment registered.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005H2P6XC8VNM127431\",\n \"status\": \"APPROVED\",\n \"amount\": 2500,\n \"serviceFee\": 100,\n \"totalDebited\": 2600,\n \"pixKey\": \"f***@exemplo.com\",\n \"comment\": \"Pedido 4821\",\n \"e2e\": null,\n \"providerRejectedReason\": null,\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T14:40:11.002Z\",\n \"sentAt\": \"2026-10-05T14:40:11.380Z\",\n \"approvedAt\": \"2026-10-05T14:40:11.702Z\",\n \"confirmedAt\": null\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "if (!pm.collectionVariables.get('idempotencyKey_post_pix_qr_payment')) {", " pm.collectionVariables.set('idempotencyKey_post_pix_qr_payment', pm.variables.replaceIn('{{$guid}}'));", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code < 500) pm.collectionVariables.unset('idempotencyKey_post_pix_qr_payment');" ] } } ] } ] } ] }, { "name": "pix-keys", "item": [ { "name": "List Pix keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/pix-keys", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys" ] }, "description": "Scope: `PIX_KEY_READ`.\n\nReturns the account Pix keys, with the default key first. The others come oldest first." }, "response": [ { "name": "Account keys", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/pix-keys", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys" ] }, "description": "Scope: `PIX_KEY_READ`.\n\nReturns the account Pix keys, with the default key first. The others come oldest first." }, "status": "Account keys.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"cmu5k2x0a000301s6ab12cd34\",\n \"key\": \"b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03\",\n \"type\": \"EVP\",\n \"status\": \"ACTIVE\",\n \"isDefault\": true,\n \"createdAt\": \"2026-09-17T14:32:05.123Z\",\n \"updatedAt\": \"2026-09-17T14:32:05.123Z\"\n },\n {\n \"id\": \"cmu5k2x0a000401s6ef56gh78\",\n \"key\": \"12345678000195\",\n \"type\": \"CNPJ\",\n \"status\": \"ACTIVE\",\n \"isDefault\": false,\n \"createdAt\": \"2026-09-20T10:00:00.000Z\",\n \"updatedAt\": \"2026-09-20T10:00:00.000Z\"\n }\n]" } ] }, { "name": "Create Pix key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix-keys", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys" ] }, "description": "Scope: `PIX_KEY_WRITE`.\n\nRegisters a new Pix key on the account, random (`EVP`) or CNPJ. The key comes back already `ACTIVE`, and the first key of the account becomes the default.", "body": { "mode": "raw", "raw": "{\n \"type\": \"EVP\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Key", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/pix-keys", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys" ] }, "description": "Scope: `PIX_KEY_WRITE`.\n\nRegisters a new Pix key on the account, random (`EVP`) or CNPJ. The key comes back already `ACTIVE`, and the first key of the account becomes the default.", "body": { "mode": "raw", "raw": "{\n \"type\": \"EVP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Key created.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmu5k2x0a000301s6ab12cd34\",\n \"key\": \"b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03\",\n \"type\": \"EVP\",\n \"status\": \"ACTIVE\",\n \"isDefault\": true,\n \"createdAt\": \"2026-09-17T14:32:05.123Z\",\n \"updatedAt\": \"2026-09-17T14:32:05.123Z\"\n}" } ] }, { "name": "{pixKeyId}", "item": [ { "name": "default", "item": [ { "name": "Set default key", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/transactions/pix-keys/:pixKeyId/default", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys", ":pixKeyId", "default" ], "variable": [ { "key": "pixKeyId", "value": "cmu5k2x0a000301s6ab12cd34", "description": "Key identifier (`id`), not its value." } ] }, "description": "Scope: `PIX_KEY_WRITE`.\n\nReplaces the account default key with the given key. The default key is the one that receives charges and the one that identifies your account in the transfers you send. To receive a transfer, any `ACTIVE` key works. Only an `ACTIVE` key can become the default." }, "response": [ { "name": "Key", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/transactions/pix-keys/:pixKeyId/default", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys", ":pixKeyId", "default" ], "variable": [ { "key": "pixKeyId", "value": "cmu5k2x0a000301s6ab12cd34", "description": "Key identifier (`id`), not its value." } ] }, "description": "Scope: `PIX_KEY_WRITE`.\n\nReplaces the account default key with the given key. The default key is the one that receives charges and the one that identifies your account in the transfers you send. To receive a transfer, any `ACTIVE` key works. Only an `ACTIVE` key can become the default." }, "status": "The key, now default.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmu5k2x0a000301s6ab12cd34\",\n \"key\": \"b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03\",\n \"type\": \"EVP\",\n \"status\": \"ACTIVE\",\n \"isDefault\": true,\n \"createdAt\": \"2026-09-17T14:32:05.123Z\",\n \"updatedAt\": \"2026-09-17T14:32:05.123Z\"\n}" } ] } ] }, { "name": "Delete Pix key", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/transactions/pix-keys/:pixKeyId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys", ":pixKeyId" ], "variable": [ { "key": "pixKeyId", "value": "cmu5k2x0a000301s6ab12cd34", "description": "Key identifier (`id`), not its value." } ] }, "description": "Scope: `PIX_KEY_WRITE`.\n\nRemoves the key from the account and from DICT. The default key cannot be deleted, and an already deleted key returns `404`." }, "response": [ { "name": "No body.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/transactions/pix-keys/:pixKeyId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "pix-keys", ":pixKeyId" ], "variable": [ { "key": "pixKeyId", "value": "cmu5k2x0a000301s6ab12cd34", "description": "Key identifier (`id`), not its value." } ] }, "description": "Scope: `PIX_KEY_WRITE`.\n\nRemoves the key from the account and from DICT. The default key cannot be deleted, and an already deleted key returns `404`." }, "status": "No body.", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] } ] } ] }, { "name": "internal-transfer", "item": [ { "name": "Transfer to another PayZu account", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey_post_internal_transfer}}", "description": "Unique value per operation, 1 to 255 visible ASCII characters, no spaces. Repeating the key with the same amount and destination returns the original operation; with a different amount or destination, `409`. Scoped to the account, no expiration. In this collection the key is created before the first send and kept until a response below 500 arrives: after a 5xx or a network failure, sending again retries the same operation." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer" ] }, "description": "Scope: `INTERNAL_TRANSFER`.\n\nSends money from your account to another PayZu account, identified by its Pix key. The amount does not go through Pix, and the response already carries the result: `CONFIRMED` means money delivered. The fee is added on top. On a `502` where the bank did not respond or refused temporarily, the transfer stays `REQUESTED` and only the same `Idempotency-Key` returns the original; a definitive refusal leaves the transfer `FAILED`. Request limit: 5 per minute per credential and 10 per account.", "body": { "mode": "raw", "raw": "{\n \"amount\": 10000,\n \"toPixKey\": \"financeiro@lojaparceira.com.br\",\n \"comment\": \"Repasse do mês\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Completed transfer", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey_post_internal_transfer}}", "description": "Unique value per operation, 1 to 255 visible ASCII characters, no spaces. Repeating the key with the same amount and destination returns the original operation; with a different amount or destination, `409`. Scoped to the account, no expiration. In this collection the key is created before the first send and kept until a response below 500 arrives: after a 5xx or a network failure, sending again retries the same operation." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer" ] }, "description": "Scope: `INTERNAL_TRANSFER`.\n\nSends money from your account to another PayZu account, identified by its Pix key. The amount does not go through Pix, and the response already carries the result: `CONFIRMED` means money delivered. The fee is added on top. On a `502` where the bank did not respond or refused temporarily, the transfer stays `REQUESTED` and only the same `Idempotency-Key` returns the original; a definitive refusal leaves the transfer `FAILED`. Request limit: 5 per minute per credential and 10 per account.", "body": { "mode": "raw", "raw": "{\n \"amount\": 10000,\n \"toPixKey\": \"financeiro@lojaparceira.com.br\",\n \"comment\": \"Repasse do mês\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Transfer registered.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005L9C3VH6KMA127431\",\n \"status\": \"CONFIRMED\",\n \"side\": \"SENT\",\n \"amount\": 10000,\n \"serviceFee\": 100,\n \"totalDebited\": 10100,\n \"counterparty\": {\n \"name\": \"Loja Parceira Ltda\",\n \"document\": \"12.345.678/0001-95\",\n \"pixKey\": \"financeiro@lojaparceira.com.br\"\n },\n \"comment\": \"Repasse do mês\",\n \"providerRejectedReason\": null,\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T15:02:44.010Z\",\n \"confirmedAt\": \"2026-10-05T15:02:44.418Z\",\n \"failedAt\": null\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "if (!pm.collectionVariables.get('idempotencyKey_post_internal_transfer')) {", " pm.collectionVariables.set('idempotencyKey_post_internal_transfer', pm.variables.replaceIn('{{$guid}}'));", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code < 500) pm.collectionVariables.unset('idempotencyKey_post_internal_transfer');" ] } } ] }, { "name": "List transfers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "status", "value": "", "description": "Transfer status.", "disabled": true }, { "key": "side", "value": "", "description": "Only one side: `SENT` or `RECEIVED`. Without it, both are returned.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true } ] }, "description": "Scope: `INTERNAL_TRANSFER_READ`.\n\nReturns the transfers the account sent and received, newest first, cursor paginated." }, "response": [ { "name": "Page of transfers", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "status", "value": "", "description": "Transfer status.", "disabled": true }, { "key": "side", "value": "", "description": "Only one side: `SENT` or `RECEIVED`. Without it, both are returned.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true } ] }, "description": "Scope: `INTERNAL_TRANSFER_READ`.\n\nReturns the transfers the account sent and received, newest first, cursor paginated." }, "status": "Page of transfers.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"hubp-20261005L9C3VH6KMA127431\",\n \"status\": \"CONFIRMED\",\n \"side\": \"SENT\",\n \"amount\": 10000,\n \"serviceFee\": 100,\n \"totalDebited\": 10100,\n \"counterparty\": {\n \"name\": \"Loja Parceira Ltda\",\n \"document\": \"12.345.678/0001-95\",\n \"pixKey\": \"f***@lojaparceira.com.br\"\n },\n \"comment\": \"Repasse do mês\",\n \"providerRejectedReason\": null,\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T15:02:44.010Z\",\n \"confirmedAt\": \"2026-10-05T15:02:44.418Z\",\n \"failedAt\": null\n },\n {\n \"id\": \"hubp-20261004M3N7KP2QRS998812\",\n \"status\": \"CONFIRMED\",\n \"side\": \"RECEIVED\",\n \"amount\": 5000,\n \"serviceFee\": 0,\n \"totalDebited\": 0,\n \"counterparty\": {\n \"name\": \"Loja Parceira Ltda\",\n \"document\": \"12.345.678/0001-95\",\n \"pixKey\": \"f***@lojaparceira.com.br\"\n },\n \"comment\": null,\n \"providerRejectedReason\": null,\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-04T11:20:00.000Z\",\n \"confirmedAt\": \"2026-10-04T11:20:00.390Z\",\n \"failedAt\": null\n }\n ],\n \"nextCursor\": \"cmu39c1do000dbngt8nk2abcd\"\n}" } ] }, { "name": "{transferId}", "item": [ { "name": "Get transfer", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer/:transferId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer", ":transferId" ], "variable": [ { "key": "transferId", "value": "hubp-20261005L9C3VH6KMA127431", "description": "Transfer identifier." } ] }, "description": "Scope: `INTERNAL_TRANSFER_READ`.\n\nReturns a transfer the account sent or received. Accepts the transfer `id` and the webhook `transferId`." }, "response": [ { "name": "Completed transfer", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer/:transferId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer", ":transferId" ], "variable": [ { "key": "transferId", "value": "hubp-20261005L9C3VH6KMA127431", "description": "Transfer identifier." } ] }, "description": "Scope: `INTERNAL_TRANSFER_READ`.\n\nReturns a transfer the account sent or received. Accepts the transfer `id` and the webhook `transferId`." }, "status": "Transfer.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"hubp-20261005L9C3VH6KMA127431\",\n \"status\": \"CONFIRMED\",\n \"side\": \"SENT\",\n \"amount\": 10000,\n \"serviceFee\": 100,\n \"totalDebited\": 10100,\n \"counterparty\": {\n \"name\": \"Loja Parceira Ltda\",\n \"document\": \"12.345.678/0001-95\",\n \"pixKey\": \"f***@lojaparceira.com.br\"\n },\n \"comment\": \"Repasse do mês\",\n \"providerRejectedReason\": null,\n \"callbackUrl\": null,\n \"createdAt\": \"2026-10-05T15:02:44.010Z\",\n \"confirmedAt\": \"2026-10-05T15:02:44.418Z\",\n \"failedAt\": null\n}" } ] }, { "name": "receipt", "item": [ { "name": "Transfer receipt", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer/:transferId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer", ":transferId", "receipt" ], "variable": [ { "key": "transferId", "value": "hubp-20261005L9C3VH6KMA127431", "description": "Transfer identifier." } ] }, "description": "Scope: `INTERNAL_TRANSFER_READ`.\n\nReturns the transfer receipt as a PDF, base64 encoded. Only for `CONFIRMED` transfers. It is not a Pix receipt and has no end-to-end ID." }, "response": [ { "name": "Receipt", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/internal-transfer/:transferId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "internal-transfer", ":transferId", "receipt" ], "variable": [ { "key": "transferId", "value": "hubp-20261005L9C3VH6KMA127431", "description": "Transfer identifier." } ] }, "description": "Scope: `INTERNAL_TRANSFER_READ`.\n\nReturns the transfer receipt as a PDF, base64 encoded. Only for `CONFIRMED` transfers. It is not a Pix receipt and has no end-to-end ID." }, "status": "Receipt.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"filename\": \"comprovante-transferencia-hubp-20261005L9C3VH6KMA127431.pdf\",\n \"contentType\": \"application/pdf\",\n \"fileBase64\": \"JVBERi0xLjcKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCvkMlAwUDC1NNUzMjNSMDEz\"\n}" } ] } ] } ] } ] }, { "name": "deposit", "item": [ { "name": "{depositId}", "item": [ { "name": "Get deposit", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/deposit/:depositId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "deposit", ":depositId" ], "variable": [ { "key": "depositId", "value": "cmu4a1b2c000001s6xyz98765", "description": "Deposit identifier." } ] }, "description": "Scope: `DEPOSIT_READ`.\n\nReturns a deposit, which is a Pix received on an account key without a charge. Use the `depositId` from the `DEPOSIT_RECEIVED` webhook." }, "response": [ { "name": "Deposit", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/deposit/:depositId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "deposit", ":depositId" ], "variable": [ { "key": "depositId", "value": "cmu4a1b2c000001s6xyz98765", "description": "Deposit identifier." } ] }, "description": "Scope: `DEPOSIT_READ`.\n\nReturns a deposit, which is a Pix received on an account key without a charge. Use the `depositId` from the `DEPOSIT_RECEIVED` webhook." }, "status": "Deposit.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmu4a1b2c000001s6xyz98765\",\n \"method\": \"PIX\",\n \"amount\": 5000,\n \"serviceFee\": 50,\n \"netAmount\": 4950,\n \"e2e\": \"E99999999202610051433a1b2c3d4e5f\",\n \"receiverPixKey\": \"b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03\",\n \"payer\": {\n \"name\": \"João Pereira\",\n \"document\": \"***.456.789-**\",\n \"bankIspb\": \"99999999\",\n \"bankName\": \"Banco Exemplo S.A.\"\n },\n \"paidAt\": \"2026-10-05T16:10:02.551Z\",\n \"createdAt\": \"2026-10-05T16:10:03.120Z\",\n \"refundedAmount\": 0,\n \"refundInProgressAmount\": 0,\n \"refundableAmount\": 5000,\n \"openInfractionProtocol\": null,\n \"refunds\": []\n}" } ] }, { "name": "receipt", "item": [ { "name": "Deposit receipt", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/deposit/:depositId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "deposit", ":depositId", "receipt" ], "variable": [ { "key": "depositId", "value": "cmu4a1b2c000001s6xyz98765", "description": "Deposit identifier." } ] }, "description": "Scope: `DEPOSIT_READ`.\n\nReturns the deposit receipt as a PDF, base64 encoded." }, "response": [ { "name": "Receipt", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/deposit/:depositId/receipt", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "deposit", ":depositId", "receipt" ], "variable": [ { "key": "depositId", "value": "cmu4a1b2c000001s6xyz98765", "description": "Deposit identifier." } ] }, "description": "Scope: `DEPOSIT_READ`.\n\nReturns the deposit receipt as a PDF, base64 encoded." }, "status": "Receipt.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"filename\": \"comprovante-pix-cmu4a1b2c000001s6xyz98765.pdf\",\n \"contentType\": \"application/pdf\",\n \"fileBase64\": \"JVBERi0xLjcKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCvkMlAwUDC1NNUzMjNSMDEz\"\n}" } ] } ] }, { "name": "refund", "item": [ { "name": "Return deposit", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/deposit/:depositId/refund", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "deposit", ":depositId", "refund" ], "variable": [ { "key": "depositId", "value": "cmu4a1b2c000001s6xyz98765", "description": "Deposit identifier." } ] }, "description": "Scope: `REFUND`.\n\nReturns all or part of a Pix received without a charge to the payer. Without `amount`, returns the remaining amount; the refund fee is added on top. The amount leaves the available balance when you make the request and returns if the return fails. One return at a time; the result arrives through the `REFUND_COMPLETED` or `REFUND_FAILED` webhooks, with `depositId`.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1000\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Return on its way", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/deposit/:depositId/refund", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "deposit", ":depositId", "refund" ], "variable": [ { "key": "depositId", "value": "cmu4a1b2c000001s6xyz98765", "description": "Deposit identifier." } ] }, "description": "Scope: `REFUND`.\n\nReturns all or part of a Pix received without a charge to the payer. Without `amount`, returns the remaining amount; the refund fee is added on top. The amount leaves the available balance when you make the request and returns if the return fails. One return at a time; the result arrives through the `REFUND_COMPLETED` or `REFUND_FAILED` webhooks, with `depositId`.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1000\n}", "options": { "raw": { "language": "json" } } } }, "status": "The updated deposit, with the return in `refunds`.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmu4a1b2c000001s6xyz98765\",\n \"method\": \"PIX\",\n \"amount\": 5000,\n \"serviceFee\": 50,\n \"netAmount\": 4950,\n \"e2e\": \"E99999999202610051433a1b2c3d4e5f\",\n \"receiverPixKey\": \"b3c7e9a2-4f1d-4c8a-9e2b-7d5f6a8c1e03\",\n \"payer\": {\n \"name\": \"João Pereira\",\n \"document\": \"***.456.789-**\",\n \"bankIspb\": \"99999999\",\n \"bankName\": \"Banco Exemplo S.A.\"\n },\n \"paidAt\": \"2026-10-05T16:10:02.551Z\",\n \"createdAt\": \"2026-10-05T16:10:03.120Z\",\n \"refundedAmount\": 0,\n \"refundInProgressAmount\": 5000,\n \"refundableAmount\": 0,\n \"openInfractionProtocol\": null,\n \"refunds\": [\n {\n \"id\": \"cmu7r2f9k000501s6ijkl9012\",\n \"status\": \"SENT\",\n \"amount\": 5000,\n \"serviceFee\": 100,\n \"totalDebited\": 5100,\n \"endToEndId\": null,\n \"rejectedReason\": null,\n \"requestedAt\": \"2026-10-06T10:05:00.000Z\",\n \"settledAt\": null,\n \"releasedAt\": null\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "balance", "item": [ { "name": "Get balance", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/balance", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "balance" ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the account available and blocked balance, with the blocked part broken down by reason." }, "response": [ { "name": "Balance", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/balance", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "balance" ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the account available and blocked balance, with the blocked part broken down by reason." }, "status": "Balance.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 152030,\n \"available\": 150530,\n \"blocked\": 1500,\n \"blockedBySecurity\": 1500,\n \"blockedByWithdraw\": 0,\n \"blockedByRefund\": 0,\n \"syncedAt\": \"2026-10-06T18:20:11.004Z\"\n}" } ] } ] }, { "name": "statement", "item": [ { "name": "Get statement", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/statement?trigger=PAYMENT,DEPOSIT", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "statement" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "trigger", "value": "PAYMENT,DEPOSIT", "description": "One or more line types, comma separated: `PAYMENT`, `DEPOSIT`, `PAYMENT_REFUND`, `PAYOUT`, `PAYOUT_REVERSAL`, `PAYOUT_REFUND_RECEIVED`, `INFRACTION_BLOCK`, `INFRACTION_SETTLED`, `INFRACTION_RELEASED`, `INTERNAL_TRANSFER`.", "disabled": false }, { "key": "originId", "value": "", "description": "Charge, withdrawal, deposit or transfer identifier as sent in the webhooks.", "disabled": true }, { "key": "amount", "value": "", "description": "Amount in cents, unsigned. Matches incoming and outgoing lines of that amount and also operations with that gross amount.", "disabled": true }, { "key": "e2e", "value": "", "description": "Pix end-to-end ID.", "disabled": true }, { "key": "document", "value": "", "description": "Payer document; punctuation is ignored. On outgoing lines, searches the destination key.", "disabled": true }, { "key": "name", "value": "", "description": "At least 2 characters, case insensitive. Payer name on incoming lines, key on outgoing lines.", "disabled": true }, { "key": "status", "value": "", "description": "State of the originating operation, not the line `status`. `PENDING`: charge awaiting payment or withdrawal still being processed. `COMPLETED`: paid charge, paid withdrawal or received Pix. `CANCELED`: expired charge or refused withdrawal. `REFUNDED`: charge with a completed refund. `WAITING_FOR_REFUND`: charge with a refund still being processed. Returns the lines of those operations; transfer and dispute lines are left out.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Sort field.", "disabled": true }, { "key": "sortDirection", "value": "", "description": "Sort direction.", "disabled": true } ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the entries that changed the available balance, cursor paginated. Each line is an entry, not an operation: a paid charge comes in net of the fee, and a withdrawal goes out at request time, for `amount + serviceFee`. Filters are combined." }, "response": [ { "name": "Page of the statement", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/statement?trigger=PAYMENT,DEPOSIT", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "statement" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "dateFrom", "value": "", "description": "Start of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "dateTo", "value": "", "description": "End of the period, by creation date. ISO 8601 or `YYYY-MM-DD`; a date without a time covers the whole day in Brasília time.", "disabled": true }, { "key": "trigger", "value": "PAYMENT,DEPOSIT", "description": "One or more line types, comma separated: `PAYMENT`, `DEPOSIT`, `PAYMENT_REFUND`, `PAYOUT`, `PAYOUT_REVERSAL`, `PAYOUT_REFUND_RECEIVED`, `INFRACTION_BLOCK`, `INFRACTION_SETTLED`, `INFRACTION_RELEASED`, `INTERNAL_TRANSFER`.", "disabled": false }, { "key": "originId", "value": "", "description": "Charge, withdrawal, deposit or transfer identifier as sent in the webhooks.", "disabled": true }, { "key": "amount", "value": "", "description": "Amount in cents, unsigned. Matches incoming and outgoing lines of that amount and also operations with that gross amount.", "disabled": true }, { "key": "e2e", "value": "", "description": "Pix end-to-end ID.", "disabled": true }, { "key": "document", "value": "", "description": "Payer document; punctuation is ignored. On outgoing lines, searches the destination key.", "disabled": true }, { "key": "name", "value": "", "description": "At least 2 characters, case insensitive. Payer name on incoming lines, key on outgoing lines.", "disabled": true }, { "key": "status", "value": "", "description": "State of the originating operation, not the line `status`. `PENDING`: charge awaiting payment or withdrawal still being processed. `COMPLETED`: paid charge, paid withdrawal or received Pix. `CANCELED`: expired charge or refused withdrawal. `REFUNDED`: charge with a completed refund. `WAITING_FOR_REFUND`: charge with a refund still being processed. Returns the lines of those operations; transfer and dispute lines are left out.", "disabled": true }, { "key": "sortBy", "value": "", "description": "Sort field.", "disabled": true }, { "key": "sortDirection", "value": "", "description": "Sort direction.", "disabled": true } ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the entries that changed the available balance, cursor paginated. Each line is an entry, not an operation: a paid charge comes in net of the fee, and a withdrawal goes out at request time, for `amount + serviceFee`. Filters are combined." }, "status": "Page of the statement.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"cmu9r1a2b000101s6stmt0002\",\n \"entryId\": \"cmu9r0z9y000001s6entr0002\",\n \"amount\": -10250,\n \"balanceAfter\": 150530,\n \"trigger\": \"PAYOUT\",\n \"description\": \"Reserva de saque\",\n \"originId\": \"cmu3wd7k1000201s6wdrw0001\",\n \"infractionProtocol\": null,\n \"gross\": 10000,\n \"fee\": 250,\n \"status\": \"SETTLED\",\n \"statusDetail\": null,\n \"statusReason\": null,\n \"statusAt\": \"2026-10-05T14:40:14.120Z\",\n \"payoutOperation\": \"WITHDRAW\",\n \"counterparty\": {\n \"name\": null,\n \"document\": null,\n \"pixKey\": \"f***@exemplo.com\"\n },\n \"postedAt\": \"2026-10-05T14:40:11.002Z\"\n },\n {\n \"id\": \"cmu9r1a2b000001s6stmt0001\",\n \"entryId\": \"cmu9r0z9y000001s6entr0001\",\n \"amount\": 1395,\n \"balanceAfter\": 160780,\n \"trigger\": \"PAYMENT\",\n \"description\": \"Pagamento recebido\",\n \"originId\": \"cmu2wbljx0000e8gtlic8q1gi\",\n \"infractionProtocol\": null,\n \"gross\": 1500,\n \"fee\": 105,\n \"status\": null,\n \"statusDetail\": null,\n \"statusReason\": null,\n \"statusAt\": null,\n \"payoutOperation\": null,\n \"counterparty\": {\n \"name\": \"Maria Souza\",\n \"document\": \"52998224725\",\n \"pixKey\": null\n },\n \"postedAt\": \"2026-10-05T14:33:10.004Z\"\n }\n ],\n \"nextCursor\": \"cmu9r1a2b000001s6stmt0001\",\n \"balance\": 150530\n}" } ] } ] }, { "name": "limits", "item": [ { "name": "Get limits and fees", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/limits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "limits" ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the per-operation limits, the fees and the daily caps that apply to the account today. Amounts in cents and percentages in basis points." }, "response": [ { "name": "Limits and fees", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/limits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "limits" ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the per-operation limits, the fees and the daily caps that apply to the account today. Amounts in cents and percentages in basis points." }, "status": "Limits and fees.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payment\": {\n \"enabled\": true,\n \"ticketMin\": 100,\n \"ticketMax\": 1000000,\n \"feeFixed\": 105,\n \"feePercentage\": 0\n },\n \"withdraw\": {\n \"enabled\": true,\n \"ticketMin\": 100,\n \"ticketMax\": 1000000,\n \"feeFixed\": 100,\n \"feePercentage\": 150\n },\n \"externalPayment\": {\n \"enabled\": true,\n \"ticketMin\": 100,\n \"ticketMax\": 1000000,\n \"feeFixed\": 100,\n \"feePercentage\": 0\n },\n \"refund\": {\n \"enabled\": true,\n \"ticketMin\": 100,\n \"ticketMax\": 1000000,\n \"feeFixed\": 100,\n \"feePercentage\": 0\n },\n \"internalTransfer\": {\n \"enabled\": true,\n \"ticketMin\": 100,\n \"ticketMax\": 1000000,\n \"feeFixed\": 100,\n \"feePercentage\": 0\n },\n \"dailyWithdraw\": {\n \"limit\": 1000000,\n \"used\": 12850\n },\n \"dailyInternalTransfer\": {\n \"limit\": null,\n \"used\": 0\n },\n \"infraction\": {\n \"feeFixed\": 500,\n \"feePercentage\": 0,\n \"blocksBalance\": true\n }\n}" } ] } ] }, { "name": "metrics", "item": [ { "name": "Get metrics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/metrics?dateFrom=2026-09-01&dateTo=2026-09-30", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "metrics" ], "query": [ { "key": "dateFrom", "value": "2026-09-01", "description": "Start of the period. Without `dateFrom` and `dateTo`, the last 30 days are used.", "disabled": false }, { "key": "dateTo", "value": "2026-09-30", "description": "End of the period. ISO 8601 or `YYYY-MM-DD`.", "disabled": false } ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the account figures for the period: charges, conversion, refunds, disputes, withdrawals and deposits." }, "response": [ { "name": "September metrics", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/metrics?dateFrom=2026-09-01&dateTo=2026-09-30", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "metrics" ], "query": [ { "key": "dateFrom", "value": "2026-09-01", "description": "Start of the period. Without `dateFrom` and `dateTo`, the last 30 days are used.", "disabled": false }, { "key": "dateTo", "value": "2026-09-30", "description": "End of the period. ISO 8601 or `YYYY-MM-DD`.", "disabled": false } ] }, "description": "Scope: `STATEMENT_READ`.\n\nReturns the account figures for the period: charges, conversion, refunds, disputes, withdrawals and deposits." }, "status": "Period metrics.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"period\": {\n \"from\": \"2026-09-01T03:00:00.000Z\",\n \"to\": \"2026-10-01T02:59:59.999Z\"\n },\n \"rails\": [\n {\n \"method\": \"PIX\",\n \"available\": true,\n \"created\": 120,\n \"paid\": 96,\n \"conversionRate\": 8000,\n \"paidAmount\": 480000,\n \"averageTicket\": 5000,\n \"refundedAmount\": 10000,\n \"refundRate\": 208,\n \"disputedAmount\": 0,\n \"disputeRate\": 0,\n \"pending\": 10,\n \"pendingAmount\": 50000,\n \"refunded\": 2\n }\n ],\n \"withdrawals\": {\n \"count\": 4,\n \"amount\": 401000\n },\n \"deposits\": {\n \"count\": 3,\n \"amount\": 30000,\n \"netAmount\": 29700\n },\n \"pixInflow\": {\n \"count\": 99,\n \"amount\": 510000\n }\n}" } ] } ] }, { "name": "infractions", "item": [ { "name": "List MED disputes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/infractions", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "infractions" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "status", "value": "", "description": "An exact status. With `status`, `open` is ignored.", "disabled": true }, { "key": "open", "value": "", "description": "`true` returns only open disputes: every status other than `CLOSED` and `CANCELLED`.", "disabled": true }, { "key": "type", "value": "", "description": "Alleged reason.", "disabled": true }, { "key": "analysisResult", "value": "", "description": "Analysis result.", "disabled": true } ] }, "description": "Scope: `INFRACTION_READ`.\n\nReturns the account MED disputes, newest first by opening date, cursor paginated. Responding to a dispute is done in the dashboard." }, "response": [ { "name": "Page of disputes", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/infractions", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "infractions" ], "query": [ { "key": "limit", "value": "", "description": "Items per page, 1 to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "`nextCursor` from the previous page.", "disabled": true }, { "key": "status", "value": "", "description": "An exact status. With `status`, `open` is ignored.", "disabled": true }, { "key": "open", "value": "", "description": "`true` returns only open disputes: every status other than `CLOSED` and `CANCELLED`.", "disabled": true }, { "key": "type", "value": "", "description": "Alleged reason.", "disabled": true }, { "key": "analysisResult", "value": "", "description": "Analysis result.", "disabled": true } ] }, "description": "Scope: `INFRACTION_READ`.\n\nReturns the account MED disputes, newest first by opening date, cursor paginated. Responding to a dispute is done in the dashboard." }, "status": "Page of disputes.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"cmu6f0a1b000001s6abcd1234\",\n \"protocol\": \"b1c2d3e4-5f60-4a7b-8c9d-0e1f2a3b4c5d\",\n \"type\": \"REFUND_REQUEST\",\n \"status\": \"OPEN\",\n \"reportedBy\": \"DEBITED_PARTICIPANT\",\n \"reportDetails\": \"Cliente não reconhece a compra.\",\n \"analysisResult\": null,\n \"analysisDetails\": null,\n \"endToEndId\": \"E99999999202610051433a1b2c3d4e5f\",\n \"blockedAmount\": 1500,\n \"feeCharged\": 0,\n \"settledAmount\": 0,\n \"reportedAt\": \"2026-10-06T10:00:00.000Z\",\n \"dueAt\": \"2026-10-13T10:00:00.000Z\",\n \"closedAt\": null,\n \"origin\": {\n \"kind\": \"PAYMENT\",\n \"id\": \"cmu2wbljx0000e8gtlic8q1gi\",\n \"amount\": 1500,\n \"paidAt\": \"2026-10-05T14:33:10.004Z\",\n \"payerName\": \"Maria Souza\",\n \"payerDocument\": \"***.982.247-**\"\n }\n }\n ]\n}" } ] }, { "name": "{protocol}", "item": [ { "name": "Get MED dispute", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/infractions/:protocol", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "infractions", ":protocol" ], "variable": [ { "key": "protocol", "value": "b1c2d3e4-5f60-4a7b-8c9d-0e1f2a3b4c5d", "description": "Dispute protocol." } ] }, "description": "Scope: `INFRACTION_READ`.\n\nReturns a MED dispute, with its stage, the blocked amount and the result. Use the `protocol` from the `INFRACTION_OPENED` webhook." }, "response": [ { "name": "Open dispute", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/infractions/:protocol", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "infractions", ":protocol" ], "variable": [ { "key": "protocol", "value": "b1c2d3e4-5f60-4a7b-8c9d-0e1f2a3b4c5d", "description": "Dispute protocol." } ] }, "description": "Scope: `INFRACTION_READ`.\n\nReturns a MED dispute, with its stage, the blocked amount and the result. Use the `protocol` from the `INFRACTION_OPENED` webhook." }, "status": "Dispute.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmu6f0a1b000001s6abcd1234\",\n \"protocol\": \"b1c2d3e4-5f60-4a7b-8c9d-0e1f2a3b4c5d\",\n \"type\": \"REFUND_REQUEST\",\n \"status\": \"OPEN\",\n \"reportedBy\": \"DEBITED_PARTICIPANT\",\n \"reportDetails\": \"Cliente não reconhece a compra.\",\n \"analysisResult\": null,\n \"analysisDetails\": null,\n \"endToEndId\": \"E99999999202610051433a1b2c3d4e5f\",\n \"blockedAmount\": 1500,\n \"feeCharged\": 0,\n \"settledAmount\": 0,\n \"reportedAt\": \"2026-10-06T10:00:00.000Z\",\n \"dueAt\": \"2026-10-13T10:00:00.000Z\",\n \"closedAt\": null,\n \"origin\": {\n \"kind\": \"PAYMENT\",\n \"id\": \"cmu2wbljx0000e8gtlic8q1gi\",\n \"amount\": 1500,\n \"paidAt\": \"2026-10-05T14:33:10.004Z\",\n \"payerName\": \"Maria Souza\",\n \"payerDocument\": \"***.982.247-**\"\n }\n}" } ] } ] } ] }, { "name": "webhooks", "item": [ { "name": "List webhook endpoints", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks" ] }, "description": "Scope: `WEBHOOK_READ`.\n\nReturns the endpoints registered on the account, oldest first. The secret is not returned." }, "response": [ { "name": "Endpoints", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks" ] }, "description": "Scope: `WEBHOOK_READ`.\n\nReturns the endpoints registered on the account, oldest first. The secret is not returned." }, "status": "Endpoints.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"cmu6w1h0k000101s6ef34gh56\",\n \"url\": \"https://sualoja.com.br/webhooks/payzu\",\n \"events\": [\n \"PAYMENT_PAID\",\n \"PAYMENT_EXPIRED\",\n \"WITHDRAW_COMPLETED\",\n \"WITHDRAW_FAILED\"\n ],\n \"isActive\": true,\n \"createdAt\": \"2026-10-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-10-01T12:00:00.000Z\"\n }\n]" } ] }, { "name": "Register webhook endpoint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks" ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nRegisters a URL to receive the webhooks of the chosen events. The response carries the secret that signs the webhooks, and it only appears there.", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://sualoja.com.br/webhooks/payzu\",\n \"events\": [\n \"PAYMENT_PAID\",\n \"PAYMENT_EXPIRED\",\n \"WITHDRAW_COMPLETED\",\n \"WITHDRAW_FAILED\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Endpoint registered", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks" ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nRegisters a URL to receive the webhooks of the chosen events. The response carries the secret that signs the webhooks, and it only appears there.", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://sualoja.com.br/webhooks/payzu\",\n \"events\": [\n \"PAYMENT_PAID\",\n \"PAYMENT_EXPIRED\",\n \"WITHDRAW_COMPLETED\",\n \"WITHDRAW_FAILED\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Endpoint registered.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmu6w1h0k000101s6ef34gh56\",\n \"url\": \"https://sualoja.com.br/webhooks/payzu\",\n \"events\": [\n \"PAYMENT_PAID\",\n \"PAYMENT_EXPIRED\",\n \"WITHDRAW_COMPLETED\",\n \"WITHDRAW_FAILED\"\n ],\n \"isActive\": true,\n \"createdAt\": \"2026-10-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-10-01T12:00:00.000Z\",\n \"secret\": \"whsec_9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\"\n}" } ] }, { "name": "{webhookId}", "item": [ { "name": "Update webhook endpoint", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "cmu6w1h0k000101s6ef34gh56", "description": "Endpoint identifier." } ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nChanges the URL or the events of an endpoint, or deactivates and reactivates it. Send at least one field.", "body": { "mode": "raw", "raw": "{\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Deactivated endpoint", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "cmu6w1h0k000101s6ef34gh56", "description": "Endpoint identifier." } ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nChanges the URL or the events of an endpoint, or deactivates and reactivates it. Send at least one field.", "body": { "mode": "raw", "raw": "{\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Endpoint updated.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cmu6w1h0k000101s6ef34gh56\",\n \"url\": \"https://sualoja.com.br/webhooks/payzu\",\n \"events\": [\n \"PAYMENT_PAID\",\n \"PAYMENT_EXPIRED\",\n \"WITHDRAW_COMPLETED\",\n \"WITHDRAW_FAILED\"\n ],\n \"isActive\": false,\n \"createdAt\": \"2026-10-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-10-06T09:00:00.000Z\"\n}" } ] }, { "name": "Delete webhook endpoint", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/transactions/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "cmu6w1h0k000101s6ef34gh56", "description": "Endpoint identifier." } ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nRemoves from the account an endpoint with no recorded delivery yet. With a recorded delivery, the deletion is refused; in that case, deactivate it with `isActive: false`." }, "response": [ { "name": "No body.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/transactions/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "cmu6w1h0k000101s6ef34gh56", "description": "Endpoint identifier." } ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nRemoves from the account an endpoint with no recorded delivery yet. With a recorded delivery, the deletion is refused; in that case, deactivate it with `isActive: false`." }, "status": "No body.", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] } ] } ] }, { "name": "callback-secret", "item": [ { "name": "Get callback secret status", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/callback-secret", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "callback-secret" ] }, "description": "Scope: `WEBHOOK_READ`.\n\nTells whether the account already has a callback secret. The value is not returned." }, "response": [ { "name": "Secret issued", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/callback-secret", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "callback-secret" ] }, "description": "Scope: `WEBHOOK_READ`.\n\nTells whether the account already has a callback secret. The value is not returned." }, "status": "Secret status.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hasCallbackSecret\": true\n}" } ] }, { "name": "Issue callback secret", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/transactions/callback-secret", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "callback-secret" ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nGenerates the account callback secret, which signs the webhooks sent to the operations `callbackUrl`. Without it, an operation with `callbackUrl` is refused. If the account already has a secret, returns `409`." }, "response": [ { "name": "Secret", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/transactions/callback-secret", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "callback-secret" ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nGenerates the account callback secret, which signs the webhooks sent to the operations `callbackUrl`. Without it, an operation with `callbackUrl` is refused. If the account already has a secret, returns `409`." }, "status": "Secret issued. It only appears in this response.", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"secret\": \"cbsec_2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae\"\n}" } ] }, { "name": "rotate", "item": [ { "name": "Rotate callback secret", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/transactions/callback-secret/rotate", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "callback-secret", "rotate" ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nGenerates a new callback secret. The previous one stops working immediately." }, "response": [ { "name": "Secret", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/transactions/callback-secret/rotate", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "callback-secret", "rotate" ] }, "description": "Scope: `WEBHOOK_WRITE`.\n\nGenerates a new callback secret. The previous one stops working immediately." }, "status": "New secret. It only appears in this response.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"secret\": \"cbsec_2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae\"\n}" } ] } ] } ] } ] }, { "name": "status", "item": [ { "name": "Service health", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/status", "host": [ "{{baseUrl}}" ], "path": [ "status" ] }, "description": "Tells whether the API is up. No credential required. Returns `500` when the service is unhealthy.", "auth": { "type": "noauth" } }, "response": [ { "name": "Service up", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/status", "host": [ "{{baseUrl}}" ], "path": [ "status" ] }, "description": "Tells whether the API is up. No credential required. Returns `500` when the service is unhealthy.", "auth": { "type": "noauth" } }, "status": "Service up.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\",\n \"updated_at\": \"2026-10-05T12:00:00.000Z\"\n}" } ] } ] } ] }