Stark Bank Darf Payment API

openapi: 3.1.0
info:
  title: Stark Bank Balance Darf Payment 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 Bank Developers
    email: help@starkbank.com
    url: https://starkbank.com
  license:
    name: Stark Bank License
servers:
- url: https://api.starkbank.com
  description: Production
- url: https://sandbox.api.starkbank.com
  description: Sandbox
security:
- digitalSignature: []
tags:
- name: Darf Payment
  description: Here we will explain how to manually pay DARFs without bar codes.
paths:
  /v2/darf-payment:
    post:
      summary: Create Darf payments
      operationId: create-darfPayment
      tags:
      - Darf Payment
      description: Use this route to pay Darfs using the available balance in your Stark Bank account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                competence:
                  type: string
                  description: 'Competence month of the service. Example: ''2020-03-10'''
                description:
                  type: string
                  description: 'Text to be displayed in your statement (min. 10 characters). Example: "payment ABC"'
                due:
                  type: string
                  format: date-time
                  description: 'Due date for payment. Example: ''2020-03-10'''
                fineAmount:
                  type: integer
                  description: 'Fixed amount due in cents for fines. Example: 234 (= R$ 2.34)'
                interestAmount:
                  type: integer
                  description: 'Amount due in cents for interest. Example: 456 (= R$ 4.56)'
                nominalAmount:
                  type: integer
                  description: 'Amount due in cents without fee or interest. Example: 23456 (= R$ 234.56)'
                revenueCode:
                  type: string
                  description: '4-digit tax code assigned by Federal Revenue. Example: "5948"'
                taxId:
                  type: string
                  description: 'Payer CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). Example: 012.345.678-90'
                referenceNumber:
                  type: string
                  description: 'Number assigned to the region of the tax. Example: "08.1.17.00-4"'
                scheduled:
                  type: string
                  format: date-time
                  description: Schedule the payment for a specific date. Default value is the current day.
                tags:
                  type: array
                  items:
                    type: string
                  description: Array of strings to tag the entity for future queries. All tags will be converted to lowercase.
              required:
              - competence
              - description
              - due
              - fineAmount
              - interestAmount
              - nominalAmount
              - revenueCode
              - 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 Darf Payments
      operationId: list-darfPayment
      tags:
      - Darf Payment
      description: Get a list of non-deleted Darf payments in chunks of at most 100. If you need smaller chunks, use the limit parameter.
      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: 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 Darfs 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/darf-payment/{id}:
    get:
      summary: Get a Darf Payment
      operationId: get-darfPayment-byId
      tags:
      - Darf Payment
      description: Get a single Darf payment by its id.
      parameters:
      - name: id
        in: path
        description: Id of the Darf payment 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 Darf Payment
      operationId: delete-darfPayment-byId
      tags:
      - Darf Payment
      description: 'Cancel a scheduled Darf payment. You can only cancel Darf payments before they start being processed.

        NOTE:Payments that have already been processed can be deleted, but not cancelled.

        '
      parameters:
      - name: id
        in: path
        description: Id of the Darf payment 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/darf-payment/{id}/pdf:
    get:
      summary: Get a Darf Payment PDF
      operationId: get-darfPayment-byId-pdf
      tags:
      - Darf Payment
      description: Get a Darf payment PDF receipt. You can only get a receipt for payments whose status are either success, processing or created.
      parameters:
      - name: id
        in: path
        description: Id of the Darf payment 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/darf-payment/log:
    get:
      summary: List Darf Payment Logs
      operationId: list-darfPayment-log
      tags:
      - Darf Payment
      description: Get a paged list of all Darf payment logs. A log tracks a change in the payment 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: paymentIds
        in: query
        description: Array of payment ids linked to the desired logs.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: types
        in: query
        description: Filters 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/darf-payment/log/{id}:
    get:
      summary: Get a Darf Payment Log
      operationId: get-darfPayment-log-byId
      tags:
      - Darf Payment
      description: Get a single Darf payment 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'
components:
  schemas:
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        code:
          type: string
          description: Error code string
        message:
          type: string
          description: Human-readable error message
  securitySchemes:
    digitalSignature:
      type: apiKey
      name: Digital-Signature
      in: header
      description: ECDSA digital signature for request authentication
externalDocs:
  url: https://docs.starkbank.com/api
  description: Stark Bank API documentation
x-tagGroups:
- name: Business Account
  tags:
  - Workspace
  - Balance
  - Transaction
- name: Cash Receivables
  tags:
  - Invoice
  - Dynamic Brcode
  - Deposit
  - Boleto
  - Boleto Holmes
  - Split
  - Split Receiver
  - Split Profile
- name: Cash Subscription
  tags:
  - Invoice Pull Subscription
  - Invoice Pull Request
- name: Card Receivables
  tags:
  - Merchant Session
  - Merchant Purchase
  - Merchant Card
  - Merchant Installment
- name: Bill Payments
  tags:
  - Transfer
  - Brcode Payment
  - Boleto Payment
  - Utility Payment
  - Tax Payment
  - Darf Payment
  - Payment Preview
  - Payment Request
- name: Others
  tags:
  - Webhook
  - Event
  - Event Attempt
  - Pix Key
  - Institutions
  - Public Key