--- title: "list agreement history" method: GET path: "/payto/agreements/{agreement_uid}/history" tags: ["Agreements"] --- # list agreement history `GET /payto/agreements/{agreement_uid}/history` ## Request - Base URL: `https://api.sandbox.zeptopayments.com` - URL: `https://api.sandbox.zeptopayments.com/payto/agreements/{agreement_uid}/history` - Auth: HTTP bearer ## Query parameters - `per_page` integer - `starting_after` string ## Response `200` successful - object - `links` PaytoPaginationLinks - `next` string: URL for next page of results. Won't be present if there are no further pages. - `data` union[] - union - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `mms_agreement_id` string, required: The agreement ID as per the MMS. Formatted as a Universally Unique Identifier (UUID) version 1, as described in IETC RFC 4122 without the 4 hyphen separators. - `resource_metadata` object, nullable: Custom metadata that was supplied to the API when the affected resource was created. - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `caused_by` 'debtor' | 'initiator', required: The party that caused the amendment - `changes` object, required - `description` string: The reason for the agreement, as narrative text. ASCII-printable characters only. - `validity_end_date` string, date, nullable: 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. - `payment_terms` object - … - `creditor` object: Who and where the payment will be made to - … - `debtor` object: Who and where the payment is taken from - … - `initiator` object: The details of the party that initiated this agreement - … - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `caused_by` 'debtor': The party that caused the amendment to be declined - PaytoEventBase - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required: More information about the failure - `failure` object, required - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` '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' | 'ZPUNP01' | 'ZPUNP02' | 'ZPUNP06' | 'ZPUNP07' | 'ZPUNP08' | 'UKNWN': A unique identifier for this specific type of reason or failure - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required: More information about the failure - `failure` object, required - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` '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' | 'UKNWN': A unique identifier for this specific type of reason or failure - PaytoEventBase - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required: More information about the failure - `failure` object, required - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` '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' | 'UKNWN': A unique identifier for this specific type of reason or failure - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `caused_by` 'debtor' | 'initiator' | 'zepto_admin' | 'zepto_system': The party that caused the agreement to be cancelled - `reason` object - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` 'AC02' | 'AC04' | 'AC05' | 'AC06' | 'AC13' | 'AG01' | 'AG03' | 'AM03' | 'AM12' | 'AM14' | 'MD07' | 'MD08' | 'MD09' | 'MD16' | 'MD17' | 'MD20' | 'MD21' | 'MS02' | 'MS03' | 'NARR' | 'RR04' | 'SL01' | 'SL11' | 'SL12' | 'CTAM' | 'CTCA' | 'CTEX' | 'MCFC' | 'MCOC' | 'MSUC' | 'NOAS': A unique identifier for this specific type of reason or failure - `narrative` string, nullable: Free text description to accompany the given reason - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `mms_agreement_id` string, required: The agreement ID as per the MMS. Formatted as a Universally Unique Identifier (UUID) version 1, as described in IETC RFC 4122 without the 4 hyphen separators. - `caused_by` 'debtor', required: The party that caused the agreement to be declined - `reason` object, required - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` 'AC02' | 'AC05' | 'AC06' | 'AC13' | 'AG01' | 'AG03' | 'AM03' | 'AM12' | 'AM14' | 'BE06' | 'MD09' | 'MD16' | 'MD21' | 'NOAS' | 'RR04' | 'SL11' | 'SL12' | 'UKNWN': A unique identifier for this specific type of reason or failure - `resource_metadata` object, nullable: Custom metadata that was supplied to the API when the affected resource was created. - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `mms_agreement_id` string, required: The agreement ID as per the MMS. Formatted as a Universally Unique Identifier (UUID) version 1, as described in IETC RFC 4122 without the 4 hyphen separators. - `resource_metadata` object, nullable: Custom metadata that was supplied to the API when the affected resource was created. - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required: Agreement creation failure details - `reason` object, required - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` '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' | 'ZPUNP01' | 'ZPUNP02' | 'ZPUNP06' | 'ZPUNP07' | 'ZPUNP08' | 'UKNWN': A unique identifier for this specific type of reason or failure - `resource_metadata` object, nullable: Custom metadata that was supplied to the API when the affected resource was created. - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `caused_by` 'debtor' | 'initiator' | 'zepto_admin' | 'zepto_system': The party that caused the agreement to be reactivated - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required: More information about the failure - `failure` object, required - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` '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' | 'UKNWN': A unique identifier for this specific type of reason or failure - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required - `caused_by` 'debtor' | 'initiator' | 'zepto_admin' | 'zepto_system': The party that caused the agreement to be suspended - `reason` object - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` 'AC02' | 'AC04' | 'AC05' | 'AC06' | 'AC13' | 'AG01' | 'AG03' | 'AM03' | 'AM12' | 'AM14' | 'MD07' | 'MD08' | 'MD09' | 'MD16' | 'MD17' | 'MD20' | 'MD21' | 'MS02' | 'MS03' | 'NARR' | 'RR04' | 'SL01' | 'SL11' | 'SL12' | 'CTAM' | 'CTCA' | 'CTEX' | 'MCFC' | 'MCOC' | 'MSUC' | 'NOAS': A unique identifier for this specific type of reason or failure - `narrative` string, nullable: Free text description to accompany the given reason_code - object - `id` string, uuid, required: The ID of the event that triggered the webhook delivery. Value is a UUIDv7 - `type` string, required: The type of event that triggered the webhook delivery - `published_at` string, date-time, required: When the event was published by Zepto - `resource_uid` string, required: Supplied unique identifier for resource that the event affected, maximum 64 characters containing only unreserved characters as defined in RFC3986. - `resource_type` 'payto_agreement' | 'payto_payment' | 'payto_refund', required: The type of resource the resource_uid relates to - `body` object, nullable, required: More information about the failure - `failure` object, required - `title` string: A short description of the reason or failure - `detail` string: A longer description of the reason or failure - `code` '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' | 'UKNWN': A unique identifier for this specific type of reason or failure ## Other responses - `401`: unauthorized - `403`: forbidden - `404`: Not Found - `422`: Unprocessable Entity - `500`: Internal Server Error --- [API](https://skmtc.dev/zeptopayments/apis/zepto-payto-api.md) - [All operations](https://skmtc.dev/zeptopayments/apis/zepto-payto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeptopayments/apis/zepto-payto-api/revisions/dfc64507b23c?raw)