v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB
Agreements

show agreement

get/payto/agreements/{agreement_uid}

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"
      }
    },
    "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"
    },
    "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"
    }
  }
}