{ "info": { "name": "Stark Infra API", "description": "This is our second API version. It is another small step towards launching the product we want to create for you, but it's a giant leap for the Brazilian financial market. We created the first banking API in Brazil and we are proud of it.\nOur API is RESTFul. This means we use predictable, resource-oriented URLs to do banking operations. The API itself speaks exclusively in JSON, including errors, but our SDK libraries convert responses to appropriate language-specific objects.\nWant to check our OpenAPI 3.1 specification? You can download our yaml file right here.\nYou can also try our Postman collection. Download it here.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://sandbox.api.starkinfra.com", "type": "string" }, { "key": "version", "value": "v2", "type": "string" }, { "key": "packages", "value": "", "type": "string" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "let prepareRequest = () => {", " const requirements = \"starkbank-ecdsa,big-integer\";", " const packages = pm.collectionVariables.get(\"packages\");", " if (packages) {", " eval(packages);", " getRandomNumberAndSetHeaders();", " return;", " } ", " pm.sendRequest({", " url: `https://southamerica-east1-api-ms-auth-dev.cloudfunctions.net/ecdsa-postman?packages=${requirements}`,", " method: 'GET'", " }, (err, res) => {", " if (err) {", " console.log(err);", " return;", " }", " eval(res.text());", " pm.collectionVariables.set('packages', res.text());", " getRandomNumberAndSetHeaders();", " return;", " });", "}", "", "let getRandomNumberAndSetHeaders = () => {", " let payload = {", " \"Gx\": \"55066263022277343669578718895168534326250603453777594175500187360389116729240\",", " \"Gy\": \"32670510020758816978083085130507043184471273380659243275938904335757337482424\",", " \"A\": \"0\",", " \"P\": \"115792089237316195423570985008687907853269984665640564039457584007908834671663\",", " \"N\": \"115792089237316195423570985008687907852837564279074904382605163141518161494337\"", " }", "", " let responseJson;", " pm.sendRequest({", " url: \"https://us-central1-api-ms-auth-sbx.cloudfunctions.net/ellipticCurveMath\",", " method: 'POST',", " header: {", " 'content-type': 'application/json' ", " },", " body: {", " mode: 'raw',", " raw: JSON.stringify(payload)", " }", "", " }, (err, res) => {", " if (err) {", " console.log(err);", " return;", " }", " responseJson = res.json();", " let status = res['code'];", " if (status == 400 || status == 404)", " throw new error.InputErrors(content, status);", " if (status == 500) ", " throw new error.InternalServerError(content, status);", " setHeaders(responseJson['randNum']);", " }); ", "};", "", "let setHeaders = (randNum) => {", " const ellipticcurve = require('starkbank-ecdsa');", " const BigInt = require('big-integer');", " const Header = require('postman-collection').Header", " const Ecdsa = ellipticcurve.Ecdsa;", " const PrivateKey = ellipticcurve.PrivateKey;", "", " let privateKeyPem = pm.environment.get('privateKey');", "", " if (!privateKeyPem) ", " throw 'You forgot to set your privateKey as an environment variable.'", "", " try {", " privateKey = PrivateKey.fromPem(privateKeyPem);", " } catch(err) {", " throw 'Private Key is invalid.'", " }", "", " let projectId = pm.environment.get('projectId');", "", " if (!projectId) ", " throw 'You forgot to set your projectId as an environment variable.'", "", " let bodyString = pm.request.body.raw == null ? \"\" : pm.request.body.raw;", " let accessId = \"project/\" + projectId;", " let accessTime = Math.floor(Date.now()/1000); ", " let message = accessId + \":\" + accessTime + \":\" + bodyString;", " let signature = Ecdsa.sign(message, privateKey, null, BigInt(randNum));", "", " pm.request.headers.add(new Header(\"Access-Id: \" + accessId));", " pm.request.headers.add(new Header(\"Access-Time: \" + accessTime));", " pm.request.headers.add(new Header(\"Access-Signature: \" + signature.toBase64()));", " ", "};", "", "prepareRequest();" ] } } ], "item": [ { "name": "Pix", "item": [ { "name": "Pix Request", "item": [ { "name": "Create Pix Requests", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-request" ] }, "description": "Send Pix payments to any Pix-enabled bank account in Brazil.\nTo create a manual Pix Request you need the receiver's account information. If you only have a Pix Key, use Get a Pix Key to retrieve the required information before creating the Pix Request.\nEvery time a participant sends you a Pix, an inbound Pix Request is created and a synchronous POST authorization request is sent to your registered pixRequestUrl, which you must answer with approval or denial within 1 second (HTTP 200) or it is denied by default. Approve with status \"approved\"; deny with status \"denied\" and a reason such as \"invalidAccountNumber\".", "body": { "mode": "raw", "raw": "{\n \"pixRequests\": [\n {\n \"amount\": \"\",\n \"externalId\": \"\",\n \"endToEndId\": \"\",\n \"senderAccountNumber\": \"\",\n \"senderBranchCode\": \"\",\n \"senderAccountType\": \"\",\n \"senderName\": \"\",\n \"senderTaxId\": \"\",\n \"receiverAccountNumber\": \"\",\n \"receiverAccountType\": \"\",\n \"receiverBankCode\": \"\",\n \"receiverTaxId\": \"\",\n \"receiverBranchCode\": \"\",\n \"receiverName\": \"\",\n \"description\": \"\",\n \"initiatorTaxId\": \"\",\n \"reconciliationId\": \"\",\n \"method\": \"\",\n \"cashAmount\": \"\",\n \"cashierType\": \"\",\n \"cashierBankCode\": \"\",\n \"priority\": \"\",\n \"reason\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Requests", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-request" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "endToEndIds", "value": "", "description": "Filter by end-to-end IDs.", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter by external IDs.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "List and filter all Pix requests. Results are paged.\nEvery time a participant sends you a Pix, an inbound Pix Request is created and a synchronous POST authorization request is sent to your registered pixRequestUrl, which you must answer with approval or denial within 1 second (HTTP 200) or it is denied by default. Approve with status \"approved\"; deny with status \"denied\" and a reason such as \"invalidAccountNumber\"." } }, { "name": "Get a Pix Request", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-request/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-request", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix request by its id." } }, { "name": "List Pix Request Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-request/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-request", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "requestIds", "value": "", "description": "Array of Pix request ids linked to the logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Pix request logs." } }, { "name": "Get a Pix Request Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-request/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-request", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix request log by its id." } } ], "description": "A Pix Request represents an inbound or outbound Pix payment in the Brazilian instant payment system.\nHere we will show you how to create and manage them." }, { "name": "Pix Reversal", "item": [ { "name": "Create Pix Reversals", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-reversal", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-reversal" ] }, "description": "Reverse a Pix payment by providing the original end-to-end ID.\nPix Reversals can only be created for inbound Pix Requests with status success. Reference the original Pix Request by passing its endToEndId.\nWhen a participant reverses a Pix you successfully sent, an authorization request is sent to your pixReversalUrl (which must differ from your pixRequestUrl); answer within 1 second (HTTP 200) or it is denied by default; if no pixReversalUrl is registered, inbound Pix Reversals are accepted by default.", "body": { "mode": "raw", "raw": "{\n \"pixReversals\": [\n {\n \"amount\": \"\",\n \"endToEndId\": \"\",\n \"externalId\": \"\",\n \"reason\": \"\",\n \"description\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Reversals", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-reversal", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-reversal" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter by external IDs.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "List and filter all Pix reversals. Results are paged." } }, { "name": "Get a Pix Reversal", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-reversal/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-reversal", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix reversal by its id." } }, { "name": "List Pix Reversal Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-reversal/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-reversal", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "reversalIds", "value": "", "description": "Array of Pix reversal ids linked to the logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Pix reversal logs." } }, { "name": "Get a Pix Reversal Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-reversal/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-reversal", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix reversal log by its id." } } ], "description": "A Pix Reversal allows you to reverse a previously made Pix transfer, sending the funds back to the original sender.\nHere we will show you how to create and manage them." }, { "name": "Pix Internal Transaction Report", "item": [ { "name": "Create Pix Internal Transaction Reports", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-internal-transaction-report", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-internal-transaction-report" ] }, "description": "Report transactions that were settled internally on the participant, such as transfers between two Indirect participants of the same Direct participant or between accounts of the same participant.", "body": { "mode": "raw", "raw": "{\n \"pixInternalTransactionReports\": [\n {\n \"referenceType\": \"\",\n \"amount\": \"\",\n \"endToEndId\": \"\",\n \"method\": \"\",\n \"created\": \"\",\n \"senderBankCode\": \"\",\n \"senderBranchCode\": \"\",\n \"senderAccountNumber\": \"\",\n \"senderAccountType\": \"\",\n \"senderTaxId\": \"\",\n \"receiverBankCode\": \"\",\n \"receiverBranchCode\": \"\",\n \"receiverAccountNumber\": \"\",\n \"receiverAccountType\": \"\",\n \"receiverTaxId\": \"\",\n \"returnId\": \"\",\n \"receiverKeyId\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Internal Transaction Reports", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-internal-transaction-report", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-internal-transaction-report" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "List of ids to get specific entities. Max = 100.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status. Options: \"created\", \"processing\", \"success\", \"failed\".", "disabled": true }, { "key": "referenceIds", "value": "", "description": "Filter by reference ids (endToEndId or returnId). Max = 30.", "disabled": true }, { "key": "referenceTypes", "value": "", "description": "Filter by reference types. Options: \"request\", \"reversal\". Max = 30.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List and filter all Pix internal transaction reports. Results are paged." } }, { "name": "Get a Pix Internal Transaction Report", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-internal-transaction-report/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-internal-transaction-report", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix internal transaction report by its id." } }, { "name": "List Pix Internal Transaction Report Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-internal-transaction-report/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-internal-transaction-report", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "Filter by log ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types. Options: \"created\", \"sent\", \"success\", \"failed\".", "disabled": true }, { "key": "reportIds", "value": "", "description": "Filter logs by Pix internal transaction report ids.", "disabled": true } ] }, "description": "Get a paged list of all Pix internal transaction report logs." } }, { "name": "Get a Pix Internal Transaction Report Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-internal-transaction-report/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-internal-transaction-report", "log", "{{id}}" ] }, "description": "Get a single Pix internal transaction report log by its id." } } ], "description": "A Pix Internal Transaction Report lets Direct and Indirect participants report transactions that were settled internally on the participant, such as transfers between two Indirect participants of the same Direct participant or between accounts of the same participant.\nHere we will show you how to create and manage them." }, { "name": "Static Brcode", "item": [ { "name": "Create Static Brcodes", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/static-brcode", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "static-brcode" ] }, "description": "Create static Pix QR codes for receiving payments.", "body": { "mode": "raw", "raw": "{\n \"staticBrcodes\": [\n {\n \"keyId\": \"\",\n \"name\": \"\",\n \"city\": \"\",\n \"amount\": \"\",\n \"cashierBankCode\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"reconciliationId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Static Brcodes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/static-brcode", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "static-brcode" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "uuids", "value": "", "description": "Filter by UUIDs.", "disabled": true } ] }, "description": "List and filter all static Brcodes. Results are paged." } }, { "name": "Get a Static Brcode", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/static-brcode/{{uuid}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "static-brcode", "{{uuid}}" ] }, "description": "Get a single static Brcode by its UUID." } } ], "description": "A Static Brcode is a QR Code that can receive multiple Pix payments with a fixed or open amount.\nHere we will show you how to create and manage them." }, { "name": "Dynamic Brcode", "item": [ { "name": "Create Dynamic Brcodes", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/dynamic-brcode", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "dynamic-brcode" ] }, "description": "Create dynamic Pix QR codes that fetch payment details from your server.", "body": { "mode": "raw", "raw": "{\n \"dynamicBrcodes\": [\n {\n \"city\": \"\",\n \"externalId\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Dynamic Brcodes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/dynamic-brcode", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "dynamic-brcode" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter by external IDs.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "uuids", "value": "", "description": "Filter by UUIDs.", "disabled": true } ] }, "description": "List and filter all dynamic Brcodes. Results are paged." } }, { "name": "Get a Dynamic Brcode", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/dynamic-brcode/{{uuid}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "dynamic-brcode", "{{uuid}}" ] }, "description": "Get a single dynamic Brcode by its UUID." } } ], "description": "A Dynamic Brcode is a QR Code that returns payment details dynamically from your server when scanned.\nThe \"subscription\", \"subscriptionAndInstant\" and \"dueAndOrSubscription\" types let a Dynamic Brcode initiate a Pix Automático recurring authorization.\nHere we will show you how to create and manage them." }, { "name": "Brcode Preview", "item": [ { "name": "Create Brcode Previews", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-preview", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-preview" ] }, "description": "Fetch and preview the details of one or more Pix QR codes before payment.", "body": { "mode": "raw", "raw": "{\n \"brcodePreviews\": [\n {\n \"id\": \"\",\n \"payerId\": \"\",\n \"scheduled\": \"\",\n \"endToEndId\": \"\",\n \"cityCode\": \"\",\n \"expand\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "A Brcode Preview allows you to fetch the information encoded in a QR code before initiating a Pix payment or accepting a Pix Subscription.\nHere we will show you how to retrieve Brcode previews." }, { "name": "Pix Pull Subscription", "item": [ { "name": "Create Pix Pull Subscriptions", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-subscription", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-subscription" ] }, "description": "Create recurring Pix authorizations (Pix Automático).\nAuthorization is obtained through one of four journeys via the subscription type: push (push notification to the payer's bank), qrcode (QR Code with direct authorization), qrcodeAndPayment (QR Code with authorization upon payment), and paymentAndOrQrcode (billing QR Code with an authorization offer).", "body": { "mode": "raw", "raw": "{\n \"pixPullSubscriptions\": [\n {\n \"subscriptions\": \"\",\n \"type\": \"\",\n \"externalId\": \"\",\n \"bacenId\": \"\",\n \"referenceCode\": \"\",\n \"interval\": \"\",\n \"installmentStart\": \"\",\n \"receiverName\": \"\",\n \"receiverTaxId\": \"\",\n \"senderTaxId\": \"\",\n \"senderAccountNumber\": \"\",\n \"senderBranchCode\": \"\",\n \"amount\": \"\",\n \"amountMinLimit\": \"\",\n \"pullRetryLimit\": \"\",\n \"installmentEnd\": \"\",\n \"due\": \"\",\n \"description\": \"\",\n \"senderBankCode\": \"\",\n \"senderFinalName\": \"\",\n \"senderFinalTaxId\": \"\",\n \"senderCityCode\": \"\",\n \"receiverBankCode\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Pull Subscriptions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-subscription", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-subscription" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter by the external ids provided on creation.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "flows", "value": "", "description": "Filter by flow direction. Options: \"in\", \"out\".", "disabled": true } ] }, "description": "List and filter all Pix pull subscriptions. Results are paged." } }, { "name": "Get a Pix Pull Subscription", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-subscription/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-subscription", "{{id}}" ] }, "description": "Get a single Pix pull subscription by its id." } }, { "name": "Update a Pix Pull Subscription", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-subscription/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-subscription", "{{id}}" ] }, "description": "Approve, deny or activate a Pix pull subscription. The allowed status transitions depend on whether you are the payer or the receiver.\nWhen confirming a received subscription, include the senderCityCode field.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"reason\": \"\",\n \"senderCityCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a Pix Pull Subscription", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-subscription/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-subscription", "{{id}}" ], "query": [ { "key": "reason", "value": "", "description": "Reason for the cancellation. The available values depend on whether you are the sender or the receiver. Options: \"accountClosed\", \"receiverOrganizationClosed\", \"receiverInternalError\", \"senderDeceased\", \"fraud\", \"senderUserRequested\", \"receiverUserRequested\", \"paymentNotFound\".", "disabled": true } ] }, "description": "Cancel a Pix pull subscription." } }, { "name": "List Pix Pull Subscription Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-subscription/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-subscription", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "subscriptionIds", "value": "", "description": "Filter logs by the Pix pull subscription ids they belong to.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter by log types. Options: \"created\", \"delivering\", \"delivered\", \"approved\", \"confirmed\", \"failed\", \"denied\", \"canceling\", \"canceled\", \"expired\".", "disabled": true } ] }, "description": "Get a paged list of all Pix pull subscription logs." } }, { "name": "Get a Pix Pull Subscription Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-subscription/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-subscription", "log", "{{id}}" ] }, "description": "Get a single Pix pull subscription log by its id." } } ], "description": "A Pix Pull Subscription is a recurring authorization (Pix Automático) that lets a receiver pull Pix payments from a payer's account on a defined schedule.\nHere we will show you how to create and manage them." }, { "name": "Pix Pull Request", "item": [ { "name": "Create Pix Pull Requests", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-request" ] }, "description": "Issue charges against active Pix pull subscriptions.\nAs the receiver bank, create a Pix Pull Request to instruct a debit from the payer's account on a scheduled date. Stark Infra verifies that the subscription is approved, the amount is within the authorized limit, the settlement date matches the subscription's charge cycle, payer/receiver details match the contract, the request is made between 10 and 2 days before settlement, and there is no other scheduled request for the same cycle.", "body": { "mode": "raw", "raw": "{\n \"pixPullRequests\": [\n {\n \"requests\": \"\",\n \"subscriptionId\": \"\",\n \"amount\": \"\",\n \"due\": \"\",\n \"attemptType\": \"\",\n \"endToEndId\": \"\",\n \"reconciliationId\": \"\",\n \"receiverAccountNumber\": \"\",\n \"receiverAccountType\": \"\",\n \"receiverBankCode\": \"\",\n \"receiverBranchCode\": \"\",\n \"description\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Pull Requests", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-request" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "subscriptionIds", "value": "", "description": "Filter by the Pix pull subscription ids the requests belong to.", "disabled": true }, { "key": "endToEndIds", "value": "", "description": "Filter by the end-to-end ids of the requests.", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter by the external ids of the requests.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "attemptTypes", "value": "", "description": "Filter by attempt type. Options: \"default\", \"scheduledRetry\", \"instantRetry\".", "disabled": true }, { "key": "flows", "value": "", "description": "Filter by flow direction. Options: \"in\", \"out\".", "disabled": true } ] }, "description": "List and filter all Pix pull requests. Results are paged." } }, { "name": "Get a Pix Pull Request", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-request/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-request", "{{id}}" ] }, "description": "Get a single Pix pull request by its id." } }, { "name": "Update a Pix Pull Request", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-request/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-request", "{{id}}" ] }, "description": "Schedule or deny a Pix pull request. Only the payer may update a pull request.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a Pix Pull Request", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-request/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-request", "{{id}}" ], "query": [ { "key": "reason", "value": "", "description": "Reason for the cancellation. The available values depend on whether you are the sender or the receiver. Options: \"accountClosed\", \"accountBlocked\", \"pixRequestFailed\", \"other\", \"senderUserRequested\", \"receiverUserRequested\"." } ] }, "description": "Cancel a Pix pull request." } }, { "name": "List Pix Pull Request Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-request/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-request", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "requestIds", "value": "", "description": "Filter logs by the Pix pull request ids they belong to.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter by log types. Options: \"created\", \"sent\", \"scheduled\", \"denied\", \"success\", \"failed\", \"canceling\", \"canceled\", \"expired\".", "disabled": true } ] }, "description": "Get a paged list of all Pix pull request logs." } }, { "name": "Get a Pix Pull Request Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-pull-request/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-pull-request", "log", "{{id}}" ] }, "description": "Get a single Pix pull request log by its id." } } ], "description": "A Pix Pull Request is a single charge issued against an active Pix Pull Subscription (Pix Automático), pulling a payment from the payer's account.\nHere we will show you how to create and manage them." }, { "name": "Pix Key", "item": [ { "name": "Create a Pix Key", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key" ] }, "description": "Register a new Pix key in DICT for your workspace.", "body": { "mode": "raw", "raw": "{\n \"pixKeys\": [\n {\n \"accountCreated\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"branchCode\": \"\",\n \"name\": \"\",\n \"taxId\": \"\",\n \"id\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of key values to get specific entities.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "taxId", "value": "", "description": "Filter Pix keys by the holder's CPF or CNPJ.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by key type.", "disabled": true } ] }, "description": "List and filter all Pix keys registered in your workspace." } }, { "name": "Get a Pix Key", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "payerTaxId", "value": "", "description": "Tax ID of the payer for DICT query purposes.", "disabled": true }, { "key": "endToEndId", "value": "", "description": "Unique end-to-end ID of the Pix transaction associated with this DICT query.", "disabled": true }, { "key": "expand", "value": "", "description": "Entity fields to expand in the response. Options: \"statistics\", \"ownerStatistics\".", "disabled": true } ] }, "description": "Get a single Pix key by its id." } }, { "name": "Update a Pix Key", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key", "{{id}}" ] }, "description": "Update the account information linked to a Pix key.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\",\n \"accountCreated\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"branchCode\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a Pix Key", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key", "{{id}}" ] }, "description": "Cancel a Pix key and remove it from DICT." } }, { "name": "List Pix Key Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "Filter by Pix key ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Pix key logs." } }, { "name": "Get a Pix Key Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key", "log", "{{id}}" ] }, "description": "Get a single Pix key log by its id." } } ], "description": "A Pix Key is an alias that can be used to identify a bank account in the Brazilian Pix system (DICT).\nHere we will show you how to create and manage them." }, { "name": "Pix Key Holmes", "item": [ { "name": "Create Pix Key Holmes", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key-holmes", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key-holmes" ] }, "description": "Request the verification of one or more Pix keys in DICT.\nYou can create up to 100 Pix key holmes in a single request.", "body": { "mode": "raw", "raw": "{\n \"pixKeyHolmes\": [\n {\n \"keyId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Key Holmes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key-holmes", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key-holmes" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "keyId", "value": "", "description": "Filter by the verified Pix key.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status. Options: \"solving\", \"solved\".", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "List and filter all Pix key holmes. Results are paged." } }, { "name": "Get a Pix Key Holmes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key-holmes/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key-holmes", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix key holmes by its id." } }, { "name": "List Pix Key Holmes Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key-holmes/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key-holmes", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "Filter by Pix key holmes log ids.", "disabled": true }, { "key": "holmesIds", "value": "", "description": "Filter logs by the Pix key holmes ids they belong to.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter by log types. Options: \"solving\", \"solved\".", "disabled": true } ] }, "description": "Get a paged list of all Pix key holmes logs." } }, { "name": "Get a Pix Key Holmes Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-key-holmes/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-key-holmes", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix key holmes log by its id." } } ], "description": "PixKeyHolmes are used by a Pix participant to verify whether a Pix key is registered in DICT, the Brazilian Central Bank's key directory.\nHere we will show you how to create and manage them." }, { "name": "Pix Claim", "item": [ { "name": "Create a Pix Claim", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-claim", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-claim" ] }, "description": "Initiate a Pix key portability or ownership claim.\nAn ownership claim changes the holder of a Pix Key (only phone keyType). A portability claim changes the linked account without changing the holder (phone, email or taxId keyTypes).", "body": { "mode": "raw", "raw": "{\n \"pixClaims\": [\n {\n \"accountCreated\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"branchCode\": \"\",\n \"name\": \"\",\n \"taxId\": \"\",\n \"keyId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Claims", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-claim", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-claim" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "bacenId", "value": "", "description": "Filter by the Central Bank ID of the Pix claim.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "flow", "value": "", "description": "Filter by claim flow. Options: \"in\" (incoming claims), \"out\" (outgoing claims).", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "keyId", "value": "", "description": "Filter by the Pix key value.", "disabled": true }, { "key": "keyType", "value": "", "description": "Filter by the type of the Pix key being claimed. Options: \"cpf\", \"cnpj\", \"phone\", \"email\", \"evp\".", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by claim type.", "disabled": true } ] }, "description": "List and filter all Pix claims. Results are paged." } }, { "name": "Get a Pix Claim", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-claim/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-claim", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix claim by its id." } }, { "name": "Update a Pix Claim", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-claim/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-claim", "{{id}}" ] }, "description": "Confirm or cancel an incoming Pix claim.\nYou must answer an inbound Pix Claim within 7 days of its status changing to delivered. If unanswered, a portability claim is rejected by default and an ownership claim is accepted by default, both with reason defaultBehavior.\nYou can only confirm Pix Claims with delivered status; confirming deletes the referenced Pix Key from Stark Infra and the Central Bank.\nYou can only cancel Pix Claims with delivered or confirmed status.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Claim Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-claim/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-claim", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "claimIds", "value": "", "description": "List of strings to filter logs by their Pix claim ids.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "Filter by Pix claim ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Pix claim logs." } }, { "name": "Get a Pix Claim Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-claim/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-claim", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix claim log by its id." } } ], "description": "A Pix Claim is used to port or own a Pix key from another institution to your workspace.\nHere we will show you how to create and manage them." }, { "name": "Pix Infraction", "item": [ { "name": "List Pix Infractions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-infraction", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-infraction" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by infraction type.", "disabled": true } ] }, "description": "List and filter all Pix infractions. Results are paged." } }, { "name": "Get a Pix Infraction", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-infraction/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-infraction", "{{id}}" ] }, "description": "Get a single Pix infraction by its id." } }, { "name": "Update a Pix Infraction", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-infraction/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-infraction", "{{id}}" ] }, "description": "Respond to an incoming Pix infraction report.\nAgree with an inbound infraction by patching its analysis to agreed, or disagree by patching it to disagreed.", "body": { "mode": "raw", "raw": "{\n \"result\": \"\",\n \"fraudType\": \"\",\n \"analysis\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a Pix Infraction", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-infraction/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-infraction", "{{id}}" ] }, "description": "Cancel a Pix infraction you reported." } }, { "name": "List Pix Infraction Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-infraction/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-infraction", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "Filter by Pix infraction ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Pix infraction logs." } }, { "name": "Get a Pix Infraction Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-infraction/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-infraction", "log", "{{id}}" ] }, "description": "Get a single Pix infraction log by its id." } } ], "description": "A Pix Infraction is used to respond to Pix fraud and operational issues to the Brazilian Central Bank.\nHere we will show you how to manage them." }, { "name": "Pix Chargeback", "item": [ { "name": "Create Pix Chargebacks", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-chargeback", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-chargeback" ] }, "description": "Request a chargeback for a Pix transaction.\nA Pix Chargeback requests the reversal of a Pix transaction and should only be created after a corresponding Pix Infraction is completed (or a system malfunction). The other participant must answer within 24 hours. The only supported reason is flaw — reversing an erroneous transaction caused by a system malfunction.", "body": { "mode": "raw", "raw": "{\n \"pixChargebacks\": [\n {\n \"amount\": \"\",\n \"reason\": \"\",\n \"referenceId\": \"\",\n \"description\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Chargebacks", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-chargeback", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-chargeback" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "bacenId", "value": "", "description": "Filter by the Central Bank ID of the Pix chargeback.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "flow", "value": "", "description": "Filter by flow direction. Options: \"in\", \"out\".", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "referenceIds", "value": "", "description": "List of end-to-end IDs of the original Pix transactions to filter by. Max = 30.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "List and filter all Pix chargebacks. Results are paged." } }, { "name": "Get a Pix Chargeback", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-chargeback/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-chargeback", "{{id}}" ] }, "description": "Get a single Pix chargeback by its id." } }, { "name": "Update a Pix Chargeback", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-chargeback/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-chargeback", "{{id}}" ] }, "description": "Respond to an incoming Pix chargeback request.", "body": { "mode": "raw", "raw": "{\n \"result\": \"\",\n \"analysis\": \"\",\n \"rejectionReason\": \"\",\n \"reversalReferenceId\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a Pix Chargeback", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-chargeback/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-chargeback", "{{id}}" ] }, "description": "Cancel a Pix chargeback you requested." } }, { "name": "List Pix Chargeback Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-chargeback/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-chargeback", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "chargebackIds", "value": "", "description": "Filter by Pix chargeback ids. Max = 30.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Pix chargeback logs." } }, { "name": "Get a Pix Chargeback Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-chargeback/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-chargeback", "log", "{{id}}" ] }, "description": "Get a single Pix chargeback log by its id." } } ], "description": "A Pix Chargeback allows you to request the return of funds from a Pix transaction made in error or due to fraud, and to respond to chargebacks opened against your transactions, through MED.\nHere we will show you how to create and manage them." }, { "name": "Pix Fraud", "item": [ { "name": "Create Pix Fraud Reports", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-fraud", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-fraud" ] }, "description": "Report a fraudulent user or Pix key to DICT.", "body": { "mode": "raw", "raw": "{\n \"pixFrauds\": [\n {\n \"externalId\": \"\",\n \"type\": \"\",\n \"taxId\": \"\",\n \"keyId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Fraud Reports", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-fraud", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-fraud" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "bacenId", "value": "", "description": "Filter by the Central Bank ID of the fraud report.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "type", "value": "", "description": "Filter by fraud type.", "disabled": true } ] }, "description": "List and filter all Pix fraud reports. Results are paged." } }, { "name": "Get a Pix Fraud Report", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-fraud/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-fraud", "{{id}}" ] }, "description": "Get a single Pix fraud report by its id." } }, { "name": "Cancel a Pix Fraud Report", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-fraud/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-fraud", "{{id}}" ] }, "description": "Cancel a Pix fraud report you submitted." } }, { "name": "List Pix Fraud Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-fraud/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-fraud", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "ids", "value": "", "description": "Filter by Pix fraud log ids.", "disabled": true }, { "key": "fraudIds", "value": "", "description": "Filter logs by the Pix fraud report ids they belong to.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter by log types. Options: \"created\", \"failed\", \"registered\", \"canceling\", \"canceled\".", "disabled": true } ] }, "description": "Get a paged list of all Pix fraud logs." } }, { "name": "Get a Pix Fraud Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-fraud/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-fraud", "log", "{{id}}" ] }, "description": "Get a single Pix fraud log by its id." } } ], "description": "A Pix Fraud report allows you to flag suspicious users or keys in the Brazilian Pix system (DICT).\nHere we will show you how to create and manage them." }, { "name": "Pix Dispute", "item": [ { "name": "Create Pix Disputes", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-dispute", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-dispute" ] }, "description": "Initiate a Pix dispute for a transaction.", "body": { "mode": "raw", "raw": "{\n \"pixDisputes\": [\n {\n \"referenceId\": \"\",\n \"method\": \"\",\n \"operatorEmail\": \"\",\n \"operatorPhone\": \"\",\n \"description\": \"\",\n \"minTransactionAmount\": \"\",\n \"maxHopCount\": \"\",\n \"maxHopInterval\": \"\",\n \"maxTransactionCount\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Disputes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-dispute", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-dispute" ], "query": [ { "key": "bacenId", "value": "", "description": "Filter for the Central Bank's unique ID of the Pix dispute.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "flow", "value": "", "description": "Filter by flow direction. Options: \"in\", \"out\".", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "referenceIds", "value": "", "description": "List of end-to-end IDs to get disputes by their original Pix transactions.", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "List and filter all Pix disputes. Results are paged." } }, { "name": "Get a Pix Dispute", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-dispute/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-dispute", "{{id}}" ] }, "description": "Get a single Pix dispute by its id." } }, { "name": "Cancel a Pix Dispute", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-dispute/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-dispute", "{{id}}" ] }, "description": "Cancel a Pix dispute you initiated." } }, { "name": "List Pix Dispute Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-dispute/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-dispute", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "disputeIds", "value": "", "description": "List of strings to get logs by their Pix dispute ids.", "disabled": true }, { "key": "ids", "value": "", "description": "Filter by Pix dispute ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Pix dispute logs." } }, { "name": "Get a Pix Dispute Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-dispute/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-dispute", "log", "{{id}}" ] }, "description": "Get a single Pix dispute log by its id." } } ], "description": "A Pix Dispute allows you to request, cancel and consult disputes related to Pix transactions through MED 2.0.\nHere we will show you how to create and manage them." }, { "name": "Pix User", "item": [ { "name": "Get a Pix User", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-user/{{taxId}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-user", "{{taxId}}" ], "query": [ { "key": "keyId", "value": "", "description": "Pix key to retrieve statistics for. When provided, the response returns the key statistics instead of the owner statistics.", "disabled": true } ] }, "description": "Retrieve a user's aggregated Pix statistics — Pix keys, Pix requests, frauds and infractions — for a specific user by their tax ID." } } ], "description": "The Pix User resource lets you consult, through DICT, an end user's statistics on Pix keys, Pix requests, frauds and infractions registered across Bacen's systems (e.g. SPI for Pix requests).\nHere we will show you how to retrieve user data." }, { "name": "Pix Balance", "item": [ { "name": "Get Pix Balance", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-balance", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-balance" ], "query": [ { "key": "before", "value": "", "description": "Date used to retrieve the balance as of the end of the informed day. Example: \"2022-01-31\". When omitted or set to the current day, the current balance is returned.", "disabled": true } ] }, "description": "Retrieve the current Pix balance of your workspace." } } ], "description": "The Pix Balance represents the current available balance in your Pix account.\nHere we will show you how to retrieve it." }, { "name": "Pix Domain", "item": [ { "name": "List Pix Domains", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-domain", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-domain" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List all registered Pix domains and their certificate chains." } } ], "description": "Pix Domains are the domains Pix participants register with Bacen to provide Brcodes, along with their respective certificate chains used for secure communication.\nHere we will show you how to list them." }, { "name": "Pix Statement", "item": [ { "name": "Create a Pix Statement", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-statement", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-statement" ] }, "description": "Request a Pix statement for a specific period and type.", "body": { "mode": "raw", "raw": "{\n \"pixStatements\": [\n {\n \"after\": \"\",\n \"before\": \"\",\n \"type\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Pix Statements", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-statement", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-statement" ], "query": [ { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true } ] }, "description": "List and filter all Pix statements. Results are paged." } }, { "name": "Get a Pix Statement", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-statement/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-statement", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Pix statement by its id." } }, { "name": "Get a Pix Statement CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-statement/{{id}}/csv", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-statement", "{{id}}", "csv" ] }, "description": "Get the CSV file for a completed Pix statement. The file is returned compressed in the gzip format." } }, { "name": "Get a Pix Statement Chunk", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-statement/{{id}}/chunk/{{number}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-statement", "{{id}}", "chunk", "{{number}}" ] }, "description": "Get a single chunk of a completed Pix statement. Large statements are split into numbered parts, letting you download one chunk at a time. The chunk is returned compressed in the gzip format." } } ], "description": "A Pix Statement allows you to request a detailed report of all Pix transactions in your account for a given period.\nHere we will show you how to create and manage them." }, { "name": "Pix Director", "item": [ { "name": "Create a Pix Director", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/pix-director", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "pix-director" ] }, "description": "Register the Pix director for your institution as required by the Brazilian Central Bank.", "body": { "mode": "raw", "raw": "{\n \"pixDirectors\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"phone\": \"\",\n \"taxId\": \"\",\n \"teamEmail\": \"\",\n \"teamPhones\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "The Pix Director represents the responsible officer for Pix operations in your institution, as required by the Brazilian Central Bank.\nHere we will show you how to register them." } ] }, { "name": "Issuing", "item": [ { "name": "Issuing Balance", "item": [ { "name": "Get the Issuing Balance", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-balance", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-balance" ] }, "description": "Get the current balance in your issuing wallet." } } ], "description": "The Issuing Balance resource represents the total funds available in your issuing wallet.\nThis balance is separate from your main Stark Infra balance and is used exclusively for card spending.\nFund your issuing balance using Issuing Invoices and withdraw using Issuing Withdrawals." }, { "name": "Issuing Product", "item": [ { "name": "List Issuing Products", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-product", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-product" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true } ] }, "description": "Get a list of available issuing products for your workspace." } } ], "description": "The Issuing Product resource lists the card products available to your workspace.\nEach product has a network, funding type, holder type, and product code that define the characteristics of cards that can be created using that product." }, { "name": "Issuing Holder", "item": [ { "name": "Create Issuing Holders", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-holder", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-holder" ] }, "description": "Use this route to create up to 100 new issuing holders at a time.", "body": { "mode": "raw", "raw": "{\n \"issuingHolders\": [\n {\n \"name\": \"\",\n \"taxId\": \"\",\n \"externalId\": \"\",\n \"rules\": \"\",\n \"tags\": \"\",\n \"expand\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Holders", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-holder", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-holder" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter holders by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "expand", "value": "", "description": "Fields to return expanded in the response. Options: \"rules\".", "disabled": true } ] }, "description": "Get a list of issuing holders in chunks of at most 100." } }, { "name": "Get an Issuing Holder", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-holder/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-holder", "{{id}}" ], "query": [ { "key": "expand", "value": "", "description": "Fields to return expanded in the response. Options: \"rules\".", "disabled": true } ] }, "description": "Get a single issuing holder by its id." } }, { "name": "Update an Issuing Holder", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-holder/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-holder", "{{id}}" ] }, "description": "Update the properties of an existing issuing holder.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"name\": \"\",\n \"rules\": \"\",\n \"tags\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel an Issuing Holder", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-holder/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-holder", "{{id}}" ] }, "description": "Cancel an issuing holder. This action is irreversible." } }, { "name": "List Issuing Holder Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-holder/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-holder", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "holderIds", "value": "", "description": "Array of holder ids to filter logs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific log entities by ids.", "disabled": true } ] }, "description": "Get a paged list of issuing holder logs." } }, { "name": "Get an Issuing Holder Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-holder/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-holder", "log", "{{id}}" ] }, "description": "Get a single issuing holder log by its id." } } ], "description": "The Issuing Holder resource represents the card holder entity in your workspace.\nA holder is associated with one or more issuing cards and defines who can use the cards issued.\nYou can set rules on the holder level to control spending limits and merchant restrictions." }, { "name": "Issuing Card", "item": [ { "name": "Create Issuing Cards", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-card", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-card" ] }, "description": "Use this route to create up to 100 new issuing cards at a time.", "body": { "mode": "raw", "raw": "{\n \"issuingCards\": [\n {\n \"holderName\": \"\",\n \"holderTaxId\": \"\",\n \"holderExternalId\": \"\",\n \"productId\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"rules\": \"\",\n \"tags\": \"\",\n \"streetLine1\": \"\",\n \"streetLine2\": \"\",\n \"district\": \"\",\n \"city\": \"\",\n \"stateCode\": \"\",\n \"zipCode\": \"\",\n \"expand\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Cards", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-card", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-card" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter cards by the specified status.", "disabled": true }, { "key": "types", "value": "", "description": "Filter cards by type. Options: \"virtual\", \"physical\".", "disabled": true }, { "key": "holderIds", "value": "", "description": "Filter cards by holder ids.", "disabled": true }, { "key": "endings", "value": "", "description": "List of strings to filter cards by their last 4 digits. Max 30.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "expand", "value": "", "description": "Fields to return expanded in the response. Options: \"rules\", \"securityCode\", \"number\", \"expiration\", \"isPinDefined\".", "disabled": true } ] }, "description": "Get a list of issuing cards in chunks of at most 100." } }, { "name": "Get an Issuing Card", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-card/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-card", "{{id}}" ], "query": [ { "key": "expand", "value": "", "description": "Fields to return expanded in the response. Options: \"rules\", \"securityCode\", \"number\", \"expiration\", \"isPinDefined\".", "disabled": true } ] }, "description": "Get a single issuing card by its id." } }, { "name": "Update an Issuing Card", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-card/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-card", "{{id}}" ] }, "description": "Update the properties of an existing issuing card.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"rules\": \"\",\n \"tags\": \"\",\n \"displayName\": \"\",\n \"pin\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel an Issuing Card", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-card/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-card", "{{id}}" ] }, "description": "Cancel an issuing card. This action is irreversible." } }, { "name": "List Issuing Card Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-card/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-card", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "cardIds", "value": "", "description": "Array of card ids to filter logs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific log entities by ids.", "disabled": true } ] }, "description": "Get a paged list of issuing card logs." } }, { "name": "Get an Issuing Card Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-card/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-card", "log", "{{id}}" ] }, "description": "Get a single issuing card log by its id." } } ], "description": "The Issuing Card resource represents a physical or virtual card issued to a holder.\nCards can be created as virtual (immediately available) or physical (requires embossing and shipping).\nYou can set rules on the card level to control spending limits, merchant restrictions, and other card behaviors." }, { "name": "Issuing Design", "item": [ { "name": "List Issuing Designs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-design", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-design" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a list of available issuing designs for your workspace." } }, { "name": "Get an Issuing Design", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-design/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-design", "{{id}}" ] }, "description": "Get a single issuing design by its id." } }, { "name": "Get an Issuing Design PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-design/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-design", "{{id}}", "pdf" ] }, "description": "Get the PDF file for a specific issuing design. This file can be used to preview the card layout." } } ], "description": "The Issuing Design resource represents the visual design of a physical card.\nDesigns define the artwork, fonts, and layout used when embossing and printing cards.\nYou can retrieve available designs and download their PDF templates." }, { "name": "Issuing Embossing Kit", "item": [ { "name": "List Issuing Embossing Kits", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-embossing-kit", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-embossing-kit" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date. Example: \"2022-01-20\".", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date. Example: \"2022-02-20\".", "disabled": true }, { "key": "designIds", "value": "", "description": "Filter by IssuingDesign ids.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a list of available issuing embossing kits for your workspace." } }, { "name": "Get an Issuing Embossing Kit", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-embossing-kit/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-embossing-kit", "{{id}}" ] }, "description": "Get a single issuing embossing kit by its id." } } ], "description": "The Issuing Embossing Kit resource represents a kit used for embossing physical cards.\nEach kit defines the card design and packaging used during the card personalization process." }, { "name": "Issuing Stock", "item": [ { "name": "List Issuing Stocks", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "designIds", "value": "", "description": "List of strings to filter stocks by specific IssuingDesign ids.", "disabled": true }, { "key": "embosserIds", "value": "", "description": "List of strings to filter stocks by specific embosser ids.", "disabled": true }, { "key": "expand", "value": "", "description": "Fields to expand information on the response. Options: \"balance\".", "disabled": true } ] }, "description": "Get a list of issuing stocks in chunks of at most 100." } }, { "name": "Get an Issuing Stock", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock", "{{id}}" ], "query": [ { "key": "expand", "value": "", "description": "Fields to expand information on the response. Options: \"balance\".", "disabled": true } ] }, "description": "Get a single issuing stock entry by its id." } }, { "name": "List Issuing Stock Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "stockIds", "value": "", "description": "Array of stock ids to filter logs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific log entities by ids.", "disabled": true } ] }, "description": "Get a paged list of issuing stock logs." } }, { "name": "Get an Issuing Stock Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock", "log", "{{id}}" ] }, "description": "Get a single issuing stock log by its id." } } ], "description": "The Issuing Stock resource tracks the inventory of physical card blanks available for embossing.\nEach stock entry is associated with a specific card design and holder type.\nMonitor your stock levels to ensure cards are available when needed." }, { "name": "Issuing Stock Rule", "item": [ { "name": "Create Issuing Stock Rules", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock-rule", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock-rule" ] }, "description": "Use this route to register stock rules.\nSend a \"rules\" array where each element carries the parameters below. At least one email or phone must be informed per rule.", "body": { "mode": "raw", "raw": "{\n \"issuingStockRules\": [\n {\n \"minimumBalance\": \"\",\n \"stockId\": \"\",\n \"emails\": \"\",\n \"phones\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Stock Rules", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock-rule", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock-rule" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter entities by status. Options: \"active\", \"canceled\".", "disabled": true }, { "key": "stockIds", "value": "", "description": "List of strings to get rules attached to specific IssuingStock ids.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "tags", "value": "", "description": "List of strings to filter entities by tags.", "disabled": true } ] }, "description": "Get a list of issuing stock rules in chunks of at most 100." } }, { "name": "Update an Issuing Stock Rule", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock-rule/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock-rule", "{{id}}" ] }, "description": "Update the properties of an existing issuing stock rule.", "body": { "mode": "raw", "raw": "{\n \"minimumBalance\": \"\",\n \"emails\": \"\",\n \"phones\": \"\",\n \"tags\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel an Issuing Stock Rule", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-stock-rule/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-stock-rule", "{{id}}" ] }, "description": "Cancel an issuing stock rule. This action is irreversible." } } ], "description": "The Issuing Stock Rule resource lets you register low-balance alerts for your card stocks.\nWhen the available count of an issuing stock falls below the configured minimum balance, the registered emails and phones are notified.\nEach issuing stock can have only one active rule at a time." }, { "name": "Issuing Restock", "item": [ { "name": "Create Issuing Restocks", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-restock", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-restock" ] }, "description": "Use this route to create up to 100 new issuing restock requests at a time.", "body": { "mode": "raw", "raw": "{\n \"issuingRestocks\": [\n {\n \"count\": \"\",\n \"stockId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Restocks", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-restock", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-restock" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter for status of retrieved entities. Options: \"created\", \"processing\", \"confirmed\", \"canceled\".", "disabled": true }, { "key": "stockIds", "value": "", "description": "List of IssuingStock ids to filter retrieved entities.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "tags", "value": "", "description": "List of strings to filter retrieved entities by tags.", "disabled": true } ] }, "description": "Get a list of issuing restock requests in chunks of at most 100." } }, { "name": "Get an Issuing Restock", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-restock/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-restock", "{{id}}" ] }, "description": "Get a single issuing restock by its id." } }, { "name": "List Issuing Restock Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-restock/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-restock", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "restockIds", "value": "", "description": "Array of restock ids to filter logs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a paged list of issuing restock logs." } }, { "name": "Get an Issuing Restock Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-restock/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-restock", "log", "{{id}}" ] }, "description": "Get a single issuing restock log by its id." } } ], "description": "The Issuing Restock resource is used to request additional card blanks when your stock is running low.\nEach restock request specifies the quantity needed and the stock to replenish.\nMonitor the status of your restock requests through the log endpoints." }, { "name": "Issuing Embossing Request", "item": [ { "name": "Create Issuing Embossing Requests", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-embossing-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-embossing-request" ] }, "description": "Use this route to create up to 100 new issuing embossing requests at a time.", "body": { "mode": "raw", "raw": "{\n \"issuingEmbossingRequests\": [\n {\n \"cardId\": \"\",\n \"kitId\": \"\",\n \"displayName1\": \"\",\n \"displayName2\": \"\",\n \"displayName3\": \"\",\n \"shippingCity\": \"\",\n \"shippingCountryCode\": \"\",\n \"shippingDistrict\": \"\",\n \"shippingService\": \"\",\n \"shippingStateCode\": \"\",\n \"shippingStreetLine1\": \"\",\n \"shippingStreetLine2\": \"\",\n \"shippingZipCode\": \"\",\n \"shippingTrackingNumber\": \"\",\n \"shippingPhone\": \"\",\n \"embosserId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Embossing Requests", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-embossing-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-embossing-request" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter requests by the specified status.", "disabled": true }, { "key": "cardIds", "value": "", "description": "List of IssuingCard ids to filter the retrieved entities.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a list of issuing embossing requests in chunks of at most 100." } }, { "name": "Get an Issuing Embossing Request", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-embossing-request/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-embossing-request", "{{id}}" ] }, "description": "Get a single issuing embossing request by its id." } }, { "name": "List Issuing Embossing Request Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-embossing-request/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-embossing-request", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "requestIds", "value": "", "description": "Array of embossing request ids to filter logs.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a paged list of issuing embossing request logs." } }, { "name": "Get an Issuing Embossing Request Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-embossing-request/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-embossing-request", "log", "{{id}}" ] }, "description": "Get a single issuing embossing request log by its id." } } ], "description": "The Issuing Embossing Request resource is used to initiate the personalization and delivery of a physical card.\nEach request specifies the card, kit, display name, and shipping address for card delivery.\nTrack the embossing and shipping status through the log endpoints." }, { "name": "Issuing Token", "item": [ { "name": "List Issuing Tokens", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter tokens by the specified status.", "disabled": true }, { "key": "cardIds", "value": "", "description": "Filter tokens by card ids.", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter tokens by external ids.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a list of issuing tokens in chunks of at most 100." } }, { "name": "Get an Issuing Token", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token", "{{id}}" ] }, "description": "Get a single issuing token by its id." } }, { "name": "Update an Issuing Token", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token", "{{id}}" ] }, "description": "Update the status or tags of an existing issuing token.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"tags\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel an Issuing Token", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token", "{{id}}" ] }, "description": "Cancel an issuing token. This action is irreversible." } }, { "name": "List Issuing Token Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "tokenIds", "value": "", "description": "Array of token ids to filter logs.", "disabled": true }, { "key": "tokenTags", "value": "", "description": "Filter logs by the tags of their tokens.", "disabled": true } ] }, "description": "Get a paged list of issuing token logs." } }, { "name": "Get an Issuing Token Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token", "log", "{{id}}" ] }, "description": "Get a single issuing token log by its id." } } ], "description": "The Issuing Token resource represents a tokenized version of a card stored in a digital wallet.\nTokens allow cardholders to make purchases using digital wallets without exposing the actual card number.\nYou can manage token status and monitor token activity through the log endpoints." }, { "name": "Issuing Token Request", "item": [ { "name": "Create an Issuing Token Request", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token-request" ] }, "description": "Use this route to process a tokenization request from a digital wallet provider.", "body": { "mode": "raw", "raw": "{\n \"issuingTokenRequests\": [\n {\n \"cardId\": \"\",\n \"walletId\": \"\",\n \"methodCode\": \"\",\n \"metadata\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "The Issuing Token Request resource is used to initiate the tokenization of a card for digital wallets.\nWhen a cardholder attempts to add a card to a digital wallet (e.g., Apple Pay, Google Pay), a token request is generated.\nProcess the token request to approve or decline the card tokenization." }, { "name": "Issuing Token Design", "item": [ { "name": "List Issuing Token Designs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token-design", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token-design" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a list of available issuing token designs for your workspace." } }, { "name": "Get an Issuing Token Design", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token-design/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token-design", "{{id}}" ] }, "description": "Get a single issuing token design by its id." } }, { "name": "Get an Issuing Token Design PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-token-design/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-token-design", "{{id}}", "pdf" ] }, "description": "Get the PDF file for a specific issuing token design. This file is used to represent the card in digital wallets." } } ], "description": "The Issuing Token Design resource represents the visual design used to display a tokenized card in a digital wallet.\nDesigns include the card artwork shown in the wallet app.\nYou can retrieve available token designs and download their PDF files." }, { "name": "Issuing Invoice", "item": [ { "name": "Create an Issuing Invoice", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-invoice", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-invoice" ] }, "description": "Use this route to create a new issuing invoice to fund your issuing balance.", "body": { "mode": "raw", "raw": "{\n \"issuingInvoices\": [\n {\n \"amount\": \"\",\n \"taxId\": \"\",\n \"name\": \"\",\n \"tags\": \"\",\n \"metadata\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-invoice", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-invoice" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter invoices by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of issuing invoices in chunks of at most 100." } }, { "name": "Get an Issuing Invoice", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-invoice/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-invoice", "{{id}}" ] }, "description": "Get a single issuing invoice by its id." } }, { "name": "List Issuing Invoice Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-invoice/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-invoice", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "ids", "value": "", "description": "Array of invoice ids to filter logs.", "disabled": true } ] }, "description": "Get a paged list of issuing invoice logs." } }, { "name": "Get an Issuing Invoice Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-invoice/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-invoice", "log", "{{id}}" ] }, "description": "Get a single issuing invoice log by its id." } } ], "description": "The Issuing Invoice resource is used to add funds to your issuing balance.\nGenerate a Pix invoice (brcode) to receive deposits directly into your issuing wallet.\nOnce paid, the funds become available in your issuing balance for card spending." }, { "name": "Issuing Billing Invoice", "item": [ { "name": "List Issuing Billing Invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-billing-invoice", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-billing-invoice" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter entities by status. Options: \"created\", \"pending\", \"overdue\", \"expired\", \"paid\".", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a list of issuing billing invoices in chunks of at most 100." } }, { "name": "Get an Issuing Billing Invoice", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-billing-invoice/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-billing-invoice", "{{id}}" ] }, "description": "Get a single issuing billing invoice by its id." } } ], "description": "The Issuing Billing Invoice resource represents the invoice that settles the postpaid usage of your issuing operation in a billing period.\nEach invoice consolidates the purchases and withdrawals settled in the billing period and can be paid via its brcode or link.\nFine and interest are applied when the invoice is paid after the due date." }, { "name": "Issuing Billing Transaction", "item": [ { "name": "List Issuing Billing Transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-billing-transaction", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-billing-transaction" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "invoiceId", "value": "", "description": "Filter transactions that compose a specific IssuingBillingInvoice.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "tags", "value": "", "description": "List of strings to filter entities by tags.", "disabled": true } ] }, "description": "Get a list of issuing billing transactions in chunks of at most 100." } } ], "description": "The Issuing Billing Transaction resource represents an entry that composes an issuing billing invoice.\nEach purchase or withdrawal settled in a billing period generates billing transactions, including the installments of installment purchases." }, { "name": "Issuing Purchase", "item": [ { "name": "List Issuing Purchases", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-purchase", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-purchase" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "status", "value": "", "description": "Filter purchases by the specified status.", "disabled": true }, { "key": "cardIds", "value": "", "description": "Filter purchases by card ids.", "disabled": true }, { "key": "holderIds", "value": "", "description": "Filter purchases by holder ids.", "disabled": true }, { "key": "endToEndIds", "value": "", "description": "Filter purchases by their end-to-end transaction ids.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true } ] }, "description": "Get a list of issuing purchases in chunks of at most 100." } }, { "name": "Get an Issuing Purchase", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-purchase/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-purchase", "{{id}}" ] }, "description": "Get a single issuing purchase by its id." } }, { "name": "Update an Issuing Purchase", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-purchase/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-purchase", "{{id}}" ] }, "description": "Update the tags of an existing issuing purchase.", "body": { "mode": "raw", "raw": "{\n \"tags\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Purchase Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-purchase/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-purchase", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true }, { "key": "purchaseIds", "value": "", "description": "Array of purchase ids to filter logs.", "disabled": true } ] }, "description": "Get a paged list of issuing purchase logs." } }, { "name": "Get an Issuing Purchase Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-purchase/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-purchase", "log", "{{id}}" ] }, "description": "Get a single issuing purchase log by its id." } } ], "description": "The Issuing Purchase resource represents a purchase transaction made with an issuing card.\nPurchases are created when a cardholder makes a payment at a merchant using an issued card.\nYou can list, retrieve, and update purchases, as well as monitor purchase events through the log endpoints." }, { "name": "Issuing Preview Installment", "item": [ { "name": "List Issuing Preview Installments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-preview-installment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-preview-installment" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "sort", "value": "", "description": "Sort order for the results. Options: \"created\", \"-created\", \"due\", \"-due\". Default: \"-created\".", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "tags", "value": "", "description": "List of strings to filter entities by tags.", "disabled": true } ] }, "description": "Get a list of issuing preview installments in chunks of at most 100." } } ], "description": "The Issuing Preview Installment resource represents an upcoming installment of an installment purchase that has not been billed yet.\nUse it to preview the amounts that will compose your future issuing billing invoices." }, { "name": "Issuing Transaction", "item": [ { "name": "List Issuing Transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-transaction", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-transaction" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "externalIds", "value": "", "description": "List of strings to get specific entities by their external ids.", "disabled": true }, { "key": "source", "value": "", "description": "Filter entities by the source entity that generated the transaction.", "disabled": true } ] }, "description": "Get a list of issuing transactions in chunks of at most 100." } }, { "name": "Get an Issuing Transaction", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-transaction/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-transaction", "{{id}}" ] }, "description": "Get a single issuing transaction by its id." } } ], "description": "The Issuing Transaction resource represents a change in your issuing balance.\nEach purchase, invoice payment, withdrawal, or fee generates an issuing transaction.\nUse transactions to reconcile your issuing balance and understand fund movements." }, { "name": "Issuing Withdrawal", "item": [ { "name": "Create an Issuing Withdrawal", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-withdrawal", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-withdrawal" ] }, "description": "Use this route to create a new issuing withdrawal and move funds from your issuing balance.", "body": { "mode": "raw", "raw": "{\n \"issuingWithdrawals\": [\n {\n \"amount\": \"\",\n \"externalId\": \"\",\n \"description\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Issuing Withdrawals", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-withdrawal", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-withdrawal" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "externalIds", "value": "", "description": "List of strings to get specific entities by their external ids.", "disabled": true } ] }, "description": "Get a list of issuing withdrawals in chunks of at most 100." } }, { "name": "Get an Issuing Withdrawal", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/issuing-withdrawal/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "issuing-withdrawal", "{{id}}" ] }, "description": "Get a single issuing withdrawal by its id." } } ], "description": "The Issuing Withdrawal resource is used to transfer funds from your issuing balance back to your main balance.\nUse withdrawals to move excess funds from your issuing wallet to your regular Stark Infra account." } ] }, { "name": "Lending", "item": [ { "name": "Credit Note", "item": [ { "name": "Create Credit Notes", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note" ] }, "description": "Create credit notes in bulk. You can create up to 100 credit notes in a single request.\nProvide either the nominalAmount (pre-tax) or the amount (net disbursed value) - the other one, along with the taxAmount (IOF) and the interest rates, is computed from the invoice schedule.", "body": { "mode": "raw", "raw": "{\n \"creditNotes\": [\n {\n \"templateId\": \"\",\n \"name\": \"\",\n \"taxId\": \"\",\n \"scheduled\": \"\",\n \"invoices\": \"\",\n \"payment\": \"\",\n \"paymentType\": \"\",\n \"signers\": \"\",\n \"externalId\": \"\",\n \"streetLine1\": \"\",\n \"streetLine2\": \"\",\n \"district\": \"\",\n \"city\": \"\",\n \"stateCode\": \"\",\n \"zipCode\": \"\",\n \"nominalAmount\": \"\",\n \"amount\": \"\",\n \"rebateAmount\": \"\",\n \"expiration\": \"\",\n \"rules\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Credit Notes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter credit notes by the specified status. Options: \"created\", \"signed\", \"processing\", \"success\", \"failed\", \"canceled\", \"expired\".", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids. Max = 100.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List and filter all credit notes created in your workspace. Results are returned paged." } }, { "name": "Get a Credit Note", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single credit note by its id." } }, { "name": "Cancel a Credit Note", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note", "{{id}}" ] }, "description": "Cancel a credit note that has not reached a final status yet. Credit notes with status \"created\", \"signed\" or \"processing\" can be canceled, which also cancels the signing document. Credit notes with status \"success\", \"failed\", \"expired\" or already \"canceled\" are returned unchanged." } }, { "name": "Get a Credit Note PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note", "{{id}}", "pdf" ] }, "description": "Get the CCB contract PDF file of a credit note. After all signers have signed, the returned file carries the digital signatures." } }, { "name": "Get a Credit Note Payment PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note/{{id}}/payment/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note", "{{id}}", "payment", "pdf" ] }, "description": "Get the disbursement transfer receipt PDF file of a credit note. Only available for credit notes with status \"success\"." } }, { "name": "List Credit Note Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "noteIds", "value": "", "description": "List of credit note ids linked to the desired logs. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log type. Options: \"created\", \"signing\", \"signed\", \"sending\", \"sent\", \"success\", \"failed\", \"refunded\", \"canceled\", \"expired\", \"updated\", \"registered\".", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a paged list of all credit note logs. A log tracks a change in the credit note entity according to its life cycle, as {\"id\", \"type\", \"errors\", \"note\", \"created\"} objects." } }, { "name": "Get a Credit Note Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-note/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-note", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single credit note log by its id." } } ], "description": "Credit Notes represent credit operations issued to individuals or businesses as Bank Credit Bills (Cédula de Crédito Bancário - CCB). They carry all the information needed to formalize a lending operation, including signers, installment invoices and the disbursement payment details.\nOnce created, the credit note generates a contract that must be digitally signed by all signers. After signing, the disbursement is transferred via Pix to the borrower's account and each installment is tracked through invoices.\nHere we will show you how to create and manage them." }, { "name": "Credit Signer", "item": [ { "name": "Update a Credit Signer", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-signer/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-signer", "{{id}}" ] }, "description": "Update the delivery state of a credit signer's signing token or link. Setting \"isSent\" to false marks it as not delivered, causing it to be sent again to the signer's contact. Use it when a signer misses the original email or SMS.", "body": { "mode": "raw", "raw": "{\n \"isSent\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "Credit Signers represent every person or entity that must sign the CCB contract of a Credit Note.\nSigners are created together with the Credit Note, through its \"signers\" parameter, and are returned embedded in the CreditNote object. Signers registered in your credit profile and the SCD signature are appended automatically.\nWhen the method is \"link\" or \"token\", the signer receives the signing link or token on the registered contact (email or phone). If a signer misses it, you can trigger a new delivery." }, { "name": "Credit Preview", "item": [ { "name": "Create Credit Previews", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-preview", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-preview" ] }, "description": "Create credit previews to simulate credit notes before actually creating them. You can create up to 100 previews in a single request.\nFor the \"sac\" and \"price\" types, provide exactly one of \"count\" or \"initialAmount\" - the other one is computed. For all types except \"custom\", provide exactly one of \"nominalAmount\" or \"amount\".", "body": { "mode": "raw", "raw": "{\n \"creditPreviews\": [\n {\n \"type\": \"\",\n \"credit\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "CreditPreviews are used to preview a credit operation before creating it.\nYou can simulate the installment schedule, the IOF tax amount, the disbursed amount and the effective interest rates of a Credit Note without persisting anything. Previews are computed on the fly and are not saved." }, { "name": "Credit Holmes", "item": [ { "name": "Create Credit Holmes", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-holmes", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-holmes" ] }, "description": "Create credit holmes requests to analyze the credit profile of a tax ID.\nYou can create up to 100 requests in a single call.", "body": { "mode": "raw", "raw": "{\n \"creditHolmes\": [\n {\n \"taxId\": \"\",\n \"competence\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Credit Holmes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-holmes", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-holmes" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter credit holmes by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List and filter all credit holmes requests in your workspace. Results are returned paged." } }, { "name": "Get a Credit Holmes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-holmes/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-holmes", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single credit holmes by its id." } }, { "name": "List Credit Holmes Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-holmes/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-holmes", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "ids", "value": "", "description": "List of credit holmes ids linked to the desired logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log type.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a paged list of all credit holmes logs. A log tracks a change in the credit holmes entity according to its life cycle." } }, { "name": "Get a Credit Holmes Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/credit-holmes/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "credit-holmes", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single credit holmes log by its id." } } ], "description": "CreditHolmes are used to request the credit analysis of a tax ID.\nThe analysis retrieves credit information from official sources for a given CPF or CNPJ, helping you evaluate the creditworthiness of a borrower." } ] }, { "name": "Ledger", "item": [ { "name": "Ledger", "item": [ { "name": "Create Ledgers", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger" ] }, "description": "Use this route to create up to 100 new ledgers at a time.", "body": { "mode": "raw", "raw": "{\n \"ledgers\": [\n {\n \"externalId\": \"\",\n \"rules\": \"\",\n \"tags\": \"\",\n \"metadata\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Ledgers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter by external IDs.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a list of ledgers in chunks of at most 100." } }, { "name": "Get a Ledger", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single ledger by its id." } }, { "name": "Update a Ledger", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger", "{{id}}" ] }, "description": "Update the rules, tags or metadata of an existing ledger.", "body": { "mode": "raw", "raw": "{\n \"rules\": \"\",\n \"tags\": \"\",\n \"metadata\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Ledger Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger", "log" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "ledgerId", "value": "", "description": "Filter logs by ledger id. Only a single ledger id can be informed per query.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a paged list of ledger logs." } }, { "name": "Get a Ledger Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single ledger log by its id." } } ], "description": "The Ledger resource is used to track the balance of a given amount by inserting LedgerTransactions to it.\nA Ledger can represent a bank account, a digital wallet, an inventory product, or any other entity whose balance you need to keep track of.\nYou can attach rules to a Ledger to limit its balance, such as a minimum or maximum balance, which are validated whenever a LedgerTransaction is created." }, { "name": "Ledger Transaction", "item": [ { "name": "Create Ledger Transactions", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger-transaction", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger-transaction" ] }, "description": "Use this route to create up to 500 new ledger transactions at a time.\nA single request may contain transactions targeting different ledgers. Each transaction is applied to its Ledger in the order it is sent and the resulting balance is returned for each one.", "body": { "mode": "raw", "raw": "{\n \"ledgerTransactions\": [\n {\n \"amount\": \"\",\n \"ledgerId\": \"\",\n \"externalId\": \"\",\n \"source\": \"\",\n \"fee\": \"\",\n \"created\": \"\",\n \"rules\": \"\",\n \"tags\": \"\",\n \"metadata\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Ledger Transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger-transaction", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger-transaction" ], "query": [ { "key": "ledgerId", "value": "", "description": "Id of the Ledger associated with the transactions. Either \"ledgerId\" or \"ids\" must be provided.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids. The informed ids may belong to transactions in different ledgers. Either \"ledgerId\" or \"ids\" must be provided.", "disabled": true }, { "key": "flow", "value": "", "description": "Direction of the Ledger Transaction. Options: \"in\" (credit), \"out\" (debit).", "disabled": true }, { "key": "externalIds", "value": "", "description": "Filter by external IDs.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a list of ledger transactions in chunks of at most 1000.\nEither \"ledgerId\" or \"ids\" must be provided. If both are sent, results are filtered by both. When filtering by \"ids\", the informed ids may reference transactions across different ledgers." } }, { "name": "Get a Ledger Transaction", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/ledger-transaction/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "ledger-transaction", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single ledger transaction by its id." } } ], "description": "The LedgerTransaction resource is used to move balance in or out of a Ledger.\nEach transaction carries an amount that is added to (or subtracted from) the Ledger balance, producing a new running balance that is returned in the response.\nTransactions are validated against the rules of their Ledger, so a transaction that would push the balance beyond a configured minimum or maximum balance is rejected." } ] }, { "name": "Identity", "item": [ { "name": "Business Identity", "item": [ { "name": "Create Business Identities", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-identity", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-identity" ] }, "description": "Create one or more BusinessIdentities to start the Contract AI flow.\nEach entry is created in pending status. Save the returned id — you'll use it as identityId when uploading the Business Attachments and as the path parameter on subsequent calls.\nValidations: the CNPJ must be valid, must be active in the official bureau and must return non-empty representatives (sócios).", "body": { "mode": "raw", "raw": "{\n \"businessIdentitys\": [\n {\n \"taxId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Business Identities", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-identity", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-identity" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date. Format: ISO 8601 or YYYY-MM-DD.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date. Format: ISO 8601 or YYYY-MM-DD.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter identities by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "taxIds", "value": "", "description": "List of CNPJs to filter the response by.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List and filter all business identities in your workspace. Results are returned paged via cursor." } }, { "name": "Get a Business Identity", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-identity/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-identity", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single business identity by its id. When status=success, the response includes the populated rules string with the signing combinations extracted by the AI Model." } }, { "name": "Update a Business Identity", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-identity/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-identity", "{{id}}" ] }, "description": "Send a business identity to processing or replace its tags.\nTo trigger the AI Model analysis, set status=processing. The identity must be in created/pending status and must already have at least one Business Attachment associated with it.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"tags\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a Business Identity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-identity/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-identity", "{{id}}" ] }, "description": "Cancel a business identity. Only identities in created or pending status can be canceled." } }, { "name": "List Business Identity Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-identity/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-identity", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "identityIds", "value": "", "description": "List of business identity ids linked to the desired logs. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log type. Options: \"created\", \"updated\", \"processing\", \"canceled\", \"success\", \"failed\".", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a paged list of all business identity logs. A log tracks a change in the business identity entity according to its lifecycle." } }, { "name": "Get a Business Identity Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-identity/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-identity", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single business identity log by its id." } } ], "description": "BusinessIdentities validate the identity of a legal entity (CNPJ) and feed its corporate documents into the Contract AI model.\nAfter creating an identity, upload one or more Business Attachments referencing the returned id and PATCH the identity to processing. The structured signing rules extracted by the AI Model are delivered through the business-identity webhook when the identity reaches success." }, { "name": "Business Attachment", "item": [ { "name": "Upload a Business Attachment", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-attachment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-attachment" ] }, "description": "Upload a single corporate document tied to a previously created Business Identity. Limit of 1 attachment per request and 2 attachments per identity.\nValidations: only PDF, JPG and PNG are accepted, ≤ 8 MB per attachment; the name must be unique among the identity's other created attachments; the identity must be in created/pending status and have fewer than 2 attachments.", "body": { "mode": "raw", "raw": "{\n \"businessAttachments\": [\n {\n \"name\": \"\",\n \"content\": \"\",\n \"identityId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Business Attachments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-attachment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-attachment" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter attachments by status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List and filter all business attachments in your workspace. Results are returned paged via cursor." } }, { "name": "Get a Business Attachment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-attachment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-attachment", "{{id}}" ], "query": [ { "key": "expand", "value": "", "description": "List of fields to expand. Currently only content is supported — when present, the response includes the base64-encoded file payload.", "disabled": true } ] }, "description": "Get a single business attachment by its id. Pass expand=content to include the base64 file payload in the response." } }, { "name": "Cancel a Business Attachment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-attachment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-attachment", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Cancel a business attachment. Only attachments in created status can be canceled." } }, { "name": "List Business Attachment Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-attachment/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-attachment", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "attachmentIds", "value": "", "description": "List of business attachment ids linked to the desired logs. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log type. Options: \"created\", \"canceled\", \"approved\", \"denied\".", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a paged list of all business attachment logs. A log tracks a change in the business attachment entity according to its lifecycle." } }, { "name": "Get a Business Attachment Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/business-attachment/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "business-attachment", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single business attachment log by its id." } } ], "description": "BusinessAttachments are corporate documents (articles of incorporation, amendments, board minutes) uploaded against a Business Identity.\nEach Business Identity accepts up to two attachments. The attachment goes through OCR and document validation; once both attachments are approved, the parent identity can be sent to processing to run the AI Model analysis." }, { "name": "Individual Identity", "item": [ { "name": "Create Individual Identities", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity" ] }, "description": "Create one or more Individual Identities. Each entry is returned in created status and already carries the validatorLink the holder will use to submit each proof.\nValidations: the workspace must have an Identity Profile; every value in proofs must be enabled on that profile.", "body": { "mode": "raw", "raw": "{\n \"individualIdentitys\": [\n {\n \"name\": \"\",\n \"email\": \"\",\n \"deliveryMethod\": \"\",\n \"proofs\": \"\",\n \"taxId\": \"\",\n \"phone\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Individual Identities", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date. Format: ISO 8601 or YYYY-MM-DD.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date. Format: ISO 8601 or YYYY-MM-DD.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter identities by the specified status.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "taxIds", "value": "", "description": "List of CPFs to filter the response by.", "disabled": true }, { "key": "email", "value": "", "description": "Filter identities by holder e-mail.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List and filter all individual identities in your workspace. Results are returned paged via cursor." } }, { "name": "Get an Individual Identity", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single individual identity by its id." } }, { "name": "Update an Individual Identity", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity", "{{id}}" ] }, "description": "Update the taxId of an individual identity after it has been created. Useful when the CPF is unknown at creation time and is only collected during the proof submission flow.", "body": { "mode": "raw", "raw": "{\n \"taxId\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel an Individual Identity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity", "{{id}}" ] }, "description": "Cancel an individual identity (soft delete). The identity transitions to failed, every pending proof is canceled and a canceled log is delivered through the webhook. Only identities in created or pending status can be canceled." } }, { "name": "List Individual Identity Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity", "log" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "identityIds", "value": "", "description": "List of individual identity ids linked to the desired logs. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log type. Options: \"created\", \"processing\", \"pending\", \"updated\", \"success\", \"failed\", \"canceled\", \"expired\".", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a paged list of all individual identity logs. A log tracks a change in the individual identity entity according to its lifecycle." } }, { "name": "Get an Individual Identity Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity", "log", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single individual identity log by its id." } } ], "description": "Individual Identities run an end-to-end identity verification on a Brazilian individual. Each entry wraps the proofs (document and/or facial biometrics) the holder must submit; Stark Infra orchestrates the collection, validates each proof and delivers the result through the individual-identity webhook subscription.\nIdentities are created in created status and are walked through processing, pending and finally success or failed by private workers. Every transition produces an Individual Identity Log." }, { "name": "Individual Identity Proof", "item": [ { "name": "List Individual Identity Proofs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity-proof", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity-proof" ], "query": [ { "key": "identityId", "value": "", "description": "Id of the parent individual identity whose proofs you want to list." }, { "key": "status", "value": "", "description": "Filter proofs by status.", "disabled": true }, { "key": "proofType", "value": "", "description": "Filter proofs by proofType. Options: identity, biometric.", "disabled": true }, { "key": "ids", "value": "", "description": "List of strings to get specific proofs by ids.", "disabled": true }, { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "List the proofs tied to an Individual Identity. The identityId query parameter is required." } }, { "name": "Get an Individual Identity Proof", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity-proof/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity-proof", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single individual identity proof by its id." } }, { "name": "Submit an Individual Identity Proof", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/individual-identity-proof/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "individual-identity-proof", "{{id}}" ] }, "description": "Submit the content of a proof. This is the step in which the holder's document or biometric is uploaded for validation.\nbiometric — content is a base64 image string with the facial selfie.\nidentity — content is a JSON-serialised string carrying the provider's documentId and/or the document file (base64 image).\nAfter a successful PATCH the proof transitions from pending to processing and the provider validates it asynchronously.", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "Each Individual Identity Proof represents one piece of evidence required by the parent Individual Identity. One proof is generated per proofType requested at creation; the holder submits the content via PATCH /v2/individual-identity-proof/:id.\nProofs go through their own lifecycle (pending → processing → success / failed / canceled / expired). The parent identity transitions to success only when every proof reaches success." }, { "name": "Individual Holmes", "item": [ { "name": "Query an Individual Bureau", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}//individual-holmes/{{searchKey}}/{{type}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "", "individual-holmes", "{{searchKey}}", "{{type}}" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of items per page for paginated bureaus. Integer in the 1..100 range. Defaults to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque page token returned by the previous call. Only meaningful for civil and criminal; ignored by every other bureau.", "disabled": true } ] }, "description": "Path params identify what to look up. The searchKey is a CPF (11 digits, masked or unmasked) for every bureau except internationalPep, where it is the person's full name. The type selects the bureau and the shape of the response.\nQuery params control paging. Only civil and criminal (JusBrasil) honour cursor — repeat the request with the returned cursor to fetch the next page." } } ], "description": "Individual Holmes queries an external bureau or one of Stark Infra's internal datasets to investigate an individual (CPF). Each request targets a single bureau through the type path parameter and returns that bureau's payload under a key named after the type queried.\nUse Individual Holmes to run KYC, anti-fraud, judicial, sanctions and federal-revenue checks on a person before onboarding, granting credit or releasing a high-risk operation. Every call is synchronous, scoped to your workspace and logged on Stark Infra's side — there is no resource lifecycle to track." }, { "name": "Business Holmes", "item": [ { "name": "Query a Business Bureau", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}//business-holmes/{{taxId}}/{{type}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "", "business-holmes", "{{taxId}}", "{{type}}" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of items per page for paginated bureaus. Integer in the 1..100 range. Defaults to 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque page token returned by the previous call. Only meaningful for civil and criminal; ignored by every other bureau.", "disabled": true } ] }, "description": "Path params identify what to look up. The taxId is the company's CNPJ (14 digits, masked or unmasked); the type selects the bureau and the shape of the response.\nQuery params control paging. Only civil and criminal (JusBrasil) honour cursor — repeat the request with the returned cursor to fetch the next page." } } ], "description": "Business Holmes queries an external bureau or one of Stark Infra's internal datasets to investigate a legal entity (CNPJ). Each request targets a single bureau through the type path parameter and returns that bureau's payload under a key named after the type queried.\nUse Business Holmes to run KYB, judicial, anti-fraud, sanctions, QSA (corporate structure) and federal-revenue checks on a company before onboarding it, granting credit or releasing a high-risk operation. Every call is synchronous, scoped to your workspace and logged on Stark Infra's side — there is no resource lifecycle to track." } ] }, { "name": "Others", "item": [ { "name": "Webhook", "item": [ { "name": "Create a Webhook", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "webhook" ] }, "description": "Register a new webhook URL. The subscriptions refer to which kinds of logs will be sent to the webhook URL being registered.\nAvailable subscriptions: pix-request, pix-reversal, pix-pull-subscription, pix-pull-request, pix-internal-transaction-report, pix-key, pix-key-holmes, pix-claim, pix-infraction, pix-chargeback, pix-dispute, issuing-card, issuing-holder, issuing-purchase, issuing-invoice, credit-note or credit-holmes", "body": { "mode": "raw", "raw": "{\n \"webhooks\": [\n {\n \"url\": \"\",\n \"subscriptions\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Webhooks", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "webhook" ], "query": [ { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of Webhooks to be retrieved. Max = 100.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a list of non-deleted webhooks in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Webhook", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/webhook/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "webhook", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Webhook by its id." } }, { "name": "Delete a Webhook", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/webhook/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "webhook", "{{id}}" ] }, "description": "Delete a single Webhook subscription.\nNOTE: This action cannot be undone." } } ], "description": "You can create webhook subscriptions to receive events whenever a new log is created. We send the event by making a POST request to your endpoint URL. The event will be delivered with a digital signature (headers[\"Digital-Signature\"]), which can be verified using the Stark Infra public key.\nIf your endpoint URL does not return a 200 status, the webhook service will try again at most three times. The interval between each attempt is 5 min, 30 min and finally 120 min.\nNOTE 1: Registered webhooks will only work for services used in that same version.\nNOTE 2: Even if you use Webhook, we strongly recommend that you create a daily task to get all undelivered events and set them as delivered. It's important to add redundancy and resilience to your system." }, { "name": "Event", "item": [ { "name": "List Events", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/event", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "event" ], "query": [ { "key": "after", "value": "", "description": "Date filter for Events created only after a specific date. Example: \"2022-01-20\"", "disabled": true }, { "key": "before", "value": "", "description": "Date filter for Events created only before a specific date. Example: \"2022-02-20\"", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "isDelivered", "value": "", "description": "If false, only gets Events that haven't been delivered. If true, only gets Events that have already been delivered.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of Events to be retrieved. Max = 100.", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a list of non-deleted events in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get an Event", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/event/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "event", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single Event by its id." } }, { "name": "Delete an Event", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/event/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "event", "{{id}}" ] }, "description": "Delete a single Event from the event list.\nNote: This action cannot be undone." } }, { "name": "Update an Event", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/event/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "event", "{{id}}" ] }, "description": "The only information you can update in an Event is the isDelivered property. This can be useful when, after experiencing server downtime on your side, you list all events with isDelivered=false, process them, and then set them as delivered to stabilize your operations.", "body": { "mode": "raw", "raw": "{\n \"isDelivered\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "Every time a log is created, a corresponding event will be generated and sent to you by webhook, if the appropriate subscription was set. Therefore, the event represents an occurrence in your workspace.\nNOTE: All the events have a log property containing an entity log. The nature of the log, however, may change according to the subscription that triggered the event. For example, if the subscription is credit-note, the log in the event will be a CreditNoteLog." }, { "name": "Event Attempt", "item": [ { "name": "List failed Webhook Event delivery attempts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/event/attempt", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "event", "attempt" ], "query": [ { "key": "after", "value": "", "description": "Filter entities created after this date.", "disabled": true }, { "key": "before", "value": "", "description": "Filter entities created before this date.", "disabled": true }, { "key": "cursor", "value": "", "description": "String used to get the next batch of results. Our SDKs handle this for you.", "disabled": true }, { "key": "eventIds", "value": "", "description": "List of Event ids to filter attempts. Example: [\"5656565656565656\", \"4545454545454545\"]", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "webhookIds", "value": "", "description": "List of Webhook ids to filter attempts. Example: [\"5656565656565656\", \"4545454545454545\"]", "disabled": true }, { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get information on failed webhook event delivery attempts." } }, { "name": "Get an Event Attempt", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/event/attempt/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "event", "attempt", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single event attempt by its id." } } ], "description": "When an Event delivery fails, an event attempt will be registered. It carries information meant to help you debug event reception issues." } ] } ] }