{ "info": { "name": "Stark Bank 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.starkbank.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": "Business Account", "item": [ { "name": "Workspace", "item": [ { "name": "Create a Workspace", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/workspace", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "workspace" ] }, "description": "Here you can create a brand new Workspace.\nNote: Only Organization credentials are able to create Workspaces.", "body": { "mode": "raw", "raw": "{\n \"workspaces\": [\n {\n \"name\": \"\",\n \"username\": \"\",\n \"allowedTaxIds\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Workspaces", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/workspace", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "workspace" ], "query": [ { "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 }, { "key": "ids", "value": "", "description": "List of IDs of the Workspaces to be retrieved.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "username", "value": "", "description": "Workspace username to be searched.", "disabled": true } ] }, "description": "Get a list of Workspaces your credentials have access to in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Workspace", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/workspace/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "workspace", "{{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 workspace by its id." } }, { "name": "Update a Workspace", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/workspace/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "workspace", "{{id}}" ] }, "description": "Update a workspace by passing its id and the fields you want to update.", "body": { "mode": "raw", "raw": "{\n \"allowedTaxIds\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"pictureType\": \"\",\n \"status\": \"\",\n \"username\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "Workspaces are bank accounts. They have independent balances, statements, operations and permissions. The only property that is shared between your workspaces is the link they have to your organization, which carries your basic information, such as tax ID, name, etc...\nThe main reason for automating the creation of multiple Workspaces is to use our infrastructure to divide your own customers into different buckets, setting them up with isolated balances and statements." }, { "name": "Balance", "item": [ { "name": "Get the Balance", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/balance", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "balance" ] }, "description": "Get the current balance in your workspace." } } ], "description": "The balance entity holds the total funds available in your workspace and can be calculated as the sum of its transactions (cash-in + cash-out).\nTherefore, you can also interpret Transactions as balance change logs." }, { "name": "Transaction", "item": [ { "name": "List Transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transaction", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transaction" ], "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": "externalIds", "value": "", "description": "Filter transactions that carry the specified 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 } ] }, "description": "Your bank statement is the list of all transactions registered in your private ledger.\nWe return it paged." } }, { "name": "Get a Transaction", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transaction/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "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 transaction by its id." } } ], "description": "Since Stark Bank is centralized, we have a private ledger to keep track of all transactions. It's important to understand that every financial operation in Stark Bank generates a transaction that is registered in our ledger.\nYou may directly generate a Transaction when you transfer money between workspaces in Stark Bank. Other times, we generate the Transaction for you, when you make a Transfer, pay a Boleto or receive money from a paid Boleto, for example." } ] }, { "name": "Cash Receivables", "item": [ { "name": "Invoice", "item": [ { "name": "Create Invoices", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice" ] }, "description": "Use this route to create up to 100 new invoices at a time.\nNOTE:If you create an invoice with amount zero, we will accept any amount paid by your customer. Otherwise we will only accept the amount specified in the invoice.", "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"amount\": \"\",\n \"name\": \"\",\n \"taxId\": \"\",\n \"descriptions\": \"\",\n \"discounts\": \"\",\n \"due\": \"\",\n \"expiration\": \"\",\n \"fine\": \"\",\n \"interest\": \"\",\n \"rules\": \"\",\n \"splits\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice" ], "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": "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 invoices by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "transactionIds", "value": "", "description": "List of transaction IDs linked to the desired invoices.", "disabled": true } ] }, "description": "Get a list of invoices in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get an Invoice", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "{{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 invoice by its id." } }, { "name": "Update an Invoice", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "{{id}}" ] }, "description": "Update a single invoice. If the invoice has not yet been paid, you can adjust parameters such as the requested amount, the due datetime and the expiration. If the invoice has already been paid, only the amount can be decreased, which will result in a payment reversal.", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"due\": \"\",\n \"expiration\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get an Invoice QR Code", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/{{id}}/qrcode", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "{{id}}", "qrcode" ], "query": [ { "key": "size", "value": "", "description": "Number of pixels in each 'box' of the QR code. Minimum = 1 and maximum = 50. Default value = 7.", "disabled": true } ] }, "description": "Get the invoice QR Code png file. Similarly to the Boleto PDF, we create a QR Code image file with the invoice data so that your customer can pay it through Pix." } }, { "name": "Get an Invoice PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "{{id}}", "pdf" ] }, "description": "Get the invoice PDF file. Similarly to the Boleto PDF, we create a PDF file with the invoice data and the QR Code so that your customer can pay it through Pix. The same PDF can also be accessed by the public \"pdf\" parameter returned in the Invoice JSON. This link is the one you should send to your customers." } }, { "name": "List Invoice Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "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": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "invoiceIds", "value": "", "description": "Array of invoice ids that are linked to the logs you desire.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of invoice logs. A log tracks a change in the invoice entity according to its life cycle." } }, { "name": "Get an Invoice Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "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 invoice Log by its id." } }, { "name": "Get a reversed Invoice Log PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/log/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "log", "{{id}}", "pdf" ] }, "description": "Whenever an Invoice is successfully reversed, a reversed log will be created. To retrieve a specific reversal receipt, you can request the corresponding log PDF." } }, { "name": "Get an Invoice Payment information", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice/{{id}}/payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice", "{{id}}", "payment" ] }, "description": "Once an invoice has been paid, you can get the payment information using the Invoice. Payment sub-resource." } } ], "description": "The Invoice resource is used to request payments from customers.\nYour customer can pay it by scanning the Pix QR Code or making a deposit to the indicated account number.\nYou can set custom fields as fine, interest, overdue date and expiration date, for a complete charge method, much better than boleto.\nIf you're used to our Boleto resource, you will feel pretty familiar with the Invoice flow. In this section, we will teach you how to create and manage your Pix invoices.\nYou can also split the Invoice between different receivers, you need to create a Split Receiver, and add the receiver into the Splits array." }, { "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": "Use this route to create up to 100 new dynamic brcodes at a time.", "body": { "mode": "raw", "raw": "{\n \"dynamicBrcodes\": [\n {\n \"amount\": \"\",\n \"displayDescription\": \"\",\n \"expiration\": \"\",\n \"rules\": \"\",\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. Our SDKs handle this for you.", "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": "list of uuids to filter retrieved objects.", "disabled": true } ] }, "description": "Get a list of brcodes in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Dynamic Brcode", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/dynamic-brcode/{{uuid}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "dynamic-brcode", "{{uuid}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Get a single dynamic brcode by its uuid." } } ], "description": "Note:This is a basic Pix QR Code solution for one time payment. For a complete Pix QR Code receivable, check the Invoice resource.\nWhen a Dynamic Brcode is paid, a Deposit is created with the tags parameter containing the string \"dynamic-brcode/\" followed by the Dynamic Brcode's uuid \"dynamic-brcode/{uuid}\" for conciliation." }, { "name": "Deposit", "item": [ { "name": "List Deposits", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/deposit", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "deposit" ], "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": "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": "sort", "value": "", "description": "Sort order considered in the response. Options are: \"created\", \"-created\".", "disabled": true }, { "key": "status", "value": "", "description": "Filter deposits by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Here you can list and filter all deposits you have received. We return it paged." } }, { "name": "Get a Deposit", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/deposit/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "deposit", "{{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 Deposit by its id." } }, { "name": "Update a Deposit", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/deposit/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "deposit", "{{id}}" ] }, "description": "Update the Deposit by passing its id to be partially or fully reversed.", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Deposit Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/deposit/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "deposit", "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": "depositIds", "value": "", "description": "Array of deposit ids that are linked to the logs you desire.", "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": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all deposit logs. A log tracks a change in the deposit entity according to its life cycle." } }, { "name": "Get a Deposit Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/deposit/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "deposit", "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 deposit log by its id." } }, { "name": "Get a reversed Deposit Log PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/deposit/log/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "deposit", "log", "{{id}}", "pdf" ] }, "description": "Whenever a Deposit is successfully reversed, a reversed log will be created. To retrieve a specific reversal receipt, you can request the corresponding log PDF." } } ], "description": "Deposits represent passive cash-ins received by your account from external transfers or payments. In this section, we will teach you how to manage your Deposits." }, { "name": "Boleto", "item": [ { "name": "Create Boletos", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto" ] }, "description": "This is how you create a new list of boletos. You can create up to 100 boletos per request. In case a boleto is paid after its due date and there is fine or interest, its amount will be updated with the paid amount. The same is valid if the boleto is paid with a discount.", "body": { "mode": "raw", "raw": "{\n \"boletos\": [\n {\n \"amount\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"name\": \"\",\n \"stateCode\": \"\",\n \"streetLine1\": \"\",\n \"streetLine2\": \"\",\n \"taxId\": \"\",\n \"zipCode\": \"\",\n \"descriptions\": \"\",\n \"discounts\": \"\",\n \"due\": \"\",\n \"fine\": \"\",\n \"interest\": \"\",\n \"overdueLimit\": \"\",\n \"receiverName\": \"\",\n \"receiverTaxId\": \"\",\n \"splits\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Boletos", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto" ], "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": "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 boletos by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of non-deleted boletos in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Boleto", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto", "{{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 boleto by its id." } }, { "name": "Delete a Boleto", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto", "{{id}}" ] }, "description": "Delete a single boleto. We will send a request to CIP to cancel the boleto registration. After the boleto registration is canceled, it won't be possible to pay it anymore.\nNOTE: This action cannot be undone." } }, { "name": "Get a Boleto PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto", "{{id}}", "pdf" ], "query": [ { "key": "hiddenFields", "value": "", "description": "List of fields to be hidden in Boleto pdf. Example: [\"customerAddress\"].", "disabled": true }, { "key": "layout", "value": "", "description": "PDF layout. Available options are \"default\" (full page) and \"booklet\" (\"carnê\").", "disabled": true } ] }, "description": "Get a downloadable boleto PDF file. This route is public and does not require the usual authentication headers. However, if you request an invalid boleto ID too many times, your IP will be blocked for this specific route." } }, { "name": "List Boleto logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto", "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": "boletoIds", "value": "", "description": "Array of boleto ids that are linked to the logs you desire.", "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 }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of boleto logs. A log tracks a change in the boleto entity according to its life cycle." } }, { "name": "Get a Boleto Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto", "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 boleto log by its id." } } ], "description": "A boleto is a method you can use to charge your customers or load your Stark Bank account. Here we will teach you how to create and manage boletos.\nYou can also split a Boleto between different receivers, you need to create a Split Receiver, and add the receiver into the Splits array." }, { "name": "Boleto Holmes", "item": [ { "name": "Create Boleto Holmes", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-holmes", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-holmes" ] }, "description": "Use this route to verify the updated status of boletos generated at Stark Bank according to CIP.", "body": { "mode": "raw", "raw": "{\n \"boletoHolmes\": [\n {\n \"boletoId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Boleto Holmes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-holmes", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-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": "boletoId", "value": "", "description": "String to get boletos holmes that refer to a specific boleto ID.", "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 }, { "key": "ids", "value": "", "description": "List of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter holmes by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of non-deleted boletos in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Boleto Holmes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-holmes/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-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 boleto holmes by its id." } }, { "name": "List Boleto Holmes Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-holmes/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-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": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "holmesIds", "value": "", "description": "Filter logs by Holmes IDs", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all boleto holmes logs. A log tracks a change in the holmes entity according to its life cycle." } }, { "name": "Get a Boleto Holmes Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-holmes/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-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 boleto holmes log by its id." } } ], "description": "Honoring the famous Sherlock Holmes, this feature allows your application to investigate updated boleto status according to CIP in less than an hour.\nHere we will teach you how to create and manage your Boleto Holmes. Ideally, since results are asynchronous, you should register a Boleto Holmes webhook subscription in order to receive the investigation results instead of polling." }, { "name": "Split", "item": [ { "name": "List Splits", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split" ], "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": "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": "receiverIds", "value": "", "description": "list of receiver ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545'].", "disabled": true }, { "key": "status", "value": "", "description": "Filter splits by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of Splits in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Split", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split", "{{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 Split by its id." } }, { "name": "List Split Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split", "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": "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": "splitIds", "value": "", "description": "Array of Split ids that are linked to the logs you desire.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of Split logs. A log tracks a change in the Split entity according to its life cycle." } }, { "name": "Get a Split Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split", "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 Split Log by its id." } } ], "description": "The Split resource is used to split an Invoice or Boleto between different receivers." }, { "name": "Split Receiver", "item": [ { "name": "Create Split Receiver", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-receiver", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-receiver" ] }, "description": "Send a list of Split Receiver objects for creation in the Stark Bank API", "body": { "mode": "raw", "raw": "{\n \"splitReceivers\": [\n {\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bankCode\": \"\",\n \"branchCode\": \"\",\n \"name\": \"\",\n \"taxId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Split Receivers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-receiver", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-receiver" ], "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": "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": "receiverIds", "value": "", "description": "List of receiver ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545'].", "disabled": true }, { "key": "status", "value": "", "description": "Filter split receivers by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "taxId", "value": "", "description": "filter for splitReceivers sent to the specified tax ID. ex: '012.345.678-90'", "disabled": true }, { "key": "transactionIds", "value": "", "description": "List of transaction IDs linked to the desired splitReceivers. ex: ['5656565656565656', '4545454545454545']", "disabled": true } ] }, "description": "Get a list of Split Receivers in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Split Receiver", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-receiver/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-receiver", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Retrieve a single Split Receiver object previously created in the Stark Bank API by its id." } }, { "name": "List Split Receiver Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-receiver/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-receiver", "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": "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": "receiverIds", "value": "", "description": "List of Split Receiver ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545'].", "disabled": true }, { "key": "types", "value": "", "description": "filter retrieved objects by event types. ex: 'processing' or 'success'", "disabled": true } ] }, "description": "Get a paged list of Split Receiver logs. A log tracks a change in the Split Receiver entity according to its life cycle." } }, { "name": "Get a Split Receiver Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-receiver/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-receiver", "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 Split Receiver Log by its id." } } ], "description": "You can create a Receiver to an Invoice or Boleto split by using the Split Receiver resource." }, { "name": "Split Profile", "item": [ { "name": "Put a Split Profile", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-profile", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-profile" ] }, "description": "Send a list containing a single Split Profile object. If the object has already been created, its rules will be updated.", "body": { "mode": "raw", "raw": "{\n \"delay\": \"\",\n \"interval\": \"\",\n \"tags\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Split Profiles", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-profile", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-profile" ], "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": "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 split profiles by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of Split Profiles in chunks of up to 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Split Profile", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-profile/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-profile", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Retrieve a single Split Profile object by its ID, which was previously created." } }, { "name": "List Split Profile Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-profile/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-profile", "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": "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": "profileIds", "value": "", "description": "List of Split Profile ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545'].", "disabled": true }, { "key": "types", "value": "", "description": "filter retrieved objects by event types. ex: 'processing' or 'success'", "disabled": true } ] }, "description": "Get a paged list of Split Profile logs. A log tracks a change in the Split Profile entity according to its life cycle." } }, { "name": "Get a Split Profile Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/split-profile/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "split-profile", "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 Split Profile Log by its id." } } ], "description": "The Split Profile resource is used to configure the behavior of split operations." } ] }, { "name": "Cash Subscription", "item": [ { "name": "Invoice Pull Subscription", "item": [ { "name": "Create Invoice Pull Subscriptions", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-subscription", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-subscription" ] }, "description": "Use this route to create new invoice pull subscriptions.", "body": { "mode": "raw", "raw": "{\n \"invoicePullSubscriptions\": [\n {\n \"displayDescription\": \"\",\n \"externalId\": \"\",\n \"interval\": \"\",\n \"name\": \"\",\n \"pullMode\": \"\",\n \"pullRetryLimit\": \"\",\n \"referenceCode\": \"\",\n \"start\": \"\",\n \"taxId\": \"\",\n \"type\": \"\",\n \"amount\": \"\",\n \"amountMinLimit\": \"\",\n \"data\": \"\",\n \"due\": \"\",\n \"end\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Invoice Pull Subscriptions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-subscription", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-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. Our SDKs handle this for you.", "disabled": true }, { "key": "expand", "value": "", "description": "List of strings to expand the invoice pull subscription information. Options: \"data\".", "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 invoice pull subscriptions by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Here you can list and filter all invoice pull subscriptions you have made. We return it paged." } }, { "name": "Get an Invoice Pull Subscription", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-subscription/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-subscription", "{{id}}" ] }, "description": "Get a single invoice pull subscription by its id." } }, { "name": "Cancel an Invoice Pull Subscription", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-subscription/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-subscription", "{{id}}" ] }, "description": "Cancel an existing invoice pull subscription. The subscription must be with \"active\" status to be canceled." } }, { "name": "List Invoice Pull Subscription Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-subscription/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-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. 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 }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "subscriptionIds", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "types", "value": "", "description": "Filter logs by log types.", "disabled": true } ] }, "description": "Get a paged list of invoice pull subscription logs. A log tracks a change in the entity according to its life cycle." } }, { "name": "Get an Invoice Pull Subscription Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-subscription/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-subscription", "log", "{{id}}" ] }, "description": "Get a single invoice pull subscription log by its id." } } ], "description": "An Invoice Pull Subscription is a recurring payment agreement between a payer and a receiver, authorized through the Pix Automatic infrastructure. Once active, it allows the receiver to periodically trigger automatic debits by issuing invoices that match the agreed conditions such as amount, frequency, and billing cycle without requiring new consent for each transaction.\nYou can use asynchronous webhooks to monitor status changes." }, { "name": "Invoice Pull Request", "item": [ { "name": "Create Invoice Pull Requests", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-request" ] }, "description": "Use this route to create new invoice pull requests.", "body": { "mode": "raw", "raw": "{\n \"invoicePullRequests\": [\n {\n \"attemptType\": \"\",\n \"due\": \"\",\n \"invoiceId\": \"\",\n \"subscriptionId\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Invoice Pull Requests", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-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. Our SDKs handle this for you.", "disabled": true }, { "key": "externalIds", "value": "", "description": "List of external IDs linked to the desired pull requests.", "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": "invoiceIds", "value": "", "description": "List of invoice IDs linked to the desired pull requests.", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "status", "value": "", "description": "Filter invoice pull request by the specified status.", "disabled": true }, { "key": "subscriptionIds", "value": "", "description": "List of subscription IDs linked to the desired pull requests.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Here you can list and filter all invoice pull requests you have made. We return it paged." } }, { "name": "Get an Invoice Pull Request", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-request/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-request", "{{id}}" ] }, "description": "Get a single Invoice Pull Request by its id." } }, { "name": "Cancel an Invoice Pull Request", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-request/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-request", "{{id}}" ] }, "description": "Cancel a single Invoice Pull Request." } }, { "name": "List Invoice Pull Request Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-request/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-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. 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 }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "requestIds", "value": "", "description": "List of strings to get specific entities by ids.", "disabled": true }, { "key": "types", "value": "", "description": "Filter payment requests by the specified types. Example: confirmed", "disabled": true } ] }, "description": "Get a paged list of invoice pull request logs. A log tracks a change in the entity according to its life cycle." } }, { "name": "Get an Invoice Pull Request Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/invoice-pull-request/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "invoice-pull-request", "log", "{{id}}" ] }, "description": "Get a single invoice pull request log by its id." } } ], "description": "An Invoice Pull Request is a command sent to the payer's bank to trigger the automatic debit of a previously issued invoice linked to an active Invoice Pull Subscription. It confirms the receiver's intent to collect the agreed amount within the current billing cycle and initiates the settlement process through the Pix infrastructure.\nYou can use asynchronous webhooks to monitor status changes." } ] }, { "name": "Card Receivables", "item": [ { "name": "Merchant Session", "item": [ { "name": "Create Merchant Sessions", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-session", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-session" ] }, "description": "This route allows the merchant to create a session that can be used by the card holder's application to create a new purchase.\nThe UUID parameter returned by the session should be used to create a Merchant Session Purchase.", "body": { "mode": "raw", "raw": "{\n \"merchantSessions\": [\n {\n \"allowedFundingTypes\": \"\",\n \"allowedInstallments\": \"\",\n \"expiration\": \"\",\n \"allowedIps\": \"\",\n \"challengeMode\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Merchant Session Purchase", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-session/{{uuid}}/purchase", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-session", "{{uuid}}", "purchase" ] }, "description": "This route can be used to create a Merchant Purchase directly from the payer's client application.\nThe UUID of a Merchant Session that was previously created by the merchant is necessary to access this route.", "body": { "mode": "raw", "raw": "{\n \"purchases\": [\n {\n \"amount\": \"\",\n \"cardExpiration\": \"\",\n \"cardNumber\": \"\",\n \"cardSecurityCode\": \"\",\n \"fundingType\": \"\",\n \"holderName\": \"\",\n \"billingCity\": \"\",\n \"billingCountryCode\": \"\",\n \"billingStateCode\": \"\",\n \"billingStreetLine1\": \"\",\n \"billingStreetLine2\": \"\",\n \"billingZipCode\": \"\",\n \"holderEmail\": \"\",\n \"holderPhone\": \"\",\n \"installmentCount\": \"\",\n \"metadata\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Merchant Sessions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-session", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-session" ], "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": "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 sessions by the specified status, such as: active, expired, success.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of merchant sessions in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Merchant Session", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-session/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-session", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Retrieve detailed information about a specific session by its id." } }, { "name": "List Merchant Session Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-session/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-session", "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": "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": "sessionIds", "value": "", "description": "Filter the merchant session ids to only include its corresponding logs", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of merchant session logs.\nA log tracks a change in the session entity according to its life cycle." } }, { "name": "Get a Merchant Session Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-session/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-session", "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 merchant session log by its id." } } ], "description": "The Merchant Session resource can be created by a merchant and used by the card holder in order to collect their card data without having to handle it on the merchant's side.\nThe card data can be sent directly from a browser or app to Stark Bank's API using the Merchant Session Purchase route." }, { "name": "Merchant Purchase", "item": [ { "name": "Create Merchant Purchase", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-purchase", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-purchase" ] }, "description": "This route is used to charge a card that has been previously saved.\nCards can only be used in this route once a previous purchase was approved through a Merchant Session Purchase.", "body": { "mode": "raw", "raw": "{\n \"merchantPurchases\": [\n {\n \"amount\": \"\",\n \"cardId\": \"\",\n \"fundingType\": \"\",\n \"billingCity\": \"\",\n \"billingCountryCode\": \"\",\n \"billingStateCode\": \"\",\n \"billingStreetLine1\": \"\",\n \"billingStreetLine2\": \"\",\n \"billingZipCode\": \"\",\n \"challengeMode\": \"\",\n \"holderEmail\": \"\",\n \"holderPhone\": \"\",\n \"installmentCount\": \"\",\n \"metadata\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a Merchant Purchase", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-purchase/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-purchase", "{{id}}" ] }, "description": "Update a single purchase. If the purchase is currently approved, you can only update the status to canceled and set the amount to 0. This action cancels the authorization. If the purchase is currently confirmed, you can update the status to reversed and adjust the amount to a lower value. This action debits the difference and reverses the purchase, partially or totally. If the purchase is partially reversed, its status will remain confirmed. However, if the purchase is fully reversed, its status will be updated to voided.", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Merchant Purchases", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-purchase", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-purchase" ], "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": "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 purchases by the specified status, such as: created, approved, denied, confirmed, paid, pending, canceled, voided, failed.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of merchant purchases in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Merchant Purchase", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-purchase/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-purchase", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Retrieve detailed information about a specific purchase by its id." } }, { "name": "List Merchant Purchase Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-purchase/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-purchase", "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": "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": "purchaseIds", "value": "", "description": "Filter the merchant purchase ids to only include its corresponding logs", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of merchant purchase logs.\nA log tracks a change in the purchase entity according to its life cycle." } }, { "name": "Get a Merchant Purchase Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-purchase/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-purchase", "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 merchant purchase log by its id." } } ], "description": "The Merchant Purchase resource can be used to charge customers with credit or debit cards.\nIf a card hasn't been used before, a Merchant Session Purchase must be created and approved with that specific card before it can be used directly in a Merchant Purchase." }, { "name": "Merchant Card", "item": [ { "name": "List Merchant Cards", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-card", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-card" ], "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": "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 cards by the specified status, such as: active, expired, canceled or blocked.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of merchant cards in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Merchant Card", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-card/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-card", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Retrieve detailed information about a specific card by its id." } }, { "name": "List Merchant Card Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-card/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-card", "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": "cardIds", "value": "", "description": "Array of card ids that are linked to the logs you desire.", "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 }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of merchant card logs.\nA log tracks a change in the card entity according to its lifecycle." } }, { "name": "Get a Merchant Card Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-card/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-card", "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 merchant card log by its id." } } ], "description": "The Merchant Card resource stores information about cards used in approved purchases.\nThese cards can be used in new purchases without the need to create a new session." }, { "name": "Merchant Installment", "item": [ { "name": "List Merchant Installments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-installment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-installment" ], "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": "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 installments by the specified status, such as: created, paid, canceled, voided.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of merchant installments in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Merchant Installment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-installment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-installment", "{{id}}" ], "query": [ { "key": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true } ] }, "description": "Retrieve detailed information about a specific installment by its id." } }, { "name": "List Merchant Installment Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-installment/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-installment", "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": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "installmentIds", "value": "", "description": "Filter the merchant installment ids to only include their corresponding logs", "disabled": true }, { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of merchant installment logs.\nA log tracks a change in the installment entity according to its life cycle." } }, { "name": "Get a Merchant Installment Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/merchant-installment/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "merchant-installment", "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 merchant installment log by its id." } } ], "description": "Merchant Installments are created for every installment in a purchase.\nThese resources will track its own due payment date and settlement lifecycle." } ] }, { "name": "Bill Payments", "item": [ { "name": "Transfer", "item": [ { "name": "Create Transfers", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transfer", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transfer" ] }, "description": "This route is used to send your transfers to their receivers.\nYou can create up to 100 transfers in a single request.", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"accountNumber\": \"\",\n \"amount\": \"\",\n \"bankCode\": \"\",\n \"branchCode\": \"\",\n \"name\": \"\",\n \"taxId\": \"\",\n \"accountType\": \"\",\n \"description\": \"\",\n \"displayDescription\": \"\",\n \"externalId\": \"\",\n \"rules\": \"\",\n \"scheduled\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Transfers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transfer", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transfer" ], "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": "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": "sort", "value": "", "description": "Sort order considered in the response. Options are: \"created\", \"-created\", \"updated\" and \"-updated\". \"-\" means descending order. Default is \"-created\".", "disabled": true }, { "key": "status", "value": "", "description": "Filter transfers by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "taxId", "value": "", "description": "Filter transfers sent to the specified tax ID.", "disabled": true }, { "key": "transactionIds", "value": "", "description": "List of transaction IDs linked to the desired transfers.", "disabled": true } ] }, "description": "Here you can list and filter all transfers you have made. We return it paged." } }, { "name": "Get a Transfer", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transfer/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transfer", "{{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 transfer by its id." } }, { "name": "Cancel a scheduled Transfer", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transfer/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transfer", "{{id}}" ] }, "description": "Cancel a scheduled transfer. You can only cancel transfers before they start being processed.\nNOTE:Canceled transfers will still appear in your queries." } }, { "name": "Get a Transfer PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transfer/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transfer", "{{id}}", "pdf" ] }, "description": "Get a PDF from a single transfer by its id." } }, { "name": "List Transfer Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transfer/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transfer", "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": "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": "transferIds", "value": "", "description": "Array of transfer ids that are linked to the logs you desire.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all transfer logs. A log tracks a change in the transfer entity according to its life cycle." } }, { "name": "Get a Transfer Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/transfer/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "transfer", "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 transfer log by its id." } } ], "description": "Transfers are used to send money to any bank account in Brazil using the Ted or Pix systems.\nHere we will show you how to create and manage them." }, { "name": "Brcode Payment", "item": [ { "name": "Create Brcode Payments", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-payment" ] }, "description": "Use this route to pay registered brcodes generated at Stark Bank or at other financial institutions using the available balance in your Stark Bank account.\nNOTE:Initially, the brcode entity amount will be zero because the brcode is processed asynchronously.", "body": { "mode": "raw", "raw": "{\n \"brcodePayments\": [\n {\n \"brcode\": \"\",\n \"description\": \"\",\n \"taxId\": \"\",\n \"amount\": \"\",\n \"rules\": \"\",\n \"scheduled\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Brcode Payments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-payment" ], "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": "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 brcode payments by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of non-deleted brcodes in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Brcode Payment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-payment", "{{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 brcode by its id." } }, { "name": "Update a Brcode Payment", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-payment", "{{id}}" ] }, "description": "Update a single brcode payment, if it hasn't been paid yet.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a Brcode Payment PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-payment/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-payment", "{{id}}", "pdf" ] }, "description": "Get a brcode payment PDF receipt. You can only get a receipt for payments whose status are either success, processing or created." } }, { "name": "List Brcode Payment Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-payment/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-payment", "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": "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": "paymentIds", "value": "", "description": "Array of payment ids linked to the desired logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all brcode payment logs. A log tracks a change in the payment entity according to its life cycle." } }, { "name": "Get a Brcode Payment Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/brcode-payment/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "brcode-payment", "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 brcode payment log by its id." } } ], "description": "Here we will teach you how to create and manage brcode payments." }, { "name": "Boleto Payment", "item": [ { "name": "Create Boleto Payments", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-payment" ] }, "description": "Use this route to pay registered boletos generated at Stark Bank or at other financial institutions using the available balance in your Stark Bank account.", "body": { "mode": "raw", "raw": "{\n \"boletoPayments\": [\n {\n \"description\": \"\",\n \"taxId\": \"\",\n \"amount\": \"\",\n \"barCode\": \"\",\n \"line\": \"\",\n \"scheduled\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Boleto Payments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-payment" ], "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": "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 boleto payments by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of non-deleted boleto payments in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Boleto Payment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-payment", "{{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 boleto payment by its id." } }, { "name": "Delete a Boleto Payment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-payment", "{{id}}" ] }, "description": "Cancel a scheduled boleto payment. You can only cancel boleto payments before they start being processed.\nNOTE:Payments that have already been processed can be deleted, but not cancelled." } }, { "name": "Get a Boleto Payment PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-payment/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-payment", "{{id}}", "pdf" ] }, "description": "Get a boleto payment PDF receipt. You can only get a receipt for payments whose status are either success, processing or created." } }, { "name": "List Boleto Payment Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-payment/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-payment", "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": "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": "paymentIds", "value": "", "description": "Array of payment ids linked to the desired logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all boleto payment logs. A log tracks a change in the payment entity according to its life cycle." } }, { "name": "Get a Boleto Payment Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/boleto-payment/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "boleto-payment", "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 boleto payment log by its id." } } ], "description": "Here we will teach you how to create and manage boleto payments." }, { "name": "Utility Payment", "item": [ { "name": "Create Utility Payments", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/utility-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "utility-payment" ] }, "description": "Use this route to pay utility bills using the available balance in your Stark Bank account.", "body": { "mode": "raw", "raw": "{\n \"utilityPayments\": [\n {\n \"description\": \"\",\n \"barCode\": \"\",\n \"line\": \"\",\n \"scheduled\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Utility Payments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/utility-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "utility-payment" ], "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": "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 utility payments by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of non-deleted utility payments in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Utility Payment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/utility-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "utility-payment", "{{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 utility payment by its id." } }, { "name": "Delete a Utility Payment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/utility-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "utility-payment", "{{id}}" ] }, "description": "Cancel a scheduled utility payment. You can only cancel utility payments before they start being processed.\nNOTE:Payments that have already been processed can be deleted, but not cancelled." } }, { "name": "Get a Utility Payment PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/utility-payment/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "utility-payment", "{{id}}", "pdf" ] }, "description": "Get a utility payment PDF receipt. You can only get a receipt for payments whose status are either success, processing or created." } }, { "name": "List Utility Payment Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/utility-payment/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "utility-payment", "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": "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": "paymentIds", "value": "", "description": "Array of payment ids linked to the desired logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all utility payment logs. A log tracks a change in the payment entity according to its life cycle." } }, { "name": "Get a Utility Payment Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/utility-payment/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "utility-payment", "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 utility payment log by its id." } } ], "description": "Here we will teach you how to create and manage utility payments, such as electricity and water bills." }, { "name": "Tax Payment", "item": [ { "name": "Create Tax Payments", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/tax-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "tax-payment" ] }, "description": "Use this route to pay taxes using the available balance in your Stark Bank account.", "body": { "mode": "raw", "raw": "{\n \"taxPayments\": [\n {\n \"description\": \"\",\n \"barCode\": \"\",\n \"line\": \"\",\n \"scheduled\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Tax Payments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/tax-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "tax-payment" ], "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": "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 tax payments by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of non-deleted tax payments in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Tax Payment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/tax-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "tax-payment", "{{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 tax payment by its id." } }, { "name": "Delete a Tax Payment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/tax-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "tax-payment", "{{id}}" ] }, "description": "Cancel a scheduled tax payment. You can only cancel tax payments before they start being processed.\nNOTE:Payments that have already been processed can be deleted, but not cancelled." } }, { "name": "Get a Tax Payment PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/tax-payment/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "tax-payment", "{{id}}", "pdf" ] }, "description": "Get a tax payment PDF receipt. You can only get a receipt for payments whose status are either success, processing or created." } }, { "name": "List Tax Payment Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/tax-payment/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "tax-payment", "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": "paymentIds", "value": "", "description": "Array of payment ids linked to the desired logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all tax payment logs. A log tracks a change in the payment entity according to its life cycle." } }, { "name": "Get a Tax Payment Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/tax-payment/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "tax-payment", "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 tax payment log by its id." } } ], "description": "Here we will explain how to create and manage tax payments, such as ISS and DAS." }, { "name": "Darf Payment", "item": [ { "name": "Create Darf payments", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/darf-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "darf-payment" ] }, "description": "Use this route to pay Darfs using the available balance in your Stark Bank account.", "body": { "mode": "raw", "raw": "{\n \"darfPayments\": [\n {\n \"competence\": \"\",\n \"description\": \"\",\n \"due\": \"\",\n \"fineAmount\": \"\",\n \"interestAmount\": \"\",\n \"nominalAmount\": \"\",\n \"revenueCode\": \"\",\n \"taxId\": \"\",\n \"referenceNumber\": \"\",\n \"scheduled\": \"\",\n \"tags\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Darf Payments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/darf-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "darf-payment" ], "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": "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 Darfs by the specified status.", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true } ] }, "description": "Get a list of non-deleted Darf payments in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a Darf Payment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/darf-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "darf-payment", "{{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 Darf payment by its id." } }, { "name": "Delete a Darf Payment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/darf-payment/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "darf-payment", "{{id}}" ] }, "description": "Cancel a scheduled Darf payment. You can only cancel Darf payments before they start being processed.\nNOTE:Payments that have already been processed can be deleted, but not cancelled." } }, { "name": "Get a Darf Payment PDF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/darf-payment/{{id}}/pdf", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "darf-payment", "{{id}}", "pdf" ] }, "description": "Get a Darf payment PDF receipt. You can only get a receipt for payments whose status are either success, processing or created." } }, { "name": "List Darf Payment Logs", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/darf-payment/log", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "darf-payment", "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": "paymentIds", "value": "", "description": "Array of payment ids linked to the desired logs.", "disabled": true }, { "key": "types", "value": "", "description": "Filters logs by log types.", "disabled": true } ] }, "description": "Get a paged list of all Darf payment logs. A log tracks a change in the payment entity according to its life cycle." } }, { "name": "Get a Darf Payment Log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/darf-payment/log/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "darf-payment", "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 Darf payment log by its id." } } ], "description": "Here we will explain how to manually pay DARFs without bar codes." }, { "name": "Payment Preview", "item": [ { "name": "Create a Payment Preview", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/payment-preview", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "payment-preview" ] }, "description": "Create a payment preview to get information from a payment.", "body": { "mode": "raw", "raw": "{\n \"paymentPreviews\": [\n {\n \"id\": \"\",\n \"scheduled\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ], "description": "A Payment Preview is used to get information from multiple types of payment to confirm any information before actually paying. If the 'scheduled' parameter is not informed, today will be assumed as the intended payment date. Right now, the 'scheduled' parameter only has effect on BrcodePreviews.\nThis resource is able to preview the following types of payment: \"brcode-payment\", \"boleto-payment\", \"utility-payment\" and \"tax-payment\"" }, { "name": "Payment Request", "item": [ { "name": "Create Payment Requests", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/payment-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "payment-request" ] }, "description": "Use this route to create new payment requests in our Web Banking approval flow.", "body": { "mode": "raw", "raw": "{\n \"paymentRequests\": [\n {\n \"centerId\": \"\",\n \"payment\": \"\",\n \"due\": \"\",\n \"tags\": \"\",\n \"type\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Payment Requests", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/payment-request", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "payment-request" ], "query": [ { "key": "centerId", "value": "", "description": "Unique ID of the targeted cost center. You can check out the cost center ID directly on its approval section on our Web Banking. Example: 5656565656565656" }, { "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": "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": "sort", "value": "", "description": "Sort order considered in the response. Options are: \"created\", \"-created\", \"updated\" and \"-updated\". \"-\" means descending order. Default is \"-created\".", "disabled": true }, { "key": "status", "value": "", "description": "Filter payment requests by the specified status. Example: success", "disabled": true }, { "key": "tags", "value": "", "description": "Filter entities that contain the specified tags.", "disabled": true }, { "key": "type", "value": "", "description": "Filters payment requests by the type inferred from the payment parameter, if it is not a dictionary. Example: boleto-payment", "disabled": true } ] }, "description": "Here you can list and filter payment requests created by the requesting user. We return it paged." } } ], "description": "Here we will teach you how to create and manage your payment requests. The payment request is the main element of our approval flow, which can be checked out by logging into our Web Banking.\nThe requests are bound to their respective cost centers and represent requests to execute specific payments, which can be transfers, boleto payments, etc. Expect more payment options to be introduced!" } ] }, { "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": "Here you can register a new webhook URL. The subscriptions refer to which kinds of logs will be sent to the webhook URL being registered. The subscriptions must be in transfer, boleto, boleto-payment, utility-payment, brcode-payment, boleto-holmes, deposit, darf-payment, payment-request or invoice.", "body": { "mode": "raw", "raw": "{\n \"webhooks\": [\n {\n \"subscriptions\": \"\",\n \"url\": \"\"\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": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of Webhooks to be retrieved. Max = 100.", "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 Bank public key. This key is recoverable by a GET request to /v2/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. In case the event cannot be delivered after those three attempts, we will stop trying to deliver the message.\nThe event sent to the endpoint URL has the structure shown to the right, where the content of the log sent will depend on the event subscription.\nNOTE 1: Registered webhooks will only work for services used in that same version. For example, if you create a transfer in v2, its logs will only trigger v2 webhooks and v1 webhooks would ignore its events.\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, preventing you from having outdated information just in case your system is temporarily unable to receive our Webhook events." }, { "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": "fields", "value": "", "description": "List of strings to filter response JSON keys. Not available in the SDKs.", "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 } ] }, "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 transfer, the log in the event will be a TransferLog. If the subscription is boleto, the log in the event will be a BoletoLog, and so on." }, { "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": "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": "webhookIds", "value": "", "description": "list of Webhook ids to filter attempts. Example: [\"5656565656565656\", \"4545454545454545\"]", "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." }, { "name": "Pix Key", "item": [ { "name": "List your DICT Keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/dict-key", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "dict-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. 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 }, { "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 dicts by the specified status.", "disabled": true }, { "key": "type", "value": "", "description": "DICT Key type. Options are: \"cpf\", \"cnpj\", \"phone\", \"email\" or \"evp\".", "disabled": true } ] }, "description": "Get a list of the DICT Keys you own (or have owned) in chunks of at most 100. If you need smaller chunks, use the limit parameter." } }, { "name": "Get a DICT Key", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/dict-key/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "dict-key", "{{id}}" ] }, "description": "Get a single DICT key by its id. This method includes keys you do not own. You can use it to retrieve a key's information before creating Transfers.\nNote: Try to avoid looking up DICT keys without sending transfers afterwards, since Bacen's system will block users making too many standalone requests in a short timespan. Invalid key searches also count towards this block.\nNote: The encrypted parameters can be used to create a transfer without the need to decrypt." } } ], "description": "The Pix keys are saved in the DICT (Diretório de Identificadores de Contas Transacionais), the centralized Pix service managed by Bacen (Brazilian Central Bank) that allows you to search for transactional accounts with convenient addressing keys.\nThe types of keys currently available are CPF, CNPJ, phone number, e-mail and EVP (random UUID). In this section, we will teach you how to manage DICT keys.\nNote: Whenever a Workspace is created, an EVP (random) DICT key is created and associated with it. This is done in order to ensure the safety of the Invoice service, since it requires an active DICT Key to work." }, { "name": "Institutions", "item": [ { "name": "List Institutions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/institution", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "institution" ], "query": [ { "key": "limit", "value": "", "description": "Number of results per cursor. Max = 100.", "disabled": true }, { "key": "search", "value": "", "description": "Part of the institution name to be searched. Example: \"stark\"", "disabled": true }, { "key": "spiCodes", "value": "", "description": "List of SPI (Pix) codes to be searched. Example: [\"20018183\"]", "disabled": true }, { "key": "strCodes", "value": "", "description": "List of STR (Ted) codes to be searched. Example: [\"260\"]", "disabled": true } ] }, "description": "Get a list of institutions." } } ], "description": "An Institution is used to query institutions registered by the Brazilian Central Bank for Pix and Ted transactions." }, { "name": "Public Key", "item": [ { "name": "List Public Keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/{{version}}/public-key", "host": [ "{{baseUrl}}" ], "path": [ "{{version}}", "public-key" ] }, "description": "Get a list of the Stark Bank public keys ordered by creation date from newest to oldest. The most recent public key is the one currently in use by the API. The older keys can be used to verify older messages." } } ], "description": "Some of our responses will be signed using our own private key, such as the messages we send by webhook. In order to verify that it was really us that generated the message, you can get our public key and verify the provided signature and content." } ] } ] }