Counterparties

Create Counterparty

Creates a counterparty, optionally with payment accounts.

Identity and account ownership verification evidence is optional. Zepto stores the evidence provided without attempting to validate it.

post/counterparties

Request

Base URL
https://api.sandbox.zeptopayments.com
URL
https://api.sandbox.zeptopayments.com/counterparties
Auth
HTTP bearer

Request body

uidstring required

A supplied unique ID, unique within your account

client_idstring uuid

The ID of the client the counterparty belongs to. Supply the sub-client's ID for counterparties of agreements initiated on its behalf.

metadataPaytoMetadata nullable

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 request

{
  "uid": "cpty_20221231_G7MQWwkQZIP8vbfH",
  "client_id": "01890a5d-ac96-774b-bcce-b302099a8057",
  "identity": {
    "legal_name": "Bobby Baker",
    "verification": {
      "provider": "Veriflux",
      "reference": "veriflux_897879cb89s7dbh765a",
      "verified_at": "2026-08-05T14:14:59+10:00"
    }
  },
  "payment_accounts": [
    {
      "uid": "pa_20221231_G7MQWwkQZIP8vbfH",
      "party_name": "Bobby Baker",
      "account_identifier": {
        "value": "123456-98765432"
      },
      "verification": {
        "provider": "Veriflux",
        "reference": "biz_cop_request_0000123456",
        "verified_at": "2026-08-05T14:14:59+10:00"
      }
    }
  ],
  "metadata": {
    "custom_key": "custom_value"
  }
}

Response

successful

Example response

{
  "data": {
    "uid": "cpty_20221231_G7MQWwkQZIP8vbfH",
    "identity": {
      "legal_name": "Bobby Baker",
      "verification": {
        "provider": "Veriflux",
        "reference": "veriflux_897879cb89s7dbh765a",
        "verified_at": "2026-08-05T14:14:59+10:00"
      }
    },
    "payment_accounts": [
      {
        "uid": "pa_20221231_G7MQWwkQZIP8vbfH",
        "party_name": "Bobby Baker",
        "account_identifier": {
          "value": "123456-98765432"
        },
        "verification": {
          "provider": "Veriflux",
          "reference": "biz_cop_request_0000123456",
          "verified_at": "2026-08-05T14:14:59+10:00"
        }
      }
    ],
    "metadata": {
      "custom_key": "custom_value"
    },
    "client_id": "019fb641-38e7-7f47-8e14-7e8470ff8226",
    "created_at": "2026-08-05T04:14:59Z"
  }
}

Changes

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