Brite Payments Transaction API

openapi: 3.2.0
info:
  title: Brite Payments Transaction API
  version: '2026-10-15'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-15: 8 operation(s) read from 9 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Brite Payments has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 3
    pages-with-code: 7
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-15'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.britepayments.com/checkout-ux-guidelines/automated-asset-deliver
  - https://docs.britepayments.com/technical-documentation/authentication
  - https://docs.britepayments.com/technical-documentation/integrate-instant-payments
  - https://docs.britepayments.com/technical-documentation/integrate-instant-payouts
  - https://docs.britepayments.com/technical-documentation/integrate-brite-play
  - https://docs.britepayments.com/technical-documentation/integrate-data-solutions
  - https://docs.britepayments.com/technical-documentation/integrate-callback-handling
  - https://docs.britepayments.com/technical-documentation/integrate-ideal
  - https://docs.britepayments.com/technical-documentation/integrate-swish
servers:
- url: https://sandbox.britepaymentgroup.com
security:
- bearer: []
tags:
- name: Transaction
paths:
  /transaction.create_withdrawal:
    post:
      operationId: post_transaction_create_withdrawal
      tags:
      - Transaction
      summary: 'Step 3: Initiate a Payout'
      x-source: https://docs.britepayments.com/technical-documentation/integrate-instant-payouts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTransactionCreateWithdrawalRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTransactionCreateWithdrawalResponse'
      x-evidence:
        kind: documentation
  /transaction.get:
    post:
      operationId: post_transaction_get
      tags:
      - Transaction
      summary: Fetch transaction details to obtain a bank_account_id
      x-source: https://docs.britepayments.com/technical-documentation/integrate-instant-payouts
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostTransactionCreateWithdrawalResponse:
      type: object
      properties:
        id:
          type: string
          description: The id of the payout transaction
        eta:
          type: integer
          description: Estimated time of arrival
    PostTransactionCreateWithdrawalRequest:
      type: object
      properties:
        amount:
          type: string
        bank_account_id:
          type: string
        merchant_reference:
          type: string
        statement_reference:
          type: string
        callbacks:
          type: array
          description: Array of callback objects with url and transaction_state
      required:
      - amount
      - bank_account_id
      - merchant_reference
  securitySchemes:
    bearer:
      type: http
      scheme: bearer