Payrix · Schema

contactsPostRequest

CompanyPaymentsEmbedded PaymentsPayment FacilitationMerchant OnboardingFintechPayoutsChargebacksSubscription

Properties

Name Type Description
entity string The identifier of the Entity that this Contact relates to.
first string The first name associated with this Contact.
middle string The middle name associated with this Contact.
last string The last name associated with this Contact.
description string A description of this Contact.
email string The email address of this Contact.
address1 string The first line of the address associated with this Contact. This field is stored as a text string and must be between 1 and 500 characters long.
address2 string The second line of the address associated with this Contact. This field is stored as a text string and must be between 1 and 500 characters long.
city string The name of the city in the address associated with this Contact. This field is stored as a text string and must be between 1 and 500 characters long.
state string The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is
zip string The ZIP code in the address associated with this Contact. This field is stored as a text string and must be between 1 and 20 characters long.
country object
phone string The phone number associated with this Contact. This field is stored as a text string and must be between 10 and 15 characters long.
fax string The fax number associated with this Contact. This field is stored as a text string and must be between 10 and 15 characters long.
frozen object
inactive object
View JSON Schema on GitHub

JSON Schema

payrix-contacts-post-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-contacts-post-request-schema.json",
  "title": "contactsPostRequest",
  "x-generated": "2026-09-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/payrix-contacts-api-openapi.yml#/components/schemas/contactsPostRequest",
  "required": [
    "entity",
    "first",
    "last",
    "email"
  ],
  "type": "object",
  "properties": {
    "entity": {
      "type": "string",
      "description": "The identifier of the Entity that this Contact relates to."
    },
    "first": {
      "type": "string",
      "description": "The first name associated with this Contact."
    },
    "middle": {
      "type": "string",
      "description": "The middle name associated with this Contact."
    },
    "last": {
      "type": "string",
      "description": "The last name associated with this Contact."
    },
    "description": {
      "type": "string",
      "description": "A description of this Contact."
    },
    "email": {
      "type": "string",
      "description": "The email address of this Contact."
    },
    "address1": {
      "type": "string",
      "description": "The first line of the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
    },
    "address2": {
      "type": "string",
      "description": "The second line of the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
    },
    "city": {
      "type": "string",
      "description": "The name of the city in the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
    },
    "state": {
      "type": "string",
      "description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
    },
    "zip": {
      "type": "string",
      "description": "The ZIP code in the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 20 characters long."
    },
    "country": {
      "allOf": [
        {
          "$ref": "#/$defs/country"
        },
        {
          "description": "The country associated with this Contact. \nValid values for this field is the 3-letter ISO code for the country."
        }
      ]
    },
    "phone": {
      "type": "string",
      "description": "The phone number associated with this Contact. \nThis field is stored as a text string and must be between 10 and 15 characters long."
    },
    "fax": {
      "type": "string",
      "description": "The fax number associated with this Contact. \nThis field is stored as a text string and must be between 10 and 15 characters long."
    },
    "frozen": {
      "allOf": [
        {
          "$ref": "#/$defs/frozen"
        },
        {
          "description": "Whether this resource is marked as frozen.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n</details>"
        }
      ]
    },
    "inactive": {
      "allOf": [
        {
          "$ref": "#/$defs/inactive"
        },
        {
          "description": "Whether this resource is marked as inactive.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n</details>"
        }
      ]
    }
  },
  "$defs": {
    "country": {
      "title": "country",
      "enum": [
        "ABW",
        "AFG",
        "AGO",
        "AIA",
        "ALA",
        "ALB",
        "AND",
        "ARE",
        "ARG",
        "ARM",
        "ASM",
        "ATA",
        "ATF",
        "ATG",
        "AUS",
        "AUT",
        "AZE",
        "BDI",
        "BEL",
        "BEN",
        "BES",
        "BFA",
        "BGD",
        "BGR",
        "BHR",
        "BHS",
        "BIH",
        "BLM",
        "BLR",
        "BLZ",
        "BMU",
        "BOL",
        "BRA",
        "BRB",
        "BRN",
        "BTN",
        "BVT",
        "BWA",
        "CAF",
        "CAN",
        "CCK",
        "CHE",
        "CHL",
        "CHN",
        "CIV",
        "CMR",
        "COD",
        "COG",
        "COK",
        "COL",
        "COM",
        "CPV",
        "CRI",
        "CUB",
        "CUW",
        "CXR",
        "CYM",
        "CYP",
        "CZE",
        "DEU",
        "DJI",
        "DMA",
        "DNK",
        "DOM",
        "DZA",
        "ECU",
        "EGY",
        "ERI",
        "ESH",
        "ESP",
        "EST",
        "ETH",
        "FIN",
        "FJI",
        "FLK",
        "FRA",
        "FRO",
        "FSM",
        "GAB",
        "GBR",
        "GEO",
        "GGY",
        "GHA",
        "GIB",
        "GIN",
        "GLP",
        "GMB",
        "GNB",
        "GNQ",
        "GRC",
        "GRD",
        "GRL",
        "GTM",
        "GUF",
        "GUM",
        "GUY",
        "HKG",
        "HMD",
        "HND",
        "HRV",
        "HTI",
        "HUN",
        "IDN",
        "IMN",
        "IND",
        "IOT",
        "IRL",
        "IRN",
        "IRQ",
        "ISL",
        "ISR",
        "ITA",
        "JAM",
        "JEY",
        "JOR",
        "JPN",
        "KAZ",
        "KEN",
        "KGZ",
        "KHM",
        "KIR",
        "KNA",
        "KOR",
        "KWT",
        "LAO",
        "LBN",
        "LBR",
        "LBY",
        "LCA",
        "LIE",
        "LKA",
        "LSO",
        "LTU",
        "LUX",
        "LVA",
        "MAC",
        "MAF",
        "MAR",
        "MCO",
        "MDA",
        "MDG",
        "MDV",
        "MEX",
        "MHL",
        "MKD",
        "MLI",
        "MLT",
        "MMR",
        "MNE",
        "MNG",
        "MNP",
        "MOZ",
        "MRT",
        "MSR",
        "MTQ",
        "MUS",
        "MWI",
        "MYS",
        "MYT",
        "NAM",
        "NCL",
        "NER",
        "NFK",
        "NGA",
        "NIC",
        "NIU",
        "NLD",
        "NOR",
        "NPL",
        "NRU",
        "NZL",
        "OMN",
        "PAK",
        "PAN",
        "PCN",
        "PER",
        "PHL",
        "PLW",
        "PNG",
        "POL",
        "PRI",
        "PRK",
        "PRT",
        "PRY",
        "PSE",
        "PYF",
        "QAT",
        "REU",
        "ROU",
        "RUS",
        "RWA",
        "SAU",
        "SDN",
        "SEN",
        "SGP",
        "SGS",
        "SHN",
        "SJM",
        "SLB",
        "SLE",
        "SLV",
        "SMR",
        "SOM",
        "SPM",
        "SRB",
        "SSD",
        "STP",
        "SUR",
        "SVK",
        "SVN",
        "SWE",
        "SWZ",
        "SXM",
        "SYC",
        "SYR",
        "TCA",
        "TCD",
        "TGO",
        "THA",
        "TJK",
        "TKL",
        "TKM",
        "TLS",
        "TON",
        "TTO",
        "TUN",
        "TUR",
        "TUV",
        "TWN",
        "TZA",
        "UGA",
        "UKR",
        "UMI",
        "URY",
        "USA",
        "UZB",
        "VAT",
        "VCT",
        "VEN",
        "VGB",
        "VIR",
        "VNM",
        "VUT",
        "WLF",
        "WSM",
        "XXK",
        "YEM",
        "ZAF",
        "ZMB",
        "ZWE"
      ],
      "type": "string"
    },
    "frozen": {
      "title": "frozen",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    },
    "inactive": {
      "title": "inactive",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/payrix-contacts-post-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.