v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB

Agreement modification

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

get/payto/agreements/{agreement_uid}/amendment

Response

successful

Example response

{
  "data": {
    "agreement_uid": "biz_agreement_G7MQWwkQZIP8vbfH",
    "changes": {
      "description": "Payment plan for loan #1234",
      "validity_end_date": "2023-12-31",
      "payment_terms": {
        "type": "fixed",
        "frequency": "monthly",
        "count": 1,
        "amount": 10000,
        "max_amount": 100000,
        "first_payment_amount": 100000,
        "last_payment_amount": 100000,
        "first_payment_date": "2023-12-31",
        "last_payment_date": "2024-12-31"
      },
      "creditor": {
        "ultimate_party_name": "Billie Jean Senior",
        "party_name": "Billie Jean Junior",
        "account_identifier": {
          "value": "123456-98765432"
        }
      },
      "initiator": {
        "name": "Jane's Flowers",
        "legal_name": "Blossoming Flowers Pty Ltd",
        "abn": "56192755287",
        "acn": "192755287"
      }
    },
    "resolution_requested_before": "2022-01-20T12:34:56Z",
    "failure": {
      "title": "Agreement Status Invalid",
      "detail": "Contact Zepto for more information - The requested operation cannot be performed for the current status of the agreement",
      "code": "MMS.API.9104"
    },
    "links": {
      "agreement": "https://api.zeptopayments.com/payto/agreements/biz_agreement_G7MQWwkQZIP8vbfH"
    }
  }
}