--- updatedAt: 2026-04-20T20:32:06.000Z agentTools: projectIndex: https://docs.zeptopayments.com/llms.txt --- # show 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` # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Zepto PayTo API", "version": "20260901", "description": "Documentation for the Zepto PayTo API.", "termsOfService": "https://www.zepto.com.au/customer-terms", "contact": { "email": "support@zepto.com.au" } }, "tags": [ { "name": "Agreement modification", "description": "Modify existing agreements" } ], "externalDocs": { "description": "Zepto API v1.0", "url": "https://docs.zeptopayments.com" }, "security": [ { "bearerAuth": [] } ], "paths": { "/payto/agreements/{agreement_uid}/amendment": { "parameters": [ { "$ref": "#/components/parameters/ZeptoAPIVersion" }, { "name": "agreement_uid", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9\\-._~]+$", "description": "A supplied unique ID", "example": "Agreement_00012345" }, "required": true } ], "get": { "summary": "show amendment", "tags": [ "Agreement modification" ], "description": "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`", "responses": { "200": { "description": "successful", "content": { "application/json": { "examples": { "Successful request": { "summary": "Successful request", "value": { "data": { "agreement_uid": "biz_agreement_123", "actor": "initiator", "changes": { "description": "A short description" }, "resolution_requested_before": null, "state": "pending", "failure": null, "created_at": "2022-02-01T09:41:00+11:00", "links": { "agreement": "https://api.zeptopayments.com/payto/agreements/biz_agreement_123" } } } } }, "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/payto.amendment" } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "examples": { "Unauthorised access token": { "summary": "Unauthorised access token", "value": { "errors": [ { "title": "Unauthorised access token", "detail": "Access token is expired or not valid", "links": { "about": "https://docs.zeptopayments.com/docs/zepto-api#authentication-and-authorisation" } } ] } } }, "schema": { "$ref": "#/components/schemas/payto.generic_errors" } } } }, "403": { "description": "forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } } }, "servers": [ { "description": "Zepto Sandbox", "url": "https://api.sandbox.zeptopayments.com" }, { "description": "Zepto Production", "url": "https://api.zeptopayments.com" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "parameters": { "ZeptoAPIVersion": { "name": "Zepto-API-Version", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^\\d{8}$", "default": "20250101", "example": "20260901" }, "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted." } }, "schemas": { "payto.account_identifier": { "type": "object", "description": "An identifier representing the parties account", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "bban", "alias_phone", "alias_email", "alias_abn", "alias_organisation_identifier" ] }, "value": { "anyOf": [ { "$ref": "#/components/schemas/payto.account_identifiers_bban" }, { "$ref": "#/components/schemas/payto.account_identifiers_alias_email" }, { "$ref": "#/components/schemas/payto.account_identifiers_alias_phone" }, { "$ref": "#/components/schemas/payto.account_identifiers_alias_abn" }, { "$ref": "#/components/schemas/payto.account_identifiers_alias_organisation_identifier" } ] } } }, "payto.account_identifiers_alias_abn": { "type": "string", "title": "ABN alias", "description": "A PayID ABN alias", "example": "123456789", "pattern": "^((\\d{9})|(\\d{11}))$" }, "payto.account_identifiers_alias_email": { "type": "string", "title": "Email alias", "description": "A PayID email alias", "example": "default@example.com", "pattern": "^(?:[a-z0-9!#$%&'*+\\/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+\\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)$" }, "payto.account_identifiers_alias_organisation_identifier": { "type": "string", "title": "Organisation alias", "description": "A PayID organisation identifier alias", "example": "Zepto Pty Ltd, Byron Bay NSW", "pattern": "^[!-@\\[-~][ -@\\[-~]{0,254}[!-@\\[-~]$" }, "payto.account_identifiers_alias_phone": { "type": "string", "title": "Phone alias", "description": "A PayID phone alias. e.g. +61-411222333", "example": "+61-411222333", "pattern": "^\\+[0-9]{1,3}-[1-9]{1,1}[0-9]{1,29}$" }, "payto.account_identifiers_bban": { "type": "string", "title": "BBAN", "description": "A branch code (BSB) and account number separated with a hyphen", "example": "123456-98765432", "pattern": "^\\d{6}-[ -~]{1,28}$" }, "payto.amendment": { "type": "object", "additionalProperties": false, "required": [ "agreement_uid", "changes", "state", "actor", "failure", "created_at", "resolution_requested_before", "links" ], "properties": { "agreement_uid": { "type": "string", "pattern": "^[A-Za-z0-9_~.-]{1,64}$", "description": "Supplied unique identifier for the related agreement", "example": "biz_agreement_G7MQWwkQZIP8vbfH", "minLength": 1, "maxLength": 64 }, "changes": { "type": "object", "description": "Changes to be applied to the mandate. Use `null` values to clear existing attributes, or provide new values to update them in the mandate.", "properties": { "description": { "type": "string", "example": "Payment plan for loan #1234", "pattern": "^[ -~]+$", "minLength": 1, "maxLength": 140, "description": "The reason for the agreement, as narrative text. ASCII-printable characters only." }, "validity_end_date": { "type": "string", "format": "date", "description": "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.", "nullable": true, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "example": "2023-12-31" }, "payment_terms": { "type": "object", "properties": { "type": { "type": "string", "description": "The pattern that payments will follow", "enum": [ "balloon", "fixed", "usage_based", "variable" ], "example": "fixed" }, "frequency": { "type": "string", "description": "The frequency at which payments will be made. Can be used in conjunction with `count` to allow more than one payment per period.", "enum": [ "adhoc", "daily", "weekly", "fortnightly", "monthly", "quarterly", "semi_annual", "annual" ], "example": "monthly" }, "count": { "type": "integer", "description": "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.", "example": 1, "minimum": 1, "nullable": true }, "amount": { "type": "integer", "description": "Fixed amount to be debited from the debtor's account. Required for 'fixed' and 'balloon' types.", "example": 10000, "minimum": 1, "maximum": 1000000000, "nullable": true }, "max_amount": { "type": "integer", "description": "The maximum allowed payment amount, in cents.", "example": 100000, "minimum": 1, "maximum": 1000000000, "nullable": true }, "first_payment_amount": { "type": "integer", "description": "Optional specified payment amount for first payment, in cents. Applicable only to 'balloon' terms type.", "example": 100000, "minimum": 1, "maximum": 1000000000, "nullable": true }, "last_payment_amount": { "type": "integer", "description": "Optional specified payment amount for last payment, in cents. Applicable only to 'balloon' terms type.", "example": 100000, "minimum": 1, "maximum": 1000000000, "nullable": true }, "first_payment_date": { "type": "string", "format": "date", "description": "The date first payment will be initiated for agreement. Date timezone is Australia Sydney.", "nullable": true, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "example": "2023-12-31" }, "last_payment_date": { "type": "string", "format": "date", "description": "The date last payment will be initiated for agreement. Date timezone is Australia Sydney.", "nullable": true, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "example": "2024-12-31" } } }, "creditor": { "type": "object", "description": "Who and where the payment will be made to", "properties": { "ultimate_party_name": { "type": "string", "example": "Billie Jean Senior", "minLength": 1, "maxLength": 140, "pattern": "^[ -~]+$", "description": "The ultimate creditor name for the account. HTML name entities are not allowed." }, "party_name": { "type": "string", "example": "Billie Jean Junior", "minLength": 1, "maxLength": 140, "pattern": "^[ -~]+$", "description": "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": { "$ref": "#/components/schemas/payto.account_identifier" }, "payment_account_uid": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9\\-._~]+$", "description": "The uid of the payment account registered via the Counterparties API, identifying the party behind the nominated account.", "example": "pa_20221231_G7MQWwkQZIP8vbfH", "nullable": true } } } } }, "resolution_requested_before": { "type": "string", "format": "date-time", "description": "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.", "example": "2022-01-20T12:34:56Z", "nullable": true }, "state": { "type": "string", "description": "Amendment status in Zepto system", "enum": [ "pending", "failed", "created", "applied", "declined", "expired", "recalled" ] }, "actor": { "type": "string", "description": "The party that initiated the amendment action", "enum": [ "debtor", "initiator" ] }, "failure": { "$ref": "#/components/schemas/payto.reason" }, "created_at": { "type": "string", "format": "date-time" }, "links": { "type": "object", "required": [ "agreement" ], "properties": { "agreement": { "type": "string", "description": "A URL to the associated agreement", "example": "https://api.zeptopayments.com/payto/agreements/biz_agreement_G7MQWwkQZIP8vbfH", "nullable": false } }, "additionalProperties": false } } }, "payto.generic_error": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "example": "Title of error" }, "detail": { "type": "string", "description": "A short description of the error", "example": "Description of error" }, "links": { "type": "object", "properties": { "about": { "type": "string", "description": "An optional link to more information on the error", "example": "https://docs.zeptopayments.com/docs/zepto-environments" } }, "required": [ "about" ] }, "meta": { "type": "object", "description": "Optional meta information about the error", "properties": { "resource_ref": { "type": "string", "description": "Resource reference of the resource impacted by the error", "example": "P2PAY.1000" }, "resource_uid": { "type": "string", "description": "Supplied ID of the resource impacted by the error", "example": "payment_34fj8djh2" } } } }, "required": [ "title", "detail" ] }, "payto.generic_errors": { "type": "object", "properties": { "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/payto.generic_error" } } }, "required": [ "errors" ] }, "payto.reason": { "type": "object", "description": "Details about the reason for the resource being in its current state", "properties": { "title": { "type": "string", "description": "A short description of the reason or failure", "example": "Agreement Status Invalid" }, "detail": { "type": "string", "description": "A longer description of the reason or failure", "example": "Contact Zepto for more information - The requested operation cannot be performed for the current status of the agreement" }, "code": { "type": "string", "description": "A unique identifier for this specific type of reason or failure", "example": "MMS.API.9104", "enum": [ "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": [ "title", "detail", "code" ], "nullable": true } } } } ```