Agreement modification

add identification to agreement

Add the identification models introduced in version 20260901 to an agreement created without them: the initiating client and the debtor's registered payment account. Identification can only be added, never changed, and must match the details already on the agreement. Each identification can be added in a separate request. The debtor payment account must belong to the agreement's initiating client; adding one to an agreement with no initiating client identifies you as the initiator. Supply initiator.client_id for any agreement initiated on behalf of a sub-client; without it the agreement is identified as initiated by you.

post/payto/agreements/{agreement_uid}/add_identification

Request

Base URL
https://api.sandbox.zeptopayments.com
URL
https://api.sandbox.zeptopayments.com/payto/agreements/{agreement_uid}/add_identification
Auth
HTTP bearer

Headers

Zepto-API-Versionstring

Example:20260901

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Request body

Example request

{
  "initiator": {
    "client_id": "b792ca63-b394-4eb2-937b-a5e5e12c77d1"
  },
  "debtor": {
    "payment_account_uid": "pa_20221231_G7MQWwkQZIP8vbfH"
  }
}

Response

successful

Example response

{
  "data": {
    "uid": "biz_agreement_G7MQWwkQZIP8vbfH",
    "created_at": "2022-01-20T12:34:56+11:00",
    "mms_agreement_id": "3de455278b21196da0c4599025cb7dfa",
    "links": {
      "self": "https://api.zeptopayments.com/payto/agreements/biz_agreement_G7MQWwkQZIP8vbfH"
    },
    "description": "Payment plan for loan #1234",
    "purpose": "loan",
    "resolution_requested_before": "2022-01-20T12:34:56Z",
    "cancel_if_unresolved": true,
    "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"
    },
    "debtor": {
      "ultimate_party_name": "Billie Jean Senior",
      "party_name": "Billie Jean Junior",
      "account_identifier": {
        "value": "123456-98765432"
      },
      "payment_account_uid": "pa_20221231_G7MQWwkQZIP8vbfH"
    },
    "creditor": {
      "ultimate_party_name": "Billie Jean Senior",
      "party_name": "Billie Jean Junior",
      "account_identifier": {
        "value": "123456-98765432"
      },
      "payment_account_uid": "pa_20221231_G7MQWwkQZIP8vbfH"
    },
    "initiator": {
      "client_id": "b792ca63-b394-4eb2-937b-a5e5e12c77d1",
      "name": "Jane's Flowers",
      "legal_name": "Blossoming Flowers Pty Ltd",
      "abn": "56192755287",
      "acn": "192755287"
    },
    "validity_start_date": "2023-01-01",
    "validity_end_date": "2023-12-31",
    "state_reason": {
      "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"
    },
    "metadata": {
      "custom_key": "custom_value"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.