> ## Documentation Index
> Fetch the complete documentation index at: https://docs.singapay.id/llms.txt
> Use this file to discover all available pages before exploring further.

# Inquiry Postpaid (v3)

> Perform a bill inquiry for postpaid products (V3). Same request/response format as V2, but the product is validated against the flat category (1 command = 1 category): the product must belong to the flat category of `command`, and both the product and its flat category must be active, otherwise response_code 06. V3 adds `educ` (education), `prop` (property/IPL) and `pbb` (land & building tax). The returned reference_number is cached for 15 minutes.



## OpenAPI

````yaml https://biller-b2b.singapay.id/docs post /api/v3/postpaid/inquiry
openapi: 3.0.0
info:
  title: B2B Biller API
  description: >-
    API documentation for the B2B Biller service. Provides endpoints for bill
    payments (postpaid/prepaid), transaction management, balance checking, and
    authentication.
  version: 1.0.0
servers:
  - url: https://sandbox-biller-b2b.singapay.id
    description: Sandbox
  - url: https://biller-b2b.singapay.id
    description: Production
security: []
tags:
  - name: Authentication
    description: OAuth2 token generation
  - name: General
    description: Bill transaction listing, detail, balance, and utilities
  - name: Postpaid V1
    description: Postpaid bill inquiry and payment (V1)
  - name: Prepaid V1
    description: Prepaid inquiry and payment — PLN Token, Pulsa, Paket Data (V1)
  - name: Postpaid V2
    description: Postpaid bill inquiry and payment (V2)
  - name: Prepaid V2
    description: Prepaid inquiry, payment, and game topup (V2)
  - name: Postpaid V3
    description: >-
      Postpaid bill inquiry and payment with flat category validation (V3) —
      adds educ, prop, pbb
  - name: Prepaid V3
    description: >-
      Prepaid inquiry, payment, and game topup with flat category validation
      (V3) — adds strmg, emoney, ewallet, cashwd
  - name: Product V3
    description: >-
      Product, flat category, synthetic category tree, and product config
      listing (V3)
  - name: General V3
    description: >-
      Transaction detail with flat category (V3). check-balance,
      list-bill-transaction and list-bill-statement stay on v1;
      reset-customer-id has no version (/api/reset-customer-id).
paths:
  /api/v3/postpaid/inquiry:
    post:
      tags:
        - Postpaid V3
      summary: Inquiry Postpaid (v3)
      description: >-
        Perform a bill inquiry for postpaid products (V3). Same request/response
        format as V2, but the product is validated against the flat category (1
        command = 1 category): the product must belong to the flat category of
        `command`, and both the product and its flat category must be active,
        otherwise response_code 06. V3 adds `educ` (education), `prop`
        (property/IPL) and `pbb` (land & building tax). The returned
        reference_number is cached for 15 minutes.
      operationId: postpaidInquiryV3
      parameters:
        - name: X-PARTNER-ID
          in: header
          description: Your unique partner API key
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - name: Content-Type
          in: header
          required: true
          schema:
            type: string
            default: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - command
                - data
              properties:
                command:
                  description: >-
                    Biller command, mapped 1:1 to a flat category (pdam→PDAM,
                    plnpos→PLNPOS, plnnon→PLNNON, intv→INTV, bpjsks→BPJSKS,
                    putk→PUTK, bputk→BPUTK, mobpos→MOBPOS, educ→EDUC, prop→PROP,
                    pbb→PBB)
                  type: string
                  enum:
                    - pdam
                    - plnpos
                    - plnnon
                    - intv
                    - bpjsks
                    - bputk
                    - putk
                    - mobpos
                    - educ
                    - prop
                    - pbb
                  example: plnpos
                data:
                  required:
                    - customer_id
                    - product_code
                  properties:
                    customer_id:
                      description: Customer/subscriber ID
                      type: string
                      example: '114676170021'
                    product_code:
                      description: Product code (must exist in products table)
                      type: string
                      example: SPPLNPOS
                    period:
                      description: >-
                        Payment period — required for bpjsks (1-12) and bputk
                        (1, 2, 3, 6 or 12)
                      type: integer
                      minimum: 1
                      example: 1
                    phone_number:
                      description: >-
                        Customer phone number. For bpjsks it is required at
                        payment (send it here or in the payment request).
                      type: string
                      maxLength: 25
                      nullable: true
                    tax_year:
                      description: >-
                        Tax year (4 digits) — required for pbb. The inquired
                        year is reused at payment.
                      type: string
                      pattern: ^[0-9]{4}$
                      example: '2025'
                      nullable: true
                  type: object
              type: object
            examples:
              PLN Pascabayar:
                summary: PLN Pascabayar (plnpos)
                value:
                  command: plnpos
                  data:
                    customer_id: '114676170021'
                    product_code: SPPLNPOS
              PLN Non Tag:
                summary: PLN Non Tagihan (plnnon)
                value:
                  command: plnnon
                  data:
                    customer_id: '114676170021'
                    product_code: SPPLNNON
              PDAM:
                summary: PDAM (pdam)
                value:
                  command: pdam
                  data:
                    customer_id: '0812345678'
                    product_code: SPPDAMPOS
              Internet TV:
                summary: Internet & TV (intv)
                value:
                  command: intv
                  data:
                    customer_id: '121234567890'
                    product_code: SPINTVPOS
              Pulsa Pascabayar:
                summary: Pulsa Pascabayar (mobpos)
                value:
                  command: mobpos
                  data:
                    customer_id: '081234567890'
                    product_code: SPMOBPOS
              BPJS Kesehatan:
                summary: BPJS Kesehatan (bpjsks, period 1-12)
                value:
                  command: bpjsks
                  data:
                    customer_id: '8888802379205901'
                    product_code: SPBPJSKSPOS
                    period: 1
                    phone_number: '081234567890'
              BPJS TK Penerima Upah:
                summary: BPJS TK Penerima Upah (putk, flat category PUTK)
                value:
                  command: putk
                  data:
                    customer_id: '0000012345678'
                    product_code: SPPUTKPOS
              BPJS TK Bukan Penerima Upah:
                summary: >-
                  BPJS TK Bukan Penerima Upah (bputk, flat category BPUTK,
                  period 1/2/3/6/12)
                value:
                  command: bputk
                  data:
                    customer_id: '0000012345678'
                    product_code: SPBPUTKPOS
                    period: 3
              Education:
                summary: Education fees (educ, V3 only)
                value:
                  command: educ
                  data:
                    customer_id: '20230001234'
                    product_code: <EDUC product code>
              Property:
                summary: Property / IPL (prop, V3 only)
                value:
                  command: prop
                  data:
                    customer_id: A12-0034
                    product_code: <PROP product code>
              PBB:
                summary: Land & building tax (pbb, V3 only)
                value:
                  command: pbb
                  data:
                    customer_id: '327301000100200300'
                    product_code: <PBB product code>
                    tax_year: '2025'
      responses:
        '200':
          description: Inquiry successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostpaidInquiryV3Response'
              examples:
                PLN Pascabayar Success:
                  summary: plnpos
                  value:
                    command: plnpos
                    response_code: '00'
                    response_text: Inquiry success
                    data:
                      amount: '69674'
                      customer_name: JOHN DOE
                      customer_id: '114676170021'
                      reference_number: SPPLNPOSRJBL0057437746821761805651
                      price: '74194'
                      created_at: '2026-08-20 13:27:31'
                PDAM Success:
                  summary: pdam (with late_fee)
                  value:
                    command: pdam
                    response_code: '00'
                    response_text: Inquiry success
                    data:
                      amount: '85000'
                      customer_name: SUHERMAN
                      late_fee: '5000'
                      customer_id: '0812345678'
                      reference_number: SPPDAMPOSRJBL0012345678901761805900
                      price: '92500'
                      created_at: '2026-08-20 13:32:15'
                BPJS Kesehatan Success:
                  summary: bpjsks
                  value:
                    command: bpjsks
                    response_code: '00'
                    response_text: Inquiry success
                    data:
                      amount: '70000'
                      customer_name: KAYAH
                      customer_id: '8888802379205901'
                      reference_number: SPBPJSKSPOSRJBL0051066291251761805800
                      price: '72500'
                      created_at: '2026-08-20 13:30:22'
                Education Success:
                  summary: educ / prop / pbb (customer_name + period)
                  value:
                    command: educ
                    response_code: '00'
                    response_text: Inquiry success
                    data:
                      amount: '1500000'
                      customer_name: ANDI PRATAMA
                      period: '202608'
                      customer_id: '20230001234'
                      reference_number: SPEDUCRJBL0012345678901761806100
                      price: '1502500'
                      created_at: '2026-08-20 13:45:00'
        '400':
          description: >-
            Product exists but is not postpaid, not in the flat category of
            `command`, or the command is unknown (06)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillerErrorV3Response'
              example:
                command: putk
                response_code: '06'
                response_text: Product ID SPBPUTKPOS is not classified as a `putk` product.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '404':
          description: >-
            Product has no flat category, product/flat category inactive, or
            merchant biller data not found (06). A product_code that does not
            exist fails validation (04, 422).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillerErrorV3Response'
              example:
                command: plnpos
                response_code: '06'
                response_text: 'Product SPPLNPOS is not available: category PLNPOS is inactive'
        '422':
          description: Validation error (04), e.g. missing period for bpjsks/bputk
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: System error (99)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillerErrorV3Response'
      security:
        - bearerAuth: []
components:
  schemas:
    PostpaidInquiryV3Response:
      description: >-
        V3 postpaid inquiry success response. Same shape as V2: the core fields
        below are always present; extra vendor fields (customer_name, period,
        late_fee, ...) depend on the command template.
      properties:
        command:
          type: string
          example: plnpos
        response_code:
          type: string
          example: '00'
        response_text:
          type: string
          example: Inquiry success
        data:
          properties:
            amount:
              description: Bill amount from the vendor
              type: string
              example: '69674'
            customer_name:
              type: string
              example: JOHN DOE
              nullable: true
            period:
              description: Billing period (command dependent)
              type: string
              example: '1'
              nullable: true
            late_fee:
              description: Late fee (command dependent)
              type: string
              example: '0'
              nullable: true
            customer_id:
              type: string
              example: '114676170021'
            reference_number:
              description: Send this to postpaid/payment within 15 minutes; usable once
              type: string
              example: SPPLNPOSRJBL0057437746821761805651
            price:
              description: >-
                Amount deducted from the merchant balance on payment (vendor
                total + product admin fee)
              type: string
              example: '74194'
            created_at:
              type: string
              example: '2026-08-20 13:27:31'
          type: object
          additionalProperties: true
      type: object
    BillerErrorV3Response:
      description: >-
        V3 biller error response. Common codes: 04 invalid argument / wrong
        password / missing reference_number (422), payment product_code or
        customer_id differ from the inquiry (400), 06 product not found, product
        or flat category inactive, reference_number used or expired (404) — or
        product not in the flat category of the command / wrong payment type /
        unknown command (400), 16 credential not found (422), 17 insufficient
        balance (400), 22/89 vendor error (503), 99 internal error (500). Full
        list: docs/feature-flow/RESPONSE_CODE_ALL.md.
      required:
        - command
        - response_code
        - response_text
      properties:
        command:
          type: string
          example: plnpos
        response_code:
          description: Error code (see schema description)
          type: string
          example: '06'
        response_text:
          type: string
          example: 'Product SPPLNPOS is not available: product is inactive'
      type: object
    UnauthorizedErrorResponse:
      description: Unauthorized error response (HTTP 401)
      required:
        - status
        - success
        - error
      properties:
        status:
          type: integer
          example: 401
        success:
          type: boolean
          example: false
        error:
          properties:
            code:
              type: integer
              example: 401
            message:
              type: string
              example: Unauthorized merchant, please sign in
          type: object
      type: object
    ValidationErrorResponse:
      description: Validation error response (HTTP 422)
      required:
        - command
        - response_code
        - response_text
        - data
      properties:
        command:
          type: string
          example: detail-bill-transaction
        response_code:
          type: string
          example: '04'
        response_text:
          type: string
          example: Rejected Format Error
        data:
          description: Field-level error messages
          type: object
          example:
            data: The data field is required.
            data.transaction_id: The data.transaction id field is required.
          additionalProperties:
            type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: JWT Bearer token obtained from /api/v1.0/access-token/b2b
      bearerFormat: JWT
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.