Assembly Payments

Assembly Payments Transaction supplementary data API

The Transaction supplementary data API from Assembly Payments — 1 operation(s) for transaction supplementary data.

Documentation GitHub OpenAPI

Operations 1

GET /transactions/{id}/supplementary_data Show Transaction Supplementary Data #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/assembly-payments:assembly-payments-transaction-supplementary-data-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: 'This swagger lists all APIs to provide additional details about a payment.

    * Transaction Supplementary Data API - This API provides additional details for successfully reconciled NPP and DE payments.

    * Failed NPP Payment Details - This API provides details for failed NPP PayTo payments.'
  version: 0.3-external
  title: Transaction supplementary data API
  contact:
    email: support@assemblypayments.com
    url: http://docs.assemblypayments.com/
servers:
- url: https://sandbox.au-0000.api.assemblypay.com
  description: Sandbox (Pre-live) server and API
- url: https://au-0000.api.assemblypay.com
  description: Production server and API
- url: https://virtserver.swaggerhub.com/AssemblyPlatforms/SupplementaryData/0.3-external
  description: SwaggerHub API Auto Mocking
tags:
- name: Transaction supplementary data
paths:
  /transactions/{id}/supplementary_data:
    get:
      tags:
      - Transaction supplementary data
      summary: Show Transaction Supplementary Data
      operationId: showTransactionSupplementaryData
      description: Show supplementary data of a specific **Transaction** using a given `:id`.
      security:
      - bearerAuth: []
      parameters:
      - in: path
        name: id
        description: Transaction ID
        required: true
        explode: false
        style: simple
        schema:
          type: string
          format: uuid
        example: 49f1cb10-0202-0138-225b-028e897a70a5
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/supplementaryData'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                    example: 'Invalid format for url param: id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                    example: Invalid or missing authorisation token
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                    example: Transaction data not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                    example: An error occurred processing your request. Please try again.
components:
  schemas:
    links:
      type: object
      required:
      - self
      - users
      - wallet_accounts
      - virtual_accounts
      - marketplaces
      - transactions
      properties:
        self:
          type: string
          example: /transactions/49f1cb10-0202-0138-225b-028e897a70a5/supplementary_data/
        users:
          type: string
          example: /transactions/49f1cb10-0202-0138-225b-028e897a70a5/users
        wallet_accounts:
          type: string
          example: /transactions/49f1cb10-0202-0138-225b-028e897a70a5/wallet_accounts
        marketplaces:
          type: string
          example: /transactions/49f1cb10-0202-0138-225b-028e897a70a5/marketplaces
        transactions:
          type: string
          example: /transactions/49f1cb10-0202-0138-225b-028e897a70a5/
        agreements:
          type: string
          description: Only available for PayTo Payments!
          example: /payto/agreements/46deb476-c1a6-41eb-8eb7-26a695bbe5bc
    base:
      type: object
      required:
      - id
      - debtor_name
      - debtor_bsb
      - debtor_account
      - creditor_account
      - creditor_name
      - remittance_information
      - type
      - type_method
      properties:
        id:
          type: string
          format: uuid
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
        debtor_name:
          type: string
          example: ASSEMBLY TEST
        debtor_bsb:
          type: string
          example: 98765
        debtor_account:
          type: string
          example: 9876512345678
        creditor_account:
          type: string
          example: 3389422762057
        creditor_name:
          type: string
          example: ACME Corp Pty Ltd
        remittance_information:
          type: string
          example: 100014014111111
        type:
          type: string
          example: deposit
        type_method:
          type: string
          example: npp_payin
    supplementaryData:
      allOf:
      - $ref: '#/components/schemas/base'
      - type: object
        required:
        - npp_details
        - links
        properties:
          npp_details:
            type: object
            $ref: '#/components/schemas/nppDetails'
          links:
            type: object
            $ref: '#/components/schemas/links'
    nppDetails:
      description: Details for the NPP payment. `npp_details` will only be present when `type_method` is `npp_payin`
      type: object
      required:
      - pay_id
      - pay_id_type
      - clearing_system_transaction_id
      - end_to_end_id
      - npp_payin_internal_id
      - cdtr_ref_inf
      - ultm_cdtr_id
      - ultmt_cdtr_schme_nm
      - ctgy_purp
      - debtor_legal_name
      properties:
        pay_id:
          type: string
          example: npp@assemblypayments.com
        pay_id_type:
          type: string
          example: EMAIL
        clearing_system_transaction_id:
          type: string
          example: CTBAAUSNXXXN20191216050126353211111
        end_to_end_id:
          type: string
        cdtr_ref_inf:
          type: string
        ultm_cdtr_id:
          type: string
        ultmt_cdtr_schme_nm:
          type: string
        ultm_cdtr_nm:
          type: string
          minLength: 0
          maxLength: 140
        ctgy_purp:
          type: string
        debtor_legal_name:
          type: string
        instruction_id:
          type: string
          maxLength: 35
          minLength: 1
          description: Unique identifier for the payment request generated as per NPPA guidelines. Only available for PayTo Payments
          example: BANKNTSTXXXI20180501000000000000010
        agreement_id:
          type: string
          description: Unique agreement identifier generated by NPPA. Only available for PayTo Payments
          example: ef0fcd9799431ef783204966f010603c
        agreement_uuid:
          type: string
          description: Unique agreement identifier generated by Zai. Only available for PayTo Payments
          format: uuid
          example: 46deb476-c1a6-41eb-8eb7-26a695bbe5bc
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-explorer-enabled: false
x-samples-languages:
- curl
- c#
- ruby
- php
- javascript
- csharp
- go
x-provenance:
  method: searched
  source: https://developer.hellozai.com/reference
  harvested: '2026-10-22'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.hellozai.com/reference/getpayinsbyinstructionid.md
  - https://developer.hellozai.com/reference/showtransactionsupplementarydata-1.md
  merge:
    pages: 2
    deduped: 3
    conflicts_kept_first: 0