---
title: "Get an Agreement"
method: GET
path: "/agreements/{agreement_ref}"
tags: ["Agreements"]
---

# Get an Agreement

`GET /agreements/{agreement_ref}`

Get a single Agreement by its reference

## Path parameters

- `agreement_ref` string, required

## Response `200`

OK

- GetAgreementResponse
  - `data` object, required
    - `ref` string, required — The Agreement reference (Min: 3 - Max: 18)
    - `initiator_id` string, uuid, required — Your Zepto account ID
    - `authoriser_id` string, uuid, required — The authoriser's account ID (AnyoneAccount)
    - `contact_id` string, uuid, required — The contact ID representing the authoriser within Zepto
    - `bank_account_id` string, uuid, required — The authoriser's bank account ID
    - `status` 'proposed' | 'accepted' | 'cancelled' | 'declined' | 'expended', required — The status of the Agreement
    - `status_reason` string, required — The reason the agreement was cancelled. This is a free text field.
    - `responded_at` string, date-time, required — The date-time when the Agreement status changed
    - `created_at` string, date-time, required — The date-time when the Agreement was created
    - `terms` Terms, required
      - `per_payout` PerPayout, required — Per-payout limits. Both `min_amount` and `max_amount` keys must be present; set either to `null` for no limit.
        - `min_amount` integer, nullable, required — Minimum amount in cents a Payment Request can be in order to be auto-approved. Specify `null` for no limit.
        - `max_amount` integer, nullable, required — Maximum amount in cents a Payment Request can be in order to be auto-approved. Specify `null` for no limit.
      - `per_frequency` PerFrequency, required — Frequency window limits. Both `days` and `max_amount` keys must be present; set either to `null` for no limit. When `max_amount` is set, `days` must also be set.
        - `days` integer, nullable, required — Number of days the frequency window covers. Specify `null` for no limit.
        - `max_amount` integer, nullable, required — Maximum aggregate amount in cents across all Payment Requests within the frequency window. Specify `null` for no limit.
      - `access_balance` boolean — When true, the Agreement allows balance access for the authoriser.
    - `metadata` object — Your custom keyed data

---

[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)