openapi: 3.1.0 info: title: Stark Infra API version: v2 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. Our 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. Want to check our OpenAPI 3.1 specification? You can download our yaml file right here. You can also try our Postman collection. Download it here. contact: name: Stark Infra Developers email: 'help@starkinfra.com' url: https://starkinfra.com license: name: Stark Infra License externalDocs: url: https://docs.starkinfra.com/api description: Stark Infra API documentation servers: - url: https://api.starkinfra.com description: Production - url: https://sandbox.api.starkinfra.com description: Sandbox paths: /v2/pix-request: post: summary: Create Pix Requests operationId: create-pixRequest tags: - Pix Request description: | Send Pix payments to any Pix-enabled bank account in Brazil. To create a manual Pix Request you need the receiver's account information. If you only have a Pix Key, use Get a Pix Key to retrieve the required information before creating the Pix Request. Every time a participant sends you a Pix, an inbound Pix Request is created and a synchronous POST authorization request is sent to your registered pixRequestUrl, which you must answer with approval or denial within 1 second (HTTP 200) or it is denied by default. Approve with status "approved"; deny with status "denied" and a reason such as "invalidAccountNumber". requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer description: 'Amount in cents to be transferred. Example: 100 (R$1.00).' externalId: type: string description: Unique string to prevent duplicates. Repeated externalIds will cause failures. endToEndId: type: string description: Unique end-to-end ID generated for the Pix request. senderAccountNumber: type: string description: Account number of the sender. senderBranchCode: type: string description: 'Branch code of the sender''s bank account.' senderAccountType: type: string description: 'Account type of the sender. Options: "checking", "savings", "salary", "payment".' senderName: type: string description: Full name of the sender. senderTaxId: type: string description: CPF or CNPJ of the sender. receiverAccountNumber: type: string description: Account number of the receiver. receiverAccountType: type: string description: 'Account type of the receiver. Options: "checking", "savings", "salary", "payment".' receiverBankCode: type: string description: Bank ISPB code of the receiver. receiverTaxId: type: string description: CPF or CNPJ of the receiver. receiverBranchCode: type: string description: 'Branch code of the receiver''s bank account.' receiverName: type: string description: Full name of the receiver. description: type: string description: Description of the Pix request. initiatorTaxId: type: string description: Tax ID of the payment initiator. reconciliationId: type: string description: Reconciliation ID for internal reference. method: type: string description: 'Method through which this Pix should be processed. Options: "manual", "dict", "initiator", "dynamicQrcode", "staticQrcode", "payerQrcode", "subscription", "contactless", "staticContactless".' cashAmount: type: string description: 'Amount in cents to be withdrawal when paying. Example: 1000 (R$10.00).' cashierType: type: string description: 'Cashier''s type for Pix Cash-out and Pix Change. Options: "merchant", "participant", "other".' cashierBankCode: type: string description: 'Cashier''s bank ISPB code for Pix Cash-out and Pix Change.' priority: type: string description: 'Pix request processing priority. Options: "high", "low".' reason: type: string description: 'Reason why this Pix request was created. Options: "customerRequest", "subscriptionFlaw", "fraud".' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - amount - externalId - endToEndId - senderAccountNumber - senderBranchCode - senderAccountType - senderName - senderTaxId - receiverAccountNumber - receiverAccountType - receiverBankCode - receiverTaxId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Requests operationId: list-pixRequest tags: - Pix Request description: | List and filter all Pix requests. Results are paged. Every time a participant sends you a Pix, an inbound Pix Request is created and a synchronous POST authorization request is sent to your registered pixRequestUrl, which you must answer with approval or denial within 1 second (HTTP 200) or it is denied by default. Approve with status "approved"; deny with status "denied" and a reason such as "invalidAccountNumber". parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: endToEndIds in: query description: Filter by end-to-end IDs. required: false schema: type: string - name: externalIds in: query description: Filter by external IDs. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-request/{id}': get: summary: Get a Pix Request operationId: get-pixRequest-byId tags: - Pix Request description: Get a single Pix request by its id. parameters: - name: id in: path description: Id of the Pix request entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-request/log: get: summary: List Pix Request Logs operationId: list-pixRequest-log tags: - Pix Request description: Get a paged list of all Pix request logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: requestIds in: query description: Array of Pix request ids linked to the logs. required: false schema: type: array items: type: string - name: types in: query description: Filter logs by log types. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-request/log/{id}': get: summary: Get a Pix Request Log operationId: get-pixRequest-log-byId tags: - Pix Request description: Get a single Pix request log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-reversal: post: summary: Create Pix Reversals operationId: create-pixReversal tags: - Pix Reversal description: | Reverse a Pix payment by providing the original end-to-end ID. Pix Reversals can only be created for inbound Pix Requests with status success. Reference the original Pix Request by passing its endToEndId. When a participant reverses a Pix you successfully sent, an authorization request is sent to your pixReversalUrl (which must differ from your pixRequestUrl); answer within 1 second (HTTP 200) or it is denied by default; if no pixReversalUrl is registered, inbound Pix Reversals are accepted by default. requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer description: Amount in cents to be reversed. endToEndId: type: string description: End-to-end ID of the original Pix request to be reversed. externalId: type: string description: Unique string to prevent duplicates. reason: type: string description: 'Reason for the reversal. Options: "fraud", "bankError", "cashierError", "customerRequest".' description: type: string description: Description of the reversal. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - amount - endToEndId - externalId - reason responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Reversals operationId: list-pixReversal tags: - Pix Reversal description: List and filter all Pix reversals. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: externalIds in: query description: Filter by external IDs. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-reversal/{id}': get: summary: Get a Pix Reversal operationId: get-pixReversal-byId tags: - Pix Reversal description: Get a single Pix reversal by its id. parameters: - name: id in: path description: Id of the Pix reversal entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-reversal/log: get: summary: List Pix Reversal Logs operationId: list-pixReversal-log tags: - Pix Reversal description: Get a paged list of all Pix reversal logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: reversalIds in: query description: Array of Pix reversal ids linked to the logs. required: false schema: type: array items: type: string - name: types in: query description: Filter logs by log types. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-reversal/log/{id}': get: summary: Get a Pix Reversal Log operationId: get-pixReversal-log-byId tags: - Pix Reversal description: Get a single Pix reversal log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-internal-transaction-report: post: summary: Create Pix Internal Transaction Reports operationId: create-pixInternalTransactionReport tags: - Pix Internal Transaction Report description: 'Report transactions that were settled internally on the participant, such as transfers between two Indirect participants of the same Direct participant or between accounts of the same participant.' requestBody: required: true content: application/json: schema: type: object properties: referenceType: type: string description: 'Origin of the report''s reference id. Options: "request" (use with endToEndId), "reversal" (use with returnId).' amount: type: integer description: 'Transaction amount in cents. Example: 100 (R$1.00).' endToEndId: type: string description: End-to-end id of the reported Pix transaction. method: type: string description: 'Type of the reported transaction. Options: "manual", "dict", "initiator", "dynamicQrcode", "staticQrcode", "payerQrcode", "subscription", "contactless", "staticContactless".' created: type: string description: Datetime of the original transaction. senderBankCode: type: string description: Bank ISPB code of the sender. senderBranchCode: type: string description: 'Branch code of the sender''s bank account.' senderAccountNumber: type: string description: Account number of the sender. senderAccountType: type: string description: 'Account type of the sender. Options: "checking", "savings", "salary", "payment", "other".' senderTaxId: type: string description: CPF or CNPJ of the sender. receiverBankCode: type: string description: Bank ISPB code of the receiver. receiverBranchCode: type: string description: 'Branch code of the receiver''s bank account.' receiverAccountNumber: type: string description: Account number of the receiver. receiverAccountType: type: string description: 'Account type of the receiver. Options: "checking", "savings", "salary", "payment", "other".' receiverTaxId: type: string description: CPF or CNPJ of the receiver. returnId: type: string description: 'Return id of the reported transaction. Required when referenceType is "reversal".' receiverKeyId: type: string description: 'Pix key of the receiver, when the transaction used one.' required: - referenceType - amount - endToEndId - method - created - senderBankCode - senderBranchCode - senderAccountNumber - senderAccountType - senderTaxId - receiverBankCode - receiverBranchCode - receiverAccountNumber - receiverAccountType - receiverTaxId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Internal Transaction Reports operationId: list-pixInternalTransactionReport tags: - Pix Internal Transaction Report description: List and filter all Pix internal transaction reports. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: List of ids to get specific entities. Max = 100. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: 'Filter by status. Options: "created", "processing", "success", "failed".' required: false schema: type: string - name: referenceIds in: query description: Filter by reference ids (endToEndId or returnId). Max = 30. required: false schema: type: string - name: referenceTypes in: query description: 'Filter by reference types. Options: "request", "reversal". Max = 30.' required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-internal-transaction-report/{id}': get: summary: Get a Pix Internal Transaction Report operationId: get-pixInternalTransactionReport-byId tags: - Pix Internal Transaction Report description: Get a single Pix internal transaction report by its id. parameters: - name: id in: path description: Id of the Pix internal transaction report entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-internal-transaction-report/log: get: summary: List Pix Internal Transaction Report Logs operationId: list-pixInternalTransactionReport-log tags: - Pix Internal Transaction Report description: Get a paged list of all Pix internal transaction report logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: Filter by log ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: 'Filter logs by log types. Options: "created", "sent", "success", "failed".' required: false schema: type: string - name: reportIds in: query description: Filter logs by Pix internal transaction report ids. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-internal-transaction-report/log/{id}': get: summary: Get a Pix Internal Transaction Report Log operationId: get-pixInternalTransactionReport-log-byId tags: - Pix Internal Transaction Report description: Get a single Pix internal transaction report log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/static-brcode: post: summary: Create Static Brcodes operationId: create-staticBrcode tags: - Static Brcode description: Create static Pix QR codes for receiving payments. requestBody: required: true content: application/json: schema: type: object properties: keyId: type: string description: Pix key to which payments will be directed. name: type: string description: Receiver name displayed in the QR code. city: type: string description: City of the receiver. amount: type: integer description: Fixed amount in cents. Leave empty for open amount QR codes. cashierBankCode: type: string description: Bank ISPB code of the cashier for Pix Saque/Troco operations. type: type: string description: 'Type of the static Brcode. Options: "instant", "instantAndOrSubscription". Defaults to "instant".' description: type: string description: Description of the static Brcode. reconciliationId: type: string description: Reconciliation ID included in the QR code. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - keyId - name - city responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Static Brcodes operationId: list-staticBrcode tags: - Static Brcode description: List and filter all static Brcodes. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: uuids in: query description: Filter by UUIDs. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/static-brcode/{uuid}': get: summary: Get a Static Brcode operationId: get-staticBrcode-byUuid tags: - Static Brcode description: Get a single static Brcode by its UUID. parameters: - name: uuid in: path description: UUID of the static Brcode. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/dynamic-brcode: post: summary: Create Dynamic Brcodes operationId: create-dynamicBrcode tags: - Dynamic Brcode description: Create dynamic Pix QR codes that fetch payment details from your server. requestBody: required: true content: application/json: schema: type: object properties: city: type: string description: City of the receiver. externalId: type: string description: Your internal ID used to match payment callbacks and to prevent duplicates. name: type: string description: Receiver name displayed in the QR code. type: type: string description: 'Type of dynamic Brcode. Options: "instant", "due", "subscription", "subscriptionAndInstant", "dueAndOrSubscription". Defaults to "instant" when omitted.' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - city - externalId - name responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Dynamic Brcodes operationId: list-dynamicBrcode tags: - Dynamic Brcode description: List and filter all dynamic Brcodes. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: externalIds in: query description: Filter by external IDs. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: uuids in: query description: Filter by UUIDs. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/dynamic-brcode/{uuid}': get: summary: Get a Dynamic Brcode operationId: get-dynamicBrcode-byUuid tags: - Dynamic Brcode description: Get a single dynamic Brcode by its UUID. parameters: - name: uuid in: path description: UUID of the dynamic Brcode. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/brcode-preview: post: summary: Create Brcode Previews operationId: create-brcodePreview tags: - Brcode Preview description: Fetch and preview the details of one or more Pix QR codes before payment. requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: QR code content (the EMV string from the QR code). payerId: type: string description: CPF or CNPJ of the payer for dynamic QR codes. scheduled: type: string format: date-time description: 'Date the payment is scheduled to be processed. This affects the preview values for due dynamic QR codes. Example: "2022-01-31".' endToEndId: type: string description: Unique end-to-end ID of the Pix transaction associated with this preview. One will be generated if none is provided. cityCode: type: string description: 'IBGE city code of the payer, with 7 digits. Example: "5300108".' expand: type: string description: 'Entity fields to expand in the response. Options: "jws".' required: - id - payerId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-pull-subscription: post: summary: Create Pix Pull Subscriptions operationId: create-pixPullSubscription tags: - Pix Pull Subscription description: | Create recurring Pix authorizations (Pix Automático). Authorization is obtained through one of four journeys via the subscription type: push (push notification to the payer's bank), qrcode (QR Code with direct authorization), qrcodeAndPayment (QR Code with authorization upon payment), and paymentAndOrQrcode (billing QR Code with an authorization offer). requestBody: required: true content: application/json: schema: type: object properties: subscriptions: type: array items: type: string description: List of 1 to 100 subscription objects to create. Each object accepts the parameters described below. type: type: string description: 'Subscription type. Options: "push", "qrcode", "qrcodeAndPayment", "paymentAndOrQrcode".' externalId: type: string description: Unique string to prevent duplicates. bacenId: type: string description: Central Bank identifier of the recurring authorization. referenceCode: type: string description: Free reference code for the subscription. interval: type: string description: 'Billing interval. Options: "week", "month", "quarter", "semester", "year".' installmentStart: type: string description: Date when the recurring authorization starts. receiverName: type: string description: Name of the receiver (creditor). receiverTaxId: type: string description: CPF or CNPJ of the receiver. senderTaxId: type: string description: CPF or CNPJ of the payer (debtor). senderAccountNumber: type: string description: Account number of the payer. senderBranchCode: type: string description: 'Branch code of the payer''s account.' amount: type: integer description: Fixed amount in cents pulled on each cycle. Omit for a variable amount. amountMinLimit: type: string description: Minimum amount in cents allowed per pull when the amount is variable. pullRetryLimit: type: string description: Maximum number of pull retries allowed per cycle. installmentEnd: type: string description: Date when the recurring authorization ends. due: type: string format: date-time description: Due datetime for the payer to approve the authorization. description: type: string description: Description presented to the payer. senderBankCode: type: string description: Bank ISPB code of the payer. senderFinalName: type: string description: 'Name of the final payer, when different from the account holder.' senderFinalTaxId: type: string description: 'CPF or CNPJ of the final payer, when different from the account holder.' senderCityCode: type: string description: IBGE city code of the payer. receiverBankCode: type: string description: Bank ISPB code of the receiver. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - subscriptions - type - externalId - bacenId - referenceCode - interval - installmentStart - receiverName - receiverTaxId - senderTaxId - senderAccountNumber - senderBranchCode responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Pull Subscriptions operationId: list-pixPullSubscription tags: - Pix Pull Subscription description: List and filter all Pix pull subscriptions. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: externalIds in: query description: Filter by the external ids provided on creation. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: flows in: query description: 'Filter by flow direction. Options: "in", "out".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-pull-subscription/{id}': get: summary: Get a Pix Pull Subscription operationId: get-pixPullSubscription-byId tags: - Pix Pull Subscription description: Get a single Pix pull subscription by its id. parameters: - name: id in: path description: Id of the Pix pull subscription entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Pix Pull Subscription operationId: update-pixPullSubscription-byId tags: - Pix Pull Subscription description: | Approve, deny or activate a Pix pull subscription. The allowed status transitions depend on whether you are the payer or the receiver. When confirming a received subscription, include the senderCityCode field. requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: 'New status. The payer may set "approved" or "denied"; the receiver may set "active".' reason: type: string description: 'Reason for the status change, required when denying. The available values depend on whether you are the sender or the receiver. Options: "invalidSenderAccountNumber", "accountClosed", "accountBlocked", "invalidBranchCode", "notRecognizedBySender", "userRejected", "notOffered".' senderCityCode: type: string description: 'IBGE city code of the payer, provided when approving.' required: - status parameters: - name: id in: path description: Id of the Pix pull subscription entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Pix Pull Subscription operationId: delete-pixPullSubscription-byId tags: - Pix Pull Subscription description: Cancel a Pix pull subscription. parameters: - name: id in: path description: Id of the Pix pull subscription entity. required: true schema: type: string - name: reason in: query description: 'Reason for the cancellation. The available values depend on whether you are the sender or the receiver. Options: "accountClosed", "receiverOrganizationClosed", "receiverInternalError", "senderDeceased", "fraud", "senderUserRequested", "receiverUserRequested", "paymentNotFound".' required: false schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-pull-subscription/log: get: summary: List Pix Pull Subscription Logs operationId: list-pixPullSubscription-log tags: - Pix Pull Subscription description: Get a paged list of all Pix pull subscription logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: subscriptionIds in: query description: Filter logs by the Pix pull subscription ids they belong to. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: 'Filter by log types. Options: "created", "delivering", "delivered", "approved", "confirmed", "failed", "denied", "canceling", "canceled", "expired".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-pull-subscription/log/{id}': get: summary: Get a Pix Pull Subscription Log operationId: get-pixPullSubscription-log-byId tags: - Pix Pull Subscription description: Get a single Pix pull subscription log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-pull-request: post: summary: Create Pix Pull Requests operationId: create-pixPullRequest tags: - Pix Pull Request description: | Issue charges against active Pix pull subscriptions. As the receiver bank, create a Pix Pull Request to instruct a debit from the payer's account on a scheduled date. Stark Infra verifies that the subscription is approved, the amount is within the authorized limit, the settlement date matches the subscription's charge cycle, payer/receiver details match the contract, the request is made between 10 and 2 days before settlement, and there is no other scheduled request for the same cycle. requestBody: required: true content: application/json: schema: type: object properties: requests: type: array items: type: string description: 'List of Pix pull request objects to be created. Min = 1, Max = 100. The parameters below describe the fields of each object.' subscriptionId: type: string description: Id of the active Pix pull subscription to charge. amount: type: integer description: Amount in cents to be pulled. due: type: string format: date-time description: Due datetime for the pull. attemptType: type: string description: 'Pull attempt type. Options: "default", "scheduledRetry", "instantRetry".' endToEndId: type: string description: End-to-end id of the Pix pull request. reconciliationId: type: string description: Reconciliation id (txid) of the pull. receiverAccountNumber: type: string description: Account number of the receiver. receiverAccountType: type: string description: 'Type of the receiver''s account.' receiverBankCode: type: string description: Bank ISPB code of the receiver. receiverBranchCode: type: string description: 'Branch code of the receiver''s account.' description: type: string description: Description of the pull request. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - requests - subscriptionId - amount - due - attemptType - endToEndId - reconciliationId - receiverAccountNumber - receiverAccountType responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Pull Requests operationId: list-pixPullRequest tags: - Pix Pull Request description: List and filter all Pix pull requests. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: subscriptionIds in: query description: Filter by the Pix pull subscription ids the requests belong to. required: false schema: type: string - name: endToEndIds in: query description: Filter by the end-to-end ids of the requests. required: false schema: type: string - name: externalIds in: query description: Filter by the external ids of the requests. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: attemptTypes in: query description: 'Filter by attempt type. Options: "default", "scheduledRetry", "instantRetry".' required: false schema: type: string - name: flows in: query description: 'Filter by flow direction. Options: "in", "out".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-pull-request/{id}': get: summary: Get a Pix Pull Request operationId: get-pixPullRequest-byId tags: - Pix Pull Request description: Get a single Pix pull request by its id. parameters: - name: id in: path description: Id of the Pix pull request entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Pix Pull Request operationId: update-pixPullRequest-byId tags: - Pix Pull Request description: Schedule or deny a Pix pull request. Only the payer may update a pull request. requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: 'New status. Options: "scheduled", "denied".' reason: type: string description: 'Reason for the status change, required when denying. Options: "senderAccountClosed", "senderAccountBlocked", "amountNotAllowed".' required: - status parameters: - name: id in: path description: Id of the Pix pull request entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Pix Pull Request operationId: delete-pixPullRequest-byId tags: - Pix Pull Request description: Cancel a Pix pull request. parameters: - name: id in: path description: Id of the Pix pull request entity. required: true schema: type: string - name: reason in: query description: 'Reason for the cancellation. The available values depend on whether you are the sender or the receiver. Options: "accountClosed", "accountBlocked", "pixRequestFailed", "other", "senderUserRequested", "receiverUserRequested".' required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-pull-request/log: get: summary: List Pix Pull Request Logs operationId: list-pixPullRequest-log tags: - Pix Pull Request description: Get a paged list of all Pix pull request logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: requestIds in: query description: Filter logs by the Pix pull request ids they belong to. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: 'Filter by log types. Options: "created", "sent", "scheduled", "denied", "success", "failed", "canceling", "canceled", "expired".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-pull-request/log/{id}': get: summary: Get a Pix Pull Request Log operationId: get-pixPullRequest-log-byId tags: - Pix Pull Request description: Get a single Pix pull request log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-key: post: summary: Create a Pix Key operationId: create-pixKey tags: - Pix Key description: Register a new Pix key in DICT for your workspace. requestBody: required: true content: application/json: schema: type: object properties: accountCreated: type: string description: Creation date of the linked bank account. accountNumber: type: string description: Account number of the linked bank account. accountType: type: string description: 'Type of the linked bank account. Options: "checking", "savings", "salary", "payment", "other".' branchCode: type: string description: Branch code of the linked bank account. name: type: string description: Name of the account holder. taxId: type: string description: CPF or CNPJ of the account holder. id: type: string description: 'Key value (CPF, CNPJ, email, phone). Leave empty to generate an EVP key.' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - accountCreated - accountNumber - accountType - branchCode - name - taxId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Keys operationId: list-pixKey tags: - Pix Key description: List and filter all Pix keys registered in your workspace. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: List of key values to get specific entities. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: taxId in: query description: 'Filter Pix keys by the holder''s CPF or CNPJ.' required: false schema: type: string - name: type in: query description: Filter by key type. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-key/{id}': get: summary: Get a Pix Key operationId: get-pixKey-byId tags: - Pix Key description: Get a single Pix key by its id. parameters: - name: id in: path description: Id (key value) of the Pix key entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: payerTaxId in: query description: Tax ID of the payer for DICT query purposes. required: false schema: type: string - name: endToEndId in: query description: Unique end-to-end ID of the Pix transaction associated with this DICT query. required: false schema: type: string - name: expand in: query description: 'Entity fields to expand in the response. Options: "statistics", "ownerStatistics".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Pix Key operationId: update-pixKey-byId tags: - Pix Key description: Update the account information linked to a Pix key. requestBody: required: true content: application/json: schema: type: object properties: reason: type: string description: 'Reason for the update. Options: "branchTransfer", "reconciliation", "userRequested".' accountCreated: type: string description: New creation date of the linked bank account. accountNumber: type: string description: New account number. accountType: type: string description: New account type. branchCode: type: string description: New branch code. name: type: string description: New holder name. required: - reason parameters: - name: id in: path description: Id (key value) of the Pix key entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Pix Key operationId: delete-pixKey-byId tags: - Pix Key description: Cancel a Pix key and remove it from DICT. parameters: - name: id in: path description: Id (key value) of the Pix key entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-key/log: get: summary: List Pix Key Logs operationId: list-pixKey-log tags: - Pix Key description: Get a paged list of all Pix key logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: Filter by Pix key ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: Filter logs by log types. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-key/log/{id}': get: summary: Get a Pix Key Log operationId: get-pixKey-log-byId tags: - Pix Key description: Get a single Pix key log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-key-holmes: post: summary: Create Pix Key Holmes operationId: create-pixKeyHolmes tags: - Pix Key Holmes description: | Request the verification of one or more Pix keys in DICT. You can create up to 100 Pix key holmes in a single request. requestBody: required: true content: application/json: schema: type: object properties: keyId: type: string description: 'Pix key to be verified. Can be a CPF, CNPJ, phone, e-mail or EVP (random) key.' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - keyId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Key Holmes operationId: list-pixKeyHolmes tags: - Pix Key Holmes description: List and filter all Pix key holmes. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: keyId in: query description: Filter by the verified Pix key. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: 'Filter by status. Options: "solving", "solved".' required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-key-holmes/{id}': get: summary: Get a Pix Key Holmes operationId: get-pixKeyHolmes-byId tags: - Pix Key Holmes description: Get a single Pix key holmes by its id. parameters: - name: id in: path description: Id of the Pix key holmes entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-key-holmes/log: get: summary: List Pix Key Holmes Logs operationId: list-pixKeyHolmes-log tags: - Pix Key Holmes description: Get a paged list of all Pix key holmes logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: Filter by Pix key holmes log ids. required: false schema: type: array items: type: string - name: holmesIds in: query description: Filter logs by the Pix key holmes ids they belong to. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: 'Filter by log types. Options: "solving", "solved".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-key-holmes/log/{id}': get: summary: Get a Pix Key Holmes Log operationId: get-pixKeyHolmes-log-byId tags: - Pix Key Holmes description: Get a single Pix key holmes log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-claim: post: summary: Create a Pix Claim operationId: create-pixClaim tags: - Pix Claim description: | Initiate a Pix key portability or ownership claim. An ownership claim changes the holder of a Pix Key (only phone keyType). A portability claim changes the linked account without changing the holder (phone, email or taxId keyTypes). requestBody: required: true content: application/json: schema: type: object properties: accountCreated: type: string description: Creation date of your linked bank account. accountNumber: type: string description: Your bank account number. accountType: type: string description: 'Your bank account type. Options: "checking", "savings", "salary", "payment".' branchCode: type: string description: Your bank account branch code. name: type: string description: Name of the account holder. taxId: type: string description: CPF or CNPJ of the account holder. keyId: type: string description: Value of the Pix key being claimed. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - accountCreated - accountNumber - accountType - branchCode - name - taxId - keyId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Claims operationId: list-pixClaim tags: - Pix Claim description: List and filter all Pix claims. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: bacenId in: query description: Filter by the Central Bank ID of the Pix claim. required: false schema: type: string - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: flow in: query description: 'Filter by claim flow. Options: "in" (incoming claims), "out" (outgoing claims).' required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: keyId in: query description: Filter by the Pix key value. required: false schema: type: string - name: keyType in: query description: 'Filter by the type of the Pix key being claimed. Options: "cpf", "cnpj", "phone", "email", "evp".' required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: type in: query description: Filter by claim type. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-claim/{id}': get: summary: Get a Pix Claim operationId: get-pixClaim-byId tags: - Pix Claim description: Get a single Pix claim by its id. parameters: - name: id in: path description: Id of the Pix claim entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Pix Claim operationId: update-pixClaim-byId tags: - Pix Claim description: | Confirm or cancel an incoming Pix claim. You must answer an inbound Pix Claim within 7 days of its status changing to delivered. If unanswered, a portability claim is rejected by default and an ownership claim is accepted by default, both with reason defaultBehavior. You can only confirm Pix Claims with delivered status; confirming deletes the referenced Pix Key from Stark Infra and the Central Bank. You can only cancel Pix Claims with delivered or confirmed status. requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: 'New status for the claim. Options: "confirmed", "canceled".' reason: type: string description: 'Reason for the status change. Options: "userRequested", "accountClosure", "fraud". Defaults to "userRequested".' required: - status parameters: - name: id in: path description: Id of the Pix claim entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-claim/log: get: summary: List Pix Claim Logs operationId: list-pixClaim-log tags: - Pix Claim description: Get a paged list of all Pix claim logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: claimIds in: query description: List of strings to filter logs by their Pix claim ids. required: false schema: type: array items: type: string - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: Filter by Pix claim ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: Filter logs by log types. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-claim/log/{id}': get: summary: Get a Pix Claim Log operationId: get-pixClaim-log-byId tags: - Pix Claim description: Get a single Pix claim log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-infraction: get: summary: List Pix Infractions operationId: list-pixInfraction tags: - Pix Infraction description: List and filter all Pix infractions. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: type in: query description: Filter by infraction type. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-infraction/{id}': get: summary: Get a Pix Infraction operationId: get-pixInfraction-byId tags: - Pix Infraction description: Get a single Pix infraction by its id. parameters: - name: id in: path description: Id of the Pix infraction entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Pix Infraction operationId: update-pixInfraction-byId tags: - Pix Infraction description: | Respond to an incoming Pix infraction report. Agree with an inbound infraction by patching its analysis to agreed, or disagree by patching it to disagreed. requestBody: required: true content: application/json: schema: type: object properties: result: type: string description: 'Result of the analysis. Options: "agreed", "disagreed".' fraudType: type: string description: 'Type of fraud associated with the infraction. Required when result is "agreed", optional when result is "disagreed". Options: "identity", "mule", "scam", "other".' analysis: type: string description: Analysis text explaining the result. required: - result - fraudType parameters: - name: id in: path description: Id of the Pix infraction entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Pix Infraction operationId: delete-pixInfraction-byId tags: - Pix Infraction description: Cancel a Pix infraction you reported. parameters: - name: id in: path description: Id of the Pix infraction entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-infraction/log: get: summary: List Pix Infraction Logs operationId: list-pixInfraction-log tags: - Pix Infraction description: Get a paged list of all Pix infraction logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: Filter by Pix infraction ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: Filter logs by log types. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-infraction/log/{id}': get: summary: Get a Pix Infraction Log operationId: get-pixInfraction-log-byId tags: - Pix Infraction description: Get a single Pix infraction log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-chargeback: post: summary: Create Pix Chargebacks operationId: create-pixChargeback tags: - Pix Chargeback description: | Request a chargeback for a Pix transaction. A Pix Chargeback requests the reversal of a Pix transaction and should only be created after a corresponding Pix Infraction is completed (or a system malfunction). The other participant must answer within 24 hours. The only supported reason is flaw — reversing an erroneous transaction caused by a system malfunction. requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer description: Amount in cents to be charged back. reason: type: string description: 'Reason for the chargeback. Options: "flaw".' referenceId: type: string description: End-to-end ID of the original Pix transaction. description: type: string description: 'Description of the chargeback request. Required when reason is "flaw".' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - amount - reason - referenceId - description responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Chargebacks operationId: list-pixChargeback tags: - Pix Chargeback description: List and filter all Pix chargebacks. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: bacenId in: query description: Filter by the Central Bank ID of the Pix chargeback. required: false schema: type: string - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: flow in: query description: 'Filter by flow direction. Options: "in", "out".' required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: referenceIds in: query description: List of end-to-end IDs of the original Pix transactions to filter by. Max = 30. required: false schema: type: array items: type: string - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-chargeback/{id}': get: summary: Get a Pix Chargeback operationId: get-pixChargeback-byId tags: - Pix Chargeback description: Get a single Pix chargeback by its id. parameters: - name: id in: path description: Id of the Pix chargeback entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Pix Chargeback operationId: update-pixChargeback-byId tags: - Pix Chargeback description: Respond to an incoming Pix chargeback request. requestBody: required: true content: application/json: schema: type: object properties: result: type: string description: 'Result of the chargeback analysis. Options: "agreed", "disagreed", "partiallyAgreed".' analysis: type: string description: Analysis text explaining the result. rejectionReason: type: string description: 'Reason for disagreement. Required when result is "disagreed". Options: "other", "noBalance", "accountClosed", "invalidRequest".' reversalReferenceId: type: string description: Return ID of the reversal used to partially or fully agree to the chargeback. required: - result parameters: - name: id in: path description: Id of the Pix chargeback entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Pix Chargeback operationId: delete-pixChargeback-byId tags: - Pix Chargeback description: Cancel a Pix chargeback you requested. parameters: - name: id in: path description: Id of the Pix chargeback entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-chargeback/log: get: summary: List Pix Chargeback Logs operationId: list-pixChargeback-log tags: - Pix Chargeback description: Get a paged list of all Pix chargeback logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: chargebackIds in: query description: Filter by Pix chargeback ids. Max = 30. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: Filter logs by log types. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-chargeback/log/{id}': get: summary: Get a Pix Chargeback Log operationId: get-pixChargeback-log-byId tags: - Pix Chargeback description: Get a single Pix chargeback log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-fraud: post: summary: Create Pix Fraud Reports operationId: create-pixFraud tags: - Pix Fraud description: Report a fraudulent user or Pix key to DICT. requestBody: required: true content: application/json: schema: type: object properties: externalId: type: string description: Unique string to prevent duplicates. type: type: string description: 'Type of fraud. Options: "identity", "mule", "scam", "other".' taxId: type: string description: CPF or CNPJ of the fraudster. keyId: type: string description: Pix key associated with the fraud. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - externalId - type - taxId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Fraud Reports operationId: list-pixFraud tags: - Pix Fraud description: List and filter all Pix fraud reports. Results are paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: bacenId in: query description: Filter by the Central Bank ID of the fraud report. required: false schema: type: string - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: type in: query description: Filter by fraud type. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-fraud/{id}': get: summary: Get a Pix Fraud Report operationId: get-pixFraud-byId tags: - Pix Fraud description: Get a single Pix fraud report by its id. parameters: - name: id in: path description: Id of the Pix fraud entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Pix Fraud Report operationId: delete-pixFraud-byId tags: - Pix Fraud description: Cancel a Pix fraud report you submitted. parameters: - name: id in: path description: Id of the Pix fraud entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-fraud/log: get: summary: List Pix Fraud Logs operationId: list-pixFraud-log tags: - Pix Fraud description: Get a paged list of all Pix fraud logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string - name: ids in: query description: Filter by Pix fraud log ids. required: false schema: type: array items: type: string - name: fraudIds in: query description: Filter logs by the Pix fraud report ids they belong to. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: 'Filter by log types. Options: "created", "failed", "registered", "canceling", "canceled".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-fraud/log/{id}': get: summary: Get a Pix Fraud Log operationId: get-pixFraud-log-byId tags: - Pix Fraud description: Get a single Pix fraud log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-dispute: post: summary: Create Pix Disputes operationId: create-pixDispute tags: - Pix Dispute description: Initiate a Pix dispute for a transaction. requestBody: required: true content: application/json: schema: type: object properties: referenceId: type: string description: End-to-end ID of the original Pix transaction. method: type: string description: 'Method of the dispute. Options: "scam", "unauthorized", "coercion", "invasion", "other", "unknown".' operatorEmail: type: string description: Contact email of the operator responsible for the Pix dispute. operatorPhone: type: string description: Contact phone number of the operator responsible for the Pix dispute. description: type: string description: 'Description of the Pix dispute. Required when method is "other".' minTransactionAmount: type: string description: Minimum amount in cents of the transactions to be tracked in the dispute. maxHopCount: type: string description: Maximum number of hops to be tracked in the dispute. maxHopInterval: type: string description: Maximum interval in seconds between hops to be tracked in the dispute. maxTransactionCount: type: string description: Maximum number of transactions to be tracked in the dispute. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - referenceId - method - operatorEmail - operatorPhone responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Disputes operationId: list-pixDispute tags: - Pix Dispute description: List and filter all Pix disputes. Results are paged. parameters: - name: bacenId in: query description: 'Filter for the Central Bank''s unique ID of the Pix dispute.' required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: flow in: query description: 'Filter by flow direction. Options: "in", "out".' required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: referenceIds in: query description: List of end-to-end IDs to get disputes by their original Pix transactions. required: false schema: type: array items: type: string - name: status in: query description: Filter by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-dispute/{id}': get: summary: Get a Pix Dispute operationId: get-pixDispute-byId tags: - Pix Dispute description: Get a single Pix dispute by its id. parameters: - name: id in: path description: Id of the Pix dispute entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Pix Dispute operationId: delete-pixDispute-byId tags: - Pix Dispute description: Cancel a Pix dispute you initiated. parameters: - name: id in: path description: Id of the Pix dispute entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-dispute/log: get: summary: List Pix Dispute Logs operationId: list-pixDispute-log tags: - Pix Dispute description: Get a paged list of all Pix dispute logs. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: disputeIds in: query description: List of strings to get logs by their Pix dispute ids. required: false schema: type: array items: type: string - name: ids in: query description: Filter by Pix dispute ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: types in: query description: Filter logs by log types. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-dispute/log/{id}': get: summary: Get a Pix Dispute Log operationId: get-pixDispute-log-byId tags: - Pix Dispute description: Get a single Pix dispute log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-user/{taxId}': get: summary: Get a Pix User operationId: get-pixUser-byTaxId tags: - Pix User description: 'Retrieve a user''s aggregated Pix statistics — Pix keys, Pix requests, frauds and infractions — for a specific user by their tax ID.' parameters: - name: taxId in: path description: CPF or CNPJ of the user to query. required: true schema: type: string - name: keyId in: query description: 'Pix key to retrieve statistics for. When provided, the response returns the key statistics instead of the owner statistics.' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-balance: get: summary: Get Pix Balance operationId: list-pixBalance tags: - Pix Balance description: Retrieve the current Pix balance of your workspace. parameters: - name: before in: query description: 'Date used to retrieve the balance as of the end of the informed day. Example: "2022-01-31". When omitted or set to the current day, the current balance is returned.' required: false schema: type: string format: date responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-domain: get: summary: List Pix Domains operationId: list-pixDomain tags: - Pix Domain description: List all registered Pix domains and their certificate chains. parameters: - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-statement: post: summary: Create a Pix Statement operationId: create-pixStatement tags: - Pix Statement description: Request a Pix statement for a specific period and type. requestBody: required: true content: application/json: schema: type: object properties: after: type: string format: date description: 'Start date of the statement period. Example: "2022-01-01".' before: type: string format: date description: 'End date of the statement period. Example: "2022-01-31".' type: type: string description: 'Type of the statement. Options: "interchange", "interchangeTotal", "transaction".' required: - after - before - type responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Pix Statements operationId: list-pixStatement tags: - Pix Statement description: List and filter all Pix statements. Results are paged. parameters: - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-statement/{id}': get: summary: Get a Pix Statement operationId: get-pixStatement-byId tags: - Pix Statement description: Get a single Pix statement by its id. parameters: - name: id in: path description: Id of the Pix statement entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-statement/{id}/csv': get: summary: Get a Pix Statement CSV operationId: get-pixStatement-byId-csv tags: - Pix Statement description: Get the CSV file for a completed Pix statement. The file is returned compressed in the gzip format. parameters: - name: id in: path description: Id of the Pix statement entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/pix-statement/{id}/chunk/{number}': get: summary: Get a Pix Statement Chunk operationId: get-pixStatement-byId-chunk-byNumber tags: - Pix Statement description: 'Get a single chunk of a completed Pix statement. Large statements are split into numbered parts, letting you download one chunk at a time. The chunk is returned compressed in the gzip format.' parameters: - name: id in: path description: Id of the Pix statement entity. required: true schema: type: string - name: number in: path description: 'Number of the chunk to retrieve, ranging from 1 to the statement''s chunkCount.' required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/pix-director: post: summary: Create a Pix Director operationId: create-pixDirector tags: - Pix Director description: Register the Pix director for your institution as required by the Brazilian Central Bank. requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: Email address of the director. name: type: string description: Full name of the director. password: type: string description: Password for director access. phone: type: string description: Phone number of the director. taxId: type: string description: CPF of the director. teamEmail: type: string description: Team email for Pix notifications. teamPhones: type: array items: type: string description: List of team phone numbers for Pix notifications. required: - email - name - password - phone - taxId - teamEmail - teamPhones responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-balance: get: summary: Get the Issuing Balance operationId: list-issuingBalance tags: - Issuing Balance description: Get the current balance in your issuing wallet. responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-product: get: summary: List Issuing Products operationId: list-issuingProduct tags: - Issuing Product description: Get a list of available issuing products for your workspace. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-holder: post: summary: Create Issuing Holders operationId: create-issuingHolder tags: - Issuing Holder description: Use this route to create up to 100 new issuing holders at a time. requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Full name of the holder. Example: "Tony Stark".' taxId: type: string description: 'Holder CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). Example: "012.345.678-90".' externalId: type: string description: 'Your unique identifier for this holder, used to prevent duplicates. Example: "my-holder-id-1234".' rules: type: array items: type: string description: List of spending rule objects to apply to the holder. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. expand: type: string description: 'Fields to return expanded in the response. Options: "rules".' required: - name - taxId - externalId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Issuing Holders operationId: list-issuingHolder tags: - Issuing Holder description: Get a list of issuing holders in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: Filter holders by the specified status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: expand in: query description: 'Fields to return expanded in the response. Options: "rules".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-holder/{id}': get: summary: Get an Issuing Holder operationId: get-issuingHolder-byId tags: - Issuing Holder description: Get a single issuing holder by its id. parameters: - name: id in: path description: Id of the issuing holder entity. required: true schema: type: string - name: expand in: query description: 'Fields to return expanded in the response. Options: "rules".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update an Issuing Holder operationId: update-issuingHolder-byId tags: - Issuing Holder description: Update the properties of an existing issuing holder. requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: 'Status to update the holder to. Options: "active", "blocked".' name: type: string description: New full name of the holder. rules: type: array items: type: string description: New list of spending rule objects to apply to the holder. tags: type: array items: type: string description: New array of strings to tag the holder. parameters: - name: id in: path description: Id of the issuing holder entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel an Issuing Holder operationId: delete-issuingHolder-byId tags: - Issuing Holder description: Cancel an issuing holder. This action is irreversible. parameters: - name: id in: path description: Id of the issuing holder entity to cancel. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-holder/log: get: summary: List Issuing Holder Logs operationId: list-issuingHolder-log tags: - Issuing Holder description: Get a paged list of issuing holder logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: holderIds in: query description: Array of holder ids to filter logs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific log entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-holder/log/{id}': get: summary: Get an Issuing Holder Log operationId: get-issuingHolder-log-byId tags: - Issuing Holder description: Get a single issuing holder log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-card: post: summary: Create Issuing Cards operationId: create-issuingCard tags: - Issuing Card description: Use this route to create up to 100 new issuing cards at a time. requestBody: required: true content: application/json: schema: type: object properties: holderName: type: string description: 'Name of the card holder. Example: "Tony Stark".' holderTaxId: type: string description: 'Tax id (CPF/CNPJ) of the card holder. Example: "012.345.678-90".' holderExternalId: type: string description: 'Unique id of the card holder in your system. Example: "my-holder-id-1234".' productId: type: string description: Id of the IssuingProduct to use for this card. type: type: string description: 'Card type. Options: "virtual", "physical". Default: "virtual".' displayName: type: string description: 'Name to be displayed on the card. Example: "TONY STARK".' rules: type: array items: type: string description: List of spending rule objects to apply to the card. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. streetLine1: type: string description: Primary line of the billing address. streetLine2: type: string description: Secondary line of the billing address. district: type: string description: District of the billing address. city: type: string description: City of the billing address. stateCode: type: string description: 'State code of the billing address. Example: "SP".' zipCode: type: string description: 'ZIP code of the billing address. Example: "01311-000".' expand: type: string description: 'Fields to return expanded in the response. Options: "rules", "securityCode", "number", "expiration", "isPinDefined".' required: - holderName - holderTaxId - holderExternalId - productId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Issuing Cards operationId: list-issuingCard tags: - Issuing Card description: Get a list of issuing cards in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: Filter cards by the specified status. required: false schema: type: string - name: types in: query description: 'Filter cards by type. Options: "virtual", "physical".' required: false schema: type: string - name: holderIds in: query description: Filter cards by holder ids. required: false schema: type: string - name: endings in: query description: List of strings to filter cards by their last 4 digits. Max 30. required: false schema: type: array items: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: expand in: query description: 'Fields to return expanded in the response. Options: "rules", "securityCode", "number", "expiration", "isPinDefined".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-card/{id}': get: summary: Get an Issuing Card operationId: get-issuingCard-byId tags: - Issuing Card description: Get a single issuing card by its id. parameters: - name: id in: path description: Id of the issuing card entity. required: true schema: type: string - name: expand in: query description: 'Fields to return expanded in the response. Options: "rules", "securityCode", "number", "expiration", "isPinDefined".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update an Issuing Card operationId: update-issuingCard-byId tags: - Issuing Card description: Update the properties of an existing issuing card. requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: 'Status to update the card to. Options: "active", "blocked".' rules: type: array items: type: string description: New list of spending rule objects to apply to the card. tags: type: array items: type: string description: New array of strings to tag the card. displayName: type: string description: New display name for the card. pin: type: string description: 'Card PIN. Numeric string of 4 to 6 digits. Write-only — it is never returned; inform "expand=isPinDefined" to check whether a PIN is set. A pending physical card must receive a pin when you activate it (set status to "active").' parameters: - name: id in: path description: Id of the issuing card entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel an Issuing Card operationId: delete-issuingCard-byId tags: - Issuing Card description: Cancel an issuing card. This action is irreversible. parameters: - name: id in: path description: Id of the issuing card entity to cancel. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-card/log: get: summary: List Issuing Card Logs operationId: list-issuingCard-log tags: - Issuing Card description: Get a paged list of issuing card logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: cardIds in: query description: Array of card ids to filter logs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific log entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-card/log/{id}': get: summary: Get an Issuing Card Log operationId: get-issuingCard-log-byId tags: - Issuing Card description: Get a single issuing card log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-design: get: summary: List Issuing Designs operationId: list-issuingDesign tags: - Issuing Design description: Get a list of available issuing designs for your workspace. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-design/{id}': get: summary: Get an Issuing Design operationId: get-issuingDesign-byId tags: - Issuing Design description: Get a single issuing design by its id. parameters: - name: id in: path description: Id of the issuing design entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-design/{id}/pdf': get: summary: Get an Issuing Design PDF operationId: get-issuingDesign-byId-pdf tags: - Issuing Design description: Get the PDF file for a specific issuing design. This file can be used to preview the card layout. parameters: - name: id in: path description: Id of the issuing design entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-embossing-kit: get: summary: List Issuing Embossing Kits operationId: list-issuingEmbossingKit tags: - Issuing Embossing Kit description: Get a list of available issuing embossing kits for your workspace. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: 'Filter entities created after this date. Example: "2022-01-20".' required: false schema: type: string format: date - name: before in: query description: 'Filter entities created before this date. Example: "2022-02-20".' required: false schema: type: string format: date - name: designIds in: query description: Filter by IssuingDesign ids. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-embossing-kit/{id}': get: summary: Get an Issuing Embossing Kit operationId: get-issuingEmbossingKit-byId tags: - Issuing Embossing Kit description: Get a single issuing embossing kit by its id. parameters: - name: id in: path description: Id of the issuing embossing kit entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-stock: get: summary: List Issuing Stocks operationId: list-issuingStock tags: - Issuing Stock description: Get a list of issuing stocks in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: designIds in: query description: List of strings to filter stocks by specific IssuingDesign ids. required: false schema: type: array items: type: string - name: embosserIds in: query description: List of strings to filter stocks by specific embosser ids. required: false schema: type: array items: type: string - name: expand in: query description: 'Fields to expand information on the response. Options: "balance".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-stock/{id}': get: summary: Get an Issuing Stock operationId: get-issuingStock-byId tags: - Issuing Stock description: Get a single issuing stock entry by its id. parameters: - name: id in: path description: Id of the issuing stock entity. required: true schema: type: string - name: expand in: query description: 'Fields to expand information on the response. Options: "balance".' required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-stock/log: get: summary: List Issuing Stock Logs operationId: list-issuingStock-log tags: - Issuing Stock description: Get a paged list of issuing stock logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: stockIds in: query description: Array of stock ids to filter logs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific log entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-stock/log/{id}': get: summary: Get an Issuing Stock Log operationId: get-issuingStock-log-byId tags: - Issuing Stock description: Get a single issuing stock log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-stock-rule: post: summary: Create Issuing Stock Rules operationId: create-issuingStockRule tags: - Issuing Stock Rule description: | Use this route to register stock rules. Send a "rules" array where each element carries the parameters below. At least one email or phone must be informed per rule. requestBody: required: true content: application/json: schema: type: object properties: minimumBalance: type: string description: 'Stock count threshold that triggers the alert. Must be a positive integer. Example: 1000.' stockId: type: string description: Id of the IssuingStock to monitor. emails: type: array items: type: string description: 'List of email addresses to notify. Max: 10.' phones: type: array items: type: string description: 'List of phone numbers to notify. Max: 10.' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - minimumBalance - stockId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Issuing Stock Rules operationId: list-issuingStockRule tags: - Issuing Stock Rule description: Get a list of issuing stock rules in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: 'Filter entities by status. Options: "active", "canceled".' required: false schema: type: string - name: stockIds in: query description: List of strings to get rules attached to specific IssuingStock ids. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: tags in: query description: List of strings to filter entities by tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-stock-rule/{id}': patch: summary: Update an Issuing Stock Rule operationId: update-issuingStockRule-byId tags: - Issuing Stock Rule description: Update the properties of an existing issuing stock rule. requestBody: required: true content: application/json: schema: type: object properties: minimumBalance: type: string description: New stock count threshold that triggers the alert. emails: type: array items: type: string description: 'New list of email addresses to notify. Max: 10.' phones: type: array items: type: string description: 'New list of phone numbers to notify. Max: 10.' tags: type: array items: type: string description: New array of strings to tag the entity. parameters: - name: id in: path description: Id of the issuing stock rule entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel an Issuing Stock Rule operationId: delete-issuingStockRule-byId tags: - Issuing Stock Rule description: Cancel an issuing stock rule. This action is irreversible. parameters: - name: id in: path description: Id of the issuing stock rule entity to cancel. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-restock: post: summary: Create Issuing Restocks operationId: create-issuingRestock tags: - Issuing Restock description: Use this route to create up to 100 new issuing restock requests at a time. requestBody: required: true content: application/json: schema: type: object properties: count: type: string description: 'Number of card blanks to request. Example: 100.' stockId: type: string description: Id of the IssuingStock to be replenished. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - count - stockId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Issuing Restocks operationId: list-issuingRestock tags: - Issuing Restock description: Get a list of issuing restock requests in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: 'Filter for status of retrieved entities. Options: "created", "processing", "confirmed", "canceled".' required: false schema: type: string - name: stockIds in: query description: List of IssuingStock ids to filter retrieved entities. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: tags in: query description: List of strings to filter retrieved entities by tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-restock/{id}': get: summary: Get an Issuing Restock operationId: get-issuingRestock-byId tags: - Issuing Restock description: Get a single issuing restock by its id. parameters: - name: id in: path description: Id of the issuing restock entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-restock/log: get: summary: List Issuing Restock Logs operationId: list-issuingRestock-log tags: - Issuing Restock description: Get a paged list of issuing restock logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: restockIds in: query description: Array of restock ids to filter logs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-restock/log/{id}': get: summary: Get an Issuing Restock Log operationId: get-issuingRestock-log-byId tags: - Issuing Restock description: Get a single issuing restock log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-embossing-request: post: summary: Create Issuing Embossing Requests operationId: create-issuingEmbossingRequest tags: - Issuing Embossing Request description: Use this route to create up to 100 new issuing embossing requests at a time. requestBody: required: true content: application/json: schema: type: object properties: cardId: type: string description: Id of the IssuingCard to be embossed. kitId: type: string description: Id of the IssuingEmbossingKit to use. displayName1: type: string description: 'First line of the name to be printed on the card. Example: "TONY STARK".' displayName2: type: string description: Second line of the name to be printed on the card. displayName3: type: string description: Third line of the name to be printed on the card. shippingCity: type: string description: City for card delivery. shippingCountryCode: type: string description: 'Country code for card delivery. Example: "BRA".' shippingDistrict: type: string description: District for card delivery. shippingService: type: string description: 'Shipping service type. Options: "loggi", "conveyor".' shippingStateCode: type: string description: 'State code for card delivery. Example: "SP".' shippingStreetLine1: type: string description: Primary street line for card delivery. shippingStreetLine2: type: string description: Secondary street line for card delivery. shippingZipCode: type: string description: 'ZIP code for card delivery. Example: "01311-000".' shippingTrackingNumber: type: string description: Tracking number for the card shipment. shippingPhone: type: string description: 'Phone number for delivery contact. Example: "+5511999999999".' embosserId: type: string description: Id of the embosser to handle this request. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - cardId - kitId - displayName1 - shippingCity - shippingCountryCode - shippingDistrict - shippingService - shippingStateCode - shippingStreetLine1 - shippingStreetLine2 - shippingZipCode - shippingTrackingNumber responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Issuing Embossing Requests operationId: list-issuingEmbossingRequest tags: - Issuing Embossing Request description: Get a list of issuing embossing requests in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: Filter requests by the specified status. required: false schema: type: string - name: cardIds in: query description: List of IssuingCard ids to filter the retrieved entities. required: false schema: type: array items: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-embossing-request/{id}': get: summary: Get an Issuing Embossing Request operationId: get-issuingEmbossingRequest-byId tags: - Issuing Embossing Request description: Get a single issuing embossing request by its id. parameters: - name: id in: path description: Id of the issuing embossing request entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-embossing-request/log: get: summary: List Issuing Embossing Request Logs operationId: list-issuingEmbossingRequest-log tags: - Issuing Embossing Request description: Get a paged list of issuing embossing request logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: requestIds in: query description: Array of embossing request ids to filter logs. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-embossing-request/log/{id}': get: summary: Get an Issuing Embossing Request Log operationId: get-issuingEmbossingRequest-log-byId tags: - Issuing Embossing Request description: Get a single issuing embossing request log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-token: get: summary: List Issuing Tokens operationId: list-issuingToken tags: - Issuing Token description: Get a list of issuing tokens in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: Filter tokens by the specified status. required: false schema: type: string - name: cardIds in: query description: Filter tokens by card ids. required: false schema: type: string - name: externalIds in: query description: Filter tokens by external ids. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-token/{id}': get: summary: Get an Issuing Token operationId: get-issuingToken-byId tags: - Issuing Token description: Get a single issuing token by its id. parameters: - name: id in: path description: Id of the issuing token entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update an Issuing Token operationId: update-issuingToken-byId tags: - Issuing Token description: Update the status or tags of an existing issuing token. requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: 'Status to update the token to. Options: "active", "blocked".' tags: type: array items: type: string description: New array of strings to tag the token. parameters: - name: id in: path description: Id of the issuing token entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel an Issuing Token operationId: delete-issuingToken-byId tags: - Issuing Token description: Cancel an issuing token. This action is irreversible. parameters: - name: id in: path description: Id of the issuing token entity to cancel. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-token/log: get: summary: List Issuing Token Logs operationId: list-issuingToken-log tags: - Issuing Token description: Get a paged list of issuing token logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: tokenIds in: query description: Array of token ids to filter logs. required: false schema: type: array items: type: string - name: tokenTags in: query description: Filter logs by the tags of their tokens. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-token/log/{id}': get: summary: Get an Issuing Token Log operationId: get-issuingToken-log-byId tags: - Issuing Token description: Get a single issuing token log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-token-request: post: summary: Create an Issuing Token Request operationId: create-issuingTokenRequest tags: - Issuing Token Request description: Use this route to process a tokenization request from a digital wallet provider. requestBody: required: true content: application/json: schema: type: object properties: cardId: type: string description: Id of the IssuingCard to be tokenized. walletId: type: string description: 'Id of the digital wallet making the tokenization request. Options: "apple", "google", "merchant".' methodCode: type: string description: 'Provisioning method. Options: "app", "manual".' metadata: type: string description: Additional data to pass along with the tokenization request. required: - cardId - walletId - methodCode responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-token-design: get: summary: List Issuing Token Designs operationId: list-issuingTokenDesign tags: - Issuing Token Design description: Get a list of available issuing token designs for your workspace. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-token-design/{id}': get: summary: Get an Issuing Token Design operationId: get-issuingTokenDesign-byId tags: - Issuing Token Design description: Get a single issuing token design by its id. parameters: - name: id in: path description: Id of the issuing token design entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-token-design/{id}/pdf': get: summary: Get an Issuing Token Design PDF operationId: get-issuingTokenDesign-byId-pdf tags: - Issuing Token Design description: Get the PDF file for a specific issuing token design. This file is used to represent the card in digital wallets. parameters: - name: id in: path description: Id of the issuing token design entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-invoice: post: summary: Create an Issuing Invoice operationId: create-issuingInvoice tags: - Issuing Invoice description: Use this route to create a new issuing invoice to fund your issuing balance. requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer description: 'Amount in cents to be deposited. Example: 10000 (R$100.00).' taxId: type: string description: 'Payer CPF or CNPJ. Example: "012.345.678-90".' name: type: string description: 'Payer full name. Example: "Tony Stark".' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. metadata: type: string description: Free-form map you can attach to the invoice. required: - amount responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Issuing Invoices operationId: list-issuingInvoice tags: - Issuing Invoice description: Get a list of issuing invoices in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: Filter invoices by the specified status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-invoice/{id}': get: summary: Get an Issuing Invoice operationId: get-issuingInvoice-byId tags: - Issuing Invoice description: Get a single issuing invoice by its id. parameters: - name: id in: path description: Id of the issuing invoice entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-invoice/log: get: summary: List Issuing Invoice Logs operationId: list-issuingInvoice-log tags: - Issuing Invoice description: Get a paged list of issuing invoice logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: ids in: query description: Array of invoice ids to filter logs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-invoice/log/{id}': get: summary: Get an Issuing Invoice Log operationId: get-issuingInvoice-log-byId tags: - Issuing Invoice description: Get a single issuing invoice log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-billing-invoice: get: summary: List Issuing Billing Invoices operationId: list-issuingBillingInvoice tags: - Issuing Billing Invoice description: Get a list of issuing billing invoices in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: 'Filter entities by status. Options: "created", "pending", "overdue", "expired", "paid".' required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-billing-invoice/{id}': get: summary: Get an Issuing Billing Invoice operationId: get-issuingBillingInvoice-byId tags: - Issuing Billing Invoice description: Get a single issuing billing invoice by its id. parameters: - name: id in: path description: Id of the issuing billing invoice entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-billing-transaction: get: summary: List Issuing Billing Transactions operationId: list-issuingBillingTransaction tags: - Issuing Billing Transaction description: Get a list of issuing billing transactions in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: invoiceId in: query description: Filter transactions that compose a specific IssuingBillingInvoice. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: tags in: query description: List of strings to filter entities by tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-purchase: get: summary: List Issuing Purchases operationId: list-issuingPurchase tags: - Issuing Purchase description: Get a list of issuing purchases in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: status in: query description: Filter purchases by the specified status. required: false schema: type: string - name: cardIds in: query description: Filter purchases by card ids. required: false schema: type: string - name: holderIds in: query description: Filter purchases by holder ids. required: false schema: type: string - name: endToEndIds in: query description: Filter purchases by their end-to-end transaction ids. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-purchase/{id}': get: summary: Get an Issuing Purchase operationId: get-issuingPurchase-byId tags: - Issuing Purchase description: Get a single issuing purchase by its id. parameters: - name: id in: path description: Id of the issuing purchase entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update an Issuing Purchase operationId: update-issuingPurchase-byId tags: - Issuing Purchase description: Update the tags of an existing issuing purchase. requestBody: required: true content: application/json: schema: type: object properties: tags: type: array items: type: string description: New array of strings to tag the purchase. description: type: string description: New description for the purchase. Max of 140 characters. parameters: - name: id in: path description: Id of the issuing purchase entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-purchase/log: get: summary: List Issuing Purchase Logs operationId: list-issuingPurchase-log tags: - Issuing Purchase description: Get a paged list of issuing purchase logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: types in: query description: Filter logs by log types. required: false schema: type: string - name: purchaseIds in: query description: Array of purchase ids to filter logs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-purchase/log/{id}': get: summary: Get an Issuing Purchase Log operationId: get-issuingPurchase-log-byId tags: - Issuing Purchase description: Get a single issuing purchase log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-preview-installment: get: summary: List Issuing Preview Installments operationId: list-issuingPreviewInstallment tags: - Issuing Preview Installment description: Get a list of issuing preview installments in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: sort in: query description: 'Sort order for the results. Options: "created", "-created", "due", "-due". Default: "-created".' required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: tags in: query description: List of strings to filter entities by tags. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-transaction: get: summary: List Issuing Transactions operationId: list-issuingTransaction tags: - Issuing Transaction description: Get a list of issuing transactions in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: externalIds in: query description: List of strings to get specific entities by their external ids. required: false schema: type: array items: type: string - name: source in: query description: Filter entities by the source entity that generated the transaction. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-transaction/{id}': get: summary: Get an Issuing Transaction operationId: get-issuingTransaction-byId tags: - Issuing Transaction description: Get a single issuing transaction by its id. parameters: - name: id in: path description: Id of the issuing transaction entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/issuing-withdrawal: post: summary: Create an Issuing Withdrawal operationId: create-issuingWithdrawal tags: - Issuing Withdrawal description: Use this route to create a new issuing withdrawal and move funds from your issuing balance. requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer description: 'Amount in cents to withdraw. Example: 10000 (R$100.00).' externalId: type: string description: 'Your unique identifier for this withdrawal, used to prevent duplicates. Example: "withdrawal-2024-001".' description: type: string description: Description of the withdrawal purpose. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. required: - amount - externalId - description responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Issuing Withdrawals operationId: list-issuingWithdrawal tags: - Issuing Withdrawal description: Get a list of issuing withdrawals in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: externalIds in: query description: List of strings to get specific entities by their external ids. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/issuing-withdrawal/{id}': get: summary: Get an Issuing Withdrawal operationId: get-issuingWithdrawal-byId tags: - Issuing Withdrawal description: Get a single issuing withdrawal by its id. parameters: - name: id in: path description: Id of the issuing withdrawal entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/credit-note: post: summary: Create Credit Notes operationId: create-creditNote tags: - Credit Note description: | Create credit notes in bulk. You can create up to 100 credit notes in a single request. Provide either the nominalAmount (pre-tax) or the amount (net disbursed value) - the other one, along with the taxAmount (IOF) and the interest rates, is computed from the invoice schedule. requestBody: required: true content: application/json: schema: type: object properties: templateId: type: string description: ID of the credit note template to be used. Templates are enabled for your workspace through your credit profile. name: type: string description: 'Borrower full name. Example: "Jamie Lannister"' taxId: type: string description: 'Borrower CPF (11 digits) or CNPJ (14 digits). Example: "012.345.678-90"' scheduled: type: string format: date-time description: 'Datetime when the credit note should be disbursed after signing. Example: "2022-06-28"' invoices: type: array items: type: object description: 'List of up to 100 Invoice objects representing the installments to be paid by the borrower. Each invoice takes a required "amount" (in cents) and optional "due", "fine" (default 2.0), "interest" (default 1.0), "expiration", "descriptions" and "tags". All invoices must share the same fine and interest.' payment: type: string description: | Transfer object used to disburse the credit amount to the borrower's account, with required "name", "taxId", "bankCode" (receiver institution ISPB, 8 digits), "branchCode" and "accountNumber", and optional "accountType" ("checking", "payment", "salary" or "savings") and "tags". Do not send an "amount" in the payment object - the disbursed amount is computed by the API. paymentType: type: string description: 'Type of the payment object. Options: "transfer".' signers: type: array items: type: string description: 'List of up to 10 CreditSigner objects representing every person or entity that must sign the contract, each with required "name", "contact" and "method". Methods: "link" (signing link sent to an email or phone contact), "token" (signing token sent to an email or phone contact), "server" and "organization" (automatic signatures over URL contacts). Signers registered in your credit profile and the SCD signature are appended automatically.' externalId: type: string description: 'Unique external ID to prevent the creation of duplicate credit notes on unintended retries. Example: "my-internal-id-123456"' streetLine1: type: string description: Borrower main address street line. streetLine2: type: string description: Borrower complement address street line. district: type: string description: Borrower address district. city: type: string description: Borrower address city. stateCode: type: string description: 'Borrower address state code. Example: "SP".' zipCode: type: string description: 'Borrower address zip code. Example: "01310-100".' nominalAmount: type: integer description: 'Nominal amount in cents to be lent, before taxes. Provide either nominalAmount or amount. Example: 100000 (R$1,000.00).' amount: type: integer description: 'Net amount in cents to be disbursed to the borrower. Provide either nominalAmount or amount. Example: 100000 (R$1,000.00).' rebateAmount: type: string description: 'Amount in cents to be discounted from the disbursed amount. Example: 100 (R$1.00).' expiration: type: integer description: 'Time span, in seconds, counted from the scheduled datetime, for the contract to be signed before the credit note expires. Default: 604800 (7 days).' rules: type: array items: type: string description: 'List of rules modifying the credit note behavior, as {"key", "value"} objects. Currently available key: "invoiceCreationMode", with values "scheduled" (default), "instant" or "never".' tags: type: array items: type: string description: List of strings to tag the credit note for future queries. required: - templateId - name - taxId - scheduled - invoices - payment - paymentType - signers - externalId - streetLine1 - streetLine2 - district - city - stateCode - zipCode responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Credit Notes operationId: list-creditNote tags: - Credit Note description: List and filter all credit notes created in your workspace. Results are returned paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: 'Filter credit notes by the specified status. Options: "created", "signed", "processing", "success", "failed", "canceled", "expired".' required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. Max = 100. required: false schema: type: array items: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/credit-note/{id}': get: summary: Get a Credit Note operationId: get-creditNote-byId tags: - Credit Note description: Get a single credit note by its id. parameters: - name: id in: path description: Id of the credit note entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Credit Note operationId: delete-creditNote-byId tags: - Credit Note description: 'Cancel a credit note that has not reached a final status yet. Credit notes with status "created", "signed" or "processing" can be canceled, which also cancels the signing document. Credit notes with status "success", "failed", "expired" or already "canceled" are returned unchanged.' parameters: - name: id in: path description: Id of the credit note entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/credit-note/{id}/pdf': get: summary: Get a Credit Note PDF operationId: get-creditNote-byId-pdf tags: - Credit Note description: 'Get the CCB contract PDF file of a credit note. After all signers have signed, the returned file carries the digital signatures.' parameters: - name: id in: path description: Id of the credit note entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/credit-note/{id}/payment/pdf': get: summary: Get a Credit Note Payment PDF operationId: get-creditNote-byId-payment-pdf tags: - Credit Note description: 'Get the disbursement transfer receipt PDF file of a credit note. Only available for credit notes with status "success".' parameters: - name: id in: path description: Id of the credit note entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/credit-note/log: get: summary: List Credit Note Logs operationId: list-creditNote-log tags: - Credit Note description: 'Get a paged list of all credit note logs. A log tracks a change in the credit note entity according to its life cycle, as {"id", "type", "errors", "note", "created"} objects.' parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: noteIds in: query description: List of credit note ids linked to the desired logs. Max = 100. required: false schema: type: array items: type: string - name: types in: query description: 'Filter logs by log type. Options: "created", "signing", "signed", "sending", "sent", "success", "failed", "refunded", "canceled", "expired", "updated", "registered".' required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/credit-note/log/{id}': get: summary: Get a Credit Note Log operationId: get-creditNote-log-byId tags: - Credit Note description: Get a single credit note log by its id. parameters: - name: id in: path description: Id of the credit note log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/credit-signer/{id}': patch: summary: Update a Credit Signer operationId: update-creditSigner-byId tags: - Credit Signer description: 'Update the delivery state of a credit signer''s signing token or link. Setting "isSent" to false marks it as not delivered, causing it to be sent again to the signer''s contact. Use it when a signer misses the original email or SMS.' requestBody: required: true content: application/json: schema: type: object properties: isSent: type: string description: Delivery state of the signing token or link. Set to false to trigger a new delivery. required: - isSent parameters: - name: id in: path description: 'Id of the credit signer entity, as returned in the "signers" field of the CreditNote object.' required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/credit-preview: post: summary: Create Credit Previews operationId: create-creditPreview tags: - Credit Preview description: | Create credit previews to simulate credit notes before actually creating them. You can create up to 100 previews in a single request. For the "sac" and "price" types, provide exactly one of "count" or "initialAmount" - the other one is computed. For all types except "custom", provide exactly one of "nominalAmount" or "amount". requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: 'Type of the credit preview. Options: "credit-note".' credit: type: string description: | CreditNotePreview object with the simulation parameters. Required fields by credit type: "sac" and "price" take "nominalInterest", "scheduled", "initialDue", "taxId" and one of "count" or "initialAmount"; "american" takes "nominalInterest", "scheduled", "initialDue", "count" and "taxId"; "bullet" takes "nominalInterest", "scheduled", "initialDue" and "taxId"; "custom" takes "scheduled", "taxId" and "invoices". Optional fields: "nominalAmount" or "amount" (one of them is required except for "custom" with amounts in the invoices), "rebateAmount" and "interval". required: - type - credit responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/credit-holmes: post: summary: Create Credit Holmes operationId: create-creditHolmes tags: - Credit Holmes description: | Create credit holmes requests to analyze the credit profile of a tax ID. You can create up to 100 requests in a single call. requestBody: required: true content: application/json: schema: type: object properties: taxId: type: string description: 'CPF (11 digits) or CNPJ (14 digits) of the entity to analyze. Example: "012.345.678-90"' competence: type: string description: 'Month and year of analysis in YYYY-MM format. Defaults to the current month. Example: "2022-06"' tags: type: array items: type: string description: List of strings to tag the entity for future queries. required: - taxId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Credit Holmes operationId: list-creditHolmes tags: - Credit Holmes description: List and filter all credit holmes requests in your workspace. Results are returned paged. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter credit holmes by the specified status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/credit-holmes/{id}': get: summary: Get a Credit Holmes operationId: get-creditHolmes-byId tags: - Credit Holmes description: Get a single credit holmes by its id. parameters: - name: id in: path description: Id of the credit holmes entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/credit-holmes/log: get: summary: List Credit Holmes Logs operationId: list-creditHolmes-log tags: - Credit Holmes description: Get a paged list of all credit holmes logs. A log tracks a change in the credit holmes entity according to its life cycle. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: ids in: query description: List of credit holmes ids linked to the desired logs. required: false schema: type: array items: type: string - name: types in: query description: Filter logs by log type. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/credit-holmes/log/{id}': get: summary: Get a Credit Holmes Log operationId: get-creditHolmes-log-byId tags: - Credit Holmes description: Get a single credit holmes log by its id. parameters: - name: id in: path description: Id of the credit holmes log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/ledger: post: summary: Create Ledgers operationId: create-ledger tags: - Ledger description: Use this route to create up to 100 new ledgers at a time. requestBody: required: true content: application/json: schema: type: object properties: externalId: type: string description: Unique string to prevent duplicates. Repeated externalIds will cause failures. rules: type: array items: type: string description: List of rule objects to apply to the Ledger. tags: type: array items: type: string description: Array of strings to tag the entity for future queries. metadata: type: string description: Dictionary of additional information about the Ledger. required: - externalId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Ledgers operationId: list-ledger tags: - Ledger description: Get a list of ledgers in chunks of at most 100. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: externalIds in: query description: Filter by external IDs. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/ledger/{id}': get: summary: Get a Ledger operationId: get-ledger-byId tags: - Ledger description: Get a single ledger by its id. parameters: - name: id in: path description: Id of the ledger entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Ledger operationId: update-ledger-byId tags: - Ledger description: 'Update the rules, tags or metadata of an existing ledger.' requestBody: required: true content: application/json: schema: type: object properties: rules: type: array items: type: string description: New list of rule objects to apply to the Ledger. tags: type: array items: type: string description: New array of strings to tag the Ledger. metadata: type: string description: New dictionary of additional information about the Ledger. parameters: - name: id in: path description: Id of the ledger entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/ledger/log: get: summary: List Ledger Logs operationId: list-ledger-log tags: - Ledger description: Get a paged list of ledger logs. parameters: - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: ledgerId in: query description: Filter logs by ledger id. Only a single ledger id can be informed per query. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/ledger/log/{id}': get: summary: Get a Ledger Log operationId: get-ledger-log-byId tags: - Ledger description: Get a single ledger log by its id. parameters: - name: id in: path description: Id of the log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/ledger-transaction: post: summary: Create Ledger Transactions operationId: create-ledgerTransaction tags: - Ledger Transaction description: | Use this route to create up to 500 new ledger transactions at a time. A single request may contain transactions targeting different ledgers. Each transaction is applied to its Ledger in the order it is sent and the resulting balance is returned for each one. requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer description: 'Amount in cents of the Ledger Transaction. Example: 100 (R$1.00).' ledgerId: type: string description: Id of the Ledger associated with this transaction. externalId: type: string description: Unique string to prevent duplicates. Repeated externalIds within the same ledger will cause failures. source: type: string description: 'Source of the Ledger Transaction. Example: "bank-transfer/123".' fee: type: string description: Fee charged in cents for this Ledger Transaction. created: type: string description: 'Datetime of the Ledger Transaction, used to import an existing transaction history. Must be in ISO format (Example: "2022-01-01T00:00:00.000000+00:00") and cannot be in the future. When creating multiple transactions in a single request, their created datetimes must be informed in chronological order. If omitted, the current datetime is used.' rules: type: array items: type: string description: 'List of rule objects that momentarily overwrite the Ledger''s rules for this transaction.' tags: type: array items: type: string description: Array of strings to tag the entity for future queries. metadata: type: string description: Dictionary of additional information about the Ledger Transaction. required: - amount - ledgerId - externalId - source responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Ledger Transactions operationId: list-ledgerTransaction tags: - Ledger Transaction description: | Get a list of ledger transactions in chunks of at most 1000. Either "ledgerId" or "ids" must be provided. If both are sent, results are filtered by both. When filtering by "ids", the informed ids may reference transactions across different ledgers. parameters: - name: ledgerId in: query description: 'Id of the Ledger associated with the transactions. Either "ledgerId" or "ids" must be provided.' required: false schema: type: string - name: ids in: query description: 'List of strings to get specific entities by ids. The informed ids may belong to transactions in different ledgers. Either "ledgerId" or "ids" must be provided.' required: false schema: type: array items: type: string - name: flow in: query description: 'Direction of the Ledger Transaction. Options: "in" (credit), "out" (debit).' required: false schema: type: string - name: externalIds in: query description: Filter by external IDs. required: false schema: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 1000. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/ledger-transaction/{id}': get: summary: Get a Ledger Transaction operationId: get-ledgerTransaction-byId tags: - Ledger Transaction description: Get a single ledger transaction by its id. parameters: - name: id in: path description: Id of the ledger transaction entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/business-identity: post: summary: Create Business Identities operationId: create-businessIdentity tags: - Business Identity description: | Create one or more BusinessIdentities to start the Contract AI flow. Each entry is created in pending status. Save the returned id — you'll use it as identityId when uploading the Business Attachments and as the path parameter on subsequent calls. Validations: the CNPJ must be valid, must be active in the official bureau and must return non-empty representatives (sócios). requestBody: required: true content: application/json: schema: type: object properties: taxId: type: string description: 'CNPJ of the legal entity, with or without punctuation. Example: "20.018.183/0001-80".' tags: type: array items: type: string description: List of strings to tag the entity for future queries. required: - taxId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Business Identities operationId: list-businessIdentity tags: - Business Identity description: List and filter all business identities in your workspace. Results are returned paged via cursor. parameters: - name: after in: query description: 'Filter entities created after this date. Format: ISO 8601 or YYYY-MM-DD.' required: false schema: type: string format: date - name: before in: query description: 'Filter entities created before this date. Format: ISO 8601 or YYYY-MM-DD.' required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter identities by the specified status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: taxIds in: query description: List of CNPJs to filter the response by. required: false schema: type: array items: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/business-identity/{id}': get: summary: Get a Business Identity operationId: get-businessIdentity-byId tags: - Business Identity description: 'Get a single business identity by its id. When status=success, the response includes the populated rules string with the signing combinations extracted by the AI Model.' parameters: - name: id in: path description: Id of the business identity entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update a Business Identity operationId: update-businessIdentity-byId tags: - Business Identity description: | Send a business identity to processing or replace its tags. To trigger the AI Model analysis, set status=processing. The identity must be in created/pending status and must already have at least one Business Attachment associated with it. requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: Only processing is accepted. Triggers the AI Model analysis. tags: type: array items: type: string description: Replace the current list of tags. parameters: - name: id in: path description: Id of the business identity entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Business Identity operationId: delete-businessIdentity-byId tags: - Business Identity description: Cancel a business identity. Only identities in created or pending status can be canceled. parameters: - name: id in: path description: Id of the business identity entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/business-identity/log: get: summary: List Business Identity Logs operationId: list-businessIdentity-log tags: - Business Identity description: Get a paged list of all business identity logs. A log tracks a change in the business identity entity according to its lifecycle. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: identityIds in: query description: List of business identity ids linked to the desired logs. Max = 100. required: false schema: type: array items: type: string - name: types in: query description: 'Filter logs by log type. Options: "created", "updated", "processing", "canceled", "success", "failed".' required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/business-identity/log/{id}': get: summary: Get a Business Identity Log operationId: get-businessIdentity-log-byId tags: - Business Identity description: Get a single business identity log by its id. parameters: - name: id in: path description: Id of the business identity log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/business-attachment: post: summary: Upload a Business Attachment operationId: create-businessAttachment tags: - Business Attachment description: | Upload a single corporate document tied to a previously created Business Identity. Limit of 1 attachment per request and 2 attachments per identity. Validations: only PDF, JPG and PNG are accepted, ≤ 8 MB per attachment; the name must be unique among the identity's other created attachments; the identity must be in created/pending status and have fewer than 2 attachments. requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'File name. Must be unique among the identity''s other created attachments.' content: type: string description: 'File payload encoded as a base64 string (e.g., data:application/pdf;base64,...).' identityId: type: string description: Id of the Business Identity that owns the attachment. tags: type: array items: type: string description: List of strings to tag the entity for future queries. required: - name - content - identityId responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Business Attachments operationId: list-businessAttachment tags: - Business Attachment description: List and filter all business attachments in your workspace. Results are returned paged via cursor. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter attachments by status. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/business-attachment/{id}': get: summary: Get a Business Attachment operationId: get-businessAttachment-byId tags: - Business Attachment description: Get a single business attachment by its id. Pass expand=content to include the base64 file payload in the response. parameters: - name: id in: path description: Id of the business attachment entity. required: true schema: type: string - name: expand in: query description: 'List of fields to expand. Currently only content is supported — when present, the response includes the base64-encoded file payload.' required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel a Business Attachment operationId: delete-businessAttachment-byId tags: - Business Attachment description: Cancel a business attachment. Only attachments in created status can be canceled. parameters: - name: id in: path description: Id of the business attachment entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/business-attachment/log: get: summary: List Business Attachment Logs operationId: list-businessAttachment-log tags: - Business Attachment description: Get a paged list of all business attachment logs. A log tracks a change in the business attachment entity according to its lifecycle. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: attachmentIds in: query description: List of business attachment ids linked to the desired logs. Max = 100. required: false schema: type: array items: type: string - name: types in: query description: 'Filter logs by log type. Options: "created", "canceled", "approved", "denied".' required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/business-attachment/log/{id}': get: summary: Get a Business Attachment Log operationId: get-businessAttachment-log-byId tags: - Business Attachment description: Get a single business attachment log by its id. parameters: - name: id in: path description: Id of the business attachment log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/individual-identity: post: summary: Create Individual Identities operationId: create-individualIdentity tags: - Individual Identity description: | Create one or more Individual Identities. Each entry is returned in created status and already carries the validatorLink the holder will use to submit each proof. Validations: the workspace must have an Identity Profile; every value in proofs must be enabled on that profile. requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Full name of the holder being verified. email: type: string description: E-mail used to deliver the validatorLink when deliveryMethod = automatic. deliveryMethod: type: string description: 'How the validatorLink reaches the holder. Options: automatic, manual.' proofs: type: array items: type: string description: 'List of proof types to collect. Each item must be one of identity, biometric and must be enabled on your workspace''s Identity Profile.' taxId: type: string description: 'CPF of the holder, with or without punctuation. Example: "012.345.678-90".' phone: type: string description: 'Holder''s phone in international format. Example: "+5511987654321".' tags: type: array items: type: string description: List of strings to tag the entity for future queries. required: - name - email - deliveryMethod - proofs responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Individual Identities operationId: list-individualIdentity tags: - Individual Identity description: List and filter all individual identities in your workspace. Results are returned paged via cursor. parameters: - name: after in: query description: 'Filter entities created after this date. Format: ISO 8601 or YYYY-MM-DD.' required: false schema: type: string format: date - name: before in: query description: 'Filter entities created before this date. Format: ISO 8601 or YYYY-MM-DD.' required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: status in: query description: Filter identities by the specified status. required: false schema: type: string - name: ids in: query description: List of strings to get specific entities by ids. required: false schema: type: array items: type: string - name: taxIds in: query description: List of CPFs to filter the response by. required: false schema: type: array items: type: string - name: email in: query description: Filter identities by holder e-mail. required: false schema: type: string - name: tags in: query description: Filter entities that contain the specified tags. required: false schema: type: array items: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/individual-identity/{id}': get: summary: Get an Individual Identity operationId: get-individualIdentity-byId tags: - Individual Identity description: Get a single individual identity by its id. parameters: - name: id in: path description: Id of the individual identity entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update an Individual Identity operationId: update-individualIdentity-byId tags: - Individual Identity description: Update the taxId of an individual identity after it has been created. Useful when the CPF is unknown at creation time and is only collected during the proof submission flow. requestBody: required: true content: application/json: schema: type: object properties: taxId: type: string description: 'CPF to assign to the identity, with or without punctuation.' parameters: - name: id in: path description: Id of the individual identity entity. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Cancel an Individual Identity operationId: delete-individualIdentity-byId tags: - Individual Identity description: 'Cancel an individual identity (soft delete). The identity transitions to failed, every pending proof is canceled and a canceled log is delivered through the webhook. Only identities in created or pending status can be canceled.' parameters: - name: id in: path description: Id of the individual identity entity. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/individual-identity/log: get: summary: List Individual Identity Logs operationId: list-individualIdentity-log tags: - Individual Identity description: Get a paged list of all individual identity logs. A log tracks a change in the individual identity entity according to its lifecycle. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: identityIds in: query description: List of individual identity ids linked to the desired logs. Max = 100. required: false schema: type: array items: type: string - name: types in: query description: 'Filter logs by log type. Options: "created", "processing", "pending", "updated", "success", "failed", "canceled", "expired".' required: false schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/individual-identity/log/{id}': get: summary: Get an Individual Identity Log operationId: get-individualIdentity-log-byId tags: - Individual Identity description: Get a single individual identity log by its id. parameters: - name: id in: path description: Id of the individual identity log entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/individual-identity-proof: get: summary: List Individual Identity Proofs operationId: list-individualIdentityProof tags: - Individual Identity Proof description: List the proofs tied to an Individual Identity. The identityId query parameter is required. parameters: - name: identityId in: query description: Id of the parent individual identity whose proofs you want to list. required: true schema: type: string - name: status in: query description: Filter proofs by status. required: false schema: type: string - name: proofType in: query description: 'Filter proofs by proofType. Options: identity, biometric.' required: false schema: type: string - name: ids in: query description: List of strings to get specific proofs by ids. required: false schema: type: array items: type: string - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. required: false schema: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/individual-identity-proof/{id}': get: summary: Get an Individual Identity Proof operationId: get-individualIdentityProof-byId tags: - Individual Identity Proof description: Get a single individual identity proof by its id. parameters: - name: id in: path description: Id of the individual identity proof entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Submit an Individual Identity Proof operationId: update-individualIdentityProof-byId tags: - Individual Identity Proof description: | Submit the content of a proof. This is the step in which the holder's document or biometric is uploaded for validation. biometric — content is a base64 image string with the facial selfie. identity — content is a JSON-serialised string carrying the provider's documentId and/or the document file (base64 image). After a successful PATCH the proof transitions from pending to processing and the provider validates it asynchronously. requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: 'Content of the proof, encoded according to the proofType.' required: - content parameters: - name: id in: path description: Id of the individual identity proof being submitted. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/individual-holmes/{searchKey}/{type}': get: summary: Query an Individual Bureau operationId: get--individualHolmes-bySearchKey-byType tags: - Individual Holmes description: | Path params identify what to look up. The searchKey is a CPF (11 digits, masked or unmasked) for every bureau except internationalPep, where it is the person's full name. The type selects the bureau and the shape of the response. Query params control paging. Only civil and criminal (JusBrasil) honour cursor — repeat the request with the returned cursor to fetch the next page. parameters: - name: searchKey in: path description: 'CPF of the individual being investigated, masked or unmasked. Example: 012.345.678-90. For the internationalPep bureau, send the person''s full name instead.' required: true schema: type: string - name: type in: path description: 'Bureau to query. Options: civil, criminal, frauds, data, dict, kyc, nationalPep, internationalPep, jointResolution6, csnu, federalRevenueRegistry, deceased, negativeMedia.' required: true schema: type: string - name: limit in: query description: Maximum number of items per page for paginated bureaus. Integer in the 1..100 range. Defaults to 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: Opaque page token returned by the previous call. Only meaningful for civil and criminal; ignored by every other bureau. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/business-holmes/{taxId}/{type}': get: summary: Query a Business Bureau operationId: get--businessHolmes-byTaxId-byType tags: - Business Holmes description: | Path params identify what to look up. The taxId is the company's CNPJ (14 digits, masked or unmasked); the type selects the bureau and the shape of the response. Query params control paging. Only civil and criminal (JusBrasil) honour cursor — repeat the request with the returned cursor to fetch the next page. parameters: - name: taxId in: path description: 'CNPJ of the company being investigated, masked or unmasked. Example: 20.018.183/0001-80.' required: true schema: type: string - name: type in: path description: 'Bureau to query. Options: civil, criminal, kyc, frauds, data, dict, jointResolution6, federalRevenueRegistry, negativeMedia, qsa.' required: true schema: type: string - name: limit in: query description: Maximum number of items per page for paginated bureaus. Integer in the 1..100 range. Defaults to 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: cursor in: query description: Opaque page token returned by the previous call. Only meaningful for civil and criminal; ignored by every other bureau. required: false schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/webhook: post: summary: Create a Webhook operationId: create-webhook tags: - Webhook description: | Register a new webhook URL. The subscriptions refer to which kinds of logs will be sent to the webhook URL being registered. Available subscriptions: pix-request, pix-reversal, pix-pull-subscription, pix-pull-request, pix-internal-transaction-report, pix-key, pix-key-holmes, pix-claim, pix-infraction, pix-chargeback, pix-dispute, issuing-card, issuing-holder, issuing-purchase, issuing-invoice, credit-note or credit-holmes requestBody: required: true content: application/json: schema: type: object properties: url: type: string description: The server URL that will receive the Webhook Events. subscriptions: type: array items: type: string description: 'Array of subscriptions. Possible values: "pix-request", "pix-reversal", "pix-pull-subscription", "pix-pull-request", "pix-internal-transaction-report", "pix-key", "pix-key-holmes", "pix-claim", "pix-infraction", "pix-chargeback", "pix-dispute", "issuing-card", "issuing-holder", "issuing-purchase", "issuing-invoice", "credit-note" or "credit-holmes"' required: - url - subscriptions responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' get: summary: List Webhooks operationId: list-webhook tags: - Webhook description: 'Get a list of non-deleted webhooks in chunks of at most 100. If you need smaller chunks, use the limit parameter.' parameters: - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: limit in: query description: Maximum number of Webhooks to be retrieved. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/webhook/{id}': get: summary: Get a Webhook operationId: get-webhook-byId tags: - Webhook description: Get a single Webhook by its id. parameters: - name: id in: path description: Id of the webhook entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Delete a Webhook operationId: delete-webhook-byId tags: - Webhook description: | Delete a single Webhook subscription. NOTE: This action cannot be undone. parameters: - name: id in: path description: Id of the Webhook to be deleted. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/event: get: summary: List Events operationId: list-event tags: - Event description: 'Get a list of non-deleted events in chunks of at most 100. If you need smaller chunks, use the limit parameter.' parameters: - name: after in: query description: 'Date filter for Events created only after a specific date. Example: "2022-01-20"' required: false schema: type: string format: date - name: before in: query description: 'Date filter for Events created only before a specific date. Example: "2022-02-20"' required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: isDelivered in: query description: 'If false, only gets Events that haven''t been delivered. If true, only gets Events that have already been delivered.' required: false schema: type: string - name: limit in: query description: Maximum number of Events to be retrieved. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/event/{id}': get: summary: Get an Event operationId: get-event-byId tags: - Event description: Get a single Event by its id. parameters: - name: id in: path description: Unique id of the event entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' delete: summary: Delete an Event operationId: delete-event-byId tags: - Event description: | Delete a single Event from the event list. Note: This action cannot be undone. parameters: - name: id in: path description: Id of the Event entity to be deleted. required: true schema: type: string responses: '200': description: Successfully deleted content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' patch: summary: Update an Event operationId: update-event-byId tags: - Event 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.' requestBody: required: true content: application/json: schema: type: object properties: isDelivered: type: string description: 'Bool signaling if the Event has or hasn''t been successfully delivered.' required: - isDelivered parameters: - name: id in: path description: 'Id of the event entity. Example: "5719405850615809"' required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' /v2/event/attempt: get: summary: List failed Webhook Event delivery attempts operationId: list-event-attempt tags: - Event Attempt description: Get information on failed webhook event delivery attempts. parameters: - name: after in: query description: Filter entities created after this date. required: false schema: type: string format: date - name: before in: query description: Filter entities created before this date. required: false schema: type: string format: date - name: cursor in: query description: String used to get the next batch of results. Our SDKs handle this for you. required: false schema: type: string - name: eventIds in: query description: 'List of Event ids to filter attempts. Example: ["5656565656565656", "4545454545454545"]' required: false schema: type: array items: type: string - name: limit in: query description: Number of results per cursor. Max = 100. required: false schema: type: integer minimum: 1 maximum: 100 - name: webhookIds in: query description: 'List of Webhook ids to filter attempts. Example: ["5656565656565656", "4545454545454545"]' required: false schema: type: array items: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' '/v2/event/attempt/{id}': get: summary: Get an Event Attempt operationId: get-event-attempt-byId tags: - Event Attempt description: Get a single event attempt by its id. parameters: - name: id in: path description: Unique id of the event attempt entity. required: true schema: type: string - name: fields in: query description: List of strings to filter response JSON keys. Not available in the SDKs. required: false schema: type: array items: type: string responses: '200': description: Successful operation content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Errors' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Errors' tags: - name: Pix Request description: | A Pix Request represents an inbound or outbound Pix payment in the Brazilian instant payment system. Here we will show you how to create and manage them. - name: Pix Reversal description: | A Pix Reversal allows you to reverse a previously made Pix transfer, sending the funds back to the original sender. Here we will show you how to create and manage them. - name: Pix Internal Transaction Report description: | A Pix Internal Transaction Report lets Direct and Indirect participants report transactions that were settled internally on the participant, such as transfers between two Indirect participants of the same Direct participant or between accounts of the same participant. Here we will show you how to create and manage them. - name: Static Brcode description: | A Static Brcode is a QR Code that can receive multiple Pix payments with a fixed or open amount. Here we will show you how to create and manage them. - name: Dynamic Brcode description: | A Dynamic Brcode is a QR Code that returns payment details dynamically from your server when scanned. The "subscription", "subscriptionAndInstant" and "dueAndOrSubscription" types let a Dynamic Brcode initiate a Pix Automático recurring authorization. Here we will show you how to create and manage them. - name: Brcode Preview description: | A Brcode Preview allows you to fetch the information encoded in a QR code before initiating a Pix payment or accepting a Pix Subscription. Here we will show you how to retrieve Brcode previews. - name: Pix Pull Subscription description: | A Pix Pull Subscription is a recurring authorization (Pix Automático) that lets a receiver pull Pix payments from a payer's account on a defined schedule. Here we will show you how to create and manage them. - name: Pix Pull Request description: | A Pix Pull Request is a single charge issued against an active Pix Pull Subscription (Pix Automático), pulling a payment from the payer's account. Here we will show you how to create and manage them. - name: Pix Key description: | A Pix Key is an alias that can be used to identify a bank account in the Brazilian Pix system (DICT). Here we will show you how to create and manage them. - name: Pix Key Holmes description: | PixKeyHolmes are used by a Pix participant to verify whether a Pix key is registered in DICT, the Brazilian Central Bank's key directory. Here we will show you how to create and manage them. - name: Pix Claim description: | A Pix Claim is used to port or own a Pix key from another institution to your workspace. Here we will show you how to create and manage them. - name: Pix Infraction description: | A Pix Infraction is used to respond to Pix fraud and operational issues to the Brazilian Central Bank. Here we will show you how to manage them. - name: Pix Chargeback description: | A Pix Chargeback allows you to request the return of funds from a Pix transaction made in error or due to fraud, and to respond to chargebacks opened against your transactions, through MED. Here we will show you how to create and manage them. - name: Pix Fraud description: | A Pix Fraud report allows you to flag suspicious users or keys in the Brazilian Pix system (DICT). Here we will show you how to create and manage them. - name: Pix Dispute description: | A Pix Dispute allows you to request, cancel and consult disputes related to Pix transactions through MED 2.0. Here we will show you how to create and manage them. - name: Pix User description: | The Pix User resource lets you consult, through DICT, an end user's statistics on Pix keys, Pix requests, frauds and infractions registered across Bacen's systems (e.g. SPI for Pix requests). Here we will show you how to retrieve user data. - name: Pix Balance description: | The Pix Balance represents the current available balance in your Pix account. Here we will show you how to retrieve it. - name: Pix Domain description: | Pix Domains are the domains Pix participants register with Bacen to provide Brcodes, along with their respective certificate chains used for secure communication. Here we will show you how to list them. - name: Pix Statement description: | A Pix Statement allows you to request a detailed report of all Pix transactions in your account for a given period. Here we will show you how to create and manage them. - name: Pix Director description: | The Pix Director represents the responsible officer for Pix operations in your institution, as required by the Brazilian Central Bank. Here we will show you how to register them. - name: Issuing Balance description: | The Issuing Balance resource represents the total funds available in your issuing wallet. This balance is separate from your main Stark Infra balance and is used exclusively for card spending. Fund your issuing balance using Issuing Invoices and withdraw using Issuing Withdrawals. - name: Issuing Product description: | The Issuing Product resource lists the card products available to your workspace. Each product has a network, funding type, holder type, and product code that define the characteristics of cards that can be created using that product. - name: Issuing Holder description: | The Issuing Holder resource represents the card holder entity in your workspace. A holder is associated with one or more issuing cards and defines who can use the cards issued. You can set rules on the holder level to control spending limits and merchant restrictions. - name: Issuing Card description: | The Issuing Card resource represents a physical or virtual card issued to a holder. Cards can be created as virtual (immediately available) or physical (requires embossing and shipping). You can set rules on the card level to control spending limits, merchant restrictions, and other card behaviors. - name: Issuing Design description: | The Issuing Design resource represents the visual design of a physical card. Designs define the artwork, fonts, and layout used when embossing and printing cards. You can retrieve available designs and download their PDF templates. - name: Issuing Embossing Kit description: | The Issuing Embossing Kit resource represents a kit used for embossing physical cards. Each kit defines the card design and packaging used during the card personalization process. - name: Issuing Stock description: | The Issuing Stock resource tracks the inventory of physical card blanks available for embossing. Each stock entry is associated with a specific card design and holder type. Monitor your stock levels to ensure cards are available when needed. - name: Issuing Stock Rule description: | The Issuing Stock Rule resource lets you register low-balance alerts for your card stocks. When the available count of an issuing stock falls below the configured minimum balance, the registered emails and phones are notified. Each issuing stock can have only one active rule at a time. - name: Issuing Restock description: | The Issuing Restock resource is used to request additional card blanks when your stock is running low. Each restock request specifies the quantity needed and the stock to replenish. Monitor the status of your restock requests through the log endpoints. - name: Issuing Embossing Request description: | The Issuing Embossing Request resource is used to initiate the personalization and delivery of a physical card. Each request specifies the card, kit, display name, and shipping address for card delivery. Track the embossing and shipping status through the log endpoints. - name: Issuing Token description: | The Issuing Token resource represents a tokenized version of a card stored in a digital wallet. Tokens allow cardholders to make purchases using digital wallets without exposing the actual card number. You can manage token status and monitor token activity through the log endpoints. - name: Issuing Token Request description: | The Issuing Token Request resource is used to initiate the tokenization of a card for digital wallets. When a cardholder attempts to add a card to a digital wallet (e.g., Apple Pay, Google Pay), a token request is generated. Process the token request to approve or decline the card tokenization. - name: Issuing Token Design description: | The Issuing Token Design resource represents the visual design used to display a tokenized card in a digital wallet. Designs include the card artwork shown in the wallet app. You can retrieve available token designs and download their PDF files. - name: Issuing Invoice description: | The Issuing Invoice resource is used to add funds to your issuing balance. Generate a Pix invoice (brcode) to receive deposits directly into your issuing wallet. Once paid, the funds become available in your issuing balance for card spending. - name: Issuing Billing Invoice description: | The Issuing Billing Invoice resource represents the invoice that settles the postpaid usage of your issuing operation in a billing period. Each invoice consolidates the purchases and withdrawals settled in the billing period and can be paid via its brcode or link. Fine and interest are applied when the invoice is paid after the due date. - name: Issuing Billing Transaction description: | The Issuing Billing Transaction resource represents an entry that composes an issuing billing invoice. Each purchase or withdrawal settled in a billing period generates billing transactions, including the installments of installment purchases. - name: Issuing Purchase description: | The Issuing Purchase resource represents a purchase transaction made with an issuing card. Purchases are created when a cardholder makes a payment at a merchant using an issued card. You can list, retrieve, and update purchases, as well as monitor purchase events through the log endpoints. - name: Issuing Preview Installment description: | The Issuing Preview Installment resource represents an upcoming installment of an installment purchase that has not been billed yet. Use it to preview the amounts that will compose your future issuing billing invoices. - name: Issuing Transaction description: | The Issuing Transaction resource represents a change in your issuing balance. Each purchase, invoice payment, withdrawal, or fee generates an issuing transaction. Use transactions to reconcile your issuing balance and understand fund movements. - name: Issuing Withdrawal description: | The Issuing Withdrawal resource is used to transfer funds from your issuing balance back to your main balance. Use withdrawals to move excess funds from your issuing wallet to your regular Stark Infra account. - name: Credit Note description: | Credit Notes represent credit operations issued to individuals or businesses as Bank Credit Bills (Cédula de Crédito Bancário - CCB). They carry all the information needed to formalize a lending operation, including signers, installment invoices and the disbursement payment details. Once created, the credit note generates a contract that must be digitally signed by all signers. After signing, the disbursement is transferred via Pix to the borrower's account and each installment is tracked through invoices. Here we will show you how to create and manage them. - name: Credit Signer description: | Credit Signers represent every person or entity that must sign the CCB contract of a Credit Note. Signers are created together with the Credit Note, through its "signers" parameter, and are returned embedded in the CreditNote object. Signers registered in your credit profile and the SCD signature are appended automatically. When the method is "link" or "token", the signer receives the signing link or token on the registered contact (email or phone). If a signer misses it, you can trigger a new delivery. - name: Credit Preview description: | CreditPreviews are used to preview a credit operation before creating it. You can simulate the installment schedule, the IOF tax amount, the disbursed amount and the effective interest rates of a Credit Note without persisting anything. Previews are computed on the fly and are not saved. - name: Credit Holmes description: | CreditHolmes are used to request the credit analysis of a tax ID. The analysis retrieves credit information from official sources for a given CPF or CNPJ, helping you evaluate the creditworthiness of a borrower. - name: Ledger description: | The Ledger resource is used to track the balance of a given amount by inserting LedgerTransactions to it. A Ledger can represent a bank account, a digital wallet, an inventory product, or any other entity whose balance you need to keep track of. You can attach rules to a Ledger to limit its balance, such as a minimum or maximum balance, which are validated whenever a LedgerTransaction is created. - name: Ledger Transaction description: | The LedgerTransaction resource is used to move balance in or out of a Ledger. Each transaction carries an amount that is added to (or subtracted from) the Ledger balance, producing a new running balance that is returned in the response. Transactions are validated against the rules of their Ledger, so a transaction that would push the balance beyond a configured minimum or maximum balance is rejected. - name: Business Identity description: | BusinessIdentities validate the identity of a legal entity (CNPJ) and feed its corporate documents into the Contract AI model. After creating an identity, upload one or more Business Attachments referencing the returned id and PATCH the identity to processing. The structured signing rules extracted by the AI Model are delivered through the business-identity webhook when the identity reaches success. - name: Business Attachment description: | BusinessAttachments are corporate documents (articles of incorporation, amendments, board minutes) uploaded against a Business Identity. Each Business Identity accepts up to two attachments. The attachment goes through OCR and document validation; once both attachments are approved, the parent identity can be sent to processing to run the AI Model analysis. - name: Individual Identity description: | Individual Identities run an end-to-end identity verification on a Brazilian individual. Each entry wraps the proofs (document and/or facial biometrics) the holder must submit; Stark Infra orchestrates the collection, validates each proof and delivers the result through the individual-identity webhook subscription. Identities are created in created status and are walked through processing, pending and finally success or failed by private workers. Every transition produces an Individual Identity Log. - name: Individual Identity Proof description: | Each Individual Identity Proof represents one piece of evidence required by the parent Individual Identity. One proof is generated per proofType requested at creation; the holder submits the content via PATCH /v2/individual-identity-proof/:id. Proofs go through their own lifecycle (pending → processing → success / failed / canceled / expired). The parent identity transitions to success only when every proof reaches success. - name: Individual Holmes description: | Individual Holmes queries an external bureau or one of Stark Infra's internal datasets to investigate an individual (CPF). Each request targets a single bureau through the type path parameter and returns that bureau's payload under a key named after the type queried. Use Individual Holmes to run KYC, anti-fraud, judicial, sanctions and federal-revenue checks on a person before onboarding, granting credit or releasing a high-risk operation. Every call is synchronous, scoped to your workspace and logged on Stark Infra's side — there is no resource lifecycle to track. - name: Business Holmes description: | Business Holmes queries an external bureau or one of Stark Infra's internal datasets to investigate a legal entity (CNPJ). Each request targets a single bureau through the type path parameter and returns that bureau's payload under a key named after the type queried. Use Business Holmes to run KYB, judicial, anti-fraud, sanctions, QSA (corporate structure) and federal-revenue checks on a company before onboarding it, granting credit or releasing a high-risk operation. Every call is synchronous, scoped to your workspace and logged on Stark Infra's side — there is no resource lifecycle to track. - name: Webhook description: | You can create webhook subscriptions to receive events whenever a new log is created. We send the event by making a POST request to your endpoint URL. The event will be delivered with a digital signature (headers["Digital-Signature"]), which can be verified using the Stark Infra public key. If 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. NOTE 1: Registered webhooks will only work for services used in that same version. NOTE 2: Even if you use Webhook, we strongly recommend that you create a daily task to get all undelivered events and set them as delivered. It's important to add redundancy and resilience to your system. - name: Event 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. NOTE: All the events have a log property containing an entity log. The nature of the log, however, may change according to the subscription that triggered the event. For example, if the subscription is credit-note, the log in the event will be a CreditNoteLog. - name: Event Attempt description: 'When an Event delivery fails, an event attempt will be registered. It carries information meant to help you debug event reception issues.' x-tagGroups: - name: Pix tags: - Pix Request - Pix Reversal - Pix Internal Transaction Report - Static Brcode - Dynamic Brcode - Brcode Preview - Pix Pull Subscription - Pix Pull Request - Pix Key - Pix Key Holmes - Pix Claim - Pix Infraction - Pix Chargeback - Pix Fraud - Pix Dispute - Pix User - Pix Balance - Pix Domain - Pix Statement - Pix Director - name: Issuing tags: - Issuing Balance - Issuing Product - Issuing Holder - Issuing Card - Issuing Design - Issuing Embossing Kit - Issuing Stock - Issuing Stock Rule - Issuing Restock - Issuing Embossing Request - Issuing Token - Issuing Token Request - Issuing Token Design - Issuing Invoice - Issuing Billing Invoice - Issuing Billing Transaction - Issuing Purchase - Issuing Preview Installment - Issuing Transaction - Issuing Withdrawal - name: Lending tags: - Credit Note - Credit Signer - Credit Preview - Credit Holmes - name: Ledger tags: - Ledger - Ledger Transaction - name: Identity tags: - Business Identity - Business Attachment - Individual Identity - Individual Identity Proof - Individual Holmes - Business Holmes - name: Others tags: - Webhook - Event - Event Attempt components: schemas: Error: type: object properties: code: type: string description: Error code string message: type: string description: Human-readable error message Errors: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' securitySchemes: digitalSignature: type: apiKey name: Digital-Signature in: header description: ECDSA digital signature for request authentication security: - digitalSignature: []