Akahu Support API

openapi: 3.2.0
info:
  title: Akahu Enduring Support API
  description: This API is the primary way for apps to interact with a user's data.
  version: 1.0.0
servers:
- url: https://api.akahu.io/v1
tags:
- name: Support
paths:
  /support/{transaction_id}:
    parameters:
    - name: transaction_id
      in: path
      required: true
      description: An Akahu Transaction ID
      schema:
        type: string
    post:
      tags:
      - Support
      summary: Transaction support
      security:
      - user_token: []
      description: 'Let us know when we get something wrong 🙏.

        The request body should match the type of request you are making:


        ### Notify Us Of A Duplicate ###


        | Parameter | Example | Description |

        |:-----------|:------------------------------------|:---------------------------------------------------------------------------------------|

        | `type` | `"DUPLICATE"` | Let us know that two Akahu transactions are actually the same transaction in the bank. |

        | `other_id` | `"trans_1111111111111111111111111"` | The duplicate transaction ID. |


        ### Notify Us Of An Enrichment Error ###


        | Parameter | Example | Description |

        |:-----------|:-------------------------------------|:------------------------------------------------------|

        | `type` | `"ENRICHMENT_ERROR"` | Let us know when we get something wrong. |

        | `fields` | `[ "merchant.name"]` | A list of dot-separated paths to the incorrect values |

        | `comment` | `"X should be Y"` | Additional info you want to include. |


        ### Suggest An Improvement To Enrichment Data ###


        | Parameter | Example | Description |

        |:-----------|:-------------------------------|:------------------------------------------------------------------------------------------------------|

        | `type` | `"ENRICHMENT_SUGGESTION"` | Let us know about further enrichment that can be applied to this transaction transaction in the bank. |

        | `comment` | `"Can you please add X to Y?"` | The enrichment information you want to tell us about. |'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - type
              properties:
                type:
                  type: string
                  example: DUPLICATE
                  enum:
                  - DUPLICATE
                  - ENRICHMENT_ERROR
                  - ENRICHMENT_SUGGESTION
                  description: 'What type of support request you want to make:


                    - `DUPLICATE` → Report duplicate transactions.


                    - `ENRICHMENT_ERROR` → Enrichment is incorrect or contained unexpected data.


                    - `ENRICHMENT_SUGGESTION` → Suggest an improvement on existing enrichment.'
                other_id:
                  type: string
                  description: In the case of duplicates, the duplicate transaction ID.
                fields:
                  type: array
                  description: In the case of enrichment errors, the dot-separated paths to the incorrect values.
                  items:
                    type: string
                comment:
                  type: string
                  description: A comment describing the problem and giving extra details.
      parameters:
      - $ref: '#/components/parameters/xAkahuId'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
              example:
                success: true
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '500':
          $ref: '#/components/responses/500'
      operationId: postSupportByTransactionId
      x-operation-id-source: derived
components:
  parameters:
    xAkahuId:
      name: X-Akahu-Id
      in: header
      required: true
      description: Your **App ID Token**.
      schema:
        type: string
      example: '{{app_token}}'
  responses:
    '500':
      description: An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Something went wrong
    '400':
      description: Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Invalid Content-Type
    '403':
      description: You are not allowed to access this content.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Forbidden
    '401':
      description: You are not authorised to access this content.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Permission Denied
  securitySchemes:
    user_token:
      type: http
      scheme: bearer
      description: 'User-level Authentication:


        Http Bearer Auth with the token being a consented **User Access Token**.

        > `Bearer {user_token}`


        This will allow you to act on a **user''s** behalf when accessing the API.'
    app_auth:
      type: http
      scheme: basic
      description: 'App-level Authentication:


        HTTP Basic Auth with the username being your **App ID Token** and the password being your **App Secret**.

        > `Basic {app_token}:{app_secret}`


        This will allow you to act as your Akahu **application**, rather than as a specific user.'
x-provenance:
  method: searched
  source: https://developers.akahu.nz/reference
  harvested: '2026-10-26'
  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://developers.akahu.nz/reference/delete_accounts-id-payment-consents-consent-id.md
  - https://developers.akahu.nz/reference/delete_accounts-id-verification-token.md
  - https://developers.akahu.nz/reference/delete_authorisations-id.md
  - https://developers.akahu.nz/reference/delete_token.md
  - https://developers.akahu.nz/reference/delete_webhooks-id.md
  - https://developers.akahu.nz/reference/get_accounts-id-transactions-pending.md
  - https://developers.akahu.nz/reference/get_accounts-id-transactions.md
  - https://developers.akahu.nz/reference/get_accounts-id-verification-token.md
  - https://developers.akahu.nz/reference/get_accounts-id.md
  - https://developers.akahu.nz/reference/get_accounts.md
  - https://developers.akahu.nz/reference/get_categories-id.md
  - https://developers.akahu.nz/reference/get_categories.md
  - https://developers.akahu.nz/reference/get_connections-id.md
  - https://developers.akahu.nz/reference/get_connections.md
  - https://developers.akahu.nz/reference/get_identity-id.md
  - https://developers.akahu.nz/reference/get_keys-id.md
  - https://developers.akahu.nz/reference/get_me.md
  - https://developers.akahu.nz/reference/get_parties.md
  - https://developers.akahu.nz/reference/get_payments-id.md
  - https://developers.akahu.nz/reference/get_payments.md
  - https://developers.akahu.nz/reference/get_transactions-id.md
  - https://developers.akahu.nz/reference/get_transactions-pending.md
  - https://developers.akahu.nz/reference/get_transactions.md
  - https://developers.akahu.nz/reference/get_webhook-events.md
  - https://developers.akahu.nz/reference/get_webhooks.md
  - https://developers.akahu.nz/reference/post_identity-id-verify-name.md
  - https://developers.akahu.nz/reference/post_par.md
  - https://developers.akahu.nz/reference/post_payments-ird.md
  - https://developers.akahu.nz/reference/post_payments.md
  - https://developers.akahu.nz/reference/post_refresh-id.md
  - https://developers.akahu.nz/reference/post_refresh.md
  - https://developers.akahu.nz/reference/post_support-transaction-id.md
  - https://developers.akahu.nz/reference/post_token.md
  - https://developers.akahu.nz/reference/post_transactions-ids.md
  - https://developers.akahu.nz/reference/post_verify-name-id.md
  - https://developers.akahu.nz/reference/post_verify-name.md
  - https://developers.akahu.nz/reference/post_webhooks.md
  merge:
    pages: 37
    deduped: 269
    conflicts_kept_first: 0