---
updatedAt: 2026-08-12T23:47:23.000Z
agentTools:
  projectIndex: https://docs.zeptopayments.com/llms.txt
---

# List Counterparties

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Zepto PayTo API",
    "version": "20260901",
    "description": "Documentation for the Zepto PayTo API.",
    "termsOfService": "https://www.zepto.com.au/customer-terms",
    "contact": {
      "email": "support@zepto.com.au"
    }
  },
  "tags": [
    {
      "name": "Counterparties",
      "description": "A counterparty is the party on the other side of a payment from the initiating\nclient - their customer, employee or supplier. A counterparty has a verifiable\nidentity and can own multiple payment accounts, so identity verification is\ncollected once per counterparty rather than once per bank account.\n"
    }
  ],
  "externalDocs": {
    "description": "Zepto API v1.0",
    "url": "https://docs.zeptopayments.com"
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/counterparties": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZeptoAPIVersion"
        }
      ],
      "get": {
        "summary": "List Counterparties",
        "tags": [
          "Counterparties"
        ],
        "parameters": [
          {
            "name": "client_id",
            "in": "query",
            "required": false,
            "description": "Only return counterparties belonging to this client",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "per_page",
            "description": "Number of results per page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 20,
              "minimum": 1,
              "maximum": 100
            }
          },
          {
            "name": "starting_after",
            "description": "Opaque pagination cursor value. Set by following \"next\" links.",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payto.counterparty_list"
                }
              }
            }
          },
          "401": {
            "description": "unauthorized",
            "content": {
              "application/json": {
                "examples": {
                  "Unauthorised access token": {
                    "summary": "Unauthorised access token",
                    "value": {
                      "errors": [
                        {
                          "title": "Unauthorised access token",
                          "detail": "Access token is expired or not valid",
                          "links": {
                            "about": "https://docs.zeptopayments.com/docs/zepto-api#authentication-and-authorisation"
                          }
                        }
                      ]
                    }
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/payto.generic_errors"
                }
              }
            }
          },
          "403": {
            "description": "forbidden"
          },
          "422": {
            "description": "Unprocessable Entity",
            "content": {
              "application/json": {
                "examples": {
                  "Non integer per_page": {
                    "summary": "Non integer per_page",
                    "value": {
                      "errors": [
                        {
                          "code": "ZCPT07",
                          "title": "Invalid pagination parameters",
                          "detail": "The `per_page` param is not valid."
                        }
                      ]
                    }
                  },
                  "No record with ID matching starting_after param": {
                    "summary": "No record with ID matching starting_after param",
                    "value": {
                      "errors": [
                        {
                          "code": "ZCPT07",
                          "title": "Invalid pagination parameters",
                          "detail": "Could not find a record for the given `starting_after` param."
                        }
                      ]
                    }
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/payto.unprocessable_counterparty_errors"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    }
  },
  "servers": [
    {
      "description": "Zepto Sandbox",
      "url": "https://api.sandbox.zeptopayments.com"
    },
    {
      "description": "Zepto Production",
      "url": "https://api.zeptopayments.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "parameters": {
      "ZeptoAPIVersion": {
        "name": "Zepto-API-Version",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string",
          "pattern": "^\\d{8}$",
          "default": "20250101",
          "example": "20260901"
        },
        "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted."
      }
    },
    "schemas": {
      "payto.account_identifier": {
        "type": "object",
        "description": "An identifier representing the parties account",
        "required": [
          "type",
          "value"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "bban",
              "alias_phone",
              "alias_email",
              "alias_abn",
              "alias_organisation_identifier"
            ]
          },
          "value": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payto.account_identifiers_bban"
              },
              {
                "$ref": "#/components/schemas/payto.account_identifiers_alias_email"
              },
              {
                "$ref": "#/components/schemas/payto.account_identifiers_alias_phone"
              },
              {
                "$ref": "#/components/schemas/payto.account_identifiers_alias_abn"
              },
              {
                "$ref": "#/components/schemas/payto.account_identifiers_alias_organisation_identifier"
              }
            ]
          }
        }
      },
      "payto.account_identifiers_alias_abn": {
        "type": "string",
        "title": "ABN alias",
        "description": "A PayID ABN alias",
        "example": "123456789",
        "pattern": "^((\\d{9})|(\\d{11}))$"
      },
      "payto.account_identifiers_alias_email": {
        "type": "string",
        "title": "Email alias",
        "description": "A PayID email alias",
        "example": "default@example.com",
        "pattern": "^(?:[a-z0-9!#$%&'*+\\/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+\\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)$"
      },
      "payto.account_identifiers_alias_organisation_identifier": {
        "type": "string",
        "title": "Organisation alias",
        "description": "A PayID organisation identifier alias",
        "example": "Zepto Pty Ltd, Byron Bay NSW",
        "pattern": "^[!-@\\[-~][ -@\\[-~]{0,254}[!-@\\[-~]$"
      },
      "payto.account_identifiers_alias_phone": {
        "type": "string",
        "title": "Phone alias",
        "description": "A PayID phone alias. e.g. +61-411222333",
        "example": "+61-411222333",
        "pattern": "^\\+[0-9]{1,3}-[1-9]{1,1}[0-9]{1,29}$"
      },
      "payto.account_identifiers_bban": {
        "type": "string",
        "title": "BBAN",
        "description": "A branch code (BSB) and account number separated with a hyphen",
        "example": "123456-98765432",
        "pattern": "^\\d{6}-[ -~]{1,28}$"
      },
      "payto.counterparty_identity": {
        "type": "object",
        "description": "The verifiable identity of the counterparty, separate from any of their payment accounts",
        "required": [
          "legal_name"
        ],
        "properties": {
          "legal_name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 140,
            "pattern": "^(?!.*&(?:[a-zA-Z][a-zA-Z0-9]*|#[0-9]+|#[xX][0-9a-fA-F]+);)[ -~]+$",
            "description": "The legal name of the person or organisation as verified by KYC",
            "example": "Bobby Baker"
          },
          "verification": {
            "type": "object",
            "nullable": true,
            "description": "Evidence that the counterparty's identity has been verified.",
            "required": [
              "type"
            ],
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "third_party_provider"
                ]
              },
              "provider": {
                "type": "string",
                "description": "The KYC provider that performed the verification. Required for third_party_provider.",
                "example": "Veriflux"
              },
              "reference": {
                "type": "string",
                "description": "The provider's reference for the verification result",
                "example": "veriflux_897879cb89s7dbh765a"
              },
              "verified_at": {
                "type": "string",
                "format": "date-time",
                "example": "2026-08-05T14:14:59+10:00"
              }
            }
          }
        }
      },
      "payto.counterparty_list": {
        "type": "object",
        "properties": {
          "links": {
            "type": "object",
            "properties": {
              "next": {
                "type": "string",
                "description": "URL for next page of results. Won't be present if there are no further pages."
              }
            },
            "example": {}
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payto.counterparty_response"
            }
          }
        }
      },
      "payto.counterparty_payment_account": {
        "type": "object",
        "description": "An account the counterparty can be paid from or to. The party name and identifier are immutable once created: provide a new payment account for a changed account rather than amending an existing one.",
        "required": [
          "uid",
          "party_name",
          "account_identifier"
        ],
        "properties": {
          "uid": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[A-Za-z0-9\\-._~]+$",
            "description": "A supplied unique ID, unique within your account",
            "example": "pa_20221231_G7MQWwkQZIP8vbfH"
          },
          "party_name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 140,
            "pattern": "^(?!.*&(?:[a-zA-Z][a-zA-Z0-9]*|#[0-9]+|#[xX][0-9a-fA-F]+);)[ -~]+$",
            "description": "Name by which the account holder is known and which is usually used to identify them. HTML name entities are not allowed. Agreements, amendments and payments that reference this payment account must name the party with this exact name, ignoring case, in the debtor or creditor ultimate_party_name. When an agreement is uplifted with add_identification, the payment account is matched against the debtor ultimate_party_name already on the agreement.",
            "example": "Bobby Baker"
          },
          "account_identifier": {
            "$ref": "#/components/schemas/payto.account_identifier"
          },
          "verification": {
            "type": "object",
            "nullable": true,
            "description": "Evidence that this account is owned by the verified identity of the counterparty.",
            "required": [
              "type"
            ],
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "zepto_validate",
                  "alias_resolution",
                  "third_party_provider"
                ]
              },
              "provider": {
                "type": "string",
                "description": "The provider that performed the verification. Required for third_party_provider, and not allowed for zepto_validate or alias_resolution, where Zepto performed the check.",
                "example": "Veriflux"
              },
              "reference": {
                "type": "string",
                "description": "The reference for the verification result: a Zepto Validate uid, the PayID alias whose display name was resolved for alias_resolution, or the provider's reference.",
                "example": "biz_cop_request_0000123456"
              },
              "verified_at": {
                "type": "string",
                "format": "date-time",
                "example": "2026-08-05T14:14:59+10:00"
              }
            }
          }
        }
      },
      "payto.counterparty_response": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "uid",
          "client_id",
          "created_at",
          "identity",
          "payment_accounts",
          "metadata"
        ],
        "properties": {
          "uid": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[A-Za-z0-9\\-._~]+$",
            "description": "A supplied unique ID, unique within your account",
            "example": "cpty_20221231_G7MQWwkQZIP8vbfH"
          },
          "identity": {
            "$ref": "#/components/schemas/payto.counterparty_identity"
          },
          "payment_accounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payto.counterparty_payment_account"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/payto.metadata"
          },
          "client_id": {
            "type": "string",
            "format": "uuid",
            "description": "The client this counterparty belongs to",
            "example": "019fb641-38e7-7f47-8e14-7e8470ff8226"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2026-08-05T04:14:59Z"
          }
        }
      },
      "payto.generic_error": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "title": {
            "type": "string",
            "example": "Title of error"
          },
          "detail": {
            "type": "string",
            "description": "A short description of the error",
            "example": "Description of error"
          },
          "links": {
            "type": "object",
            "properties": {
              "about": {
                "type": "string",
                "description": "An optional link to more information on the error",
                "example": "https://docs.zeptopayments.com/docs/zepto-environments"
              }
            },
            "required": [
              "about"
            ]
          },
          "meta": {
            "type": "object",
            "description": "Optional meta information about the error",
            "properties": {
              "resource_ref": {
                "type": "string",
                "description": "Resource reference of the resource impacted by the error",
                "example": "P2PAY.1000"
              },
              "resource_uid": {
                "type": "string",
                "description": "Supplied ID of the resource impacted by the error",
                "example": "payment_34fj8djh2"
              }
            }
          }
        },
        "required": [
          "title",
          "detail"
        ]
      },
      "payto.generic_errors": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "minItems": 1,
            "items": {
              "$ref": "#/components/schemas/payto.generic_error"
            }
          }
        },
        "required": [
          "errors"
        ]
      },
      "payto.metadata": {
        "type": "object",
        "nullable": true,
        "description": "Use for your custom data. A place to store any miscellaneous information your system may need in regards to the record you are creating. This will be included in associated webhook payloads under the `resource_metadata` key. Nested values (i.e., objects and arrays) are not allowed. The maximum size of this parameter is 2kb.",
        "example": {
          "custom_key": "custom_value"
        }
      },
      "payto.unprocessable_counterparty_error": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "title",
          "detail",
          "code"
        ],
        "properties": {
          "title": {
            "type": "string",
            "example": "Title of error"
          },
          "code": {
            "type": "string",
            "description": "A code assigned to the type of error received",
            "example": "E100",
            "enum": [
              "ZCPT00",
              "ZCPT03",
              "ZCPT04",
              "ZCPT05",
              "ZCPT06",
              "ZCPT07"
            ]
          },
          "detail": {
            "type": "string",
            "description": "A short description of the error",
            "example": "Description of error"
          },
          "links": {
            "type": "object",
            "properties": {
              "about": {
                "type": "string",
                "description": "An optional link to more information on the error",
                "example": "https://docs.zeptopayments.com/docs/zepto-environments"
              }
            },
            "required": [
              "about"
            ]
          },
          "meta": {
            "type": "object",
            "description": "Optional meta information about the error",
            "properties": {
              "resource_ref": {
                "type": "string",
                "description": "Resource reference of the resource impacted by the error",
                "example": "P2PAY.1000"
              },
              "resource_uid": {
                "type": "string",
                "description": "Supplied ID of the resource impacted by the error",
                "example": "payment_34fj8djh2"
              }
            }
          }
        }
      },
      "payto.unprocessable_counterparty_errors": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "minItems": 1,
            "items": {
              "$ref": "#/components/schemas/payto.unprocessable_counterparty_error"
            }
          }
        },
        "required": [
          "errors"
        ]
      }
    }
  }
}
```