Billease Trx API

openapi: 3.2.0
info:
  title: Billease Trx API
  version: '2026-09-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-09-28: 10 operation(s) read from 10 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Billease has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 9
    pages-with-code: 1
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-09-28'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.billease.ph/api-trx
  - https://docs.billease.ph/api-callback
  - https://docs.billease.ph/api-products
  - https://docs.billease.ph/integration/api-specification
  - https://docs.billease.ph/redocusaurus/plugin-redoc-0.yaml
  - https://docs.billease.ph/redocusaurus/plugin-redoc-1.yaml
  - https://docs.billease.ph/redocusaurus/plugin-redoc-2.yaml
  - https://docs.billease.ph/integration/deals/intro
  - https://docs.billease.ph/integration/deals/product-sync
  - https://docs.billease.ph/integration/deals/transaction-orders
servers:
- url: https://trx-test.billease.ph
security:
- bearer: []
tags:
- name: Trx
paths:
  /trx/refund/{refundId}:
    get:
      operationId: get_trx_refund_refundId
      tags:
      - Trx
      summary: GET /trx/refund/{refund_id}
      description: Poll the status of a refund using the refund_id returned by POST /trx/{id}/refund.
      x-source: https://docs.billease.ph/integration/deals/transaction-orders
      parameters:
      - name: refundId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /trx/transaction:
    post:
      operationId: post_trx_transaction
      tags:
      - Trx
      summary: Create transaction
      x-source: https://docs.billease.ph/api-callback
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTrxTransactionRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTrxTransactionResponse'
      x-evidence:
        kind: documentation
  /trx/transaction/{trxId}:
    get:
      operationId: get_trx_transaction_trxId
      tags:
      - Trx
      summary: GET /trx/transaction/{trx_id}
      description: Read‑only endpoint for manual debugging to check whether a transaction order reached the merchant; any 2xx means the order exists.
      x-source: https://docs.billease.ph/integration/deals/transaction-orders
      parameters:
      - name: trxId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /trx/{id}/{id}:
    get:
      operationId: get_trx_id_id
      tags:
      - Trx
      summary: GET /trx/{id}/history
      description: Retrieve the full timestamped sequence of a transaction.
      x-source: https://docs.billease.ph/integration/deals/transaction-orders
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
    post:
      operationId: post_trx_id_id
      tags:
      - Trx
      summary: Refund items
      description: This operation refunds one or more items from the transaction.
      x-source: https://docs.billease.ph/api-trx
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTrxIdIdRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTrxIdIdResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
components:
  schemas:
    PostTrxIdIdResponse:
      type: object
      properties:
        refund_id:
          type: string
          description: Refund identifier
        refund_time:
          type: string
          description: Time of refund
        status:
          type: string
          description: Refund status
    PostTrxTransactionRequest:
      type: object
      properties:
        order_id:
          type: string
          description: Order ID. Echo it back on every POST /trx/{id}/update call.
        trx_id:
          type: string
          description: Transaction ID (UUID). It also goes in the path of the delivery-status update calls.
        product_id:
          type: string
          description: Your product id, the same id you send us on POST /products/sync.
        amount:
          type: number
          description: Amount paid by the customer, in major currency units.
        currency:
          type: string
          description: Currency.
        created:
          type: string
          description: Timestamp when the transaction order creation was initiated on partner side.
        customer:
          type: object
          description: Recipient of the goods, and where they ship.
        sender:
          type: object
          description: The buyer, when the goods were purchased for someone else.
      required:
      - order_id
      - trx_id
      - product_id
      - amount
      - currency
      - created
      - customer
    PostTrxTransactionResponse:
      type: object
      properties:
        status:
          type: string
          description: OK
        in_stock:
          type: integer
          description: Remaining stock count.
    PostTrxIdIdRequest:
      type: object
      properties:
        items:
          type: array
          description: Array of integers non-empty unique Array of ids
        reason_refund:
          type: string
          description: Refund reason
        amount:
          type: number
          description: Amount to be refunded
  securitySchemes:
    bearer:
      type: http
      scheme: bearer