---
title: "show amendment"
method: GET
path: "/payto/agreements/{agreement_uid}/amendment"
tags: ["Agreement modification"]
---

# show amendment

`GET /payto/agreements/{agreement_uid}/amendment`

This will return any in-progress amendment for an Agreement (e.g. no response from debtor). If the Agreement has no in-progress amendment, endpoint will return `404`

## Response `200`

successful

- object
  - `data` PaytoAmendment, required
    - `agreement_uid` string, required — Supplied unique identifier for the related agreement
    - `changes` object, required — Changes to be applied to the mandate. Use `null` values to clear existing attributes, or provide new values to update them in the mandate.
      - `description` string — The reason for the agreement, as narrative text. ASCII-printable characters only.
      - `validity_end_date` string, date, nullable — End date of the validity of the agreement. If specified, the agreement will be valid until 23:59:59.999 Australia Sydney time on this date.
      - `payment_terms` object
        - `type` 'balloon' | 'fixed' | 'usage_based' | 'variable' — The pattern that payments will follow
        - `frequency` 'adhoc' | 'daily' | 'weekly' | 'fortnightly' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' — The frequency at which payments will be made. Can be used in conjunction with `count` to allow more than one payment per period.
        - `count` integer, nullable — Count of payments allowed per frequency period. With non-adhoc frequency periods, if count is not given, one payment per frequency period will be allowed. If frequency is adhoc and count is not given, unlimited payments will be allowed.
        - `amount` integer, nullable — Fixed amount to be debited from the debtor's account. Required for 'fixed' and 'balloon' types.
        - `max_amount` integer, nullable — The maximum allowed payment amount, in cents.
        - `first_payment_amount` integer, nullable — Optional specified payment amount for first payment, in cents. Applicable only to 'balloon' terms type.
        - `last_payment_amount` integer, nullable — Optional specified payment amount for last payment, in cents. Applicable only to 'balloon' terms type.
        - `first_payment_date` string, date, nullable — The date first payment will be initiated for agreement. Date timezone is Australia Sydney.
        - `last_payment_date` string, date, nullable — The date last payment will be initiated for agreement. Date timezone is Australia Sydney.
      - `creditor` object — Who and where the payment will be made to
        - `ultimate_party_name` string — The ultimate creditor name for the account. HTML name entities are not allowed.
        - `party_name` string — The name of the creditor party must accurately represent the creditor party and may be the same as the ultimate_party_name. HTML name entities are not allowed.
        - `account_identifier` PaytoAccountIdentifier — An identifier representing the parties account
          - `type` 'bban' | 'alias_phone' | 'alias_email' | 'alias_abn' | 'alias_organisation_identifier', required
          - `value` union, required
            - string — A branch code (BSB) and account number separated with a hyphen
            - string — A PayID email alias
            - string — A PayID phone alias. e.g. +61-411222333
            - string — A PayID ABN alias
            - string — A PayID organisation identifier alias
      - `initiator` object — The details of the party that initiated this agreement
        - `name` string — The name of the initating party for this agreement. Displayed to the end customer by their financial institution. HTML name entities are not allowed.
        - `legal_name` string — The legal name of the initating party for this agreement. HTML name entities are not allowed.
        - `abn` string, nullable — The Australian Business Number (ABN) of the initiating party for this agreement.
        - `acn` string, nullable — The Australian Company Number (ACN) of the initiating party for this agreement.
    - `resolution_requested_before` string, date-time, nullable, required — Requested resolution (accept/decline) deadline for this amendment. It will be provided in any notification sent to the debtor. This time is for informational purposes only and does not affect the expiry time. If not provided, it defaults to 5 days from amendment creation. Value must be an ISO8601 date-time in UTC timezone.
    - `state` 'pending' | 'failed' | 'created' | 'applied' | 'declined' | 'expired' | 'recalled', required — Amendment status in Zepto system
    - `actor` 'debtor' | 'initiator', required — The party that initiated the amendment action
    - `failure` PaytoReason, nullable, required — Details about the reason for the resource being in its current state
      - `title` string, required — A short description of the reason or failure
      - `detail` string, required — A longer description of the reason or failure
      - `code` 'MMS.API.9000' | 'MMS.API.9001' | 'MMS.API.9002' | 'MMS.API.9003' | 'MMS.API.9005' | 'MMS.API.9006' | 'MMS.API.9007' | 'MMS.API.9008' | 'MMS.API.9009' | 'MMS.API.9010' | 'MMS.API.9011' | 'MMS.API.9013' | 'MMS.API.9015' | 'MMS.API.9016' | 'MMS.API.9017' | 'MMS.API.9018' | 'MMS.API.9019' | 'MMS.API.9101' | 'MMS.API.9102' | 'MMS.API.9103' | 'MMS.API.9104' | 'MMS.API.9105' | 'MMS.API.9106' | 'MMS.API.9107' | 'MMS.API.9108' | 'MMS.API.9109' | 'MMS.API.9110' | 'MMS.API.9111' | 'MMS.API.9112' | 'MMS.API.9113' | 'MMS.API.9114' | 'MMS.API.9115' | 'MMS.API.9116' | 'MMS.API.9117' | 'MMS.API.9118' | 'MMS.API.9119' | 'MMS.API.9120' | 'MMS.API.9121' | 'MMS.API.9301' | 'MMS.API.9302' | 'MMS.API.9303' | 'MMS.API.9401' | 'MMS.API.9402' | 'MMS.API.9501' | 'MMS.API.9601' | 'MMS.API.9900' | 'MMS.API.9901' | 'AVED' | 'BVSD' | 'MCGP' | 'NACT' | 'AC02' | 'AC05' | 'AC06' | 'AC13' | 'AG01' | 'AG03' | 'AM03' | 'AM12' | 'AM14' | 'BE06' | 'MD09' | 'MD16' | 'MD21' | 'NOAS' | 'RR04' | 'SL11' | 'SL12' | 'AB01' | 'AB02' | 'AB03' | 'AB04' | 'AB08' | 'AC03' | 'AC07' | 'AC14' | 'AC15' | 'AG07' | 'AGNT' | 'AM01' | 'AM02' | 'AM04' | 'AM06' | 'AM09' | 'AM19' | 'AM21' | 'BE05' | 'BE08' | 'BE22' | 'CH20' | 'CH21' | 'CURR' | 'CUST' | 'DT02' | 'DT04' | 'ED05' | 'ED06' | 'FF04' | 'FF08' | 'FF10' | 'FF11' | 'FRAD' | 'MD01' | 'MD02' | 'MD20' | 'MS02' | 'MS03' | 'NARR' | 'NAUT' | 'RR02' | 'RR03' | 'RC05' | 'SL01' | 'SL13' | 'SL14' | 'TD03' | 'TM01' | 'ZPPAY24' | 'AC04' | 'MD07' | 'MD08' | 'MD17' | 'CTAM' | 'CTCA' | 'CTEX' | 'MCFC' | 'MCOC' | 'MSUC' | 'ZPUNP01' | 'ZPUNP02' | 'ZPUNP06' | 'ZPUNP07' | 'ZPUNP08' | 'ZPPAY00' | 'ZPREF07' | 'UKNWN' | 'UKNWN', required — A unique identifier for this specific type of reason or failure
    - `created_at` string, date-time, required
    - `links` object, required
      - `agreement` string, required — A URL to the associated agreement

## Other responses

- `401` — unauthorized
- `403` — forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/zeptopayments/apis/zepto-api.md) · [All operations](https://skmtc.net/zeptopayments/apis/zepto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeptopayments/zepto-api/revisions/6353e9b9af6f/schema)